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

Flex

A flexbox container with token gap, alignment, and direction props.

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

Import

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

Examples

Row & column

Row & column
Show source
tsx
export function FlexBasic() {
  return (
    <Flex gap={2} wrap="wrap" align="center">
      <Badge>Flex</Badge>
      <Badge tone="accent">gap 2</Badge>
      <Badge tone="danger">wrap</Badge>
    </Flex>
  )
}

Props

PropTypeDefaultDescription
alignProperty.AlignItems | undefinedalign-items.
asReact.ElementType<any, keyof React.JSX.IntrinsicElements> | undefined
asChildboolean | undefined
direction"row" | "column" | "row-reverse" | "column-reverse" | undefinedflex-direction. Defaults to `row`.
gapSpaceProp | undefinedGap between items (spacing token or raw value).
inlineboolean | undefinedRender as inline-flex.
justifyProperty.JustifyContent | undefinedjustify-content.
pSpaceProp | undefinedPadding (all sides).
pxSpaceProp | undefinedPadding inline.
pySpaceProp | undefinedPadding block.
wrap"nowrap" | "wrap" | "wrap-reverse" | undefinedflex-wrap.

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.