[docs][material-ui][Pagination] Clarify pagination page prop API (m…

…ui#42220) Signed-off-by: Mandar-Pandya <[email protected]> Co-authored-by: ZeeshanTamboli <[email protected]>
sai6855 · May 16, 2024 · 7882099 · 7882099
1 parent 997bec6
commit 7882099
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/docs/translations/api-docs/pagination/pagination.json b/docs/translations/api-docs/pagination/pagination.json
@@ -28,7 +28,9 @@
         "page": "The page selected."
       }
     },
-    "page": { "description": "The current page." },
+    "page": {
+      "description": "The current page. Unlike <code>TablePagination</code>, which starts numbering from <code>0</code>, this pagination starts from <code>1</code>."
+    },
     "renderItem": {
       "description": "Render the item.",
       "typeDescriptions": { "params": "The props to spread on a PaginationItem." }

diff --git a/packages/mui-material/src/Pagination/Pagination.js b/packages/mui-material/src/Pagination/Pagination.js
@@ -199,7 +199,7 @@ Pagination.propTypes /* remove-proptypes */ = {
    */
   onChange: PropTypes.func,
   /**
-   * The current page.
+   * The current page. Unlike `TablePagination`, which starts numbering from `0`, this pagination starts from `1`.
    */
   page: integerPropType,
   /**

diff --git a/packages/mui-material/src/usePagination/usePagination.d.ts b/packages/mui-material/src/usePagination/usePagination.d.ts
@@ -43,7 +43,7 @@ export interface UsePaginationProps {
    */
   onChange?: (event: React.ChangeEvent<unknown>, page: number) => void;
   /**
-   * The current page.
+   * The current page. Unlike `TablePagination`, which starts numbering from `0`, this pagination starts from `1`.
    */
   page?: number;
   /**