Sidebar

Builds persistent app navigation.

View preview API reference View in Figma

FrameworksAstro · React · Elements

Registry commandlumen add Sidebar

InteractionNative markup

Design sourceLinked component node

See it in context

Preview

Copy a working example

Usage

---
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-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>
  </>
)

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>

<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.

Glass

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.

---
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-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>
  </>
)

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>

<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.
surface	"default" \| "glass"	"default"	Deprecated alias for glass; surface="glass" maps to glass={true}.
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.