API di Tour · Needless UI

Import

import-tour.ts

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

Un tour guidato.

NuiTour: Proprietà
Nome	Tipo	Predefinito	Descrizione
`steps`Input	`NuiTourStep[]`	`[]`	I passaggi, in ordine.
`open`Bidirezionale	`boolean`	`false`	Se il tour è attivo.
`step`Bidirezionale	`number`	`0`	Il passaggio mostrato, da 0.
`labels`Input	`Partial<NuiTourLabels>`		Ogni testo che mostra, da tradurre.
`finished`Output	`void`		Emette quando l’ultimo passaggio è completato.
`dismissed`Output	`number`		Emette il passaggio su cui il tour è terminato, quando termina in anticipo.
`start`Metodo	`(from?: number) => void`		Avvia il tour, dal primo passaggio o da quello indicato.
`end`Metodo	`(finished: boolean) => void`		Termina il tour, come completato o interrotto.

Un passaggio del tour.

NuiTourStep: Proprietà
Nome	Tipo	Predefinito	Descrizione
`target`Proprietà	`string \| Element \| (() => Element \| null)`		Ciò a cui punta. Senza target, la card compare al centro.
`title`Proprietà	`string`		Il titolo della card.
`content`Proprietà	`string \| TemplateRef`		Il suo testo, o un template.
`side`Proprietà	`'top' \| 'bottom' \| 'start' \| 'end'`	`'bottom'`	Su quale lato del target va la card.
`align`Proprietà	`'start' \| 'center' \| 'end'`	`'center'`	Come la card si allinea al target.
`padding`Proprietà	`number`	`8`	Margine intorno al target evidenziato, in pixel.
`interactive`Proprietà	`boolean`	`false`	Il target si può usare mentre la card è visibile.
`beforeShow`Proprietà	`() => void \| Promise<void>`		Viene eseguito prima che il passaggio compaia. Se restituisce una promise, il tour la attende.