JGuang

空状态

Empty · Ant Design

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

空状态

空状态时的展示占位图。

何时使用

  • 当目前没有数据时,用于显式的用户提示。
  • 初始化场景时的引导创建流程。

代码演示

  • 基本 · basic
  • 选择图片 · simple
  • 自定义 · customize
  • 全局化配置 · config-provider
  • 自定义语义结构的样式和类 · style-class
  • 无描述 · description

API

通用属性参考:通用属性

<Empty>
  <Button>创建</Button>
</Empty>
参数说明类型默认值版本全局配置
classNames用于自定义组件内部各语义化结构的 class,支持对象或函数Record<SemanticDOM, string> | (info: { props })=> Record<SemanticDOM, string>-5.23.0
description自定义描述内容ReactNode-×
image设置显示图片,为 string 时表示自定义图片地址。ReactNodeEmpty.PRESENTED_IMAGE_DEFAULT5.27.0
imageStyle图片样式,请使用 styles.image 替代CSSProperties-×
styles用于自定义组件内部各语义化结构的行内 style,支持对象或函数Record<SemanticDOM, CSSProperties> | (info: { props })=> Record<SemanticDOM, CSSProperties>-5.23.0

内置图片

  • Empty.PRESENTED_IMAGE_SIMPLE

    <div class="site-empty-buildIn-img site-empty-buildIn-simple"><div>
  • Empty.PRESENTED_IMAGE_DEFAULT

    <div class="site-empty-buildIn-img site-empty-buildIn-default"></div>

Semantic DOM

语义节点原生说明版本
root根元素,设置文本对齐、字体和行高样式5.23.0
image图标元素,设置高度、透明度、边距和图片样式5.23.0
description描述元素,设置文本颜色样式5.23.0
footer底部元素,设置顶部边距和操作按钮样式5.23.0

语义说明来源: vendor/components/empty/demo/_semantic.tsx

主题变量(Design Token)

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

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

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

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

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

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

/** Component only token. Which will handle additional calculation of alias token */
// biome-ignore lint/suspicious/noEmptyInterface: ComponentToken need to be empty by default
export interface ComponentToken {}

/**
 * @desc Empty 组件的 Token
 * @descEN Token for Empty component
 */
interface EmptyToken extends FullToken<'Empty'> {
  /**
   * @desc 空状态图片类名
   * @descEN Class name for empty state image
   */
  emptyImgCls: string;
  /**
   * @desc 空状态图片高度
   * @descEN Height of empty state image
   */
  emptyImgHeight: number | string;
  /**
   * @desc 小号空状态图片高度
   * @descEN Height of small empty state image
   */
  emptyImgHeightSM: number | string;
  /**
   * @desc 中号空状态图片高度
   * @descEN Height of medium empty state image
   */
  emptyImgHeightMD: number | string;
}

原生通用属性

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/empty/index.tsx
  • vendor/components/empty/style/index.ts

来源与许可

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

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