Skip to main content

Descriptions

Layout

Descriptions — a responsive definition list of label↔value pairs.

import { Descriptions } from "@elabs-ai/components-ui";
Install
npm install @elabs-ai/components-tokens @elabs-ai/components-ui

Skipping the @source line is the most common first failure: Tailwind does not scan node_modules, so every component renders unstyled. The one-time wiring

Prompt for your coding agent

Paste it into Claude Code, Cursor, Codex or any other coding agent. Text in [brackets] is yours to fill in.

Add the brand-ui Descriptions component (from @elabs-ai/components-ui) to this project.

1. Read https://elabs-ai.com/llms.txt first: it maps every package and the rules. If you can use MCP servers, connect https://elabs-ai.com/mcp and use its search, docs and tokens tools. If not, run the same lookups in the terminal: `npx -y @elabs-ai/components-cli search "<what you need>"` and `npx -y @elabs-ai/components-cli docs <Component>`.
2. Look Descriptions up before writing code: `npx -y @elabs-ai/components-cli docs Descriptions` prints its real props, variants, what it pairs with and what to avoid.
3. If @elabs-ai/components-ui is not installed yet: `pnpm add @elabs-ai/components-tokens @elabs-ai/components-ui` (or `npm install @elabs-ai/components-tokens @elabs-ai/components-ui`). If this is the first brand-ui package in the project, wire it once: import `@elabs-ai/components-tokens/styles.css` plus the `themes/light.css` and `themes/dark.css` stylesheets in the CSS entry, add one Tailwind `@source` line per installed @elabs-ai package (Tailwind does not scan node_modules, so without it everything renders unstyled), and wrap the app root in `ThemeProvider` from `@elabs-ai/components-tokens`.
4. Use it here: [the screen or file, and what it should show]
5. Rules: use only @elabs-ai/components-* components and the semantic tokens — no raw colours, no raw font sizes, no arbitrary Tailwind values. Look up each component's real props with the docs tool before you use it; never guess a prop.
6. Done means: the typecheck passes, `npx -y @elabs-ai/components-cli audit src --strict` reports nothing, and you have opened the app and looked at every screen you touched in the light and the dark theme.

Examples

4 live examples

Narrow Labels

Short labels beside sentence-long values earn a narrower label column.

Two Columns

Vertical Three Columns

API

Descriptions

PropTypeDescription
columns1 | 2 | 3Number of columns at the widest breakpoint. Collapses to a single column on small screens. Default 1.
layoutDescriptionsLayout`horizontal` places the label beside the value; `vertical` stacks the label above the value. Default `horizontal`.
labelWidthDescriptionsLabelWidthWidth of the label column in the `horizontal` layout, as a share of the item. Default `"1/3"`. Ignored by `vertical`.

Also accepts: HTMLAttributes<HTMLDListElement>, VariantProps<typeof descriptionsVariants>

DescriptionsItem

PropTypeDescription
labelrequiredReact.ReactNodeThe term / label for this entry.
numericbooleanWhen the value is numeric, set this so the value uses `tabular-nums` for aligned digits.

Also accepts: HTMLAttributes<HTMLDivElement>