Skip to content
Edit this page

PaginationItem API

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

Props

Props of the native component are also available.

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
color

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'
component

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

Type:

elementType
components

The components used for each slot inside.
This prop is an alias for the slots prop. It's recommended to use the slots prop instead.

Type:

{ first?: elementType, last?: elementType, next?: elementType, previous?: elementType }

Default:

{}
disabled

If true, the component is disabled.

Type:

bool

Default:

false
page

The current page number.

Type:

node
selected

If true the pagination item is selected.

Type:

bool

Default:

false
shape

The shape of the pagination item.

Type:

'circular' | 'rounded'

Default:

'circular'
size

The size of the component.

Type:

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

Default:

'medium'
slots

The components used for each slot inside.
This prop is an alias for the components prop, which will be deprecated in the future.

Type:

{ first?: elementType, last?: elementType, next?: elementType, previous?: elementType }

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
type

The type of pagination item.

Type:

'end-ellipsis' | 'first' | 'last' | 'next' | 'page' | 'previous' | 'start-ellipsis'

Default:

'page'
variant

The variant to use.

Type:

'outlined' | 'text' | string

Default:

'text'
The ref is forwarded to the root element.

Theme default props

You can use MuiPaginationItem 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.


.MuiPaginationItem-rootroot

Styles applied to the root element.

.MuiPaginationItem-pagepage

Styles applied to the root element if type="page".

.MuiPaginationItem-sizeSmallsizeSmall

Styles applied to the root element if size="small".

.MuiPaginationItem-sizeLargesizeLarge

Styles applied to the root element if size="large".

.MuiPaginationItem-texttext

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

.MuiPaginationItem-textPrimarytextPrimary

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

.MuiPaginationItem-textSecondarytextSecondary

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

.MuiPaginationItem-outlinedoutlined

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

.MuiPaginationItem-outlinedPrimaryoutlinedPrimary

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

.MuiPaginationItem-outlinedSecondaryoutlinedSecondary

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

.MuiPaginationItem-roundedrounded

Styles applied to the root element if rounded="true".

.MuiPaginationItem-ellipsisellipsis

Styles applied to the root element if type="start-ellipsis" or type="end-ellipsis".

.MuiPaginationItem-firstLastfirstLast

Styles applied to the root element if type="first" or type="last".

.MuiPaginationItem-previousNextpreviousNext

Styles applied to the root element if type="previous" or type="next".

.Mui-focusVisiblefocusVisibleSTATE

State class applied to the root element if keyboard focused.

.Mui-disableddisabledSTATE

State class applied to the root element if disabled={true}.

.Mui-selectedselectedSTATE

State class applied to the root element if selected={true}.

.MuiPaginationItem-iconicon

Styles applied to the icon to display.

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