mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-05 13:37:52 +08:00
b7208603ee
Signed-off-by: afc163 <afc163@gmail.com> Co-authored-by: afc163 <afc163@gmail.com>
4.0 KiB
4.0 KiB
category | group | title | subtitle | description | 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 |
何时使用
常见于详情页的信息展示。
// >= 5.8.0 可用,推荐的写法 ✅
const items: DescriptionsProps['items'] = [
{
key: '1',
label: 'UserName',
children: <p>Zhou Maomao</p>,
},
{
key: '2',
label: 'Telephone',
children: <p>1810000000</p>,
},
{
key: '3',
label: 'Live',
children: <p>Hangzhou, Zhejiang</p>,
},
{
key: '4',
label: 'Remark',
children: <p>empty</p>,
},
{
key: '5',
label: 'Address',
children: <p>No. 18, Wantang Road, Xihu District, Hangzhou, Zhejiang, China</p>,
},
];
<Descriptions title="User Info" items={items} />;
// <5.8.0 可用,>=5.8.0 时不推荐 🙅🏻♀️
<Descriptions title="User Info">
<Descriptions.Item label="UserName">Zhou Maomao</Descriptions.Item>
<Descriptions.Item label="Telephone">1810000000</Descriptions.Item>
<Descriptions.Item label="Live">Hangzhou, Zhejiang</Descriptions.Item>
<Descriptions.Item label="Remark">empty</Descriptions.Item>
<Descriptions.Item label="Address">
No. 18, Wantang Road, Xihu District, Hangzhou, Zhejiang, China
</Descriptions.Item>
</Descriptions>;
代码演示
基本
带边框的
复杂文本的情况
自定义尺寸
响应式
垂直
垂直带边框的
自定义 label & wrapper 样式
JSX demo
组件 Token
API
通用属性参考:通用属性
Descriptions
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
bordered | 是否展示边框 | boolean | false | |
colon | 配置 Descriptions.Item 的 colon 的默认值 |
boolean | true | |
column | 一行的 DescriptionItems 数量,可以写成像素值或支持响应式的对象写法 { xs: 8, sm: 16, md: 24} |
number | Record<Breakpoint, number> | 3 | |
contentStyle | 自定义内容样式 | CSSProperties | - | 4.10.0 |
extra | 描述列表的操作区域,显示在右上方 | ReactNode | - | 4.5.0 |
items | 描述列表项内容 | DescriptionsItem[] | - | 5.8.0 |
labelStyle | 自定义标签样式 | CSSProperties | - | 4.10.0 |
layout | 描述布局 | horizontal | vertical |
horizontal |
|
size | 设置列表的大小。可以设置为 middle 、small , 或不填(只有设置 bordered={true} 生效) |
default | middle | small |
- | |
title | 描述列表的标题,显示在最顶部 | ReactNode | - |
DescriptionItem
参数 | 说明 | 类型 | 默认值 | 版本 |
---|---|---|---|---|
contentStyle | 自定义内容样式 | CSSProperties | - | 4.9.0 |
label | 内容的描述 | ReactNode | - | |
labelStyle | 自定义标签样式 | CSSProperties | - | 4.9.0 |
span | 包含列的数量 | number | Screens | 1 | screens: 5.9.0 |
span 是 Description.Item 的数量。 span={2} 会占用两个 DescriptionItem 的宽度。当同时配置
style
和labelStyle
(或contentStyle
)时,两者会同时作用。样式冲突时,后者会覆盖前者。