logoAnt Design

⌘ K
  • 设计
  • 研发
  • 组件
  • 博客
  • 资源
  • 国内镜像
5.25.4
  • 组件总览
  • 通用
    • Button按钮
    • FloatButton悬浮按钮
      5.0.0
    • Icon图标
    • Typography排版
  • 布局
    • Divider分割线
    • Flex弹性布局
      5.10.0
    • Grid栅格
    • Layout布局
    • Space间距
    • Splitter分隔面板
      5.21.0
  • 导航
    • Anchor锚点
    • Breadcrumb面包屑
    • Dropdown下拉菜单
    • Menu导航菜单
    • Pagination分页
    • Steps步骤条
    • Tabs标签页
  • 数据录入
    • AutoComplete自动完成
    • Cascader级联选择
    • Checkbox多选框
    • ColorPicker颜色选择器
      5.5.0
    • DatePicker日期选择框
    • Form表单
    • Input输入框
    • InputNumber数字输入框
    • Mentions提及
    • Radio单选框
    • Rate评分
    • Select选择器
    • Slider滑动输入条
    • Switch开关
    • TimePicker时间选择框
    • Transfer穿梭框
    • TreeSelect树选择
    • Upload上传
  • 数据展示
    • Avatar头像
    • Badge徽标数
    • Calendar日历
    • Card卡片
    • Carousel走马灯
    • Collapse折叠面板
    • Descriptions描述列表
    • Empty空状态
    • Image图片
    • List列表
    • Popover气泡卡片
    • QRCode二维码
      5.1.0
    • Segmented分段控制器
    • Statistic统计数值
    • Table表格
    • Tag标签
    • Timeline时间轴
    • Tooltip文字提示
    • Tour漫游式引导
      5.0.0
    • Tree树形控件
  • 反馈
    • Alert警告提示
    • Drawer抽屉
    • Message全局提示
    • Modal对话框
    • Notification通知提醒框
    • Popconfirm气泡确认框
    • Progress进度条
    • Result结果
    • Skeleton骨架屏
    • Spin加载中
    • Watermark水印
      5.1.0
  • 其他
    • Affix固钉
    • App包裹组件
      5.1.0
    • ConfigProvider全局化配置
    • Util工具类
      5.13.0
何时使用
代码演示
基本
带边框的
自定义尺寸
响应式
垂直
垂直带边框的
整行
API
Descriptions
DescriptionItem
Semantic DOM
主题变量(Design Token)

Descriptions
描述列表

