Skip to content
Edit this page

PaginationItem API

The API documentation of the PaginationItem React component. Learn more about the props and the CSS customization points.

Import

import PaginationItem from '@material-ui/lab/PaginationItem';
// or
import { PaginationItem } from '@material-ui/lab';

You can learn more about the difference by reading this guide.

Component name

The MuiPaginationItem name can be used for providing default props or style overrides at the theme level.

Props

Name Type Default Description
color 'standard'
| 'primary'
| 'secondary'		 'standard' The active color.
component elementType The component used for the root node. Either a string to use a HTML element or a component.
disabled bool false If true, the item will be disabled.
page number The current page number.
selected bool false If true the pagination item is selected.
shape 'round'
| 'rounded'		 'round' The shape of the pagination item.
size 'small'
| 'medium'
| 'large'		 'medium' The size of the pagination item.
type 'page'
| 'first'
| 'last'
| 'next'
| 'previous'
| 'start-ellipsis'
| 'end-ellipsis'		 'page' The type of pagination item.
variant 'text'
| 'outlined'		 'text' The pagination item variant.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (native element).

CSS

Rule name Global class Description
root .MuiPaginationItem-root Styles applied to the root element.
page .MuiPaginationItem-page Styles applied to the root element if type="page".
sizeSmall .MuiPaginationItem-sizeSmall Styles applied applied to the root element if size="small".
sizeLarge .MuiPaginationItem-sizeLarge Styles applied applied to the root element if size="large".
textPrimary .MuiPaginationItem-textPrimary Styles applied to the root element if variant="text" and color="primary".
textSecondary .MuiPaginationItem-textSecondary Styles applied to the root element if variant="text" and color="secondary".
outlined .MuiPaginationItem-outlined Styles applied to the root element if outlined="true".
outlinedPrimary .MuiPaginationItem-outlinedPrimary Styles applied to the root element if variant="outlined" and color="primary".
outlinedSecondary .MuiPaginationItem-outlinedSecondary Styles applied to the root element if variant="outlined" and color="secondary".
rounded .MuiPaginationItem-rounded Styles applied to the root element if rounded="true".
ellipsis .MuiPaginationItem-ellipsis Styles applied to the root element if type="start-ellipsis" or type="end-ellipsis".
focusVisible .Mui-focusVisible Pseudo-class applied to the root element if keyboard focused.
disabled .Mui-disabled Pseudo-class applied to the root element if disabled={true}.
selected .Mui-selected Pseudo-class applied to the root element if selected={true}.
icon .MuiPaginationItem-icon Styles applied to the icon element.

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Demos