docs: update scrollIntoView() block parameter description in API documentation #36727
+6
−3
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
github-actions
bot
added
Content:WebAPI
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
FelixTakeOne
changed the title
tengweiherr
reviewed
Nov 11, 2024
| - `end`: Aligns the element's bottom edge with the bottom of the scrollable container, placing the element at the end of the visible area vertically. | ||
| - `nearest`: Scrolls the element to the nearest edge in the vertical direction. If the element is closer to the top edge of the scrollable container, it will align to the top; if it's closer to the bottom | ||
| edge, it will align to the bottom. This minimizes the scrolling distance. | ||
| - Defaults to `start`. | ||
| - `inline` {{optional_inline}} |
There was a problem hiding this comment.
Nice job! I was about to submit the PR too. Since you’ve already created it, would you mind adding descriptions to the inline properties as well?
Something like the following, feel free to use your own words
- `start`: Aligns the left of the element with the left of the visible area of the scrollable ancestor.
- `center`: Aligns the center of the element with the horizontal center of the visible area of the scrollable ancestor.
- `end`: Aligns the right of the element with the right of the visible area of the scrollable ancestor.
- `nearest`: Aligns the element with the nearest horizontal edge of the visible area of the scrollable ancestor.
github-actions
bot
added
size/xs
github-actions
bot
added
size/s
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| - `start`: Aligns the element's left edge with the left of the scrollable container, making the element appear at the start of the visible area horizontally. | ||
| - `center`: Aligns the element horizontally at the center of the scrollable container, positioning it in the middle of the visible area. | ||
| - `end`: Aligns the element's right edge with the right of the scrollable container, placing the element at the end of the visible area horizontally. | ||
| - `nearest`: Scrolls the element to the nearest edge in the horizontal direction. If the element is closer to the left edge of the scrollable container, it will align to the left; if it's closer to the |
There was a problem hiding this comment.
[mdn-linter] reported by reviewdog 🐶
Suggested change
| - `nearest`: Scrolls the element to the nearest edge in the horizontal direction. If the element is closer to the left edge of the scrollable container, it will align to the left; if it's closer to the | |
| - `nearest`: Scrolls the element to the nearest edge in the horizontal direction. If the element is closer to the left edge of the scrollable container, it will align to the left; if it's closer to the |
|
Preview URLs (comment last updated: 2024-11-11 22:28:44) |
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.
Description
Updated the documentation for the
blockparameter inscrollIntoView()to clarify its possible values (start,center,end,nearest) and their effects on vertical alignment. This change improves understanding of the parameter by providing a detailed explanation similar to the existingbehaviorparameter description.Motivation
The original documentation lacked specific details on how the
blockparameter values affect element alignment within the scrollable ancestor. By expanding this section, we help developers better understand the use ofblock, especially in cases where precise element positioning is needed.Additional details
For reference, see MDN scrollIntoView page.
Related issues and pull requests
Fixes #36679