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
92 lines
5.6 KiB
JSON
92 lines
5.6 KiB
JSON
{
|
|
"componentDescription": "A `TableCell` based component for placing inside `TableFooter` for pagination.",
|
|
"propDescriptions": {
|
|
"ActionsComponent": {
|
|
"description": "The component used for displaying the actions. Either a string to use a HTML element or a component."
|
|
},
|
|
"backIconButtonProps": {
|
|
"description": "Props applied to the back arrow <a href=\"https://mui.com/material-ui/api/icon-button/\"><code>IconButton</code></a> component.<br>This prop is an alias for <code>slotProps.actions.previousButton</code> and will be overridden by it if both are used."
|
|
},
|
|
"classes": { "description": "Override or extend the styles applied to the component." },
|
|
"component": {
|
|
"description": "The component used for the root node. Either a string to use a HTML element or a component."
|
|
},
|
|
"count": {
|
|
"description": "The total number of rows.<br>To enable server side pagination for an unknown number of items, provide -1."
|
|
},
|
|
"disabled": { "description": "If <code>true</code>, 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.<br>For localization purposes, you can use the provided <a href=\"https://mui.com/material-ui/guides/localization/\">translations</a>.",
|
|
"typeDescriptions": {
|
|
"type": {
|
|
"name": "type",
|
|
"description": "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>."
|
|
},
|
|
"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>."
|
|
},
|
|
"nextIconButtonProps": {
|
|
"description": "Props applied to the next arrow <a href=\"https://mui.com/material-ui/api/icon-button/\"><code>IconButton</code></a> element.<br>This prop is an alias for <code>slotProps.actions.nextButton</code> and will be overridden by it if both are used."
|
|
},
|
|
"onPageChange": {
|
|
"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." }
|
|
}
|
|
},
|
|
"onRowsPerPageChange": {
|
|
"description": "Callback fired when the number of rows per page is changed.",
|
|
"typeDescriptions": {
|
|
"event": { "name": "event", "description": "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."
|
|
},
|
|
"SelectProps": {
|
|
"description": "Props applied to the rows per page <a href=\"https://mui.com/material-ui/api/select/\"><code>Select</code></a> element.<br>This prop is an alias for <code>slotProps.select</code> and will be overridden by it if both are used."
|
|
},
|
|
"showFirstButton": { "description": "If <code>true</code>, show the first-page button." },
|
|
"showLastButton": { "description": "If <code>true</code>, show the last-page button." },
|
|
"slotProps": { "description": "The props used for each slot inside." },
|
|
"slots": { "description": "The components used for each slot inside." },
|
|
"sx": {
|
|
"description": "The system prop that allows defining system overrides as well as additional CSS styles."
|
|
}
|
|
},
|
|
"classDescriptions": {
|
|
"input": {
|
|
"description": "Styles applied to {{nodeName}}.",
|
|
"nodeName": "the Select component <code>root</code> element"
|
|
},
|
|
"selectIcon": {
|
|
"description": "Styles applied to {{nodeName}}.",
|
|
"nodeName": "the Select component <code>icon</code> class"
|
|
},
|
|
"selectRoot": {
|
|
"description": "Styles applied to {{nodeName}}.",
|
|
"nodeName": "the Select component <code>root</code> element"
|
|
}
|
|
},
|
|
"slotDescriptions": {
|
|
"actions": "The slots that passed to the actions slot.",
|
|
"displayedRows": "The tag that renders the displayedRows slot.",
|
|
"menuItem": "The component that renders the select slot. <a href=\"https://mui.com/material-ui/api/menu-item/#props\">Follow this guide</a> to learn more about the requirements for this component.",
|
|
"root": "The component that renders the root slot. <a href=\"https://mui.com/material-ui/api/table-cell/#props\">Follow this guide</a> to learn more about the requirements for this component.",
|
|
"select": "The component that renders the select slot. <a href=\"https://mui.com/material-ui/api/select/#props\">Follow this guide</a> to learn more about the requirements for this component.",
|
|
"selectLabel": "The tag that renders the selectLabel slot.",
|
|
"spacer": "The tag that renders the spacer slot.",
|
|
"toolbar": "The component that renders the toolbar slot. <a href=\"https://mui.com/material-ui/api/toolbar/#props\">Follow this guide</a> to learn more about the requirements for this component."
|
|
}
|
|
}
|