mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-16 09:39:10 +08:00
36bcaaef85
* chore: use varaible.less * chore: basic primary varaible * chore: Move to variable * chore: align active color * chore: global fix of css variable * chore: primary colors * chore: button danger * chore: btn default error color * chore: button series * chore: More examples * chore: More components * chore: Form demo * chore: form style * fix: Tag & Alert variable * chore: update footer * chore: rm tmp code * chore: transfer * fix: picker column active color * chore: Adjust active bg color * chore: table hover color * chore: all css variables * chore: Global using variables * chore: Test case * chore: Update test logic * chore: back of default less * chore: entry of site use proxy style * chore: update entry * chore: split of variables * refactor: quick dist speed * fix: site use variable version * chore: Update less config * chore: add mv script * chore: Update repalcement script * chore: Add inject variables * chore: Update script * fix: script path * chore: Move to component instead * chore: fix condition * chore: update config * chore: Update in less transform * chore: Modify logic * chore: change to variables * chore: Update name * fix: script name * chore: do inject * revert: back of path * chore: 2 way of generate * bump tools * chore: Add auto replacement script * chore: auto genrate less file * chore: fix test * test: More test case * chore: Update limit config * test: coverage * docs: Update doc
41 lines
2.0 KiB
Markdown
41 lines
2.0 KiB
Markdown
---
|
|
category: Components
|
|
type: Data Display
|
|
title: Descriptions
|
|
cols: 1
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/MjtG9_FOI/Descriptions.svg
|
|
---
|
|
|
|
Display multiple read-only fields in groups.
|
|
|
|
## When To Use
|
|
|
|
Commonly displayed on the details page.
|
|
|
|
## API
|
|
|
|
### Descriptions
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| bordered | Whether to display the border | boolean | false | |
|
|
| colon | Change default props `colon` value of Descriptions.Item | boolean | true | |
|
|
| column | The number of `DescriptionItems` in a row,could be a number or a object like `{ xs: 8, sm: 16, md: 24}`,(Only set `bordered={true}` to take effect) | number | 3 | |
|
|
| contentStyle | Customize content style | CSSProperties | - | 4.10.0 |
|
|
| extra | The action area of the description list, placed at the top-right | ReactNode | - | 4.5.0 |
|
|
| labelStyle | Customize label style | CSSProperties | - | 4.10.0 |
|
|
| layout | Define description layout | `horizontal` \| `vertical` | `horizontal` | |
|
|
| size | Set the size of the list. Can be set to `middle`,`small`, or not filled | `default` \| `middle` \| `small` | - | |
|
|
| title | The title of the description list, placed at the top | ReactNode | - | |
|
|
|
|
### DescriptionItem
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
| ------------ | ------------------------------ | ------------- | ------- | ------- |
|
|
| contentStyle | Customize content style | CSSProperties | - | 4.9.0 |
|
|
| label | The description of the content | ReactNode | - | |
|
|
| labelStyle | Customize label style | CSSProperties | - | 4.9.0 |
|
|
| span | The number of columns included | number | 1 | |
|
|
|
|
> 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.
|