2020-03-22 11:38:02 +08:00
|
|
|
|
---
|
|
|
|
|
category: Components
|
2022-11-09 12:28:04 +08:00
|
|
|
|
group: Layout
|
2020-03-22 11:38:02 +08:00
|
|
|
|
title: Space
|
2022-11-30 20:14:41 +08:00
|
|
|
|
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*ZiJ3SbOH9SUAAAAAAAAAAAAADrJ8AQ/original
|
2023-02-09 22:17:31 +08:00
|
|
|
|
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*37T2R6O9oi0AAAAAAAAAAAAADrJ8AQ/original
|
2020-03-22 11:38:02 +08:00
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
Set components spacing.
|
|
|
|
|
|
|
|
|
|
## When To Use
|
|
|
|
|
|
2022-10-18 16:23:10 +08:00
|
|
|
|
- Avoid components clinging together and set a unified space.
|
2022-11-27 01:58:55 +08:00
|
|
|
|
- Use Space.Compact when child form components are compactly connected and the border is collapsed (After version `antd@4.24.0` Supported).
|
2020-03-22 11:38:02 +08:00
|
|
|
|
|
2022-11-09 12:28:04 +08:00
|
|
|
|
## Examples
|
|
|
|
|
|
2022-11-17 17:31:26 +08:00
|
|
|
|
<!-- prettier-ignore -->
|
2022-11-09 12:28:04 +08:00
|
|
|
|
<code src="./demo/base.tsx">Basic Usage</code>
|
|
|
|
|
<code src="./demo/vertical.tsx">Vertical Space</code>
|
|
|
|
|
<code src="./demo/size.tsx">Space Size</code>
|
|
|
|
|
<code src="./demo/align.tsx">Align</code>
|
|
|
|
|
<code src="./demo/wrap.tsx">Wrap</code>
|
|
|
|
|
<code src="./demo/split.tsx">Split</code>
|
|
|
|
|
<code src="./demo/compact.tsx">Compact Mode for form component</code>
|
|
|
|
|
<code src="./demo/compact-buttons.tsx">Button Compact Mode</code>
|
|
|
|
|
<code src="./demo/compact-button-vertical.tsx">Vertical Compact Mode</code>
|
|
|
|
|
<code src="./demo/compact-debug.tsx" debug>Input addon debug</code>
|
|
|
|
|
<code src="./demo/compact-nested.tsx" debug>Nested Space Compact</code>
|
|
|
|
|
<code src="./demo/debug.tsx" debug>Diverse Child</code>
|
|
|
|
|
<code src="./demo/gap-in-line.tsx" debug>Flex gap style</code>
|
|
|
|
|
|
2020-03-22 11:38:02 +08:00
|
|
|
|
## API
|
|
|
|
|
|
2023-08-08 18:27:48 +08:00
|
|
|
|
Common props ref:[Common props](/docs/react/common-props)
|
|
|
|
|
|
2022-11-17 17:31:26 +08:00
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
|
|
|
| --- | --- | --- | --- | --- |
|
|
|
|
|
| align | Align items | `start` \| `end` \|`center` \|`baseline` | - | 4.2.0 |
|
|
|
|
|
| direction | The space direction | `vertical` \| `horizontal` | `horizontal` | 4.1.0 |
|
2022-12-22 14:12:26 +08:00
|
|
|
|
| size | The space size | [Size](#size) \| [Size\[\]](#size) | `small` | 4.1.0 \| Array: 4.9.0 |
|
2022-11-17 17:31:26 +08:00
|
|
|
|
| split | Set split | ReactNode | - | 4.7.0 |
|
|
|
|
|
| wrap | Auto wrap line, when `horizontal` effective | boolean | false | 4.9.0 |
|
2020-11-27 13:40:40 +08:00
|
|
|
|
|
|
|
|
|
### Size
|
|
|
|
|
|
|
|
|
|
`'small' | 'middle' | 'large' | number`
|
2022-10-18 16:23:10 +08:00
|
|
|
|
|
|
|
|
|
### Space.Compact
|
|
|
|
|
|
|
|
|
|
Use Space.Compact when child form components are compactly connected and the border is collapsed. The supported components are:
|
|
|
|
|
|
|
|
|
|
- Button
|
|
|
|
|
- AutoComplete
|
|
|
|
|
- Cascader
|
|
|
|
|
- DatePicker
|
|
|
|
|
- Input/Input.Search
|
|
|
|
|
- Select
|
|
|
|
|
- TimePicker
|
|
|
|
|
- TreeSelect
|
|
|
|
|
|
2022-11-17 17:31:26 +08:00
|
|
|
|
| Property | Description | Type | Default | Version |
|
|
|
|
|
| --- | --- | --- | --- | --- |
|
|
|
|
|
| block | Option to fit width to its parent\'s width | boolean | false | 4.24.0 |
|
|
|
|
|
| direction | Set direction of layout | `vertical` \| `horizontal` | `horizontal` | 4.24.0 |
|
|
|
|
|
| size | Set child component size | `large` \| `middle` \| `small` | `middle` | 4.24.0 |
|
2023-04-11 10:25:24 +08:00
|
|
|
|
|
2023-05-31 13:43:38 +08:00
|
|
|
|
### `styles` and `classNames` attribute
|
|
|
|
|
|
|
|
|
|
<!-- prettier-ignore -->
|
|
|
|
|
| Property | Description | Version |
|
|
|
|
|
| -------- | ------------------------- | ------- |
|
|
|
|
|
| item | set `Space` child element | 5.6.0 |
|
|
|
|
|
|
2023-04-11 10:25:24 +08:00
|
|
|
|
## Design Token
|
|
|
|
|
|
|
|
|
|
<ComponentTokenTable component="Space"></ComponentTokenTable>
|