JGuang

栅格

Grid · Ant Design

交互预览
npm install antd@6.6.5 @ant-design/icons@6.3.4 dayjs@1.11.23

栅格

24 栅格系统。

设计理念

<div class="grid-demo"> <img draggable="false" src="https://gw.alipayobjects.com/zos/bmw-prod/9189c9ef-c601-40dc-9960-c11dbb681888.svg" alt="grid design" /> </div>

在多数业务情况下,Ant Design 需要在设计区域内解决大量信息收纳的问题,因此在 12 栅格系统的基础上,我们将整个设计建议区域按照 24 等分的原则进行划分。

划分之后的信息区块我们称之为『盒子』。建议横向排列的盒子数量最多四个,最少一个。『盒子』在整个屏幕上占比见上图。设计部分基于盒子的单位定制盒子内部的排版规则,以保证视觉层面的舒适感。

概述

布局的栅格化系统,我们是基于行(row)和列(col)来定义信息区块的外部框架,以保证页面的每个区域能够稳健地排布起来。下面简单介绍一下它的工作原理:

  • 通过 row 在水平方向建立一组 column(简写 col)。
  • 你的内容应当放置于 col 内,并且,只有 col 可以作为 row 的直接元素。
  • 栅格系统中的列是指 1 到 24 的值来表示其跨越的范围。例如,三个等宽的列可以使用 <Col span={8} /> 来创建。
  • 如果一个 row 中的 col 总和超过 24,那么多余的 col 会作为一个整体另起一行排列。

我们的栅格化系统基于 Flex 布局,允许子元素在父节点内的水平对齐方式 - 居左、居中、居右、等宽排列、分散排列。子元素与子元素之间,支持顶部对齐、垂直居中对齐、底部对齐的方式。同时,支持使用 order 来定义元素的排列顺序。

布局是基于 24 栅格来定义每一个『盒子』的宽度,但不拘泥于栅格。

代码演示

  • 基础栅格 · basic
  • 区块间隔 · gutter
  • 左右偏移 · offset
  • 栅格排序 · sort
  • 排版 · flex
  • 对齐 · flex-align
  • 排序 · flex-order
  • Flex 填充 · flex-stretch
  • 响应式布局 · responsive
  • Flex 响应式布局 · responsive-flex
  • 其他属性的响应式 · responsive-more
  • 栅格配置器 · playground
  • useBreakpoint Hook · useBreakpoint

API

通用属性参考:通用属性

Ant Design 的布局组件若不能满足你的需求,你也可以直接使用社区的优秀布局组件:

Row

参数说明类型默认值版本全局配置
align垂直对齐方式top | middle | bottom | stretch | {[key in 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xxxl']: 'top' | 'middle' | 'bottom' | 'stretch'}topobject: 4.24.0×
gutter栅格间隔,可以写成字符串CSS单位或支持响应式的对象写法来设置水平间隔 { xs: 8, sm: 16, md: 24}。或者使用数组形式同时设置 [水平间距, 垂直间距]number | string | object | array0string: 5.28.0×
justify水平排列方式start | end | center | space-around | space-between | space-evenly | {[key in 'xs' | 'sm' | 'md' | 'lg' | 'xl' | 'xxl' | 'xxxl']: 'start' | 'end' | 'center' | 'space-around' | 'space-between' | 'space-evenly'}startobject: 4.24.0×
wrap是否自动换行booleantrue4.8.0×

Col

参数说明类型默认值版本全局配置
flexflex 布局属性。数字类型对应 'flex: n n auto';字符串类型直接透传(例如纯数字字符串 'n' 对应 'flex: n 1 0')string | number-×
offset栅格左侧的间隔格数,间隔内不可以有栅格number0×
order栅格顺序number0×
pull栅格向左移动格数number0×
push栅格向右移动格数number0×
span栅格占位格数,为 0 时相当于 display: nonenumber-×
xs窗口宽度 < 576px 响应式栅格,可为栅格数或一个包含其他属性的对象number | object-×
sm窗口宽度 ≥ 576px 响应式栅格,可为栅格数或一个包含其他属性的对象number | object-×
md窗口宽度 ≥ 768px 响应式栅格,可为栅格数或一个包含其他属性的对象number | object-×
lg窗口宽度 ≥ 992px 响应式栅格,可为栅格数或一个包含其他属性的对象number | object-×
xl窗口宽度 ≥ 1200px 响应式栅格,可为栅格数或一个包含其他属性的对象number | object-×
xxl窗口宽度 ≥ 1600px 响应式栅格,可为栅格数或一个包含其他属性的对象number | object-×
xxxl窗口宽度 ≥ 1920px 响应式栅格,可为栅格数或一个包含其他属性的对象number | object-6.3.0×

您可以使用 主题定制 修改 screen[XS|SM|MD|LG|XL|XXL|XXXL] 来修改断点值(自 5.1.0 起,codesandbox demo)。

响应式栅格的断点扩展自 BootStrap 4 的规则(不包含链接里 occasionally 的部分)。

主题变量(Design Token)

类型、继承关系和原生令牌声明保持固定源码原文;默认值由原生主题计算,并可能受 ConfigProvider 覆盖。本表不伪造静态默认值。

原生 ComponentToken 未声明可直接提取的自有字段;共享令牌或继承关系以以下声明为准。

声明来源: vendor/components/grid/style/index.ts

import { unit } from '@ant-design/cssinjs';

import type { CSSObject } from '@ant-design/cssinjs';

import type { AliasToken, FullToken, GenerateStyle, GetDefaultToken } from '../../theme/internal';

import { genStyleHooks, mergeToken } from '../../theme/internal';

import { genCssVar } from '../../theme/util/genStyleUtils';

// biome-ignore lint/suspicious/noEmptyInterface: ComponentToken need to be empty by default
export interface ComponentToken {}

interface GridRowToken extends FullToken<'Grid'> {
  //
}

interface GridColToken extends FullToken<'Grid'> {
  /**
   * @desc 网格列数
   * @descEN Number of grid columns
   */
  gridColumns: number;
}

原生通用属性

Tips: 以下通用属性适用于 antd 大部分组件,不支持的组件会单独说明。

参数说明类型默认值
style自定义样式CSSProperties-
className自定义类名string-
rootClassName添加在组件最外层的 classNamestring-
autoFocus自动获取焦点,仅对表单类、链接、交互容器等可聚焦元素生效booleanfalse

安装并复现示例

npm install antd@6.6.5 @ant-design/icons@6.3.4 dayjs@1.11.23

使用 ConfigProvider 和原生 App,并单独配置 dayjs 语言。每个示例在查看代码中列出完整源码文件和额外固定依赖。示例名称用于选择演示,不是组件通用属性。主题、语言与 SSR 初始化见资源安装指南。

原生类型参考

源码查看器包含未修改的原生实现和以下声明文件,继承类型仍位于原生包中。代码中的英文注释保留为源码参考。

  • vendor/components/grid/RowContext.ts
  • vendor/components/grid/col.tsx
  • vendor/components/grid/hooks/useGutter.ts
  • vendor/components/grid/row.tsx
  • vendor/components/grid/style/index.ts

来源与许可

https://github.com/ant-design/ant-design/tree/4a39f54842eade4e565ab336ef6097cd7e723cdd

保留原生中英文正文与可执行示例;官网专用的嵌入章节和令牌表格在本地展开。Ant Design 使用 MIT 许可,另列依赖的许可证也需保留。上传预览禁止向外发起请求,不提供后端服务。