Skip to content

Specify how ListBox works with DataProvider #5862

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.

Sign up for GitHub

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

Open
HerbertsVaadin wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Specify how ListBox works with DataProvider #5862

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions articles/components/list-box/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,9 @@ List Box isn't designed to be used as an input field in forms, and lacks feature
See related components later for better options for use in forms.
List Box is best suited for use as a lightweight, scrollable, single-column list for single or multi-selection of items.

The List Box API supports using a [classname]`DataProvider` as its data source. However, List Box does not support lazy loading: all items are fetched from the data provider at once. For large data sets, consider using Virtual List or Grid for displaying items, or Combo Box or Multi-Select Combo Box when selection is required.


== Related Components

|===
Expand All @@ -222,6 +225,9 @@ List Box is best suited for use as a lightweight, scrollable, single-column list
|<<../combo-box#,Combo Box>>
|Select a value from a filterable overlay. Appropriate for large sets of options. Supports lazy loading and entry of custom values.

|<<../multi-select-combo-box#,Multi-Select Combo Box>>
| Select multiple values from a filterable overlay. Appropriate for large sets of options and supports lazy loading.

|<<../radio-button#,Radio Button Group>>
|Select a single option from a list. Optimal accessibility, as all options are visible without any user action.

Expand All @@ -230,6 +236,10 @@ List Box is best suited for use as a lightweight, scrollable, single-column list

|<<../grid#,Grid>>
|A more advanced list component for cases where multiple columns, filtering or lazy loading is required.

|<<../virtual-list#,Virtual List>>
| Display a large, scrollable list of items with lazy loading and custom item rendering.

|===


Expand Down
Loading