Some checks failed
No response / noResponse (push) Has been cancelled
CI / Continuous releases (push) Has been cancelled
CI / test-dev (macos-latest) (push) Has been cancelled
CI / test-dev (ubuntu-latest) (push) Has been cancelled
CI / test-dev (windows-latest) (push) Has been cancelled
Maintenance / main (push) Has been cancelled
Scorecards supply-chain security / Scorecards analysis (push) Has been cancelled
CodeQL / Analyze (push) Has been cancelled
69 lines
3.4 KiB
JSON
69 lines
3.4 KiB
JSON
{
|
|
"componentDescription": "A pagination for tables.",
|
|
"propDescriptions": {
|
|
"count": {
|
|
"description": "The total number of rows.<br>To enable server side pagination for an unknown number of items, provide -1."
|
|
},
|
|
"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=\"https://mui.com/material-ui/guides/localization/\">translations</a>.",
|
|
"typeDescriptions": {
|
|
"type": "The link or button type to format ('first' | 'last' | 'next' | 'previous')."
|
|
}
|
|
},
|
|
"labelDisplayedRows": {
|
|
"description": "Customize the displayed rows label. Invoked with a <code>{ from, to, count, page }</code> object.<br>For localization purposes, you can use the provided <a href=\"https://mui.com/material-ui/guides/localization/\">translations</a>."
|
|
},
|
|
"labelId": { "description": "Id of the label element within the pagination." },
|
|
"labelRowsPerPage": {
|
|
"description": "Customize the rows per page label.<br>For localization purposes, you can use the provided <a href=\"https://mui.com/material-ui/guides/localization/\">translations</a>."
|
|
},
|
|
"onPageChange": {
|
|
"description": "Callback fired when the page is changed.",
|
|
"typeDescriptions": {
|
|
"event": "The event source of the callback.",
|
|
"page": "The page selected."
|
|
}
|
|
},
|
|
"onRowsPerPageChange": {
|
|
"description": "Callback fired when the number of rows per page is changed.",
|
|
"typeDescriptions": { "event": "The event source of the callback." }
|
|
},
|
|
"page": { "description": "The zero-based index of the current page." },
|
|
"rowsPerPage": {
|
|
"description": "The number of rows per page.<br>Set -1 to display all the rows."
|
|
},
|
|
"rowsPerPageOptions": {
|
|
"description": "Customizes the options of the rows per page select field. If less than two options are available, no select field will be displayed. Use -1 for the value with a custom label to show all the rows."
|
|
},
|
|
"selectId": { "description": "Id of the select element within the pagination." },
|
|
"slotProps": { "description": "The props used for each slot inside the TablePagination." },
|
|
"slots": {
|
|
"description": "The components used for each slot inside the TablePagination. Either a string to use a HTML element or a component."
|
|
}
|
|
},
|
|
"classDescriptions": {
|
|
"input": {
|
|
"description": "Class name applied to {{nodeName}}.",
|
|
"nodeName": "the Select component <code>root</code> element"
|
|
},
|
|
"selectIcon": {
|
|
"description": "Class name applied to {{nodeName}}.",
|
|
"nodeName": "the Select component <code>icon</code> class"
|
|
},
|
|
"selectRoot": {
|
|
"description": "Class name applied to {{nodeName}}.",
|
|
"nodeName": "the Select component <code>root</code> element"
|
|
}
|
|
},
|
|
"slotDescriptions": {
|
|
"actions": "The component that renders the actions.",
|
|
"displayedRows": "The component that renders the displayed rows.",
|
|
"menuItem": "The component that renders the menu item.",
|
|
"root": "The component that renders the root.",
|
|
"select": "The component that renders the select.",
|
|
"selectLabel": "The component that renders the select label.",
|
|
"spacer": "The component that renders the spacer.",
|
|
"toolbar": "The component that renders the toolbar."
|
|
}
|
|
}
|