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

Box

The token-driven layout atom: padding/margin scale props and polymorphism.

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

Import

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

Examples

Spacing scale

Spacing scale
Show source
tsx
export function BoxBasic() {
  return (
    <Flex gap={2} wrap="wrap">
      <Box p={2} style={cell}>p=2</Box>
      <Box p={3} style={cell}>p=3</Box>
      <Box p={4} style={cell}>p=4</Box>
    </Flex>
  )
}

Props

PropTypeDefaultDescription
asReact.ElementType<any, keyof React.JSX.IntrinsicElements> | undefinedElement to render. Defaults to `div`.
asChildboolean | undefinedRender the single child, merging props/ref onto it (Radix Slot).
mSpaceProp | undefinedMargin (all sides).
mxSpaceProp | undefinedMargin inline (start + end).
mySpaceProp | undefinedMargin block (start + end).
pSpaceProp | undefinedPadding (all sides).
pbSpaceProp | undefinedPadding block-end.
plSpaceProp | undefinedPadding inline-start.
prSpaceProp | undefinedPadding inline-end.
ptSpaceProp | undefinedPadding block-start.
pxSpaceProp | undefinedPadding inline (start + end).
pySpaceProp | undefinedPadding block (start + end).

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.