OverlaysGlass surface
Sheet
Shows a side sheet for secondary flows.
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.
View Sheet 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,
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>'use client'
import { Button, Sheet, useDialog } from '@santi020k/lumen-react'
export function Example() {
const sheet = useDialog()
return (
<>
<Button {...sheet.triggerProps} variant="outline">Open details</Button>
<Sheet {...sheet.dialogProps} aria-labelledby="details-title">
<h2 id="details-title">Deployment details</h2>
<p>Illustrative build details for the preview.</p>
<Button {...sheet.closeProps} variant="secondary">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>Framework differences
React: Use useDialog to connect triggerProps, dialogProps, and closeProps. The hook owns modal behavior while Sheet supplies the surface.
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 Sheetlumen add Sheetpnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add Sheet --target reactlumen add Sheet --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add Sheet --target elementslumen add Sheet --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.
View Sheet 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,
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>'use client'
import { Button, Sheet, useDialog } from '@santi020k/lumen-react'
export function Example() {
const sheet = useDialog()
return (
<>
<Button {...sheet.triggerProps} variant="outline">Open details</Button>
<Sheet {...sheet.dialogProps} aria-labelledby="details-title">
<h2 id="details-title">Deployment details</h2>
<p>Illustrative build details for the preview.</p>
<Button {...sheet.closeProps} variant="secondary">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>API 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 |
|---|---|---|---|
| glass | boolean | "subtle" | "strong" | false | Applies the tokenized liquid-glass surface treatment with backdrop-filter fallbacks; "subtle" and "strong" adjust the fill intensity. |
| 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. |