[docs] Improve data grid pageSizeOptions prop documentation
#11682
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
oliviertassinari
added
docs
oliviertassinari
force-pushed
the
pageSizeOptions
branch
from
34a1aa0
to
1a44f0e
Compare
|
Deploy preview: https://deploy-preview-11682--material-ui-x.netlify.app/ Updated pages: |
oliviertassinari
added
the
feature: Pagination
oliviertassinari
changed the title
| @@ -11,14 +11,20 @@ By default, each page contains 100 rows. The user can change the size of the pag | |||
|
|
|||
| ### Page size options | |||
|
|
|||
| You can configure the page size the user can choose from with the `pageSizeOptions` prop. | |||
There was a problem hiding this comment.
The first two sentences says the same thing.
| You should either provide an array of: | ||
|
|
||
| - **numbers**, each number will be used for the option's label and value. | ||
|
|
||
| - **objects**, the `value` and `label` keys will be used respectively for the value and label of the option (useful for language strings such as 'All'). |
There was a problem hiding this comment.
useful for language strings such as 'All'
is false information.
<DataGrid pageSizeOptions={[{ value: -1, label: 'All' }]}>Doesn't work
There was a problem hiding this comment.
Interesting. Should we support this use case anyways? I wonder if it'd be solved better by turning pagination off rather than supporting it with pageSizeOptions.
Signed-off-by: Olivier Tassinari <[email protected]>
| You can configure the page size the user can choose from with the `pageSizeOptions` prop. | ||
|
|
||
| It's possible to customize the options shown in the "Rows per page" select using the `pageSizeOptions` prop. | ||
| You should either provide an array of: |
There was a problem hiding this comment.
This is wrong, it's not Array<number> | Array<object> but Array<number | object>.
Signed-off-by: Olivier Tassinari <[email protected]>
Signed-off-by: Olivier Tassinari <[email protected]>
MBilalShafi
changed the title
pageSizeOptions docs
MBilalShafi
approved these changes
Jan 14, 2024
MBilalShafi
changed the title
pageSizeOptions docspageSizeOptions prop documentation
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.
This is a continuation of #9438. I saw this from mui/material-ui#40589
Preview https://deploy-preview-11682--material-ui-x.netlify.app/x/react-data-grid/pagination/#page-size-options