TablePaginationActions API

API reference docs for the React TablePaginationActions 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:

Pagination

Import

import TablePaginationActions from '@mui/material/TablePaginationActions';
// or
import { TablePaginationActions } from '@mui/material';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

Name	Type	Default	Description
count*	number	-	The total number of rows. `-1` means the total is unknown (server-side pagination): the next-page button stays enabled and the last-page button is disabled.
getItemAriaLabel*	func	-	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').
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*	number	-	The zero-based index of the current page.
rowsPerPage*	number	-	The number of rows per page. `-1` means all the rows are shown on one page.
showFirstButton*	bool	-	If `true`, show the first-page button.
showLastButton*	bool	-	If `true`, show the last-page button.
classes	object	-	Override or extend the styles applied to the component. See CSS classes API below for more details.
disabled	bool	false	If `true`, the component is disabled.
slotProps	{ firstButton?: object, firstButtonIcon?: object, lastButton?: object, lastButtonIcon?: object, nextButton?: object, nextButtonIcon?: object, previousButton?: object, previousButtonIcon?: object }	{}	The props used for each slot inside.
slots	{ firstButton?: elementType, firstButtonIcon?: elementType, lastButton?: elementType, lastButtonIcon?: elementType, nextButton?: elementType, nextButtonIcon?: elementType, previousButton?: elementType, previousButtonIcon?: elementType }	{}	The components used for each slot inside.
sx	Array<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.

Theme default props

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

Slots

Slot name	Default component	Description
firstButton	`IconButton`	The component that renders the first button.
lastButton	`IconButton`	The component that renders the last button.
nextButton	`IconButton`	The component that renders the next button.
previousButton	`IconButton`	The component that renders the previous button.
firstButtonIcon	`FirstPageIcon`	The component that renders the first button icon.
lastButtonIcon	`LastPageIcon`	The component that renders the last button icon.
nextButtonIcon	`KeyboardArrowRight`	The component that renders the next button icon.
previousButtonIcon	`KeyboardArrowLeft`	The component that renders the previous button icon.

CSS classes

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

Class name	Rule name	Description
.MuiTablePaginationActions-root	root	Styles applied to the root element.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.