ValyroUI English version

Tour

Онбординг-тур: подсветка элементов, шаги, прогресс и возобновление. Pro · Окна и уведомления › Подсказки и туры

Установка

npx valyro-cli@latest login
npx valyro-cli@latest add tour
npm install valyro-ui-pro

import 'valyro-ui-pro/styles.css';
import { Tour } from 'valyro-ui-pro';

Пропсы

PropTypeDefault
steps *TourStep[]Stops in order; each spotlights its target (or is centered without one) with a card of title, text and media.
openbooleanControlled open; use with onOpenChange.
defaultOpenbooleanfalseInitial open when uncontrolled.
onOpenChange(open: boolean) => voidCalled with the new open when it changes.
stepnumberCurrent step; keep it to resume the tour where the user left.
defaultStepnumber0Initial step when uncontrolled.
onStepChange(step: number) => voidCalled with the new step when it changes.
onFinish() => voidCalled when the user presses Done on the last step.
onSkip(step: number) => voidCalled when the user leaves early (✕ or Escape), with the step they left on.
closeOnEscapebooleantrueEscape skips the tour. Default true.
closeOnOverlayClickbooleanfalseA click on the dimmed backdrop skips the tour. Default false.
showProgressbooleantrueProgress dots. Default true.
classNamestringClass for the card.
labelsPartial<TourLabels>Overrides for the built-in English text; keys left out keep their defaults.

Похожие компоненты

  • Popover — Всплывающий контент
  • Hover Card — Карточка при наведении
  • Alert — Предупреждения
  • Toast — Всплывающие уведомления
  • Notification Center — Центр уведомлений
  • Loading Overlay — Экран загрузки
  • Dialog — Модальные окна
  • Confirm Dialog — Подтверждение действий
  • Drawer — Выдвижные панели
  • Bottom Sheet — Нижняя шторка в стиле iOS: точки остановки, свайп, режим «подглядывания»

Назад: Hover Card · Далее: Text Input · Весь раздел «Окна и уведомления»