Dialog

A modal dialog that traps focus, returns focus on close, locks scroll, honors ESC, and renders a glass backdrop through a themed portal.

Group: Overlays · Import path: @orionshub/lucent/dialog · Client component — ships a "use client" boundary.

Import

import { Dialog } from '@orionshub/lucent'
import '@orionshub/lucent/styles.css' // once, at your app root

Examples

Modal dialog

Modal dialog

Show source

export function DialogBasic() {
  return (
    <Dialog.Root>
      <Dialog.Trigger asChild><Button>Open dialog</Button></Dialog.Trigger>
      <Dialog.Content>
        <Dialog.Title>Edit profile</Dialog.Title>
        <Dialog.Description>Focus is trapped and returned; ESC closes; page scroll locks.</Dialog.Description>
        <div style={{ display: 'flex', justifyContent: 'flex-end', gap: 8, marginBlockStart: 24 }}>
          <Dialog.Close asChild><Button variant="ghost">Cancel</Button></Dialog.Close>
          <Dialog.Close asChild><Button>Save</Button></Dialog.Close>
        </div>
      </Dialog.Content>
    </Dialog.Root>
  )
}

Props

DialogContent

Prop	Type	Default	Description
overlayClassName	string | undefined	—	Overlay className passthrough.

DialogTitle

This component forwards native element props. It exposes no additional public props, or its props are documented inline above.

DialogDescription

This component forwards native element props. It exposes no additional public props, or its props are documented inline above.

Guidance

One-time CSS import

Import the compiled stylesheet once at your app root: import '@orionshub/lucent/styles.css'. Components ship stable class names and read design tokens from CSS custom properties — there is no style runtime. See CSS Import.

Transparency & solid mode

Every glass surface reads --lucent-glass-opacity (0.60–1.0). Dial it at runtime with setGlassOpacity(), or switch to setContrast('solid') for a fully opaque, high-contrast rendering. See Transparency & Solid Mode.

Portal theming

This component renders through a portal to document.body. Because theme tokens are scoped to :root, portalled content stays themed automatically — do not nest it inside a transformed/backdrop-filter ancestor if you portal it manually. See Portal Theming.

Reduced motion

Animations are CSS-only and disabled under @media (prefers-reduced-motion: reduce). See Reduced Motion.

RTL

Authored with CSS logical properties — set dir="rtl" on a parent (or the document) and layout mirrors with no JS. Toggle RTL from the glass-controls panel to preview. See RTL Support.

SSR / Next.js

Client component — ships a "use client" boundary. All components are safe to import in a Server Component tree; interactive ones carry their own "use client" boundary. See SSR & Next.js.