Vivid API

Pagination

Help users navigate forwards and backwards through a series of pages. For example, search results or guidance that's divided into multiple pages.

Usage

import { registerPagination } from '@vonage/vivid-api';
registerPagination('your-prefix');

API Reference

Properties

PropertyTypeDefaultDescription
navIconsboolean
selectedIndex
(modelValue)
number
shape'rounded' | 'pill'The shape the pagination should have.
size'condensed' | 'normal' | 'super-condensed'The size the pagination should have.
totalnumber
PropertyTypeDefaultDescription
nav-iconsboolean
selected-indexnumber
shape'rounded' | 'pill'The shape the pagination should have.
size'condensed' | 'normal' | 'super-condensed'The size the pagination should have.
totalnumber

Events

NameTypeDescription
pagination-changeCustomEvent<{selectedIndex: number, total: number, oldIndex: number}>Fires when the page changes.
NameTypeDescription
pagination-changeCustomEvent<{selectedIndex: number, total: number, oldIndex: number}>Fires when the page changes.