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

Heading

Polymorphic display/heading type with the Grotesk system-first stack.

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

Import

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

Examples

Levels

Levels
Show source
tsx
export function HeadingBasic() {
  return (
    <div style={{ display: 'flex', flexDirection: 'column', gap: 8 }}>
      <Heading size="display" as="h2">Display heading</Heading>
      <Heading size="heading" as="h3">Section heading</Heading>
    </div>
  )
}

Props

PropTypeDefaultDescription
asReact.ElementType<any, keyof React.JSX.IntrinsicElements> | undefinedThe element to render. Defaults to `h2`.
childrenReact.ReactNode
size"heading" | "display" | undefinedType-role size. Defaults to `heading`.

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.