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.

Component demos

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

The total number of rows.
To enable server side pagination for an unknown number of items, provide -1.

Type:integer


onPageChangeRequired

Callback fired when the page is changed.

Type:func

Signature:
function(event: React.MouseEvent | null, page: number) => void
  • event The event source of the callback.
  • page The page selected.

pageRequired

The zero-based index of the current page.

Type:integer


rowsPerPageRequired

The number of rows per page.
Set -1 to display all the rows.

Type:integer


ActionsComponent

The component used for displaying the actions. Either a string to use a HTML element or a component.

Type:elementType

Default:TablePaginationActions


backIconButtonProps

Props applied to the back arrow IconButton component.
This prop is an alias for slotProps.actions.previousButton and will be overriden by it if both are used.

Type:object


classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object


component

The component used for the root node. Either a string to use a HTML element or a component.

Type:elementType


disabled

If true, the component is disabled.

Type:bool

Default:false


getItemAriaLabel

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.

Type:func

Default:function defaultGetAriaLabel(type) { return `Go to ${type} page`; }

Signature:
function(type: string) => string
  • type The link or button type to format ('first' | 'last' | 'next' | 'previous').

labelDisplayedRows

Customize the displayed rows label. Invoked with a { from, to, count, page } object.
For localization purposes, you can use the provided translations.

Type:func

Default:function defaultLabelDisplayedRows({ from, to, count }) { return `${from}–${to} of ${count !== -1 ? count : `more than ${to}`}`; }


labelRowsPerPage

Customize the rows per page label.
For localization purposes, you can use the provided translations.

Type:node

Default:'Rows per page:'


nextIconButtonProps

Props applied to the next arrow IconButton element.
This prop is an alias for slotProps.actions.nextButton and will be overriden by it if both are used.

Type:object


onRowsPerPageChange

Callback fired when the number of rows per page is changed.

Type:func

Signature:
function(event: React.ChangeEvent) => void
  • event The event source of the callback.

rowsPerPageOptions

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.

Type:Array<number
| { label: string, value: number }>

Default:[10, 25, 50, 100]


SelectProps

Props applied to the rows per page Select element.
This prop is an alias for slotProps.select and will be overriden by it if both are used.

Type:object

Default:{}


showFirstButton

If true, show the first-page button.

Type:bool

Default:false


showLastButton

If true, show the last-page button.

Type:bool

Default:false


slotProps

The props used for each slot inside the TablePagination.

Type:{ actions?: { firstButton?: object, lastButton?: object, nextButton?: object, previousButton?: object }, select?: object }

Default:{}


sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func
| object
| bool>
| func
| object


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 classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

.MuiTablePagination-actions

Styles applied to the internal TablePaginationActions component.

Rule name:actions


.MuiTablePagination-displayedRows

Styles applied to the displayed rows Typography element.

Rule name:displayedRows


.MuiTablePagination-input

Styles applied to the Select component root element.

Rule name:input


.MuiTablePagination-menuItem

Styles applied to the MenuItem component.

Rule name:menuItem


.MuiTablePagination-root

Styles applied to the root element.

Rule name:root


.MuiTablePagination-select

Styles applied to the Select component select class.

Rule name:select


.MuiTablePagination-selectIcon

Styles applied to the Select component icon class.

Rule name:selectIcon


.MuiTablePagination-selectLabel

Styles applied to the select label Typography element.

Rule name:selectLabel


.MuiTablePagination-selectRoot

Styles applied to the Select component root element.

Rule name:selectRoot


.MuiTablePagination-spacer

Styles applied to the spacer element.

Rule name:spacer


.MuiTablePagination-toolbar

Styles applied to the Toolbar component.

Rule name:toolbar



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

Edit this page

Was this page helpful?


TableHeadTableRow

Blog

Store