Descriptions 描述列表

数据展示

以键值对形式展示多个字段的只读详情,常见于详情页。

何时使用

需要描述列表功能时使用本组件。

代码示例

基础用法

tsx

import { Descriptions } from "@/components/ui/descriptions"

export function Basic() {
return <Descriptions>Default</Descriptions>
}

尺寸

tsx

{/* 尺寸对照 */}
<div className="flex flex-wrap items-center gap-3">
<Descriptions size="sm">Sm</Descriptions>
<Descriptions size="default">Default</Descriptions>
<Descriptions size="lg">Lg</Descriptions>
</div>

样式变体

layout

layout	说明	默认
`horizontal`		✓
`vertical`

尺寸

Size	说明	默认
`default`	默认尺寸	✓
`sm`	小号
`lg`	大号

bordered

bordered	说明	默认
`true`		✓
`false`

API / Props

Descriptions

Prop	Type	Default	说明
`className`	`string`	—	自定义样式类名
`items`	`DescriptionItem[]`	—	选项/数据项列表
`column`	`number`	`3`	Column count
`labelWidth`	`string \| number`	—	Label width
...rest	`React.ComponentProps<"div">`	—	透传 `<div>` 原生属性

注意事项

CVA 变体: 通过 class-variance-authority 管理样式变体,类型安全。变体对象可导出复用。
原生属性: 继承所有 <div> 原生 HTML 属性。

📘 完整交互式示例与控件属性请查看 Storybook 文档。