Skip
Don't show again
Tour skip renders a "Don't show again" checkbox inside the tooltip. When checked, the tour won't replay for returning users. The state is persisted in localStorage under a configurable key. Pass false to disable.
Config
| Property | Type | Default | Description |
|---|---|---|---|
checked | boolean | false | Initial checked state |
label | string | Don't show again | Checkbox label text |
disabled | boolean | false | Whether the checkbox is disabled |
aria | Partial<ComponentAriaProps> | — | ARIA attributes |
customClasses | Partial<BordaTourSkipComponentClasses> | — | Custom CSS classes |
customStyles | Partial<BordaTourSkipComponentStyles> | — | Custom inline styles |
customHtml | Partial<BordaTourSkipComponentHtml> | — | Custom HTML for input/label |
await borda.mount({
steps: [...],
tourSkip: {
label: 'Do not show this again',
},
});
Disabling
await borda.mount({
steps: [...],
tourSkip: false,
});
Customization
tourSkip: {
customClasses: {
root: 'my-skip-wrapper',
label: 'text-xs text-gray-400',
},
}
Interface
interface BordaTourSkipProps {
checked: boolean;
label: string;
disabled: boolean;
aria: Partial<ComponentAriaProps>;
customClasses: Partial<BordaTourSkipComponentClasses>;
customStyles: Partial<BordaTourSkipComponentStyles>;
customHtml: Partial<BordaTourSkipComponentHtml>;
}