Toggle

A two-state pressable button exposing aria-pressed.

Group: Form Controls · Import path: @orionshub/lucent/toggle · Client component — ships a "use client" boundary.

Import

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

Examples

Pressed state

Pressed state

Show source

export function ToggleBasic() {
  return (
    <div style={row}>
      <Toggle aria-label="Bold" defaultPressed><b>B</b></Toggle>
      <Toggle aria-label="Italic"><i>I</i></Toggle>
      <Toggle aria-label="Underline"><u>U</u></Toggle>
    </div>
  )
}

Props

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.

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.