materialuiupgraded

Version:

Material-UI's workspace package

75 lines (55 loc) • 5.55 kB

Markdown

--- filename: /packages/material-ui/src/TablePagination/TablePagination.js title: TablePagination API ---  # TablePagination The API documentation of the TablePagination React component. Learn more about the properties and the CSS customization points. ```js import TablePagination from '@material-ui/core/TablePagination'; ``` A `TableCell` based component for placing inside `TableFooter` for pagination. ## Props | Name | Type | Default | Description | |:-----|:-----|:--------|:------------| | ActionsComponent | union: string |  func |  object | TablePaginationActions | The component used for displaying the actions. Either a string to use a DOM element or a component. | | backIconButtonProps | object | | Properties applied to the back arrow [`IconButton`](/api/icon-button/) component. | | classes | object | | Override or extend the styles applied to the component. See [CSS API](#css-api) below for more details. | | component | union: string |  func |  object | TableCell | The component used for the root node. Either a string to use a DOM element or a component. | | count * | number | | The total number of rows. | | labelDisplayedRows | func | ({ from, to, count }) => `${from}-${to} of ${count}` | Customize the displayed rows label. | | labelRowsPerPage | node | 'Rows per page:' | Customize the rows per page label. Invoked with a `{ from, to, count, page }` object. | | nextIconButtonProps | object | | Properties applied to the next arrow [`IconButton`](/api/icon-button/) element. | | onChangePage * | func | | Callback fired when the page is changed. **Signature:** `function(event: object, page: number) => void` *event:* The event source of the callback *page:* The page selected | | onChangeRowsPerPage | func | | Callback fired when the number of rows per page is changed. **Signature:** `function(event: object) => void` *event:* The event source of the callback | | page * | number | | The zero-based index of the current page. | | rowsPerPage * | number | | The number of rows per page. | | rowsPerPageOptions | array | [5, 10, 25] | Customizes the options of the rows per page select field. If less than two options are available, no select field will be displayed. | | SelectProps | object | | Properties applied to the rows per page [`Select`](/api/select/) element. | Any other properties supplied will be spread to the root element ([TableCell](/api/table-cell/)). ## CSS API You can override all the class names injected by Material-UI thanks to the `classes` property. This property accepts the following keys: | Name | Description | |:-----|:------------| | root | Styles applied to the root element. | toolbar | Styles applied to the Toolbar component. | spacer | Styles applied to the spacer element. | caption | Styles applied to the caption Typography components if `variant="caption"`. | selectRoot | Styles applied to the Select component `root` class. | select | Styles applied to the Select component `select` class. | selectIcon | Styles applied to the Select component `icon` class. | input | Styles applied to the `InputBase` component. | menuItem | Styles applied to the MenuItem component. | actions | Styles applied to the internal `TablePaginationActions` component. Have a look at [overriding with classes](/customization/overrides/#overriding-with-classes) section and the [implementation of the component](https://github.com/mui-org/material-ui/tree/master/packages/material-ui/src/TablePagination/TablePagination.js) for more detail. If using the `overrides` key of the theme as documented [here](/customization/themes/#customizing-all-instances-of-a-component-type), you need to use the following style sheet name: `MuiTablePagination`. ## Inheritance The properties of the [TableCell](/api/table-cell/) component are also available. You can take advantage of this behavior to [target nested components](/guides/api/#spread). ## Demos - [Tables](/demos/tables/)