Documentation
Data display
Descriptions
Presents a set of labeled facts as an aligned key–value list.
01
See it in context
Preview
- Name
- Alice
- Role
- Engineer
02
Copy a working example
Usage
---
import { Descriptions } from '@santi020k/lumen-astro'
---
<Descriptions items={[{ label: 'Name', value: 'Alice' }, { label: 'Role', value: 'Engineer' }]} />---
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' }]} />
</>
)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 items={[{ label: 'Name', value: 'Alice' }, { label: 'Role', value: 'Engineer' }]}></lumen-descriptions><script type="module">
import { defineLumenElements } from '@santi020k/lumen-elements/define'
defineLumenElements()
</script>
<lumen-descriptions items={[{ label: 'Name', value: 'Alice' }, { label: 'Role', value: 'Engineer' }]}></lumen-descriptions>03
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. React props follow the same names; Elements use equivalent kebab-case attributes where custom elements expose them.
| Attribute | Values | Default | Description |
|---|---|---|---|
| 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. |