{
"componentDescription": "",
"propDescriptions": {
"boundaryCount": { "description": "Number of always visible pages at the beginning and end." },
"classes": { "description": "Override or extend the styles applied to the component." },
"color": {
"description": "The active color. It supports both default and custom theme colors, which can be added as shown in the palette customization guide."
},
"count": { "description": "The total number of pages." },
"defaultPage": {
"description": "The page selected by default when the component is uncontrolled."
},
"disabled": { "description": "If true, the component is disabled." },
"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.
For localization purposes, you can use the provided translations.",
"typeDescriptions": {
"type": {
"name": "type",
"description": "The link or button type to format ('page' | 'first' | 'last' | 'next' | 'previous' | 'start-ellipsis' | 'end-ellipsis'). Defaults to 'page'."
},
"page": { "name": "page", "description": "The page number to format." },
"selected": { "name": "selected", "description": "If true, the current page is selected." }
}
},
"hideNextButton": { "description": "If true, hide the next-page button." },
"hidePrevButton": { "description": "If true, hide the previous-page button." },
"onChange": {
"description": "Callback fired when the page is changed.",
"typeDescriptions": {
"event": { "name": "event", "description": "The event source of the callback." },
"page": { "name": "page", "description": "The page selected." }
}
},
"page": {
"description": "The current page. Unlike TablePagination, which starts numbering from 0, this pagination starts from 1."
},
"renderItem": {
"description": "Render the item.",
"typeDescriptions": {
"params": { "name": "params", "description": "The props to spread on a PaginationItem." }
}
},
"shape": { "description": "The shape of the pagination items." },
"showFirstButton": { "description": "If true, show the first-page button." },
"showLastButton": { "description": "If true, show the last-page button." },
"siblingCount": {
"description": "Number of always visible pages before and after the current page."
},
"size": { "description": "The size of the component." },
"sx": {
"description": "The system prop that allows defining system overrides as well as additional CSS styles."
},
"variant": { "description": "The variant to use." }
},
"classDescriptions": {
"outlined": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the root element",
"conditions": "variant=\"outlined\""
},
"root": { "description": "Styles applied to the root element." },
"text": {
"description": "Styles applied to {{nodeName}} if {{conditions}}.",
"nodeName": "the root element",
"conditions": "variant=\"text\""
},
"ul": { "description": "Styles applied to {{nodeName}}.", "nodeName": "the ul element" }
}
}