zynactradocs

Description List

Label and value pairs for a record's details, in a side panel or a summary before confirming.

Role
Payroll admin
Scope
Company: Acme Lanka (Pvt) Ltd
Status
Active
Reason
Covering March payroll while Dilani is on leave.

Usage

import { DescriptionDetails, DescriptionItem, DescriptionList, DescriptionTerm } from "@zynactra/ui/description-list"
<DescriptionList>
  <DescriptionItem>
    <DescriptionTerm>Role</DescriptionTerm>
    <DescriptionDetails>Payroll admin</DescriptionDetails>
  </DescriptionItem>
</DescriptionList>

Labels sit beside values from the sm breakpoint and stack below it. layout="vertical" always stacks, for narrow panels.

Guidelines

  • Use it to read a record. To edit one, use a form with Field.
  • Keep terms to a word or two; put long explanations in the details.
  • Show a missing value as a dash or a short phrase ("Never expires"), not an empty row.
Edit on GitHub

On this page