Sidebar
Builds persistent app navigation.
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.
Framework usage
Switch targets to compare the adapter code. The preview stays visually stable because all three packages share the same tokens andui-* class contract.---
import { Sidebar } from '@santi020k/lumen-astro'
---
<Sidebar aria-label="App">
<a aria-current="page" href="/docs">Dashboard</a>
<a href="/docs">Projects</a>
<a href="/docs">Settings</a>
</Sidebar>import { Sidebar } from '@santi020k/lumen-react'
export const Example = () => (
<>
<Sidebar aria-label="App">
<a aria-current="page" href="/docs">Dashboard</a>
<a href="/docs">Projects</a>
<a href="/docs">Settings</a>
</Sidebar>
</>
)<script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<lumen-sidebar aria-label="App">
<a aria-current="page" href="/docs">Dashboard</a>
<a href="/docs">Projects</a>
<a href="/docs">Settings</a>
</lumen-sidebar>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 Sidebarlumen add Sidebarpnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add Sidebar --target reactlumen add Sidebar --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add Sidebar --target elementslumen add Sidebar --target elementsGlass
Add the glass prop to apply the shared blur, saturation, border, and highlight tokens. Glass reads best over vivid content, so place the surface above imagery or color.
Framework usage
Switch targets to compare the adapter code. The preview stays visually stable because all three packages share the same tokens andui-* class contract.---
import { Sidebar } from '@santi020k/lumen-astro'
---
<div class="docs-glass-demo" style="justify-items: center;">
<Sidebar aria-label="App" glass style="max-width: 16rem;">
<a aria-current="page" href="/docs">Dashboard</a>
<a href="/docs">Projects</a>
<a href="/docs">Team</a>
<a href="/docs">Settings</a>
</Sidebar>
</div>import { Sidebar } from '@santi020k/lumen-react'
export const Example = () => (
<>
<div className="docs-glass-demo" style={{ justifyItems: 'center' }}>
<Sidebar aria-label="App" glass style={{ maxWidth: '16rem' }}>
<a aria-current="page" href="/docs">Dashboard</a>
<a href="/docs">Projects</a>
<a href="/docs">Team</a>
<a href="/docs">Settings</a>
</Sidebar>
</div>
</>
)<script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<div class="docs-glass-demo" style="justify-items: center;">
<lumen-sidebar aria-label="App" glass style="max-width: 16rem;">
<a aria-current="page" href="/docs">Dashboard</a>
<a href="/docs">Projects</a>
<a href="/docs">Team</a>
<a href="/docs">Settings</a>
</lumen-sidebar>
</div>API 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 |
|---|---|---|---|
| glass | boolean | "subtle" | "strong" | false | Applies the tokenized liquid-glass surface treatment with backdrop-filter fallbacks; "subtle" and "strong" adjust the fill intensity. |
| variant | "default" | "unstyled" | "default" | Keeps aside semantics while removing Lumen layout and presentation. |
| 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. |