Перейти к содержимому
v2.5.0
English
Русский
Документация

PageControl

PageControl — составной компонент для коротких индикаторов страниц или шагов, обычно в каруселях и онбординге.

Пропсы корня

ПропТипПо умолчанию
activenumber—
Контролируемый активный индекс.
defaultActivenumber0
Неконтролируемый начальный активный индекс.
onChangeActive(value: number) => void—
Колбэк, вызываемый, когда пользователь выбирает другую страницу. Получает новый индекс в виде числа.
refRef<HTMLUListElement>—
Ref, передаваемый на нижележащий элемент <ul>.
sizePageControlSize'md'
Определяет размер элементов индикатора страниц.

Также принимает все атрибуты <ul>.

Дочерние части

  • PageControlItem: стандартный элемент-точка.
  • PageControlProgress: анимированный элемент в виде прогресса.

PageControlItem

ПропТипПо умолчанию
indexобязательныйnumber—
Индекс элемента страницы (с нуля). Используется для идентификации и сравнения с активным индексом из контекста.
refRef<HTMLButtonElement>—
Ref, передаваемый на нижележащий элемент кнопки.
currentboolean—
Принудительно помечает элемент активным независимо от контекста. Если не задан, активное состояние определяется сравнением index с активным индексом из контекста.
sizePageControlSize—
Определяет размер элементов индикатора страниц.

Также принимает все атрибуты <button>.

PageControlProgress

ПропТипПо умолчанию
indexобязательныйnumber—
Индекс элемента страницы (с нуля). Используется, чтобы определить, активен ли этот элемент сейчас.
durationnumber5000
Длительность анимации прогресса в миллисекундах. Определяет, сколько времени занимает заполнение. Если не задана, по умолчанию 5000 мс.
refRef<HTMLButtonElement>—
Ref, передаваемый на нижележащий элемент кнопки.
currentboolean—
Активен ли сейчас этот элемент страницы. Если не задан, активное состояние определяется из контекста.
sizePageControlSize—
Определяет размер элементов индикатора страниц.

Также принимает все атрибуты <button>.

Типы

  • PageControlProps
  • PageControlItemProps
  • PageControlProgressProps

Модель состояния

  • Корень поддерживает контролируемое и неконтролируемое активное состояние.
  • Стрелки меняют активный элемент влево и вправо.
  • Перетаскивание пальцем или стилусом позволяет провести по элементам.