PaginationItem API

API reference docs for the React PaginationItem component. Learn about the props, CSS, and other APIs of this exported module.

Component demos

For examples and details on the usage of this React component, visit the component demo pages:

Pagination

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:{}

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.

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 classes

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

.Mui-disabledSTATE

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

.Mui-focusVisibleSTATE

State class applied to the root element if keyboard focused.

.Mui-selectedSTATE

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

.MuiPaginationItem-ellipsis

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

Rule name:ellipsis

.MuiPaginationItem-firstLast

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

Rule name:firstLast

.MuiPaginationItem-icon

Styles applied to the icon to display.

Rule name:icon

.MuiPaginationItem-outlined

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

Rule name:outlined

.MuiPaginationItem-outlinedPrimary

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

Rule name:outlinedPrimary

.MuiPaginationItem-outlinedSecondary

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

Rule name:outlinedSecondary

.MuiPaginationItem-page

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

Rule name:page

.MuiPaginationItem-previousNext

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

Rule name:previousNext

.MuiPaginationItem-root

Styles applied to the root element.

Rule name:root

.MuiPaginationItem-rounded

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

Rule name:rounded

.MuiPaginationItem-sizeLarge

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

Rule name:sizeLarge

.MuiPaginationItem-sizeSmall

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

Rule name:sizeSmall

.MuiPaginationItem-text

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

Rule name:text

.MuiPaginationItem-textPrimary

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

Rule name:textPrimary

.MuiPaginationItem-textSecondary

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

Rule name:textSecondary

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.