Documentation
Overlays
Tour
Guides people through product features using a sequence of anchored steps.
01
See it in context
Preview
Click this button to get started.
02
Copy a working example
Usage
---
import {
Button,
Tour
} from '@santi020k/lumen-astro'
---
<Tour steps={[{ target: '#demo-btn', content: 'Click this button to get started.' }]} />
<Button id="demo-btn">Start guided tour</Button>---
import {
Button,
Tour
} from '@santi020k/lumen-astro'
---
<Tour steps={[{ target: '#demo-btn', content: 'Click this button to get started.' }]} />
<Button id="demo-btn">Start guided tour</Button>import { Button, Tour } from '@santi020k/lumen-react'
export const Example = () => (
<>
<Tour steps={[{ target: '#demo-btn', content: 'Click this button to get started.' }]} />
<Button id="demo-btn">Start guided tour</Button>
</>
)import { Button, Tour } from '@santi020k/lumen-react'
export const Example = () => (
<>
<Tour steps={[{ target: '#demo-btn', content: 'Click this button to get started.' }]} />
<Button id="demo-btn">Start guided tour</Button>
</>
)<script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<lumen-tour steps={[{ target: '#demo-btn', content: 'Click this button to get started.' }]}></lumen-tour>
<lumen-button id="demo-btn">Start guided tour</lumen-button><script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<lumen-tour steps={[{ target: '#demo-btn', content: 'Click this button to get started.' }]}></lumen-tour>
<lumen-button id="demo-btn">Start guided tour</lumen-button>03
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. React props follow the same names; Elements use equivalent kebab-case attributes where custom elements expose them.
| Attribute | Values | Default | Description |
|---|---|---|---|
| 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. |