Components
Pagination
Code

Pagination

Pagination triggers allow merchants to view the size of a list and navigate between pages.

<Pagination page={page} onPageChange={(page, type) => {}} total={total} />

Parameters

props

  • Type: @vtex/shoreline-components.PaginationProps & @types/react.React.RefAttributes<typescript.HTMLDivElement>

Props

loading (optional)

Whether the pagination is loading or not.

  • Type: boolean

  • Default: false

onPageChange (optional)

  • Type: { (page: number, type: next | prev): void; }

page

Pagination current page

  • Type: number

size (optional)

Page size

  • Type: number

  • Default: 25

total

The total number of items

  • Type: number

View source (opens in a new tab)