Data display
Descriptions
Presents a set of labeled facts as an aligned key–value list.
01
See it and copy it
Framework example
Choose Astro, React, or Elements to compare native usage against the shared visual output. Each example assumes the framework-level setup is already complete.
- Name
- Alice
- Role
- Engineer
View Descriptions code
Framework usage
Switch targets to compare the adapter code. This live preview runs the Astro example. React and Elements use their own behavior APIs; complete the matching framework setup before copying an example.---
import { Descriptions } from '@santi020k/lumen-astro'
---
<Descriptions items={[{ label: 'Name', value: 'Alice' }, { label: 'Role', value: 'Engineer' }]} />import { Descriptions } from '@santi020k/lumen-react'
export const Example = () => (
<>
<Descriptions items={[{ label: 'Name', value: 'Alice' }, { label: 'Role', value: 'Engineer' }]} />
</>
)<script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<lumen-descriptions role="group" aria-label="Record details">
<lumen-description-item>
<lumen-description-term id="record-status">Status</lumen-description-term>
<lumen-description-detail aria-labelledby="record-status"><lumen-badge variant="success">Active</lumen-badge></lumen-description-detail>
</lumen-description-item>
<lumen-description-item>
<lumen-description-term id="record-link">Related record</lumen-description-term>
<lumen-description-detail aria-labelledby="record-link"><a href="/docs/components/descriptions">View record details</a></lumen-description-detail>
</lumen-description-item>
</lumen-descriptions>02
Choose your target
Add this component
Choose the package for your runtime. All adapters share the Lumen stylesheet. Use the matching registry command when you want a local wrapper for that framework.
pnpm add @santi020k/lumen-astropnpm add @santi020k/lumen-astrolumen add Descriptionslumen add Descriptionspnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add Descriptions --target reactlumen add Descriptions --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add Descriptions --target elementslumen add Descriptions --target elementsAPI reference
Lumen-specific props and runtime attributes for the Astro primitive. Use the framework differences above and the copyable examples for React composition and Elements attributes; the public adapter types define their supported contracts.
| Attribute | Values | Default | Description |
|---|---|---|---|
| items | Array<{ label, value }> | [] | Defines the labelled facts. |
| columns | number | 1 | Sets the preferred number of aligned columns. |
| class, className | string | "" | Merges custom classes with the generated ui-* root classes. |
| ...native attributes | HTML attributes | - | Forwards standard attributes to the root element unless the component consumes them. |