mention the scroll to index issue in TreeGrid #636
Merged
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
sosa-vaadin
removed
the
Language unchecked
sissbruecker
reviewed
Jul 8, 2021
magi42
approved these changes
Jul 9, 2021
rolfsmeds
requested changes
Jul 12, 2021
| @@ -89,6 +89,17 @@ include::{root}/src/main/java/com/vaadin/demo/domain/Person.java[group=Java,tags | |||
|
|
|||
| Tree Grid is not meant to be used as a navigation menu. | |||
|
|
|||
| === Avoid Using Scroll to Index | |||
There was a problem hiding this comment.
This feels like an unncessarily detailed explanation of why scrollToIndex is problematic. We really just need to explain that scrollToIndex is not reliable and thus should be avoided.
| Without the knowledge of the complete hierarchy, Tree Grid cannot reliably calculate an exact scroll position. | ||
| Therefore, the effective index of an item depends on the complete hierarchy of the tree. | ||
|
|
||
| .Index of items can vary |
There was a problem hiding this comment.
This admonition title doesn't do a very good job of summarizing the problem, which is that scrollToIndex is not reliable.
I propose omitting the long explanation above in favor of an admonition like:
.scrollToIndex not reliable
CAUTION: The behavior of the scrollToIndex method in Tree Grid is not deterministic due to lazy loading hierarchical data. Usage of this method is not recommended.
sosa-vaadin
force-pushed
the
scroll-to-index
branch
from
b31c78b
to
8b6117d
Compare
rolfsmeds
approved these changes
Jul 14, 2021
sosa-vaadin
force-pushed
the
scroll-to-index
branch
from
8b6117d
to
fbb6b91
Compare
magi42
pushed a commit
that referenced
this pull request
Sep 9, 2021
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
Add a mention to an issue with the
scrollToIndex(index)method in TreeGrid.Related issue: vaadin/flow-components#1016