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

Name	Type	Default	Description
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
color	'primary' \| 'secondary' \| 'standard'	'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 is disabled.
page	number		The current page number.
selected	bool	false	If `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 pagination item.
type	'end-ellipsis' \| 'first' \| 'last' \| 'next' \| 'page' \| 'previous' \| 'start-ellipsis'	'page'	The type of pagination item.
variant	'outlined' \| 'text' \| string	'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"`.
text	.MuiPaginationItem-text	Styles applied to the root element if `variant="text"`.
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 `variant="outlined"`.
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 using one of these customization options:

With a rule name of the classes object prop.
With a global class name.
With a theme and an styleOverrides property.

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

Demos

Pagination