[material-ui][Pagination] Update getItemAriaLabel page param type (#…

…43399)
mui · Aug 23, 2024 · 9f4b846 · 9f4b846
1 parent 7b72eb3
commit 9f4b846
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 6 deletions.
diff --git a/docs/pages/material-ui/api/pagination.json b/docs/pages/material-ui/api/pagination.json
@@ -15,7 +15,7 @@
     "getItemAriaLabel": {
       "type": { "name": "func" },
       "signature": {
-        "type": "function(type: string, page: number, selected: bool) => string",
+        "type": "function(type: string, page: number | null, selected: boolean) => string",
         "describedArgs": ["type", "page", "selected"]
       }
     },

diff --git a/packages/mui-material/src/Pagination/Pagination.d.ts b/packages/mui-material/src/Pagination/Pagination.d.ts
@@ -42,11 +42,15 @@ export interface PaginationProps
    *
    * For localization purposes, you can use the provided [translations](/material-ui/guides/localization/).
    * @param {string} type The link or button type to format ('page' | 'first' | 'last' | 'next' | 'previous' | 'start-ellipsis' | 'end-ellipsis'). Defaults to 'page'.
-   * @param {number} page The page number to format.
-   * @param {bool} selected If true, the current page is selected.
+   * @param {number | null} page The page number to format.
+   * @param {boolean} selected If true, the current page is selected.
    * @returns {string}
    */
-  getItemAriaLabel?: (type: UsePaginationItem['type'], page: number, selected: boolean) => string;
+  getItemAriaLabel?: (
+    type: UsePaginationItem['type'],
+    page: UsePaginationItem['page'],
+    selected: UsePaginationItem['selected'],
+  ) => string;
 
   /**
    * Render the item.

diff --git a/packages/mui-material/src/Pagination/Pagination.js b/packages/mui-material/src/Pagination/Pagination.js
@@ -176,8 +176,8 @@ Pagination.propTypes /* remove-proptypes */ = {
    *
    * For localization purposes, you can use the provided [translations](/material-ui/guides/localization/).
    * @param {string} type The link or button type to format ('page' | 'first' | 'last' | 'next' | 'previous' | 'start-ellipsis' | 'end-ellipsis'). Defaults to 'page'.
-   * @param {number} page The page number to format.
-   * @param {bool} selected If true, the current page is selected.
+   * @param {number | null} page The page number to format.
+   * @param {boolean} selected If true, the current page is selected.
    * @returns {string}
    */
   getItemAriaLabel: PropTypes.func,