Theme

DescriptionList

display @dryui/ui Compound

Responsive term and value list for summaries and specs

detailssummarymetadatadefinitions

Start Here

Start from the smallest working snippet, then move to interactive examples and the full API contract below.

Styled quick start

Copy this entrypoint first. It includes the imports required to get the component on screen.

svelte
<script lang="ts">
  import '@dryui/ui/themes/default.css';
  import '@dryui/ui/themes/dark.css';
  import { DescriptionList } from '@dryui/ui';
</script>

<DescriptionList.Root>
  <DescriptionList.Item>
    <DescriptionList.Term>Workspace</DescriptionList.Term>
    <DescriptionList.Description>North America expansion</DescriptionList.Description>
  </DescriptionList.Item>
  <DescriptionList.Item>
    <DescriptionList.Term>Status</DescriptionList.Term>
    <DescriptionList.Description>Reviewing launch checklist</DescriptionList.Description>
  </DescriptionList.Item>
</DescriptionList.Root>

Import options

Root package

ts
import { DescriptionList } from '@dryui/ui'

Per-component subpath

ts
import { DescriptionList } from '@dryui/ui/description-list'

Customize

Use the interactive examples to see common variants, states, and composition patterns before building your own.

Project summary

Workspace
APAC expansion
Status
On track
svelte
<script lang="ts">
  import { Badge, DescriptionList } from '@dryui/ui';
</script>

<DescriptionList.Root>
  <DescriptionList.Item>
    <DescriptionList.Term>Workspace</DescriptionList.Term>
    <DescriptionList.Description>APAC expansion</DescriptionList.Description>
  </DescriptionList.Item>
  <DescriptionList.Item>
    <DescriptionList.Term>Status</DescriptionList.Term>
    <DescriptionList.Description><Badge variant="soft">On track</Badge></DescriptionList.Description>
  </DescriptionList.Item>
</DescriptionList.Root>

Profile details

Owner
Elena Rossi
Release window
April 14, 09:00 UTC
svelte
<script lang="ts">
  import { DescriptionList } from '@dryui/ui';
</script>

<DescriptionList.Root>
  <DescriptionList.Item>
    <DescriptionList.Term>Owner</DescriptionList.Term>
    <DescriptionList.Description>Elena Rossi</DescriptionList.Description>
  </DescriptionList.Item>
  <DescriptionList.Item>
    <DescriptionList.Term>Release window</DescriptionList.Term>
    <DescriptionList.Description>April 14, 09:00 UTC</DescriptionList.Description>
  </DescriptionList.Item>
</DescriptionList.Root>

Structure

Compound components always start with DescriptionList.Root. Use this structure block to understand required wrappers before you wire state or styling.

DescriptionList.Root
  DescriptionList.Item
    DescriptionList.Term
    DescriptionList.Description
DescriptionList.Root DescriptionList.ItemDescriptionList.TermDescriptionList.Description

Compose

The full API contract lives here: props, CSS variables, and the public data attributes you can target when styling.

Compound component. Start with DescriptionList.Root, then add only the parts you need.

DescriptionList.ItemDescriptionList.TermDescriptionList.Description

DescriptionList.Root

Prop Type Default Required Bindable
children
Snippet
— ✓ —

Forwards <dl> attributes via rest props. Common examples: id, style, role.

DescriptionList.Item

Prop Type Default Required Bindable
children
Snippet
— ✓ —

Forwards <div> attributes via rest props. Common examples: id, style, role.

DescriptionList.Term

Prop Type Default Required Bindable
children
Snippet
— ✓ —

Forwards <element> attributes via rest props. Common examples: id, class, aria-label.

DescriptionList.Description

Prop Type Default Required Bindable
children
Snippet
— ✓ —

Forwards <element> attributes via rest props. Common examples: id, class, aria-label.