Description list
Facts about one thing as term and value: stacked, inline like a receipt, or a grid of key figures (KeyValueGrid).
Web et mobile — le même composant pour React et React Native. Bêta : son API peut encore changer à une version mineure.
Pourquoi il est là. Facts of an object: Orazaka's job details and Orochia's order pages.
Quand l’utiliser
- A job's details in a side panel.
- A payout's or a tip's breakdown.
- An account's limits as a grid of figures.
Quand ne pas l’utiliser
Installation
Installer
npm install @krizaka/ui @krizaka/tailwind @krizaka/tokens tailwindcssStyles
@import "tailwindcss";
@import "@krizaka/tailwind";
@import "@krizaka/ui/tailwind.css";Importer
import { DescriptionList, KeyValueGrid } from "@krizaka/ui/description-list";Exemples
Details
A job's status, studio, start and credits.
- Status
- Running
- Studio
- Dubbing · English, Spanish
- Started
- Oct 11, 2026, 14:02by Elena Ruiz
- Credits
- 120estimated, charged at the end
Receipt
layout="inline": where a tip goes.
- Tip from @mina
- $10.00
- Payment fees
- −$0.50
- Platform
- −$1.00
- To you
- $8.50paid on Oct 15
Key figures
KeyValueGrid: an account's limits as cards that wrap.
- Requests / min
- 600
- Concurrent jobs
- 8
- Storage
- 50 GB18 GB used
- Retention
- 30 days
Props
DescriptionList
Term and value pairs — a job's details, a payout's breakdown — stacked, inline like a receipt, or as cards.
| Prop | Type | Défaut | Description |
|---|---|---|---|
itemsrequis | readonly DescriptionItem[] | — | The pairs, in reading order. |
layout | "grid" | "inline" | "stacked" | — | stacked (default: a details panel) · inline (term left, value right: a receipt, a summary) · grid (cards). |
KeyValueGrid
Key figures as a grid of cards that wraps with the width: a job's numbers, an account's limits.
| Prop | Type | Défaut | Description |
|---|---|---|---|
itemsrequis | readonly DescriptionItem[] | — | The pairs, in reading order. |
minWidth | number | 10 | The narrowest a card may be before the grid wraps, in rem. Default 10. |
Accessibilité
- A
dl: each term (dt) names its value (dd). - On React Native each pair is one element, read as “term, value”.
Bonnes pratiques
- Keep the terms short and the values formatted (
@krizaka/intl). - Inline for amounts that add up; grid for figures to scan.
Composants liés
Générée depuis le code de @krizaka/ui 3.9.0 : son meta.ts, ses exemples et ses types.Modifier cette documentation sur GitHub