Skip to content

Search documentation

Search guides, examples, and component APIs.

Quick links
↑↓ NavigateEnter OpenEsc Close
Get started

Documentation navigation

Components / Display

DescriptionList

Responsive semantic key-value details with concise item composition.

Last changed in version 0.13.0: Add avatar groups and chips, expand the block gallery, and improve component colors, spacing, and motion.

Interactive showcase

Customer
Mira Laurent
Plan
Growth
Email
mira@example.com
Status
Active

Install

Run in your project
bunx --bun @getweini/cli@latest add description-list

Start with this example

Import the files copied by the install command, then place the component in your Vue template. The text and values in the example belong to your app; change them to fit your task.

Customer
Mira Laurent
Status
Paid
Order
ORD-2048
Total
€128.00
Address
24 Rue du Marché, Luxembourg
Vue
<script setup lang="ts">
import Badge from './components/ui/badge/Badge.vue'
import DescriptionList from './components/ui/description-list/DescriptionList.vue'
import DescriptionListItem from './components/ui/description-list/DescriptionListItem.vue'
</script>

<template>
  <DescriptionList :columns="2" divided class="w-full max-w-2xl">
    <DescriptionListItem label="Customer">Mira Laurent</DescriptionListItem>
    <DescriptionListItem label="Status"><Badge variant="success">Paid</Badge></DescriptionListItem>
    <DescriptionListItem label="Order">ORD-2048</DescriptionListItem>
    <DescriptionListItem label="Total">€128.00</DescriptionListItem>
    <DescriptionListItem label="Address" span="full">
      24 Rue du Marché, Luxembourg
    </DescriptionListItem>
  </DescriptionList>
</template>

DescriptionList preserves native dl, dt, and dd semantics with responsive columns, spanning, and stacked or inline layouts. Items have no bottom borders.

When to use it

Record details

Present stable labels and values for an order, account, or profile.

Review summary

Let people scan submitted values before confirming a workflow.

More examples

Compact rows

Align terms and values in generously spaced rows.

Compact rows
<script setup lang="ts">
import DescriptionList from './components/ui/description-list/DescriptionList.vue'
import DescriptionListItem from './components/ui/description-list/DescriptionListItem.vue'
</script>

<template>
  <DescriptionList divided>
    <DescriptionListItem label="Order" layout="inline">ORD-2048</DescriptionListItem>
    <DescriptionListItem label="Customer" layout="inline">Mira Laurent</DescriptionListItem>
    <DescriptionListItem label="Total" layout="inline">€128.00</DescriptionListItem>
  </DescriptionList>
</template>

Responsive metadata

Use three columns and let long content span the full grid.

Responsive metadata
<script setup lang="ts">
import DescriptionList from './components/ui/description-list/DescriptionList.vue'
import DescriptionListItem from './components/ui/description-list/DescriptionListItem.vue'
</script>

<template>
  <DescriptionList :columns="3">
    <DescriptionListItem label="Region">Luxembourg</DescriptionListItem>
    <DescriptionListItem label="Team">Operations</DescriptionListItem>
    <DescriptionListItem label="Owner">Mira Laurent</DescriptionListItem>
    <DescriptionListItem span="full">
      <template #term>Notes</template>
      Customer requested delivery before 17:00.
    </DescriptionListItem>
  </DescriptionList>
</template>

Complete API

Every public prop, model, event, slot, and exposed member of the installed Vue parts is listed below. “Not set” means you can leave that value out; “Required” means you must provide it. Native HTML attributes also work where the component uses a native element.

DescriptionList

Complete API for DescriptionList
NameType or signatureDefaultWhat it does
columnsprop1 | 2 | 3 | undefined1Define the columns shown in the table.
dividedpropboolean | undefinedfalseThe compatibility divided prop retains 16px block padding for roomy rows without adding separator lines.
defaultslot() => unknownRequiredContent shown inside DescriptionList.

DescriptionListItem

Complete API for DescriptionListItem
NameType or signatureDefaultWhat it does
labelpropstring | undefinedNot setVisible or accessible name for this item.
spanprop1 | 2 | 3 | "full" | undefined1Controls the span behavior of DescriptionListItem.
layoutprop"stacked" | "inline" | undefined"stacked"Controls the layout behavior of DescriptionListItem.
termslot(() => unknown) | undefinedOptionalContent for the term area of DescriptionListItem.
defaultslot() => unknownRequiredContent shown inside DescriptionListItem.
Public type definitions
Public types
// packages/frameworks/vue/components/description-list/types.ts
export interface DescriptionListProps {
  columns?: 1 | 2 | 3
  divided?: boolean
}

export interface DescriptionListItemProps {
  label?: string
  span?: 1 | 2 | 3 | 'full'
  layout?: 'stacked' | 'inline'
}

Implementation notes

  • Choose columns for the available width; the layout collapses to one column on small screens.
  • Use span="full" for values such as notes or addresses that should consume the complete responsive row.

Accessibility and localization

  • Keep each term concise and place its corresponding value in the same DescriptionListItem.

Source contract and editing guidance