NavigationInteractive playground

Pagination

Navigate paginated result sets.

Preparing the playground…

Text and Markdown example

Pagination · Example

1function Example() {
2 const [page, setPage] = useState(1);
3 return <Pagination><PaginationContent>{[1,2,3].map(value => <PaginationItem key={value}><PaginationLink href="#" isActive={page === value} onClick={event => {event.preventDefault();setPage(value)}}>{value}</PaginationLink></PaginationItem>)}</PaginationContent></Pagination>;
4}

Read documentation in Markdown

How to use it

Keep page state in your application and connect events. Mark the current link with isActive.

Import

React / Next.js

1import { Pagination, PaginationContent, PaginationItem, PaginationLink, PaginationButton, PaginationPrevious, PaginationNext, PaginationEllipsis } from "@kivora/nextjs";

Interactive examples run inside a component with "use client". The playground's Copy button includes the imports needed for the current example.

API reference 0.2.0

Types from the installed published version, including component properties and common HTML attributes. “Optional” does not imply a default value; omitting a property lets the component decide.

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

Subcomponents and composition

Review each component's properties and published declaration. Native and accessibility attributes are inherited from the element specified by its type.

Pagination13 properties

Pagination · TypeScript

1Pagination: React.ForwardRefExoticComponent<PaginationProps & React.RefAttributes<HTMLElement>>

PaginationContent13 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLUListElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLUListElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLUListElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

PaginationContent · TypeScript

1PaginationContent: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLUListElement>, HTMLUListElement>, "ref"> & React.RefAttributes<HTMLUListElement>>

PaginationItem14 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLLIElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLLIElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLLIElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.
`value`	`string \| number \| readonly string[]`	Controlled value. Update it from the change callback.

PaginationItem · TypeScript

1PaginationItem: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.LiHTMLAttributes<HTMLLIElement>, HTMLLIElement>, "ref"> & React.RefAttributes<HTMLLIElement>>

PaginationLink15 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`isActive`	`boolean`	Configures isActive. The type describes the supported values and structure.
`onChange`	`ChangeEventHandler<HTMLAnchorElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLAnchorElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLAnchorElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.
`type`	`string`	Operation type or mode; values depend on the component.

PaginationLink · TypeScript

1PaginationLink: React.ForwardRefExoticComponent<PaginationLinkProps & React.RefAttributes<HTMLAnchorElement>>

PaginationButton18 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`disabled`	`boolean`	Disable interaction with the control.
`id`	`string`	Element identifier; associates labels and descriptions.
`isActive`	`boolean`	Configures isActive. The type describes the supported values and structure.
`name`	`string`	Name used to identify the control in forms.
`onChange`	`ChangeEventHandler<HTMLButtonElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLButtonElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLButtonElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.
`type`	`"button" \| "submit" \| "reset"`	Operation type or mode; values depend on the component.
`value`	`string \| number \| readonly string[]`	Controlled value. Update it from the change callback.

PaginationButton · TypeScript

1PaginationButton: React.ForwardRefExoticComponent<PaginationButtonProps & React.RefAttributes<HTMLButtonElement>>

PaginationPrevious16 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`isActive`	`boolean`	Configures isActive. The type describes the supported values and structure.
`label`	`string`	Text or accessible label.
`onChange`	`ChangeEventHandler<HTMLAnchorElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLAnchorElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLAnchorElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.
`type`	`string`	Operation type or mode; values depend on the component.

PaginationPrevious · TypeScript

1PaginationPrevious: React.ForwardRefExoticComponent<PaginationPreviousProps & React.RefAttributes<HTMLAnchorElement>>

PaginationNext16 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`isActive`	`boolean`	Configures isActive. The type describes the supported values and structure.
`label`	`string`	Text or accessible label.
`onChange`	`ChangeEventHandler<HTMLAnchorElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLAnchorElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLAnchorElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.
`type`	`string`	Operation type or mode; values depend on the component.

PaginationNext · TypeScript

1PaginationNext: React.ForwardRefExoticComponent<PaginationNextProps & React.RefAttributes<HTMLAnchorElement>>

PaginationEllipsis13 properties

Property	Type	Description
`aria-label`	`string`	Accessible name of the control.
`children`	`ReactNode`	Content or child elements of the component.
`className`	`string`	Additional CSS classes to customize the element.
`defaultChecked`	`boolean`	Initial selection of the control.
`defaultValue`	`string \| number \| readonly string[]`	Initial value when the component manages its own state.
`id`	`string`	Element identifier; associates labels and descriptions.
`onChange`	`ChangeEventHandler<HTMLSpanElement, Element>`	Change event. Check the type: some controls return an object, others a DOM event.
`onClick`	`MouseEventHandler<HTMLSpanElement>`	Action performed when the element is activated.
`onSubmit`	`SubmitEventHandler<HTMLSpanElement>`	Form submission event.
`role`	`AriaRole`	Semantic role of the element. Keep the default role unless a change is justified.
`style`	`CSSProperties`	React inline styles.
`tabIndex`	`number`	Keyboard focus order and availability.
`title`	`string`	Title or supplementary information.

PaginationEllipsis · TypeScript

1PaginationEllipsis: React.ForwardRefExoticComponent<Omit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, "ref"> & React.RefAttributes<HTMLSpanElement>>

API generated from @kivora/nextjs 0.2.0View package