Sheet

Shows a side sheet for secondary flows.

View preview API reference View in Figma

FrameworksAstro · React · Elements

Registry commandlumen add Sheet

InteractionNative markup

Design sourceLinked component node

See it in context

Preview

Copy a working example

Usage

---
import {
  Button,
  Sheet
} from '@santi020k/lumen-astro'
---

<Button variant="outline" data-ui-sheet-trigger="ex-sheet">Open details</Button>
<Sheet id="ex-sheet">
  <h2>Deployment details</h2>
  <p>Build 128 deployed from main in 42s.</p>
  <Button variant="ghost" data-ui-sheet-close>Close</Button>
</Sheet>

---
import {
  Button,
  Sheet
} from '@santi020k/lumen-astro'
---

<Button variant="outline" data-ui-sheet-trigger="ex-sheet">Open details</Button>
<Sheet id="ex-sheet">
  <h2>Deployment details</h2>
  <p>Build 128 deployed from main in 42s.</p>
  <Button variant="ghost" data-ui-sheet-close>Close</Button>
</Sheet>

import { Button, Sheet } from '@santi020k/lumen-react'

export const Example = () => (
  <>
    <Button variant="outline" data-ui-sheet-trigger="ex-sheet">Open details</Button>
    <Sheet id="ex-sheet">
      <h2>Deployment details</h2>
      <p>Build 128 deployed from main in 42s.</p>
      <Button variant="ghost" data-ui-sheet-close>Close</Button>
    </Sheet>
  </>
)

import { Button, Sheet } from '@santi020k/lumen-react'

export const Example = () => (
  <>
    <Button variant="outline" data-ui-sheet-trigger="ex-sheet">Open details</Button>
    <Sheet id="ex-sheet">
      <h2>Deployment details</h2>
      <p>Build 128 deployed from main in 42s.</p>
      <Button variant="ghost" data-ui-sheet-close>Close</Button>
    </Sheet>
  </>
)

<script type="module">
  import { defineLumenElements } from '@santi020k/lumen-elements/define'

  defineLumenElements()
</script>

<lumen-button variant="outline" data-ui-sheet-trigger="ex-sheet">Open details</lumen-button>
<lumen-sheet id="ex-sheet">
  <h2>Deployment details</h2>
  <p>Build 128 deployed from main in 42s.</p>
  <lumen-button variant="ghost" data-ui-sheet-close>Close</lumen-button>
</lumen-sheet>

<script type="module">
  import { defineLumenElements } from '@santi020k/lumen-elements/define'

  defineLumenElements()
</script>

<lumen-button variant="outline" data-ui-sheet-trigger="ex-sheet">Open details</lumen-button>
<lumen-sheet id="ex-sheet">
  <h2>Deployment details</h2>
  <p>Build 128 deployed from main in 42s.</p>
  <lumen-button variant="ghost" data-ui-sheet-close>Close</lumen-button>
</lumen-sheet>

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

pnpm add @santi020k/lumen-astro

lumen add Sheet

lumen add Sheet

pnpm add @santi020k/lumen-react

pnpm add @santi020k/lumen-react

lumen add Sheet --target react

lumen add Sheet --target react

pnpm add @santi020k/lumen-elements

pnpm add @santi020k/lumen-elements

lumen add Sheet --target elements

lumen add Sheet --target elements

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 {
  Button,
  Sheet
} from '@santi020k/lumen-astro'
---

<div class="docs-glass-demo" style="justify-items: center;">
  <Button variant="outline" data-ui-sheet-trigger="ex-sheet-glass">Open glass details</Button>
</div>
<Sheet id="ex-sheet-glass" glass>
  <h2>Deployment details</h2>
  <p>The glass sheet slides in as a full-height lens: page content stays visible, blurred and saturated.</p>
  <Button variant="ghost" data-ui-sheet-close>Close</Button>
</Sheet>

---
import {
  Button,
  Sheet
} from '@santi020k/lumen-astro'
---

<div class="docs-glass-demo" style="justify-items: center;">
  <Button variant="outline" data-ui-sheet-trigger="ex-sheet-glass">Open glass details</Button>
</div>
<Sheet id="ex-sheet-glass" glass>
  <h2>Deployment details</h2>
  <p>The glass sheet slides in as a full-height lens: page content stays visible, blurred and saturated.</p>
  <Button variant="ghost" data-ui-sheet-close>Close</Button>
</Sheet>

import { Button, Sheet } from '@santi020k/lumen-react'

export const Example = () => (
  <>
    <div className="docs-glass-demo" style={{ justifyItems: 'center' }}>
      <Button variant="outline" data-ui-sheet-trigger="ex-sheet-glass">Open glass details</Button>
    </div>
    <Sheet id="ex-sheet-glass" glass>
      <h2>Deployment details</h2>
      <p>The glass sheet slides in as a full-height lens: page content stays visible, blurred and saturated.</p>
      <Button variant="ghost" data-ui-sheet-close>Close</Button>
    </Sheet>
  </>
)

import { Button, Sheet } from '@santi020k/lumen-react'

export const Example = () => (
  <>
    <div className="docs-glass-demo" style={{ justifyItems: 'center' }}>
      <Button variant="outline" data-ui-sheet-trigger="ex-sheet-glass">Open glass details</Button>
    </div>
    <Sheet id="ex-sheet-glass" glass>
      <h2>Deployment details</h2>
      <p>The glass sheet slides in as a full-height lens: page content stays visible, blurred and saturated.</p>
      <Button variant="ghost" data-ui-sheet-close>Close</Button>
    </Sheet>
  </>
)

<script type="module">
  import { defineLumenElements } from '@santi020k/lumen-elements/define'

  defineLumenElements()
</script>

<div class="docs-glass-demo" style="justify-items: center;">
  <lumen-button variant="outline" data-ui-sheet-trigger="ex-sheet-glass">Open glass details</lumen-button>
</div>
<lumen-sheet id="ex-sheet-glass" glass>
  <h2>Deployment details</h2>
  <p>The glass sheet slides in as a full-height lens: page content stays visible, blurred and saturated.</p>
  <lumen-button variant="ghost" data-ui-sheet-close>Close</lumen-button>
</lumen-sheet>

<script type="module">
  import { defineLumenElements } from '@santi020k/lumen-elements/define'

  defineLumenElements()
</script>

<div class="docs-glass-demo" style="justify-items: center;">
  <lumen-button variant="outline" data-ui-sheet-trigger="ex-sheet-glass">Open glass details</lumen-button>
</div>
<lumen-sheet id="ex-sheet-glass" glass>
  <h2>Deployment details</h2>
  <p>The glass sheet slides in as a full-height lens: page content stays visible, blurred and saturated.</p>
  <lumen-button variant="ghost" data-ui-sheet-close>Close</lumen-button>
</lumen-sheet>

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}.
id	string	-	Connects the dialog surface to a matching trigger attribute value.
data-ui-sheet-trigger	target id	-	Marks an external trigger and points it at the dialog id.
data-ui-sheet-close	boolean attribute	-	Marks a child control that closes the nearest dialog.
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.