ایمپورت
import { NuiTour, type NuiTourStep } from '@needless-ui/angular/tour';NuiTour
یک تور راهنما.
| نام | نوع | پیشفرض | توضیح |
|---|---|---|---|
stepsورودی | NuiTourStep[] | [] | گامها، به ترتیب. |
openدوطرفه | boolean | false | اینکه تور در جریان است یا نه. |
stepدوطرفه | number | 0 | گامی که نمایش داده میشود، از ۰. |
labelsورودی | Partial<NuiTourLabels> | همهٔ متنهایی که نشان میدهد، برای ترجمه. | |
finishedخروجی | void | وقتی آخرین گام انجام شود منتشر میشود. | |
dismissedخروجی | 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> | پیش از نمایش گام اجرا میشود. اگر promise برگرداند، تور منتظرش میماند. |