امپورٹ
import { NuiTour, type NuiTourStep } from '@needless-ui/angular/tour';NuiTour
ایک گائیڈڈ ٹور۔
| نام | ٹائپ | ڈیفالٹ | تفصیل |
|---|---|---|---|
stepsان پٹ | NuiTourStep[] | [] | مراحل، ترتیب سے۔ |
openدو طرفہ | boolean | false | ٹور چل رہا ہے یا نہیں۔ |
stepدو طرفہ | number | 0 | دکھایا گیا مرحلہ، 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 لوٹائے تو ٹور اس کا انتظار کرتا ہے۔ |