@gitlab/svgs

中文文档
3.174.0发布于 2026/11/11MITCommonJS零依赖近 30 天下载 35.8万

GitLab SVG 资产

中文使用文档
文档目录10 节
  1. 预览 SVG 库
  2. 所需资源
  3. 图标
  4. 添加图标或插图
  5. 添加第三方标志或商标
  6. 从 Figma 导出图标
  7. Figma 代码连接中的映射图标
  8. 文件图标
  9. 出版新版本
  10. 捐款

Gitlab SVGs (英语)

这个软件包管理了 GitLab 的全部 SVG 资产,方法是从图标中创建 SVG 示意图,并优化 SVG 插图.

预览 SVG 库

浏览、参考和搜索 GitLab 设计系统 网站:

或者,看看他们 当地例如, http://localhost:2018/product-foundations/iconography-directory (中文(中国大陆) )。 。 。 .

所需资源

  • 您将需要 线条 财务报告和审定财务报表 节点 已安装。 在Mac上,你可以安装线条 brew install yarn。 。 。 .
  • 第一次,或从 main 分支, 使用 yarn install 以安装最新的依赖.
  • 确保你在 packages/gitlab-svgs 子目录.

图标

yarn run svg - 构建SVG图案并优化插图.

所有输出保存到 dist 我们主要应用程序中引用的文件夹 。 这个 dist 文件夹已生成, 但没有被承诺 .

添加图标或插图

  • 添加第三方标志或商标的,参见: 本节。 。 。 .

  • 审查下列文件:

  • 有最新消息吗 main 在本地副本中的分支 设计. gitlab.com ,然后创建一个新的本地分支.

    # Retrieve the latest updates
    git pull
    # Create a new local branch
    git checkout -b new-branch-name
    
  • 通过运行确定您的依赖关系是否更新 yarn install。 。 。 .

  • 导出图标或插图为 .svg 文档中 :

  • 替换十六进制 fill, (中文(简体) ), stroke,以及 stroke-width 示例中的数值 --gl-illustration-* 设计标志,因此适应了暗模式. 跟着 插图导出指南。 。 。 .

  • 如果您在导出时没有压缩 SVG, 您可以使用 塞尔维亚 在导出后优化它.

    # Optimize our `huge_test.svg` file
    yarn run svgo ./path/to/huge_test.svg
    
  • 对于图标,添加或更新图标的条目 sprite_icons/icons.meta.json (以字母顺序排列),使用来自Figma组件的关键词和描述.

  • 添加一个 更改列表 联 合 国 @gitlab/svgs 包件带有小起伏.

  • 添加新 SVG 后运行 yarn run svg 用于重建 dist 文件夹,然后 预览 他们.

  • 如果您对新/已修改的 SVG 满意, 请承诺并推进您的更改并创建合并请求 .

    # After committing your changes, use this to create a remote branch. A link will then be available to create the merge request.
    git push -u origin new-branch-name
    
  • 将合并请求指定给维护者 GitLab 服务器 项目. 您可以在 GitLab项目概况页。 。 。 .

添加第三方标志或商标

  1. 见 gitLab 添加第三方商标的程序 在手册中.
  2. 将核定资产置入 /illustrations/third-party-logos 目录.

从 Figma 导出图标

图标只有在合并为 GitLab 产品图标 在 Figma 中存档。 这保证了被导出的是图标的最终版本,如果有需要,导出设置会被保留给开发者交接.

  1. 确认图标跟随 图标设计准则。 。 。 .
  2. 确保图标周围的父框架没有背景填充.
  3. 选择图标并在右侧属性面板中添加 SVG 作为导出选项。 无论您是否使用高级 SVG 导出插件, 都应该这样做 。 如果您想在导出时优化图标,则使用以下进程,否则通过属性面板导出图标并跳到下一步 .
    1. 安装 高级 SVG 导出 插件 。 该插件使用 塞尔维亚 在引擎盖下。 使用默认设置 .
    2. 选择图标并运行插件,导出到 sprite_icons 文件夹.
  4. 在文本编辑器中打开所产生的 SVG 文件并 :
    • 删除 fill="none" 从主窗口 <svg> 键.
    • 添加一个 viewBox 匹配图标框架的属性,或者 viewBox="0 0 16 16" 或者说 viewBox="0 0 12 12"如果不见了 法格玛出口通常不包括在内.
    • 删除任何 <desc> 或者说 <clipPath> 要素.
  5. 添加新 SVG 后运行 yarn run svg 用于重建 dist 文件夹.

公司或产品的品牌图标可能具有具体的颜色要求,应从 brand-例如, brand-slack.svg。这些图标可能与 fill="#000" 防止色彩被覆盖.

Figma 代码连接中的映射图标

每个图标有一个 代码连接 条目,以便在 Figma Dev Mode 中选择它 <gl-icon name="…" /> 片断.

  1. 在图标的法格玛分支合并为 GitLab 产品图标 文件,为图标添加条目 icon.figma.batch.json,使用图标 node-id 从合并文件。 节点ID合并后会改变分行,所以不要使用分行的分行. 添加一个 "size" 非 16px 图标的字段 "size": 12。 。 。 .

  2. 合并请求合并后,设计系统小组的一名成员将出版地图 packages/gitlab-ui 文件夹。 这个 figma:connect 脚本无法从寄存器根获取 。 出版需要 .figma.env 文件夹中的文件 FIGMA_ACCESS_TOKEN 拥有 file_content:read 财务报告和审定财务报表 file_code_connect:write 瞄准镜。 见 .figma.env.exampleA级 403 Token expired 错误表示需要重新生成符号 .

    # From the repository root
    cd packages/gitlab-ui
    # Validate the mappings
    yarn figma:connect publish --dry-run
    # Publish the mappings to Figma
    yarn figma:connect publish --force
    
  3. 在Figma Dev Mode中,选择图标并验证其片断出现.

文件图标

此软件包还捆绑基于文件图标 PKief/vscode-材料-icon-主题。 。 。 .

在建设CI期间,采取了以下步骤:

  1. vscode-material-icon-them的下载基于以下版本: 正在构建 scripts/ file icons version。 。 。 .
  2. 然后使用的所有文件类型 src/ file icon map.js (中文(简体) ) 复制到 file_icons 文件夹.
  3. 他们从那里被捆绑在图标上
  4. 未使用的文件图标被复制到 file_icons_unused

出版新版本

发布新版本的软件包,比如 @gitlab/svgs,我们使用 变化。学习如何 创建 更改和发布软件包。 。 。 .

捐款

GitLab是一个开源项目,我们高兴地接受社区捐款。 请参考 捐款额 详细情况.

版本与发布记录

@gitlab/svgs 共发布 409 个版本,首次发布于 2018/10/31;过去 12 个月发布了 26 个版本。

版本发布日期距今
3.174.0latest2026/11/114 天前
3.173.02026/11/105 天前
3.172.02026/11/078 天前
3.171.02026/10/3016 天前
3.170.02026/10/2917 天前
3.169.02026/10/1927 天前

关于 @gitlab/svgs 的常见问题

@gitlab/svgs 是什么?

GitLab SVG 资产

如何安装 @gitlab/svgs?

在项目目录运行 npm install @gitlab/svgs,或使用 pnpm add / yarn add / bun add。

@gitlab/svgs 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/gitlab__svgs 是否存在。

@gitlab/svgs 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@gitlab/svgs 可以商用吗?

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

@gitlab/svgs 的下载量有多少?

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

@gitlab/svgs 还在维护吗?

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