API пагинации
Эта страница предоставляет обзор API компонента Pagination, детализируя его свойства, события, слоты и предоставляемые методы/состояния.
Свойства
Компонент Pagination принимает следующие свойства:
| Свойство | По умолчанию | Тип | Описание |
|---|---|---|---|
modelValue | 1 | number или undefined | Текущая активная страница. |
mode | "outlined" | "outlined", "filled", "underlined" или undefined | Визуальный стиль компонента пагинации. |
sizePage | 5 | number или undefined | Количество элементов, отображаемых на одной странице. |
sizesSelector | [5, 15, 20, 50, 100, 150] | Array<number> или undefined | Доступные варианты для выбора размера страницы. |
visibleNumberPages | 5 | number или undefined | Количество страниц, видимых в навигации пагинации. |
total | 0 | number или undefined | Общее количество элементов на всех страницах. |
isInfoText | false | boolean или undefined | Отображает информационный текст о состоянии пагинации. |
isPageSizeSelector | false | boolean или undefined | Включает селектор для выбора размера страницы. |
isHiddenNavigationButtons | false | boolean или undefined | Скрывает кнопки навигации "Предыдущая" и "Следующая". |
class | "" | StyleClass или undefined | Пользовательский CSS-класс для контейнера пагинации. |
События
Компонент Pagination генерирует следующие события:
| Событие | Полезная нагрузка | Описание |
|---|---|---|
update:modelValue | number | Генерируется при изменении активной страницы. |
update:sizePage | number | Генерируется при обновлении размера страницы пользователем. |
Слоты
Компонент Pagination предоставляет следующие слоты:
| Слот | Полезная нагрузка | Описание |
|---|---|---|
default | VNode[] | Слот по умолчанию для пользовательского содержимого внутри компонента пагинации. |
Предоставляемые методы и состояния
Компонент Pagination предоставляет следующие методы и состояния через ref:
| Предоставляемое | Значение | Описание |
|---|---|---|
selectPageSize | SelectExpose или undefined | Ссылка на селектор размера страницы. |
sizePage | number или undefined | Текущий размер страницы. |
visibleNumberPages | number | Количество страниц, видимых в элементе управления пагинацией. |
total | number | Общее количество элементов на всех страницах. |
isInfoText | boolean | Указывает, включён ли информационный текст о пагинации. |
isPageSizeSelector | boolean | Указывает, включён ли селектор размера страницы. |
isNavigationButtons | boolean | Указывает, видны ли кнопки навигации. |
arraySizesSelector | Array<{ key: number; value: string }> | Доступные размеры для селектора размера страницы. |
pages | Array<number> | Массив номеров страниц, доступных для навигации. |
activePage | number | Номер текущей активной страницы. |
mode | string | Текущий режим стилизации пагинации. |
paramsSelect | Partial<BaseSelectProps> | Параметры для компонента селектора размера страницы. |
switchPage | (value: number | Array<number>) => void | Переключает на указанную страницу или массив страниц в навигации. |
switchSizePage | (sizePageValue: number) => void | Обновляет размер страницы. |