API của Tour hướng dẫn

Import

import-tour.ts

import { NuiTour, type NuiTourStep } from '@needless-ui/angular/tour';

Một tour hướng dẫn.

NuiTour: Thuộc tính
Tên	Kiểu	Mặc định	Mô tả
`steps`Input	`NuiTourStep[]`	`[]`	Các bước, theo thứ tự.
`open`Hai chiều	`boolean`	`false`	Tour có đang chạy hay không.
`step`Hai chiều	`number`	`0`	Bước đang hiển thị, tính từ 0.
`labels`Input	`Partial<NuiTourLabels>`		Mọi văn bản mà tour hiển thị, để dịch.
`finished`Output	`void`		Phát ra khi bước cuối cùng hoàn tất.
`dismissed`Output	`number`		Phát ra bước mà tour dừng lại, khi tour kết thúc sớm.
`start`Phương thức	`(from?: number) => void`		Bắt đầu tour, từ bước đầu tiên hoặc từ bước được chỉ định.
`end`Phương thức	`(finished: boolean) => void`		Kết thúc tour, dưới dạng hoàn tất hoặc bỏ dở.

Một bước của tour.

NuiTourStep: Thuộc tính
Tên	Kiểu	Mặc định	Mô tả
`target`Thuộc tính	`string \| Element \| (() => Element \| null)`		Phần tử mà bước chỉ vào. Nếu không có, thẻ hiện ở giữa.
`title`Thuộc tính	`string`		Tiêu đề của thẻ.
`content`Thuộc tính	`string \| TemplateRef`		Nội dung dạng văn bản, hoặc một template.
`side`Thuộc tính	`'top' \| 'bottom' \| 'start' \| 'end'`	`'bottom'`	Thẻ nằm ở phía nào của đích.
`align`Thuộc tính	`'start' \| 'center' \| 'end'`	`'center'`	Cách thẻ căn chỉnh với đích.
`padding`Thuộc tính	`number`	`8`	Khoảng trống quanh đích trong vùng sáng, tính bằng pixel.
`interactive`Thuộc tính	`boolean`	`false`	Có thể dùng đích khi thẻ đang hiện.
`beforeShow`Thuộc tính	`() => void \| Promise<void>`		Chạy trước khi bước hiện ra. Nếu hàm trả về promise, tour sẽ chờ nó.