Also available as vitreui— the same library under a shorter name.npm i vitreui
Skip to content

Icon Button

A square, icon-only button that enforces an accessible name at the type level (aria-label or label is required).

Group: Primitives · Import path: @orionshub/lucent/icon-button · Server-safe — renders on the server without a client bundle.

Import

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

Examples

Accessible icon buttons

Accessible icon buttons
Show source
tsx
export function IconButtonBasic() {
  return (
    <div style={row}>
      <IconButton icon={<PlusIcon />} aria-label="Add" variant="solid" />
      <IconButton icon={<PlusIcon />} aria-label="Add" variant="soft" />
      <IconButton icon={<PlusIcon />} aria-label="Add" variant="outline" />
      <IconButton icon={<PlusIcon />} aria-label="Add" variant="ghost" />
    </div>
  )
}

Props

PropTypeDefaultDescription
aria-label*string
icon*React.ReactNodeThe icon to render.
asChildboolean | undefinedRender the single child element instead of a <button> (via Slot).
labelundefined
size"sm" | "md" | "lg" | undefinedSize. Defaults to `md`.
variant"solid" | "soft" | "ghost" | "outline" | undefinedVisual style. Defaults to `ghost`.

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

Server-safe — renders on the server without a client bundle. All components are safe to import in a Server Component tree; interactive ones carry their own "use client" boundary. See SSR & Next.js.

Released under the MIT License.