Overlays
Tour
Guides people through product features using a sequence of anchored steps.
01
See it and copy it
Framework example
Choose Astro, React, or Elements to compare native usage against the shared visual output. Each example assumes the framework-level setup is already complete.
Click this button to get started.
View Tour code
Framework usage
Switch targets to compare the adapter code. This live preview runs the Astro example. React and Elements use their own behavior APIs; complete the matching framework setup before copying an example.---
import {
Button,
Tour
} from '@santi020k/lumen-astro'
---
<Tour id="demo-tour" steps={[{ target: '#demo-btn', content: 'Click this button to get started.' }]} />
<Button data-ui-tour-open="#demo-tour" id="demo-btn">Start guided tour</Button>import {
Button,
Tour
} from '@santi020k/lumen-react'
export const Example = () => (
<>
<Tour id="demo-tour" steps={[{ target: '#demo-btn', content: 'Click this button to get started.' }]} />
<Button data-ui-tour-open="#demo-tour" id="demo-btn">Start guided tour</Button>
</>
)<script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<lumen-tour id="demo-tour" steps={[{ target: '#demo-btn', content: 'Click this button to get started.' }]}></lumen-tour>
<lumen-button data-ui-tour-open="#demo-tour" id="demo-btn">Start guided tour</lumen-button>02
Choose your target
Add this component
Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.
pnpm add @santi020k/lumen-astropnpm add @santi020k/lumen-astrolumen add Tourlumen add Tourpnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add Tour --target reactlumen add Tour --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add Tour --target elementslumen add Tour --target elementsAPI reference
Lumen-specific props and runtime attributes for the Astro primitive. Use the framework differences above and the copyable examples for React composition and Elements attributes; the public adapter types define their supported contracts.
| Attribute | Values | Default | Description |
|---|---|---|---|
| steps | Array<{ target, content, title? }> | [] | Defines the ordered anchored guidance steps. |
| nextLabel, closeLabel | string | "Next", "Close" | Sets the tour navigation action labels. |
| class, className | string | "" | Merges custom classes with the generated ui-* root classes. |
| ...native attributes | HTML attributes | - | Forwards standard attributes to the root element unless the component consumes them. |