Skip to content

TablePagination API

API reference docs for the React TablePagination component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import TablePagination from '@mui/material/TablePagination';
// or
import { TablePagination } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

A TableCell based component for placing inside TableFooter for pagination.

Props

Props of the TableCell component are also available.

NameTypeDefaultDescription
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: React.MouseEvent<HTMLButtonElement> | null, page: number) => void
event: 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.
ActionsComponentelementTypeTablePaginationActions
The component used for displaying the actions. Either a string to use a HTML element or a component.
backIconButtonPropsobject
Props applied to the back arrow IconButton component.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
getItemAriaLabelfuncfunction 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) => string
type: The link or button type to format ('first' | 'last' | 'next' | 'previous').
labelDisplayedRowsfuncfunction 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.
labelRowsPerPagenode'Rows per page:'
Customize the rows per page label.
For localization purposes, you can use the provided translations.
nextIconButtonPropsobject
Props applied to the next arrow IconButton element.
onRowsPerPageChangefunc
Callback fired when the number of rows per page is changed.

Signature:
function(event: React.ChangeEvent<HTMLTextAreaElement | HTMLInputElement>) => void
event: The event source of the callback.
rowsPerPageOptionsArray<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.
SelectPropsobject{}
Props applied to the rows per page Select element.
showFirstButtonboolfalse
If true, show the first-page button.
showLastButtonboolfalse
If true, show the last-page button.
sxArray<func
| object
| bool>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the TableCell component are also available on TablePagination. You can take advantage of this to target nested components.

Theme default props

You can use MuiTablePagination to change the default props of this component with the theme.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

Rule nameGlobal classDescription
root.MuiTablePagination-rootStyles applied to the root element.
toolbar.MuiTablePagination-toolbarStyles applied to the Toolbar component.
spacer.MuiTablePagination-spacerStyles applied to the spacer element.
selectLabel.MuiTablePagination-selectLabelStyles applied to the select label Typography element.
selectRoot.MuiTablePagination-selectRootStyles applied to the Select component root element.
select.MuiTablePagination-selectStyles applied to the Select component select class.
selectIcon.MuiTablePagination-selectIconStyles applied to the Select component icon class.
input.MuiTablePagination-inputStyles applied to the Select component root element.
menuItem.MuiTablePagination-menuItemStyles applied to the MenuItem component.
displayedRows.MuiTablePagination-displayedRowsStyles applied to the displayed rows Typography element.
actions.MuiTablePagination-actionsStyles applied to the internal TablePaginationActions component.

You can override the style of the component using one of these customization options: