Pagination API

API reference docs for the React Pagination 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 Pagination from '@mui/material/Pagination';
// or
import { Pagination } from '@mui/material';

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

Props

Props of the native component are also available.

Number of always visible pages at the beginning and end.

Type:

integer

Default:

1

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'

The total number of pages.

Type:

integer

Default:

1

The page selected by default when the component is uncontrolled.

Type:

integer

Default:

1

If true, the component is disabled.

Type:

bool

Default:

false

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

Signature:

function(type: string, page: number, selected: bool) => string

type The link or button type to format ('page' | 'first' | 'last' | 'next' | 'previous'). Defaults to 'page'.
page The page number to format.
selected If true, the current page is selected.

If true, hide the next-page button.

Type:

bool

Default:

false

If true, hide the previous-page button.

Type:

bool

Default:

false

Callback fired when the page is changed.

Type:

func

Signature:

function(event: React.ChangeEvent, page: number) => void

event The event source of the callback.
page The page selected.

The current page.

Type:

integer

Render the item.

Type:

func

Default:

(item) => <PaginationItem {...item} />

Signature:

function(params: PaginationRenderItemParams) => ReactNode

params The props to spread on a PaginationItem.

The shape of the pagination items.

Type:

'circular' | 'rounded'

Default:

'circular'

If true, show the first-page button.

Type:

bool

Default:

false

If true, show the last-page button.

Type:

bool

Default:

false

Number of always visible pages before and after the current page.

Type:

integer

Default:

1

The size of the component.

Type:

'small' | 'medium' | 'large' | string

Default:

'medium'

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 variant to use.

Type:

'outlined' | 'text' | string

Default:

'text'

The 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.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.

Styles applied to the root element.

Styles applied to the ul element.

Styles applied to the root element if variant="outlined".

Styles applied to the root element if variant="text".

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.

Have any feedback about this new API display design?

We've heard from you and iterated on making the design of API content documentation more scalable and easier to parse! We value your input, so please don't hesitate to share any additional feedback you may have.