Tour
Introduce people to new features using multi-step tours.
Props#
Tour#
| Prop | Type | Default | Description |
|---|---|---|---|
| children | type ONLY_FOR_FORMAT =
| string
| number
| boolean
| ReactElement<any, string | JSXElementConstructor<any>>
| Iterable<ReactNode>
| ReactPortal
| PromiseLikeOfReactNode | ||
| defaultIsActive | boolean | Activate the tour by default. | |
| initialStep | number | The initial step index. | |
| isActive | boolean | Make the tour controlled. | |
| onComplete | () => void | Called when the last step is completed. | |
| onDismiss | (index: number) => void | Called when the current step is closed or dismissed. |
TourSpotlight#
| Prop | Type | Default | Description |
|---|---|---|---|
| closeOnClick | boolean | ||
| hideOverlay | boolean | ||
| motionPreset | "fade" | "none" | ||
| spacing | number |
Was this helpful?