@gravity-ui/illustrations

中文文档
3.0.0发布于 2026/11/05MITTypeScript零依赖近 30 天下载 2.9万

重力UI 插图包

中文使用文档
文档目录11 节
  1. 安装
  2. 使用量
  3. 反应
  4. 特别工作组
  5. 发展
  6. 许可证
  7. 对于人工智能特工
  8. 何时使用
  9. 不使用时
  10. 常见陷阱
  11. AI代理的文件

@gravity-ui/ 杂乱无章 npm package CI storybook

安装

npm install --save-dev @gravity-ui/illustrations

使用量

反应

筹备

设置插图主题 。 执行下列任何步骤:

用自有颜色的托盘定义 css-tokes

在应用程序中定义以下 cs- takes :

--gil-color-object-base: rgb(255, 190, 92);
--gil-color-object-accent-heavy: rgb(211, 101, 7);
--gil-color-object-hightlight: rgb(255, 216, 157);
--gil-color-shadow-over-object: rgb(211, 158, 80);
--gil-color-background-lines: rgb(140, 140, 140);
--gil-color-background-shapes: rgb(242, 242, 242);
--gil-color-object-accent-light: rgb(255, 255, 255);
--gil-color-object-danger: rgb(255, 0, 61);
使用带有默认重力主题的混音器

在不同的主题中, 使用下列组合图来进行样式插图

@import '@gravity-ui/illustrations/styles/theme.scss';

.g-root {
  &_theme_light {
    @include g-illustrations-colors-light;
  }

  &_theme_light-hc {
    @include g-illustrations-colors-light-hc;
  }

  &_theme_dark {
    @include g-illustrations-colors-dark;
  }

  &_theme_dark-hc {
    @include g-illustrations-colors-dark-hc;
  }
}
预安装重力主题项目的替代方案

或者,如果 @gravity-ui/uikit 已安装在工程中, 并使用默认主题, 您可以只导入 styles.scss 转到您的工程中带有样式的根文件 :

// existing gravity styles definition
import '@gravity-ui/uikit/styles/styles.css';
// just add one more import below
import '@gravity-ui/illustrations/styles/styles.scss';

组件使用量

import NotFound from '@gravity-ui/illustrations/NotFound';

或者说

import {NotFound} from '@gravity-ui/illustrations';

特别工作组

你可能需要一个合适的装载器

import notFound from '@gravity-ui/illustrations/svgs/not-found-light.svg';

发展

为了按照新设计来更新插图,修改 svg-s 在轻主题中的内容(<this-repository-root>/svgs/<illustration-name>-light.svg 文件),然后运行命令 :

npm run generate

许可证

根据麻省理工学院的许可证分发。 见 自由主义 详细情况.

对于人工智能特工

为Gravity UI apps设计的一组平面 SVG 插图(空状态,出错,未发现等)——当您需要现成的,有主题意识的占位符/空状态的相片而不是绘制出自己的或使用裸光的图标时,可以到达.

何时使用

  • 空状态, 404/ error 页面, 或登入需要一致插图的占位符, 而不是功能化的 UI 控制.
  • 可主题的艺术作品——SVG通过SCSS混音或CSS变量对重力主题符号(轻/暗,高相接)作出回应.
  • 导入艺术品为 React 组件( 默认) 或原始 .svg 文档.

不使用时

  • 用于功能化的 UI 图标(chevrons, check, buttons),使用 @gravity-ui/icons ——插图是装饰性的艺术品,不是UI甘油.
  • 对于一个一次性的插图,您已经拥有一个资产,直接导入该资产而不是拉入此套件.

常见陷阱

  • 没有主题导入的渲染 — 插图显示为无色, 除非导入 @gravity-ui/illustrations/styles/styles.scss (或定义 --gil-color-* CSS标志.
  • 迷幻默认导出名称 ——插图组件为PascalCase命名出品(例如. NotFound),从包根或每个文件导入(@gravity-ui/illustrations/NotFound) (中文(简体) ).
  • 导入 .svg 直接装入非配置捆绑器 ——原始SVG进口需要合适的装载机;更喜欢React组件出口来避免捆绑器的设置.

AI代理的文件

安装版本的可代理读取文档位于 node_modules/@gravity-ui/illustrations/docs/INDEX.md。 。 。 .

版本与发布记录

@gravity-ui/illustrations 共发布 5 个版本,首次发布于 2024/03/27;过去 12 个月发布了 2 个版本。

版本发布日期距今
3.0.0latest2026/11/0511 天前
2.1.12026/04/216 个月前
2.1.02025/02/281.7 年前
2.0.02025/02/051.8 年前
1.0.02024/03/272 年前

关于 @gravity-ui/illustrations 的常见问题

@gravity-ui/illustrations 是什么?

重力UI 插图包

如何安装 @gravity-ui/illustrations?

在项目目录运行 npm install @gravity-ui/illustrations,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)、react-dom(^18.0.0 || ^19.0.0)、@gravity-ui/uikit(^8.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@gravity-ui/illustrations 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@gravity-ui/illustrations 可以商用吗?

@gravity-ui/illustrations 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@gravity-ui/illustrations 的下载量有多少?

根据 npm 官方下载统计,@gravity-ui/illustrations 在 2026/10/17 – 2026/11/15 这 30 天内被下载 28,944 次,日均约 965 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@gravity-ui/illustrations 还在维护吗?

最新版本 3.0.0 发布于 2026/11/05(11 天前);至今共发布 5 个版本,其中过去 12 个月发布了 2 个;首次发布于 2024/03/27。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。