Pagination API
API reference docs for the React Pagination component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import Pagination from '@mui/material/Pagination';
// or
import { Pagination } from '@mui/material';Props of the native component are also available.
Override or extend the styles applied to the component.
See CSS API below for more details.
Type:object
The active color. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.
Type:'primary'
| 'secondary'
| 'standard'
| string
Default:'standard'
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
function(type: string, page: number, selected: bool) => stringtypeThe link or button type to format ('page' | 'first' | 'last' | 'next' | 'previous' | 'start-ellipsis' | 'end-ellipsis'). Defaults to 'page'.pageThe page number to format.selectedIf true, the current page is selected.
Callback fired when the page is changed.
Type:func
function(event: React.ChangeEvent, page: number) => void eventThe event source of the callback.pageThe page selected.
Render the item.
Type:func
Default:(item) => <PaginationItem {...item} />
function(params: PaginationRenderItemParams) => ReactNodeparamsThe props to spread on a PaginationItem.
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
ref is forwarded to the root element.Theme default props
You can use MuiPagination to change the default props of this component with the theme.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
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
styleOverridesproperty in a custom theme.