Skip to main content

Description list

Label and value pairs for metadata.

mrn://postgresql/table/shop.public.orders 1,284,019
<mm-description-list>
<mm-description term="MRN" mono>mrn://postgresql/table/shop.public.orders</mm-description>
<mm-description term="Rows">1,284,019</mm-description>
<mm-description term="Retention"></mm-description> <!-- shows "Not set" -->
</mm-description-list>

Guidance​

A description list sets out an object's metadata as label and value pairs: the Details section of the asset blade, a pipeline's configuration, a member's profile. Labels are the sentence-case label style in mm-text-2; values are dense text that wraps anywhere, so long MRNs never push the layout wider. Nothing is boxed: pairs are separated by spacing alone.

layout="columns" (default) puts a 120px label column beside the values. stacked puts each label above its value, for narrow places. inline-grid lays pairs across 2 to 4 columns (columns), for short KPI-like metadata such as rows, size and freshness.

The list is exposed as a list of term and definition pairs, since native dl semantics cannot cross shadow roots.

Properties​

PropertyAttributeTypeDefaultDescription
layoutlayoutDescriptionLayout'columns'columns (label column beside values, default), stacked or inline-grid.
columnscolumnsnumber3Number of columns for inline-grid, 2 to 4.

Slots​

SlotDescription
Defaultmm-description items.

CSS parts​

PartDescription
listThe grid.

Examples​

Every state of mm-description-list in Storybook, with keyboard and screen reader tests.