Skip to main content
196

Search Lumen

Find components, APIs, guides, and recipes.

GitHub
Web docs
Framework guide

Astro

The reference implementation for Lumen UI, with the complete component catalog, automatic component CSS, and controllers that load on demand.

Surface
Full
Runtime
On demand
Package
Astro

Start with a complete Astro project

The free MIT starter includes landing page, ecommerce, dashboard, and portfolio templates. Explore seven Lumen themes in light and dark mode, then edit the same source in your own project.

Installation

V5 Astro components import their own CSS. Install @santi020k/lumen separately as a development dependency for CLI commands. Mount UIPrimitives once in your root layout only if you use interactive primitives; do not add it beside every component.

pnpm

bash
pnpm add @santi020k/lumen-astro

npm

bash
npm install @santi020k/lumen-astro

yarn

bash
yarn add @santi020k/lumen-astro

Usage Example

astro
---
import { Button, Card, Input, Label } from '@santi020k/lumen-astro'
---

<Card>
  <Label for="email">Email</Label>
  <Input id="email" type="email" placeholder="you@example.com" />
  <Button>Subscribe</Button>
</Card>

Overview

  • Reference implementation for markup, props, automatic component CSS, and selective progressive enhancement.
  • In v5, await LumenInitUiPrimitives(scope); ui:ready follows completion and ui:runtime-error reports failed enhancement.
  • Mount UIPrimitives once in the root layout for interactive primitives and CustomEvents.
  • Use lumen add Component or lumen add recipe-name --target astro when you want local .astro starter files.

Progressive Enhancement Runtime

Interactive components like Dialogs, Popovers, Tabs, and Selects rely on a lightweight, vanilla JavaScript runtime. Mount <UIPrimitives /> once in your Astro root layout to wire up keyboard navigation, focus trapping, and disclosure state for matching components. In v5, controllers load on demand and initialization is asynchronous. Await window.LumenInitUiPrimitives(scope) for application-created markup;ui:ready follows completion and ui:runtime-error reports failures.

astro
---
import { Button, Card } from '@santi020k/lumen-astro'
import UIPrimitives from '@santi020k/lumen-astro/runtime'
---

<UIPrimitives />
<Card><Button>Save</Button></Card>
Switch content

Try the tabs

Focus a tab and use the arrow keys to switch views.

Your workspace is ready.

No new activity today.

Tabs API and examples
Open an overlay

Try the dialog

Open help, press Escape to dismiss it, then check where focus returns.

Workspace help

Keep your team settings in one place.

Dialog API and examples
Native HTML behavior

Try the disclosure

Click the question or focus it and press Enter. This also works without JavaScript.

Does this need JavaScript?

Native details can open and close without the runtime.

Accordion API and examples

Copy a demo · Astro snippets assume styles and UIPrimitives are already mounted in your root layout.

astro
---
import { Tabs, TabsList, TabsPanel, TabsTrigger } from '@santi020k/lumen-astro'
---

<Tabs initialValue="overview">
  <TabsList aria-label="Workspace view">
    <TabsTrigger value="overview">Overview</TabsTrigger>
    <TabsTrigger value="activity">Activity</TabsTrigger>
  </TabsList>
  <TabsPanel value="overview">
    <p>Your workspace is ready.</p>
  </TabsPanel>
  <TabsPanel value="activity">
    <p>No new activity today.</p>
  </TabsPanel>
</Tabs>
Web docsFull catalog