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';
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.

countRequired

onPageChangeRequired

pageRequired

rowsPerPageRequired

ActionsComponent

backIconButtonProps

classes

component

getItemAriaLabel

labelDisplayedRows

labelRowsPerPage

nextIconButtonProps

onRowsPerPageChange

rowsPerPageOptions

SelectProps

showFirstButton

showLastButton

sx

The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the TableCell component are also available in 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.

.MuiTablePagination-root

.MuiTablePagination-toolbar

.MuiTablePagination-spacer

.MuiTablePagination-selectLabel

.MuiTablePagination-selectRoot

.MuiTablePagination-select

.MuiTablePagination-selectIcon

.MuiTablePagination-input

.MuiTablePagination-menuItem

.MuiTablePagination-displayedRows

.MuiTablePagination-actions


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