Descriptions

Display key-value pairs in a structured, labeled format.

When to Use

  • For detail pages showing entity attributes
  • To display read-only form data
  • For profile information or order summaries

Import

import { Descriptions } from "orizon";

Examples

Basic

User Info
Name:John Brown
Phone:1810000000
Address:New York, USA
Email:john@example.com
<Descriptions
  title="User Info"
  items={[
    { key: "1", label: "Name", children: "John Brown" },
    { key: "2", label: "Phone", children: "1810000000" },
    { key: "3", label: "Address", children: "New York, USA" },
  ]}
/>

Bordered

Order Details
Product:Orizon ProPrice:$99.00Quantity:1
Status:Shipped
<Descriptions bordered title="Order Details" items={items} />

Vertical Layout

Name:
Jane Smith
Role:
Designer
Department:
Product
<Descriptions layout="vertical" items={items} />

API

DescriptionsProps

  • itemsDescriptionsItem[] — Description item data
  • titleReactNode — Title above the descriptions
  • extraReactNode — Extra content in header
  • borderedboolean — Show borders (default: false)
  • columnnumber | ResponsiveObject — Items per row (default: 3)
  • layout"horizontal" | "vertical" — Label layout (default: "horizontal")
  • size"default" | "middle" | "small" — Size (default: "default")
  • colonboolean — Show colon after label (default: true)
  • labelStyleCSSProperties — Label styles
  • contentStyleCSSProperties — Content styles

DescriptionsItem

  • keystring — Unique identifier
  • labelReactNode — Item label
  • childrenReactNode — Item content
  • spannumber — Columns this item spans (default: 1)
  • labelStyleCSSProperties — Override label styles
  • contentStyleCSSProperties — Override content styles