Description List

Read-only grouped label/value metadata composition with no data-state ownership.

Identity

Category: Data display
Status: stable public Registry/export-map component family
Targets: iOS · Android · Web, subject to the compatibility contract
Prerequisites: @beemvp/beeui-ui installed (or this component’s source copied via the Registry CLI below) and, on Web, the BeeUI Tailwind/Uniwind theme CSS loaded — see Start for full platform setup.
Source: packages/ui/src/components/description-list.tsx

Import

import { DescriptionItem, DescriptionList } from '@beemvp/beeui-ui';

There is no documented deep/private source import. For source ownership from a BeeUI checkout:

pnpm beeui add description-list

Registry (used throughout this page) is BeeUI’s source-ownership manifest — registry/registry.json — that the pnpm beeui/@beemvp/beeui-cli CLI reads to copy a component’s real source into your app and rewrite its internal imports; it is not an npm package index. This component’s own Registry entry: registry/registry.json.

Composition and public API

Family exports: DescriptionItem DescriptionList
- Also routed here, outside the Registry family:
  - description-list
- Package export subpath: @beemvp/beeui-ui/description-list

Exported types: DescriptionItemProps, DescriptionListProps

The generated API inventory is mechanically joined to packages/ui/src/index.ts, Registry metadata, and the component reference contract. Each type’s field table below is parsed directly from that source, not a second hand-maintained copy; for the fuller behavior narrative see the canonical component behavior catalog.

State and behavior contract

Stateless read-only grouped label/value composition; it owns no data-state, loading, or formatting behavior — callers pass already-resolved values.

Props

`DescriptionItemProps`

DescriptionItemProps is exactly MetadataRowProps.

Prop	Type	Default	Description
`className`	`string`	—	Extra utility classes, merged after the component’s own via `cn(...)`, so they win on conflict. An escape hatch for source-owned and application work, not a cross-engine portability guarantee.
`description`	`React.ReactNode`	—	Secondary supporting text rendered beneath the primary label or title.
`label` (required)	`React.ReactNode`	—	The visible text naming this element, and the accessible name unless one is set explicitly.
`value` (required)	`React.ReactNode`	—	Rendered end-aligned opposite the label, in a column capped at 60% of the row’s width.

Also carries every prop of Omit<ViewProps, 'children'> — that upstream contract is not reproduced here.

`DescriptionListProps`

Prop	Type	Default	Description
`className`	`string`	—	Extra utility classes, merged after the component’s own via `cn(...)`, so they win on conflict. An escape hatch for source-owned and application work, not a cross-engine portability guarantee.

Also carries every prop of ViewProps — that upstream contract is not reproduced here.

The executable fixtures below are the source-grounded usage examples; consumers should not infer state ownership from DOM structure or another UI library.

Provider and dependencies

No additional provider is required by this family. BeeUIProvider remains the recommended application root.
Peer/native dependencies visible to this Registry item: react, react-native
Registry dependency closure: core-cn, metadata-row, theme
Safe-area ownership remains explicit: shell surfaces touching system edges opt into SafeArea; components do not silently invent app-shell insets.
Web consumers load the BeeUI semantic theme CSS as documented in Web onboarding.

Platform behavior

This family ships no platform-specific file, and its own source takes no Platform branch.

The same public family is exposed across the supported target matrix; meaningful platform differences remain governed by the compatibility contract.

Evidence classes are not equal and this page does not blur them: Web behavior is exercised in a real browser, while iOS and Android carry package/export and native-compile evidence, which is not device-runtime proof. The compatibility contract records which class each claim rests on.

Accessibility

Roles this family assigns: none set in description-list.tsx.
Accessibility states and properties it sets: none set in description-list.tsx.

Keyboard/focus behavior, announcements, Dynamic Type/Web zoom, RTL and reduced-motion expectations are not derived here — see Accessibility overview, Keyboard & focus, RTL/localization and Large text & zoom. BeeUI does not claim universal accessibility certification from automated tests.

Styling and theming

Style axes: none of its own — its appearance comes from tokens and your own classes; it also carries Omit<ViewProps, 'children'>, ViewProps.
Class-name surfaces: className.

Colors, spacing and typography come from semantic tokens rather than from values written here — see Theming and Density. A className is an escape hatch for source-owned and application work, not a cross-engine portability guarantee.

Executable examples

Primary executable fixture: apps/showcase/__tests__/accessibility-readonly.test.tsx
Additional fixture: apps/showcase/component-gallery/component-gallery.tsx
Additional fixture: apps/showcase/patterns/dashboard-finance/screens/invoice-detail-screen.tsx
Additional fixture: apps/showcase/patterns/dashboard-finance/screens/transaction-detail-screen.tsx

Addressable examples

Each link below opens the Showcase at that exact example, not at the top of the gallery:

basic — smallest meaningful complete usage
composition — the composition example

The Showcase links demonstrate Web behavior; use the native-preview guide for real simulator/emulator/device paths.

Live Web preview

This frame loads the real BeeUI Web Showcase on demand; it is not a second docs-only implementation. It proves browser behavior only. Use native preview for iOS/Android simulator, emulator or device paths.

Composition anatomy

Family root / primary export: DescriptionList
- Public composition parts / helpers:
  - DescriptionItem
- Exported type surface:
  - DescriptionItemProps
  - DescriptionListProps

The tree above is ordinary document structure so it remains readable with keyboard and assistive technology; it is derived from the real public export family rather than a canvas-only diagram.

Verified example source

These are the parts of the typechecked runtime Showcase fixture behind this live preview — apps/showcase/component-gallery/component-gallery.tsx, 1103 lines — where Description List is actually used: 9 lines in 1 place. Each block is copied verbatim from the line range named above it, so it is the same executable source, not a retelling of it. The rest of that file exercises other families and is not reproduced here.

Imports the examples below need (a filtered subset of the fixture’s own top-level imports):

import { DescriptionItem, DescriptionList } from '@beemvp/beeui-ui';
import * as React from 'react';
import { Uniwind } from 'uniwind';

lines 1048–1056:

                <DescriptionList>
                  <DescriptionItem label="Runtime" value="React Native 0.86.2" />
                  <DescriptionItem label="Styling" value="Uniwind 1.10.1" />
                  <DescriptionItem
                    description="Generated and compiled in CI"
                    label="Native verification"
                    value="Expo + bare RN"
                  />
                </DescriptionList>

Open the fixture itself for the full surrounding component. For a smaller app-specific example, start from the imports and fixture-state blocks above and keep only the state your screen owns.

Limitations

The list is a plain container with no description-list or list semantics — the label-to-value association is visual only. Each DescriptionItem is a metadata row, so its value column is capped at 60% of the row width and a long value wraps inside that cap rather than widening it.