展示多个只读字段的组合。
使用import { Descriptions } from "antd";
源码components/descriptions
文档
编辑此页更新日志
文档贡献者
  • Collapse折叠面板Empty空状态

    相关资源

    Ant Design X
    Ant Design Charts
    Ant Design Pro
    Pro Components
    Ant Design Mobile
    Ant Design Mini
    Ant Design Web3
    Ant Design Landing-首页模板集
    Scaffolds-脚手架市场
    Umi-React 应用开发框架
    dumi-组件/文档研发工具
    qiankun-微前端框架
    Ant Motion-设计动效
    国内镜像站点 🇨🇳

    社区

    Awesome Ant Design
    Medium
    Twitter
    yuque logoAnt Design 语雀专栏
    Ant Design 知乎专栏
    体验科技专栏
    seeconf logoSEE Conf-蚂蚁体验科技大会
    加入我们

    帮助

    GitHub
    更新日志
    常见问题
    报告 Bug
    议题
    讨论区
    StackOverflow
    SegmentFault

    Ant XTech logo更多产品

    yuque logo语雀-构建你的数字花园
    AntV logoAntV-数据可视化解决方案
    Egg logoEgg-企业级 Node.js 框架
    Kitchen logoKitchen-Sketch 工具集
    Galacean logoGalacean-互动图形解决方案
    xtech logo蚂蚁体验科技
    主题编辑器
    Made with ❤ by
    蚂蚁集团和 Ant Design 开源社区

    何时使用

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

    tsx
    // >= 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>;

    代码演示

    User Info
    UserNameZhou Maomao
    Telephone1810000000
    LiveHangzhou, Zhejiang
    Remarkempty
    AddressNo. 18, Wantang Road, Xihu District, Hangzhou, Zhejiang, China
    基本

    简单的展示。

    CodeSandbox Icon
    codeblock
    codepen icon
    External Link Icon
    expand codeexpand code
    User Info
    ProductCloud DatabaseBilling ModePrepaidAutomatic RenewalYES
    Order time2018-04-24 18:00:00Usage Time2019-04-24 18:00:00
    StatusRunning
    Negotiated Amount$80.00Discount$20.00Official Receipts$60.00
    Config InfoData disk type: MongoDB
    Database version: 3.4
    Package: dds.mongo.mid
    Storage space: 10 GB
    Replication factor: 3
    Region: East China 1
    带边框的

    带边框和背景颜色列表。

    CodeSandbox Icon
    codeblock
    codepen icon
    External Link Icon
    expand codeexpand code


    Custom Size
    ProductCloud DatabaseBillingPrepaidTime18:00:00
    Amount$80.00Discount$20.00Official$60.00
    Config InfoData disk type: MongoDB
    Database version: 3.4
    Package: dds.mongo.mid
    Storage space: 10 GB
    Replication factor: 3
    Region: East China 1


    Custom Size
    ProductCloud Database
    BillingPrepaid
    Time18:00:00
    Amount$80.00
    Discount$20.00
    Official$60.00
    自定义尺寸

    自定义尺寸,适应在各种容器中展示。

    CodeSandbox Icon
    codeblock
    codepen icon
    External Link Icon
    expand codeexpand code
    Responsive Descriptions
    ProductCloud DatabaseBillingPrepaidTime18:00:00
    Amount$80.00Discount$20.00Official$60.00
    Config InfoData disk type: MongoDB
    Database version: 3.4
    Package: dds.mongo.mid
    Hardware InfoCPU: 6 Core 3.5 GHz
    Storage space: 10 GB
    Replication factor: 3
    Region: East China 1
    响应式

    通过响应式的配置可以实现在小屏幕设备上的完美呈现。

    CodeSandbox Icon
    codeblock
    codepen icon
    External Link Icon
    expand codeexpand code
    User Info
    UserName
    Telephone
    Live
    Zhou Maomao
    1810000000
    Hangzhou, Zhejiang
    Address
    Remark
    No. 18, Wantang Road, Xihu District, Hangzhou, Zhejiang, China
    empty
    垂直

    垂直的列表。

    CodeSandbox Icon
    codeblock
    codepen icon
    External Link Icon
    expand codeexpand code
    User Info
    ProductBilling ModeAutomatic Renewal
    Cloud DatabasePrepaidYES
    Order timeUsage Time
    2018-04-24 18:00:002019-04-24 18:00:00
    Status
    Running
    Negotiated AmountDiscountOfficial Receipts
    $80.00$20.00$60.00
    Config Info
    Data disk type: MongoDB
    Database version: 3.4
    Package: dds.mongo.mid
    Storage space: 10 GB
    Replication factor: 3
    Region: East China 1
    垂直带边框的

    垂直带边框和背景颜色的列表。

    CodeSandbox Icon
    codeblock
    codepen icon
    External Link Icon
    expand codeexpand code
    User Info
    UserNameZhou MaomaoLiveHangzhou, Zhejiang
    Remarkempty
    AddressNo. 18, Wantang Road, Xihu District, Hangzhou, Zhejiang, China
    整行

    整行的展示。

    CodeSandbox Icon
    codeblock
    codepen icon
    External Link Icon
    expand codeexpand code

    API

    通用属性参考:通用属性

    Descriptions

    参数说明类型默认值版本
    bordered是否展示边框booleanfalse
    colon配置 Descriptions.Item 的 colon 的默认值。表示是否显示 label 后面的冒号booleantrue
    column一行的 DescriptionItems 数量,可以写成像素值或支持响应式的对象写法 { xs: 8, sm: 16, md: 24}number | Record<Breakpoint, number>3
    contentStyle自定义内容样式,请使用 styles={{ content: {} }} 替换CSSProperties-4.10.0
    extra描述列表的操作区域,显示在右上方ReactNode-4.5.0
    items描述列表项内容DescriptionsItem[]-5.8.0
    labelStyle自定义标签样式,请使用 styles={{ label: {} }} 替换CSSProperties-4.10.0
    layout描述布局horizontal | verticalhorizontal
    size设置列表的大小。可以设置为 middle 、small, 或不填(只有设置 bordered={true} 生效)default | middle | small-
    title描述列表的标题,显示在最顶部ReactNode-
    classNames语义化结构 classRecord<SemanticDOM, string>-5.23.0
    styles语义化结构 styleRecord<SemanticDOM, CSSProperties>-5.23.0

    DescriptionItem

    参数说明类型默认值版本
    contentStyle自定义内容样式,请使用 styles={{ content: {} }} 替换CSSProperties-4.9.0
    label内容的描述ReactNode-
    labelStyle自定义标签样式,请使用 styles={{ label: {} }} 替换CSSProperties-4.9.0
    span包含列的数量(filled 铺满当前行剩余部分)number| filled | Screens1screens: 5.9.0,filled: 5.22.0

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

    Semantic DOM

    Toggle Border
    User Info
    Telephone1810000000
    • root
      5.23.0
      根元素
    • header
      5.23.0
      头部元素
    • title
      5.23.0
      标题元素
    • extra
      5.23.0
      额外内容
    • label
      5.23.0
      标签元素
    • content
      5.23.0
      内容元素

    主题变量(Design Token)

    组件 Token如何定制?
    Token 名称描述类型默认值
    colonMarginLeft冒号左间距number2
    colonMarginRight冒号右间距number8
    contentColor内容区域文字颜色stringrgba(0,0,0,0.88)
    extraColor额外区域文字颜色stringrgba(0,0,0,0.88)
    itemPaddingBottom子项下间距number16
    itemPaddingEnd子项结束间距number16
    labelBg标签背景色stringrgba(0,0,0,0.02)
    labelColor标签文字颜色stringrgba(0,0,0,0.45)
    titleColor标题文字颜色stringrgba(0,0,0,0.88)
    titleMarginBottom标题下间距number20
    全局 Token如何定制?