mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-15 08:59:15 +08:00
20561d6f9d
* docs: init ref * docs all support * docs: fix link show
94 lines
5.7 KiB
Markdown
94 lines
5.7 KiB
Markdown
---
|
||
category: Components
|
||
group: Layout
|
||
title: Grid
|
||
description: 24 Grids System.
|
||
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*mfJeS6cqZrEAAAAAAAAAAAAADrJ8AQ/original
|
||
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*DLUwQ4B2_zQAAAAAAAAAAAAADrJ8AQ/original
|
||
---
|
||
|
||
## Design concept
|
||
|
||
<div class="grid-demo">
|
||
<img src="https://gw.alipayobjects.com/zos/bmw-prod/9189c9ef-c601-40dc-9960-c11dbb681888.svg" alt="grid design" />
|
||
</div>
|
||
|
||
In most business situations, Ant Design needs to solve a lot of information storage problems within the design area, so based on 12 Grids System, we divided the design area into 24 sections.
|
||
|
||
We name the divided area 'box'. We suggest four boxes for horizontal arrangement at most, one at least. Boxes are proportional to the entire screen as shown in the picture above. To ensure a high level of visual comfort, we customize the typography inside of the box based on the box unit.
|
||
|
||
## Outline
|
||
|
||
In the grid system, we define the frame outside the information area based on `row` and `column`, to ensure that every area can have stable arrangement.
|
||
|
||
Following is a brief look at how it works:
|
||
|
||
- Establish a set of `column` in the horizontal space defined by `row` (abbreviated col).
|
||
- Your content elements should be placed directly in the `col`, and only `col` should be placed directly in `row`.
|
||
- The column grid system is a value of 1-24 to represent its range spans. For example, three columns of equal width can be created by `<Col span={8} />`.
|
||
- If the sum of `col` spans in a `row` are more than 24, then the overflowing `col` as a whole will start a new line arrangement.
|
||
|
||
Our grid systems base on Flex layout to allow the elements within the parent to be aligned horizontally - left, center, right, wide arrangement, and decentralized arrangement. The Grid system also supports vertical alignment - top aligned, vertically centered, bottom-aligned. You can also define the order of elements by using `order`.
|
||
|
||
Layout uses a 24 grid layout to define the width of each "box", but does not rigidly adhere to the grid layout.
|
||
|
||
## Examples
|
||
|
||
<!-- prettier-ignore -->
|
||
<code src="./demo/basic.tsx">Basic Grid</code>
|
||
<code src="./demo/gutter.tsx">Grid Gutter</code>
|
||
<code src="./demo/offset.tsx">Column offset</code>
|
||
<code src="./demo/sort.tsx">Grid sort</code>
|
||
<code src="./demo/flex.tsx">Typesetting</code>
|
||
<code src="./demo/flex-align.tsx">Alignment</code>
|
||
<code src="./demo/flex-order.tsx">Order</code>
|
||
<code src="./demo/flex-stretch.tsx">Flex Stretch</code>
|
||
<code src="./demo/responsive.tsx">Responsive</code>
|
||
<code src="./demo/responsive-flex.tsx" version="5.14.0">Flex Responsive</code>
|
||
<code src="./demo/responsive-more.tsx">More responsive</code>
|
||
<code src="./demo/playground.tsx">Playground</code>
|
||
<code src="./demo/useBreakpoint.tsx">useBreakpoint Hook</code>
|
||
|
||
## API
|
||
|
||
Common props ref:[Common props](/docs/react/common-props)
|
||
|
||
If the Ant Design grid layout component does not meet your needs, you can use the excellent layout components of the community:
|
||
|
||
- [react-flexbox-grid](http://roylee0704.github.io/react-flexbox-grid/)
|
||
- [react-blocks](https://github.com/whoisandy/react-blocks/)
|
||
|
||
### Row
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| --- | --- | --- | --- | --- |
|
||
| align | Vertical alignment | `top` \| `middle` \| `bottom` \| `stretch` \| `{[key in 'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl' \| 'xxl']: 'top' \| 'middle' \| 'bottom' \| 'stretch'}` | `top` | object: 4.24.0 |
|
||
| gutter | Spacing between grids, could be a number or a object like { xs: 8, sm: 16, md: 24}. Or you can use array to make horizontal and vertical spacing work at the same time `[horizontal, vertical]` | number \| object \| array | 0 | |
|
||
| justify | Horizontal arrangement | `start` \| `end` \| `center` \| `space-around` \| `space-between` \| `space-evenly` \| `{[key in 'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl' \| 'xxl']: 'start' \| 'end' \| 'center' \| 'space-around' \| 'space-between' \| 'space-evenly'}` | `start` | object: 4.24.0 |
|
||
| wrap | Auto wrap line | boolean | true | 4.8.0 |
|
||
|
||
### Col
|
||
|
||
| Property | Description | Type | Default | Version |
|
||
| --- | --- | --- | --- | --- |
|
||
| flex | Flex layout style | string \| number | - | |
|
||
| offset | The number of cells to offset Col from the left | number | 0 | |
|
||
| order | Raster order | number | 0 | |
|
||
| pull | The number of cells that raster is moved to the left | number | 0 | |
|
||
| push | The number of cells that raster is moved to the right | number | 0 | |
|
||
| span | Raster number of cells to occupy, 0 corresponds to `display: none` | number | none | |
|
||
| xs | `screen < 576px` and also default setting, could be a `span` value or an object containing above props | number \| object | - | |
|
||
| sm | `screen ≥ 576px`, could be a `span` value or an object containing above props | number \| object | - | |
|
||
| md | `screen ≥ 768px`, could be a `span` value or an object containing above props | number \| object | - | |
|
||
| lg | `screen ≥ 992px`, could be a `span` value or an object containing above props | number \| object | - | |
|
||
| xl | `screen ≥ 1200px`, could be a `span` value or an object containing above props | number \| object | - | |
|
||
| xxl | `screen ≥ 1600px`, could be a `span` value or an object containing above props | number \| object | - | |
|
||
|
||
You can modify the breakpoints values using by modifying `screen[XS|SM|MD|LG|XL|XXL]` with [theme customization](/docs/react/customize-theme) (since 5.1.0, [sandbox demo](https://codesandbox.io/s/antd-reproduction-template-forked-dlq3r9?file=/index.js)).
|
||
|
||
The breakpoints of responsive grid follow [BootStrap 4 media queries rules](https://getbootstrap.com/docs/4.0/layout/overview/#responsive-breakpoints) (not including `occasionally part`).
|
||
|
||
## Design Token
|
||
|
||
<ComponentTokenTable component="Grid"></ComponentTokenTable>
|