ant-design/components/descriptions/index.zh-CN.md
Zack Chang 4efa0b64db
feat: less to component token for Descriptions (#42038)
* feat: less to component token for List

* fix: title

* feat: add debug demo

* chore: rename

* Update index.tsx

---------

Co-authored-by: zhangjianxiong <zhangjx@tsintergy.com>
Co-authored-by: MadCcc <1075746765@qq.com>
2023-05-17 14:22:48 +08:00

2.6 KiB

category subtitle group title cover coverDark
Components 描述列表 数据展示 Descriptions https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*fHdlTpif6XQAAAAAAAAAAAAADrJ8AQ/original https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*d27AQJrowGAAAAAAAAAAAAAADrJ8AQ/original

成组展示多个只读字段。

何时使用

常见于详情页的信息展示。

代码演示

基本 带边框的 复杂文本的情况 自定义尺寸 响应式 垂直 垂直带边框的 自定义 label & wrapper 样式 组件 Token

API

Descriptions

参数 说明 类型 默认值 版本
bordered 是否展示边框 boolean false
colon 配置 Descriptions.Itemcolon 的默认值 boolean true
column 一行的 DescriptionItems 数量,可以写成像素值或支持响应式的对象写法 { xs: 8, sm: 16, md: 24} number 3
contentStyle 自定义内容样式 CSSProperties - 4.10.0
extra 描述列表的操作区域,显示在右上方 ReactNode - 4.5.0
labelStyle 自定义标签样式 CSSProperties - 4.10.0
layout 描述布局 horizontal | vertical horizontal
size 设置列表的大小。可以设置为 middlesmall, 或不填(只有设置 bordered={true} 生效) default | middle | small -
title 描述列表的标题,显示在最顶部 ReactNode -

DescriptionItem

参数 说明 类型 默认值 版本
contentStyle 自定义内容样式 CSSProperties - 4.9.0
label 内容的描述 ReactNode -
labelStyle 自定义标签样式 CSSProperties - 4.9.0
span 包含列的数量 number 1

span 是 Description.Item 的数量。 span={2} 会占用两个 DescriptionItem 的宽度。当同时配置 stylelabelStyle(或 contentStyle)时,两者会同时作用。样式冲突时,后者会覆盖前者。

Design Token