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

Visually Hidden

Hide content visually while keeping it available to assistive technology — for accessible names that shouldn’t clutter the UI.

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

Import

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

Examples

Accessible-only label

Accessible-only label
Show source
tsx
export function VisuallyHiddenBasic() {
  return (
    <Button>
      <span aria-hidden>★</span>
      <VisuallyHidden>Add to favourites</VisuallyHidden>
    </Button>
  )
}

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

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.