Data display
DescriptionTerm
Composes rich description term content.
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.
- Status
- Active
- Related record
- View record details
View DescriptionTerm 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 { Badge, DescriptionDetail, DescriptionItem, Descriptions, DescriptionTerm, Link } from '@santi020k/lumen-astro'
---
<Descriptions columns={2} aria-label="Record details">
<DescriptionItem>
<DescriptionTerm>Status</DescriptionTerm>
<DescriptionDetail><Badge variant="success">Active</Badge></DescriptionDetail>
</DescriptionItem>
<DescriptionItem>
<DescriptionTerm>Related record</DescriptionTerm>
<DescriptionDetail><Link href="/docs/components/descriptions">View record details</Link></DescriptionDetail>
</DescriptionItem>
</Descriptions>import { Badge, DescriptionDetail, DescriptionItem, Descriptions, DescriptionTerm, Link } from '@santi020k/lumen-react'
export const Example = () => (
<>
<Descriptions columns={2} aria-label="Record details">
<DescriptionItem>
<DescriptionTerm>Status</DescriptionTerm>
<DescriptionDetail><Badge variant="success">Active</Badge></DescriptionDetail>
</DescriptionItem>
<DescriptionItem>
<DescriptionTerm>Related record</DescriptionTerm>
<DescriptionDetail><Link href="/docs/components/descriptions">View record details</Link></DescriptionDetail>
</DescriptionItem>
</Descriptions>
</>
)<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 DescriptionTermlumen add DescriptionTermpnpm add @santi020k/lumen-reactpnpm add @santi020k/lumen-reactlumen add DescriptionTerm --target reactlumen add DescriptionTerm --target reactpnpm add @santi020k/lumen-elementspnpm add @santi020k/lumen-elementslumen add DescriptionTerm --target elementslumen add DescriptionTerm --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 |
|---|---|---|---|
| children | rich content | required | Composes a description term. Astro and React render dt; Elements expose term semantics on the host. |
| 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. |