Make the scrollAncestorsToShowRect() function take the limiter element
#14599
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
oleq
reviewed
Jul 18, 2023
| { | ||
| parent, | ||
| getRect, | ||
| alignToTop, | ||
| forceScroll, | ||
| ancestorOffset = 0 | ||
| ancestorOffset = 0, | ||
| limiterElement |
There was a problem hiding this comment.
Shouldn't we add this option to scrollAncestorsToShowTarget() and use it in the document outline instead of making this helper public?
I mean, this limiterElement argument would stay there (it needs docs, BTW) but we wouldn't need to make this low-level API exportable.
There was a problem hiding this comment.
TBH this choice was purely caused by the functions signatures.
scrollAncestorsToShowTarget() has 2 params of which one is optional. I didn't want to enforce passing the nullish ancestorOffset to use limiterElement. However DO was the only place that used this function and it was passing the ancestorOffset anyways, so I guess we can go with your proposal.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Suggested merge commit message (convention)
Feature(utils): Made the
scrollAncestorsToShowRect()function take the limiter element, which will stop it from scrolling further ancestors. Closes #14598.Additional information
The code coverage was essentially provided in
scrollAncestorsToShowTarget()function tests.