Skip to content

Commit df6516e

Browse files
github-actions[bot]Mandar-PandyaZeeshanTamboli
authored
[docs][material-ui][Pagination] Clarify pagination page prop API (@Mandar-Pandya) (#42265)
Signed-off-by: Mandar-Pandya <[email protected]> Co-authored-by: Mandar-Pandya <[email protected]> Co-authored-by: ZeeshanTamboli <[email protected]>
1 parent 607daac commit df6516e

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

docs/translations/api-docs/pagination/pagination.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@
2828
"page": "The page selected."
2929
}
3030
},
31-
"page": { "description": "The current page." },
31+
"page": {
32+
"description": "The current page. Unlike <code>TablePagination</code>, which starts numbering from <code>0</code>, this pagination starts from <code>1</code>."
33+
},
3234
"renderItem": {
3335
"description": "Render the item.",
3436
"typeDescriptions": { "params": "The props to spread on a PaginationItem." }

packages/mui-material/src/Pagination/Pagination.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ Pagination.propTypes /* remove-proptypes */ = {
198198
*/
199199
onChange: PropTypes.func,
200200
/**
201-
* The current page.
201+
* The current page. Unlike `TablePagination`, which starts numbering from `0`, this pagination starts from `1`.
202202
*/
203203
page: integerPropType,
204204
/**

packages/mui-material/src/usePagination/usePagination.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ export interface UsePaginationProps {
4343
*/
4444
onChange?: (event: React.ChangeEvent<unknown>, page: number) => void;
4545
/**
46-
* The current page.
46+
* The current page. Unlike `TablePagination`, which starts numbering from `0`, this pagination starts from `1`.
4747
*/
4848
page?: number;
4949
/**

0 commit comments

Comments
 (0)