mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-04 00:49:39 +08:00
40e77c40d3
* docs: add dark overview * docs: show dark cover in dark theme * docs: update cover
41 lines
1.5 KiB
Markdown
41 lines
1.5 KiB
Markdown
---
|
|
category: Components
|
|
title: Divider
|
|
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*7sMiTbzvaDoAAAAAAAAAAAAADrJ8AQ/original
|
|
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*KPSEQ74PLg4AAAAAAAAAAAAADrJ8AQ/original
|
|
demo:
|
|
cols: 2
|
|
group:
|
|
title: Layout
|
|
order: 2
|
|
---
|
|
|
|
A divider line separates different content.
|
|
|
|
## When To Use
|
|
|
|
- Divide sections of article.
|
|
- Divide inline text and links such as the operation column of table.
|
|
|
|
## Examples
|
|
|
|
<!-- prettier-ignore -->
|
|
<code src="./demo/horizontal.tsx">Horizontal</code>
|
|
<code src="./demo/with-text.tsx">Divider with title</code>
|
|
<code src="./demo/plain.tsx">Text without heading style</code>
|
|
<code src="./demo/vertical.tsx">Vertical</code>
|
|
<code src="./demo/customize-style.tsx" debug>Style Customization</code>
|
|
|
|
## API
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
| --- | --- | --- | --- | --- |
|
|
| children | The wrapped title | ReactNode | - | |
|
|
| className | The className of container | string | - | |
|
|
| dashed | Whether line is dashed | boolean | false | |
|
|
| orientation | The position of title inside divider | `left` \| `right` \| `center` | `center` | |
|
|
| orientationMargin | The margin-left/right between the title and its closest border, while the `orientation` must be `left` or `right` | string \| number | - | |
|
|
| plain | Divider text show as plain style | boolean | true | 4.2.0 |
|
|
| style | The style object of container | CSSProperties | - | |
|
|
| type | The direction type of divider | `horizontal` \| `vertical` | `horizontal` | |
|