الاستيراد
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)، انتظرته الجولة. |