Skip to content
Edit this page

TablePaginationUnstyled API

API reference docs for the React TablePaginationUnstyled 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 TablePaginationUnstyled from '@mui/base/TablePaginationUnstyled';
// or
import { TablePaginationUnstyled } from '@mui/base';
You can learn about the difference by reading this guide on minimizing bundle size.

A pagination for tables.

Props

Props of the native component are also available.

NameTypeDefaultDescription
count*number
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.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
getItemAriaLabelfuncfunction defaultGetAriaLabel(type: ItemAriaLabelType) { 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 }: LabelDisplayedRowsArgs) { 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.
labelIdstring
Id of the label element within the pagination.
labelRowsPerPagenode'Rows per page:'
Customize the rows per page label.
For localization purposes, you can use the provided translations.
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.
selectIdstring
Id of the select element within the pagination.
slotProps{ actions?: func
| object, displayedRows?: func
| object, menuItem?: func
| object, root?: func
| object, select?: func
| object, selectLabel?: func
| object, spacer?: func
| object, toolbar?: func
| object }		{}
The props used for each slot inside the TablePagination.
slots{ actions?: elementType, displayedRows?: elementType, menuItem?: elementType, root?: elementType, select?: elementType, selectLabel?: elementType, spacer?: elementType, toolbar?: elementType }{}
The components used for each slot inside the TablePagination. Either a string to use a HTML element or a component.

The ref is forwarded to the root element.

CSS

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 `TablePaginationUnstyledActions` component.

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