Skip to content

PaginationItem API

API documentation for the React PaginationItem component. Learn about the available props, and the CSS API.

Import

import PaginationItem from '@material-ui/core/PaginationItem';
// or
import { PaginationItem } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiPaginationItem can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
color'primary'
| 'secondary'
| 'standard'
'standard'The active color.
componentelementTypeThe component used for the root node. Either a string to use a HTML element or a component.
disabledboolfalseIf true, the component is disabled.
pagenumberThe current page number.
selectedboolfalseIf true the pagination item is selected.
shape'circular'
| 'rounded'
'circular'The shape of the pagination item.
size'large'
| 'medium'
| 'small'
'medium'The size of the component.
type'end-ellipsis'
| 'first'
| 'last'
| 'next'
| 'page'
| 'previous'
| 'start-ellipsis'
'page'The type of pagination item.
variant'outlined'
| 'text'
| string
'text'The variant to use.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).

CSS

Rule nameGlobal classDescription
root.MuiPaginationItem-rootStyles applied to the root element.
page.MuiPaginationItem-pageStyles applied to the root element if type="page".
sizeSmall.MuiPaginationItem-sizeSmallStyles applied to the root element if size="small".
sizeLarge.MuiPaginationItem-sizeLargeStyles applied to the root element if size="large".
text.MuiPaginationItem-textStyles applied to the root element if variant="text".
textPrimary.MuiPaginationItem-textPrimaryStyles applied to the root element if variant="text" and color="primary".
textSecondary.MuiPaginationItem-textSecondaryStyles applied to the root element if variant="text" and color="secondary".
outlined.MuiPaginationItem-outlinedStyles applied to the root element if variant="outlined".
outlinedPrimary.MuiPaginationItem-outlinedPrimaryStyles applied to the root element if variant="outlined" and color="primary".
outlinedSecondary.MuiPaginationItem-outlinedSecondaryStyles applied to the root element if variant="outlined" and color="secondary".
rounded.MuiPaginationItem-roundedStyles applied to the root element if rounded="true".
ellipsis.MuiPaginationItem-ellipsisStyles applied to the root element if type="start-ellipsis" or type="end-ellipsis".
focusVisible.Mui-focusVisiblePseudo-class applied to the root element if keyboard focused.
disabled.Mui-disabledPseudo-class applied to the root element if disabled={true}.
selected.Mui-selectedPseudo-class applied to the root element if selected={true}.
icon.MuiPaginationItem-iconStyles applied to tThe icon to display.

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos