Импорт
import { NuiTour, type NuiTourStep } from '@needless-ui/angular/tour';NuiTour
Пошаговый тур.
| Имя | Тип | По умолчанию | Описание |
|---|---|---|---|
stepsInput | NuiTourStep[] | [] | Шаги по порядку. |
openДвусторонний | boolean | false | Идёт ли тур. |
stepДвусторонний | number | 0 | Показанный шаг, начиная с 0. |
labelsInput | Partial<NuiTourLabels> | Все показываемые туром тексты — для перевода. | |
finishedOutput | void | Срабатывает, когда пройден последний шаг. | |
dismissedOutput | number | Передаёт шаг, на котором тур прервали, если его завершили досрочно. | |
startМетод | (from?: number) => void | Запускает тур с первого или с указанного шага. | |
endМетод | (finished: boolean) => void | Завершает тур как пройденный или прерванный. |
NuiTourStep
Шаг тура.
| Имя | Тип | По умолчанию | Описание |
|---|---|---|---|
targetСвойство | string | Element | (() => Element | null) | На что указывает шаг. Без него карточка показывается по центру. | |
titleСвойство | string | Заголовок карточки. | |
contentСвойство | string | TemplateRef | Её текст или шаблон. | |
sideСвойство | 'top' | 'bottom' | 'start' | 'end' | 'bottom' | С какой стороны от целевого элемента стоит карточка. |
alignСвойство | 'start' | 'center' | 'end' | 'center' | Выравнивание карточки относительно целевого элемента. |
paddingСвойство | number | 8 | Отступ вокруг целевого элемента в подсветке, в пикселях. |
interactiveСвойство | boolean | false | Целевым элементом можно пользоваться, пока открыта карточка. |
beforeShowСвойство | () => void | Promise<void> | Выполняется перед показом шага. Если вернуть промис, тур его дождётся. |