Skip
Configure the "Don't show again" feature with persistent localStorage storage.
The skip feature adds a "Don't show again" checkbox to the tooltip. When checked, the onboarding won't replay for returning users — the state is persisted in localStorage.
Config
| Property | Type | Default | Description |
|---|---|---|---|
storageKey | string | borda-skip | Key used in localStorage to persist the skip flag |
await borda.mount({
steps: [
{
target: '#welcome',
title: 'Welcome',
description: 'This onboarding will help you get started.',
placement: 'bottom-center',
},
{
target: '#dashboard',
title: 'Your dashboard',
description: 'Everything you need is right here.',
placement: 'middle-end',
},
],
skip: {
storageKey: 'my-app-onboarding-skip',
},
});
Disabling skip
Pass false to remove the skip checkbox entirely:
await borda.mount({
steps: [...],
skip: false,
});
Runtime API
Control the skip state programmatically:
// Check if the user chose to skip
instance.skip.isSkipped;
// Set the skip flag manually
instance.skip.set(true);
// Clear the persisted flag (onboarding will replay next time)
instance.skip.clear();
// Read the active storage key
instance.skip.storageKey;