ਇੰਪੋਰਟ
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> | ਕਦਮ ਦਿਸਣ ਤੋਂ ਪਹਿਲਾਂ ਚੱਲਦਾ ਹੈ। ਪ੍ਰੌਮਿਸ ਮਿਲਣ ’ਤੇ ਟੂਰ ਉਸ ਦੀ ਉਡੀਕ ਕਰਦਾ ਹੈ। |