Tailwind Usage & Examples

The current active page. Indexed from 1

The total number of pages

A callback handler which is called when the user clicks a new page. The newPage parameter is indexed from 1

Note that the active page will not change unless the current prop is updated to reflect the new page (as in the example above)

The maximum width (in pixels) of the pagination component. Use this prop if you want to override the automatic sizing. Note the width may be exceeded if it’s not possible a component to the specified width

Class name for the top level <ul> container

Defaults to pagination

When this prop is set, extraClassName prop (below) will be ignored

Alias for containerClassName see above

Useful when using Bootstrap styles, extra classNames to be added to the top level <ul> container. Use this prop to override the default justify value - for example to align elements to the start of the page use: justify-content-start

Defaults to justify-content-center, not applicable if className prop is set

Class name for all the <li> elements

Defaults to page-item

Class name for <a> or <span> child elements within an <li> element:

<li ...><a class='page-link'>1</a></li>

Defaults to page-link

Appended to <li> class name for the active element:

<li class='page-item active'><a class='page-link'>1</a></li>

Defaults to active

Appended to <li> class name for all non active elements (including nav elements):

<li class='page-item inactive'><a class='page-link'>1</a></li>

Defaults to ”

Appended to <li> class name for non-clickable elements (disabled nav buttons and the break/ellipsis):

<li class='page-item disabled'><span class='page-link'>...</span></li>

Defaults to disabled

Appended to <li> class name for nav items (« / » buttons)

Setting to ‘my-nav’ would give html similar to:

<li class='page-item my-nav'><span class='page-link'>«</span></li>

By default will not be output

Appended to <li> class name for the previous button («)

Setting to ‘my-previous-button’ would give html similar to:

<li class='page-item my-previous-button'><span class='page-link'>«</span></li>

Overrides navClassName and by default will not be output

Appended to <li> class name for the next button (»)

Setting to ‘my-next-button’ would give html similar to:

<li class='page-item my-next-button'><span class='page-link'>»</span></li>

Overrides navClassName and by default will not be output

Function to use when merging multiple class names

Tailwind users can set this to twMerge from the tailwind-merge package to remove duplicate Tailwind classes

import { twMerge } from 'tailwind-merge';

<ResponsivePagination
  classMerge={twMerge}
  // ...other props
/>

The label for the previous button, defaults to «

See the FAQ for further information on using React components for this prop

The label for the next button, defaults to »

See the FAQ for further information on using React components for this prop

The accessibility ARIA label for the previous button, defaults to Previous

The accessibility ARIA label for the next button, defaults to Next

The accessibility ARIA label for page links - expects a function which takes the page number and active boolean and returns the ARIA label (or undefined), example:

<ResponsivePagination
  //...
  ariaPageLabel={(page, active) => (active ? `Active Page ${page}` : `Goto Page ${page}`)}
/>

Set to false to prevent output of aria-current='page' for the active page <li>

See MDN’s article on aria-current for further details

When set to false the nav buttons («/») will not be rendered. Defaults to true

Specify that nav buttons («/») and/or the ellipsis (…) can be dropped for very narrow widths (useful if the component is used in narrow widths with high page numbers)

Valid behaviours should be imported from react-responsive-pagination/narrowBehaviour, example:

import ResponsivePagination from 'react-responsive-pagination';
import { dropEllipsis } from 'react-responsive-pagination/narrowBehaviour';

<ResponsivePagination /*...*/ narrowBehaviour={dropEllipsis} />

Valid NarrowBehaviours:

dropEllipsis - drop the ellipsis (…) for narrow widths
dropNav - drop the nav («/») for narrow widths
dropFirstAndLast - drop the first and last pages for narrow widths

The default behaviour is to not drop any elements (this may change in a future major release)

Using Multiple NarrowBehaviours

Multiple NarrowBehaviours can be combined using the combine helper (also imported from react-responsive-pagination/narrowBehaviour), example:

import ResponsivePagination from 'react-responsive-pagination';
import { dropEllipsis, dropNav, combine } from 'react-responsive-pagination/narrowBehaviour';

<ResponsivePagination
  //...
  narrowBehaviour={combine(dropNav, dropEllipsis)}
/>

The behaviours will be applied in order so in this example, combine(dropNav, dropEllipsis) will drop the nav («/») initially and then further drop the ellipsis (…) if required