DescriptionList

Usage

import { DescriptionList } from "@devvy-ui/react";

<DescriptionList items={[{term:"Workspace",description:"Orbit"},{term:"Plan",description:"Team"},{term:"Region",description:"Asia Pacific"}]} />

API reference

Native HTML attributes, className, style and a forwarded ref are supported. Component-specific props:

Prop	Type	Default	Description
items	readonly DescriptionItem[]	required	term and description for each row.
orientation	horizontal \| vertical	horizontal	Column layout; narrow screens stack automatically.

Source ownership

Run npx @devvy-ui/cli init once in your React project, then add the source:

npx @devvy-ui/cli add description-list

Make the source yours.

Start from the canonical implementation used by the package and registry. Change the code, keep the MIT notice, and build the behavior your project needs.

DescriptionList.tsxREACT / TSX

import { forwardRef, type HTMLAttributes, type ReactNode } from 'react';
import { cx } from '../lib/cx';
export interface DescriptionItem {
  id?: string;
  term: ReactNode;
  description: ReactNode;
}
export interface DescriptionListProps extends Omit<HTMLAttributes<HTMLDListElement>, 'children'> {
  items: readonly DescriptionItem[];
  orientation?: 'horizontal' | 'vertical';
}
export const DescriptionList = forwardRef<HTMLDListElement, DescriptionListProps>(
  function DescriptionList({ items, orientation = 'horizontal', className, ...props }, ref) {
    return (
      <dl
        {...props}
        ref={ref}
        className={cx('dvy-description-list', className)}
        data-orientation={orientation}
      >
        {items.map((item, index) => (
          <div key={item.id ?? index}>
            <dt>{item.term}</dt>
            <dd>{item.description}</dd>
          </div>
        ))}
      </dl>
    );
  },
);

Edit your own copy. Downloaded source uses your changes; the component preview above uses the shipped version. Run the source installer first to include shared helpers.

Interactive preview

Usage

API reference

Accessibility & behavior

Platform Behavior & Guidelines

Source ownership

Make the source yours.