logoAnt Design

⌘ K
  • Design
  • Development
  • Components
  • Blog
  • Resources
5.25.0
  • Components Overview
  • General
    • Button
    • FloatButton
      5.0.0
    • Icon
    • Typography
  • Layout
    • Divider
    • Flex
      5.10.0
    • Grid
    • Layout
    • Space
    • Splitter
      5.21.0
  • Navigation
    • Anchor
    • Breadcrumb
    • Dropdown
    • Menu
    • Pagination
    • Steps
    • Tabs
  • Data Entry
    • AutoComplete
    • Cascader
    • Checkbox
    • ColorPicker
      5.5.0
    • DatePicker
    • Form
    • Input
    • InputNumber
    • Mentions
    • Radio
    • Rate
    • Select
    • Slider
    • Switch
    • TimePicker
    • Transfer
    • TreeSelect
    • Upload
  • Data Display
    • 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
  • Feedback
    • Alert
    • Drawer
    • Message
    • Modal
    • Notification
    • Popconfirm
    • Progress
    • Result
    • Skeleton
    • Spin
    • Watermark
      5.1.0
  • Other
    • Affix
    • App
      5.1.0
    • ConfigProvider
    • Util
      5.13.0

Descriptions

Display multiple read-only fields in a group.
Importimport { Descriptions } from "antd";
Sourcecomponents/descriptions
Docs
Edit this pageChangelog

Resources

Ant Design X
Ant Design Charts
Ant Design Pro
Pro Components
Ant Design Mobile
Ant Design Mini
Ant Design Web3
Ant Design Landing-Landing Templates
Scaffolds-Scaffold Market
Umi-React Application Framework
dumi-Component doc generator
qiankun-Micro-Frontends Framework
Ant Motion-Motion Solution
China Mirror 🇨🇳

Community

Awesome Ant Design
Medium
Twitter
yuque logoAnt Design in YuQue
Ant Design in Zhihu
Experience Cloud Blog
seeconf logoSEE Conf-Experience Tech Conference

Help

GitHub
Change Log
FAQ
Bug Report
Issues
Discussions
StackOverflow
SegmentFault

Ant XTech logoMore Products

yuque logoYuQue-Document Collaboration Platform
AntV logoAntV-Data Visualization
Egg logoEgg-Enterprise Node.js Framework
Kitchen logoKitchen-Sketch Toolkit
Galacean logoGalacean-Interactive Graphics Solution
xtech logoAnt Financial Experience Tech
Theme Editor
Made with ❤ by
Ant Group and Ant Design Community
loading

When To Use

Commonly displayed on the details page.

tsx
// works when >= 5.8.0, recommended ✅
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} />;
// works when <5.8.0 , deprecated when >=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>;

Examples

API

Common props ref:Common props

Descriptions

PropertyDescriptionTypeDefaultVersion
borderedWhether to display the borderbooleanfalse
colonChange default props colon value of Descriptions.Item. Indicates whether the colon after the label is displayedbooleantrue
columnThe number of DescriptionItems in a row, could be an object (like { xs: 8, sm: 16, md: 24}, but must have bordered={true}) or a numbernumber | Record<Breakpoint, number>3
contentStyleCustomize content style, Please use styles={{ content: {} }} insteadCSSProperties-4.10.0
extraThe action area of the description list, placed at the top-rightReactNode-4.5.0
itemsDescribe the contents of the list itemDescriptionsItem[]-5.8.0
labelStyleCustomize label styleCSSProperties, Please use styles={{ label: {} }} instead-4.10.0
layoutDefine description layouthorizontal | verticalhorizontal
sizeSet the size of the list. Can be set to middle,small, or not filleddefault | middle | small-
titleThe title of the description list, placed at the topReactNode-
classNamesSemantic DOM classRecord<SemanticDOM, string>-5.23.0
stylesSemantic DOM styleRecord<SemanticDOM, CSSProperties>-5.23.0

DescriptionItem

PropertyDescriptionTypeDefaultVersion
contentStyleCustomize content style, Please use styles={{ content: {} }} insteadCSSProperties-4.9.0
labelThe description of the contentReactNode-
labelStyleCustomize label style, Please use styles={{ label: {} }} insteadCSSProperties-4.9.0
spanThe number of columns included(filled Fill the remaining part of the current row)number | filled | Screens1screens: 5.9.0, filled: 5.22.0

The number of span Description.Item. Span={2} takes up the width of two DescriptionItems. When both style and labelStyle(or contentStyle) configured, both of them will work. And next one will overwrite first when conflict.

Semantic DOM

Design Token

Component TokenHow to use?
Token NameDescriptionTypeDefault Value
colonMarginLeftLeft margin of colonnumber2
colonMarginRightRight margin of colonnumber8
contentColorText color of contentstringrgba(0,0,0,0.88)
extraColorText color of extra areastringrgba(0,0,0,0.88)
itemPaddingBottomBottom padding of itemnumber16
itemPaddingEndEnd padding of itemnumber16
labelBgBackground color of labelstringrgba(0,0,0,0.02)
labelColorText color of labelstringrgba(0,0,0,0.45)
titleColorText color of titlestringrgba(0,0,0,0.88)
titleMarginBottomBottom margin of titlenumber20
Global TokenHow to use?
Basic

Simplest Usage.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
border

Descriptions with border and background color.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
Custom size

Custom sizes to fit in a variety of containers.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
responsive

Responsive configuration enables perfect presentation on small screen devices.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
Vertical

Simplest Usage.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
Vertical border

Descriptions with border and background color.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
row

Display of the entire line.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
User Info
UserNameZhou Maomao
Telephone1810000000
LiveHangzhou, Zhejiang
Remarkempty
AddressNo. 18, Wantang Road, Xihu District, Hangzhou, Zhejiang, China
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


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
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
User Info
UserName
Telephone
Live
Zhou Maomao
1810000000
Hangzhou, Zhejiang
Address
Remark
No. 18, Wantang Road, Xihu District, Hangzhou, Zhejiang, China
empty
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
User Info
UserNameZhou MaomaoLiveHangzhou, Zhejiang
Remarkempty
AddressNo. 18, Wantang Road, Xihu District, Hangzhou, Zhejiang, China
Toggle Border
User Info
Telephone1810000000
  • root
    5.23.0
    root element
  • header
    5.23.0
    header element
  • title
    5.23.0
    title element
  • extra
    5.23.0
    extra element
  • label
    5.23.0
    label element
  • content
    5.23.0
    content element