[material-ui][Pagination] Update type parameter of `getItemAriaLabe…

…l` prop (#39390) Co-authored-by: ZeeshanTamboli <[email protected]>
mui · Oct 11, 2023 · 604d819 · 604d819
1 parent e417dcf
commit 604d819
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 8 deletions.
diff --git a/docs/translations/api-docs/pagination/pagination.json b/docs/translations/api-docs/pagination/pagination.json
@@ -14,7 +14,7 @@
     "getItemAriaLabel": {
       "description": "Accepts a function which returns a string value that provides a user-friendly name for the current page. This is important for screen reader users.<br>For localization purposes, you can use the provided <a href=\"/material-ui/guides/localization/\">translations</a>.",
       "typeDescriptions": {
-        "type": "The link or button type to format (&#39;page&#39; | &#39;first&#39; | &#39;last&#39; | &#39;next&#39; | &#39;previous&#39;). Defaults to &#39;page&#39;.",
+        "type": "The link or button type to format (&#39;page&#39; | &#39;first&#39; | &#39;last&#39; | &#39;next&#39; | &#39;previous&#39; | &#39;start-ellipsis&#39; | &#39;end-ellipsis&#39;). Defaults to &#39;page&#39;.",
         "page": "The page number to format.",
         "selected": "If true, the current page is selected."
       }

diff --git a/packages/mui-material/src/Pagination/Pagination.d.ts b/packages/mui-material/src/Pagination/Pagination.d.ts
@@ -41,16 +41,13 @@ export interface PaginationProps
    * This is important for screen reader users.
    *
    * 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'). Defaults to 'page'.
+   * @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.
    * @returns {string}
    */
-  getItemAriaLabel?: (
-    type: 'page' | 'first' | 'last' | 'next' | 'previous',
-    page: number,
-    selected: boolean,
-  ) => string;
+  getItemAriaLabel?: (type: UsePaginationItem['type'], page: number, selected: boolean) => string;
+
   /**
    * Render the item.
    * @param {PaginationRenderItemParams} 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
@@ -174,7 +174,7 @@ Pagination.propTypes /* remove-proptypes */ = {
    * This is important for screen reader users.
    *
    * 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'). Defaults to 'page'.
+   * @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.
    * @returns {string}