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

Avatar

An image avatar with a graceful initials/fallback after a load delay.

Group: Primitives · Import path: @orionshub/lucent/avatar · Client component — ships a "use client" boundary.

Import

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

Examples

Image & fallback

Image & fallback
Show source
tsx
export function AvatarBasic() {
  return (
    <div style={row}>
      <Avatar src="https://i.pravatar.cc/80?img=1" alt="Ada" fallback="AD" />
      <Avatar fallback="JD" />
    </div>
  )
}

Props

PropTypeDefaultDescription
fallback*React.ReactNodeFallback content (initials / icon) shown when the image is unavailable.
altstring | undefinedAlt text for the image.
delayMsnumber | undefinedDebounce (ms) before showing the fallback, to avoid flash on fast loads.
srcstring | undefinedImage source. When absent or failed, the fallback renders.

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

Client component — ships a "use client" boundary. 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.