Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TreeList Virtual Scrolling #2089

Merged
merged 11 commits into from
May 14, 2024
Merged

TreeList Virtual Scrolling #2089

merged 11 commits into from
May 14, 2024

Conversation

svdimitr
Copy link
Contributor

@svdimitr svdimitr commented May 9, 2024

@svdimitr svdimitr requested a review from a team May 9, 2024 13:57
@svdimitr svdimitr self-assigned this May 9, 2024
@svdimitr svdimitr requested a review from a team as a code owner May 9, 2024 13:57
## Enabling Virtual Scrolling

* Set the `ScrollMode` parameter to `TreeListScrollMode.Virtual` (the default value is `Scrollable`).
* Set the `Height` and `RowHeight` parameters.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can mention explicitly here that one parameter is string, while the other is decimal.

svdimitr and others added 3 commits May 13, 2024 14:20
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
Co-authored-by: Dimo Dimov <961014+dimodi@users.noreply.github.com>
}
````

## Notes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Notes is non-structured content that should be avoided. Consider moving everything to another place with better structure. For example, some of the notes can go to the "Using" section and some notes can go to a new "Setting/Using RowHeight" section.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I completely agree that must change the way we present the information in the Notes section. I suggest that we make that decision when the PR for the Grid Virtual Scrolling page is submitted.

components/treelist/virtual-scrolling.md Outdated Show resolved Hide resolved
components/treelist/virtual-scrolling.md Outdated Show resolved Hide resolved
## Enabling Virtual Scrolling

* Set the `ScrollMode` parameter to `TreeListScrollMode.Virtual` (the default value is `Scrollable`).
* Set the `Height` and `RowHeight` parameters.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • You may want to give some guidance on how to set these parameters correctly so the developer can reduce the potential issues. You mention them multiple times in the "Notes" section below and they seem pretty important for the proper configuration.
  • You may want to mention how the different values will affect the behavior and performance.

}
````

## Notes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed, these types of sections aren't user-friendly and don't provide enough context and structure to help the developer with the implementation. Consider transforming this section by using any of the approaches below or a combination of them:

  • Split the Notes section into several sections describing specific implementations, their common pitfalls and ways to avoid them.
  • Move some of the information to KBs.
  • Use sample code with detailed comments explaining what to watch for. If appropriate, use tabs to demonstrate alternative ways.

components/treelist/virtual-scrolling.md Outdated Show resolved Hide resolved
components/treelist/virtual-scrolling.md Outdated Show resolved Hide resolved
components/treelist/virtual-scrolling.md Outdated Show resolved Hide resolved
components/treelist/virtual-scrolling.md Outdated Show resolved Hide resolved
svdimitr and others added 6 commits May 14, 2024 18:23
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
Co-authored-by: Yordan <60105689+yordan-mitev@users.noreply.github.com>
@dimodi dimodi merged commit d6c199f into master May 14, 2024
1 check passed
@github-actions github-actions bot deleted the treelist-virtual-rows branch May 14, 2024 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants