TablePagination API
Documentação da API para o componente React TablePagination . Aprenda sobre as propriedades disponíveis e a API CSS.
Importação
import TablePagination from '@mui/material/TablePagination';
// ou
import { TablePagination } from '@mui/material';A TableCell based component for placing inside TableFooter for pagination.
Nome do componente
The nameMuiTablePagination can be used when providing default props or style overrides in the theme.Propriedades
Props of the TableCell component are also available.
| Nome | Tipo | Padrão | Descrição |
|---|---|---|---|
| count* | integer | The total number of rows. To enable server side pagination for an unknown number of items, provide -1. | |
| onPageChange* | func | Callback fired when the page is changed. Signature: function(event: object, page: number) => voidevent: The event source of the callback. page: The page selected. | |
| page* | integer | The zero-based index of the current page. | |
| rowsPerPage* | integer | The number of rows per page. Set -1 to display all the rows. | |
| ActionsComponent | elementType | TablePaginationActions | The component used for displaying the actions. Either a string to use a HTML element or a component. |
| backIconButtonProps | object | Props applied to the back arrow IconButton component. | |
| classes | object | Sobrescreve ou extende os estilos aplicados para o componente. Veja a API CSS abaixo para maiores detalhes. | |
| component | elementType | The component used for the root node. Either a string to use a HTML element or a component. | |
| getItemAriaLabel | func | function defaultGetAriaLabel(type) { return `Go to ${type} page`; } | 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. Signature: function(type: string) => stringtype: The link or button type to format ('first' | 'last' | 'next' | 'previous'). |
| labelDisplayedRows | func | function defaultLabelDisplayedRows({ from, to, count }) { return `${from}-${to} of ${count !== -1 ? count : `more than ${to}`}`; } | Customize the displayed rows label. Invoked with a { from, to, count, page } object.For localization purposes, you can use the provided translations. |
| labelRowsPerPage | node | 'Rows per page:' | Customize the rows per page label. For localization purposes, you can use the provided translations. |
| nextIconButtonProps | object | Props applied to the next arrow IconButton element. | |
| onRowsPerPageChange | func | Callback fired when the number of rows per page is changed. Signature: function(event: object) => voidevent: The event source of the callback. | |
| rowsPerPageOptions | Array<number | { label: string, value: number }> | [10, 25, 50, 100] | 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 | object | {} | Props applied to the rows per page Select element. |
| showFirstButton | bool | false | If true, show the first-page button. |
| showLastButton | bool | false | If true, show the last-page button. |
| sx | func | object | The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. |
O
ref é encaminhado para o elemento raiz.Herança
Embora não explicitamente documentado acima, as propriedades do componente TableCell também estão disponíveis em TablePagination. Você pode tirar vantagem disso para manipular componentes aninhados.CSS
| Nome da regra | Classe global | Descrição |
|---|---|---|
| root | .MuiTablePagination-root | Estilos aplicados ao elemento raiz. |
| toolbar | .MuiTablePagination-toolbar | Estilos aplicados a the Toolbar component. |
| spacer | .MuiTablePagination-spacer | Estilos aplicados a the spacer element. |
| selectLabel | .MuiTablePagination-selectLabel | Estilos aplicados a the select label Typography element. |
| selectRoot | .MuiTablePagination-selectRoot | Estilos aplicados a the Select component `root` element. |
| select | .MuiTablePagination-select | Estilos aplicados a the Select component `select` class. |
| selectIcon | .MuiTablePagination-selectIcon | Estilos aplicados a the Select component `icon` class. |
| input | .MuiTablePagination-input | Estilos aplicados a the Select component `root` element. |
| menuItem | .MuiTablePagination-menuItem | Estilos aplicados a the MenuItem component. |
| displayedRows | .MuiTablePagination-displayedRows | Estilos aplicados a the displayed rows Typography element. |
| actions | .MuiTablePagination-actions | Estilos aplicados a the internal `TablePaginationActions` component. |
Você pode sobrescrever o estilo do componente usando uma dessas opções de customização:
- With a global class name.
- With a rule name as part of the component's
styleOverridesproperty in a custom theme.