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

[combo-box] Clarify filtering with dataProvider #5069

Open
steverep opened this issue Nov 22, 2022 · 1 comment
Open

[combo-box] Clarify filtering with dataProvider #5069

steverep opened this issue Nov 22, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation vaadin-combo-box

Comments

@steverep
Copy link
Contributor

Description

The [documentation for vaadin-combo-box](https://cdn.vaadin.com/vaadin-web-components/23.3.0-alpha2/#/elements/vaadin-combo-box) does not adequately describe how the params.filter` should affect the returned results. Basically there would be 2 options:

  1. Apply the filter to the entire data set, then paginate the results, i.e. items always has a full page of results (except the last) and size is the total number of filtered results
  2. Paginate the data set, then apply the filter to the requested page, i.e. size is the total number of unfiltered items and the returned items could be empty

I presume that option 1 is correct, but it would be nice if the docs were clearer. The example does not use params.filter so it also cannot be inferred from that.

Expected outcome

Clearer docs specifying one of the 2 options above.

Minimal reproducible example

n/a

Steps to reproduce

n/a

Environment

n/a

Browsers

No response

@steverep
Copy link
Contributor Author

Along the same lines, also assume the page numbers start at 1, but nice to clarify.

@web-padawan web-padawan added documentation Improvements or additions to documentation vaadin-combo-box labels Nov 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation vaadin-combo-box
Projects
None yet
Development

No branches or pull requests

2 participants