@fungi.computer/sigils

中文文档
0.3.2发布于 2026/11/14MITTypeScriptES Module零依赖近 30 天下载 8662

真菌经批准的图示符号和视觉研究

中文使用文档
文档目录9 节
  1. 安装或设置
  2. 快开始
  3. 核心概念
  4. API 参考
  5. 实例和检查
  6. 限制和错误
  7. 贡献和许可证
  8. 主题颜色
  9. 包装的消费者准备状态

数字@fungi.computer/sigils(中文(简体) )

Sigils为真菌接口提供装饰性的SVG标记. 它的画廊显示 标记与参考艺术和视觉研究,使消费者能够检查 哪些画被批准, 活的,或静止的概念.

安装或设置

npm install @fungi.computer/sigils react

Sigils需要作为同伴依赖的回放18.3或19.2.

快开始

这个说明性的例子是一个装饰性的标志。 随函附上 控制自己的可访问名称 :

import { Sigil } from "@fungi.computer/sigils";

<button aria-label="List files">
  <Sigil name="list" size={24} />
</button>;

Sigil 在一个64乘以64的视图框中 制造出一个隐藏的相机 SVG 。 打电话者控制 它的大小和提供周围控件的可读文本.

核心概念

公共部分接受 SigilName 和一个可选像素 size。 。 。 . isSigilName 检查字符串是否是软件包可用名称之一; 它不检查是否为某一特定行动批准使用该标记,或 允许.

工作台将图书馆、家庭、案件、资料来源和 曲线回顾. 它的权限 使用页面是一个可视化研究,而非已运出 权限屏幕。 SVG在软件包中的存在并不能赋予能力 或暗示一个接口使用它.

API 参考

见大众 组件和类型出口。 。 。 . Sigil 财务报告和审定财务报表 isSigilName 是运行时间输出; SigilName 是导出类型.

@fungi.computer/sigils/favicon 出口 fungiFaviconSvg以真菌为标志 独立 SVG 文档,以及 fungiFaviconHref,与数据URI中用于 <link rel="icon" type="image/svg+xml">。该建筑使 <Sigil name="fungi" /> {\fn黑体\fs22\bord1\shad0\3aHBE\4aH00\fscx67\fscy66\2cHFFFFFF\3cH808080}所以真人网的表面会吸收他们 选项卡图标.

实例和检查

从寄存器根启动本地工作台 :

pnpm --filter @fungi.computer/sigils workbench

打开由 workbench 命令打印的本地地址来比较分组 标记、核准的示例、概念和参考图像。 检查源图像 在重新使用艺术品之前在工作台上加分和状态标签.

软件包宣布构建、 显示和打字检查命令 :

pnpm --filter @fungi.computer/sigils build
pnpm --filter @fungi.computer/sigils lint
pnpm --filter @fungi.computer/sigils typecheck

限制和错误

西吉斯只提供艺术品。 父控件拥有其无障碍名称, 互动,和权限的意义。 工作台包括候选人和 未批准用于生产的参考艺术。 检查每个标记的状态 而不是按批准的方式对待所有可用的 SVG.

贡献和许可证

参考页将源页与每个标记相配,并指明其是否 矢量是活的,批准的,还是一个概念. 保存这些源图像 标签与工作台。 从寄存器根构建它 pnpm --filter @fungi.computer/sigils build. Sigils 持有麻省理工学院许可证;见 自由主义。 。 。 .

主题颜色

Sigils通过内置 SVG 样式使用 Stipe 的插图角色, 有字面 斯提普不在时会掉头 主题可能重置 --stipe-art-* 角色。 。 。 页次 数字、强调线、生成艺术和完成等 --stipe-sketch-ink 并保留黑暗主题的艺术奶油。 图 眼睛的使用 --color-base-100,所以他们读作被淘汰。 清单和印刷 保留彩色形状的奶油细节 --stipe-art-cream 在两种外表. 没有分开 --sigil-figure* 钩子.

工作台通过Tailwind载货。 它的主题切换开关拿铁和 mocha;画廊默认跟随它,带有可选的显式画布主题. 主题故事比较了拿铁,野外指南,咨询,摩查和 在64、28、20和16像素(包括残疾的图尔图斯)进行野外制导 过滤器。 调色板默认和主题所有者居住在斯提普,而不是在这个包中.

包装的消费者准备状态

运行 pnpm run build, (中文(简体) ), pnpm run pack 财务报告和审定财务报表 pnpm run stranger 本包中. 保存的陌生人证明只安装了包裹 tarball 到新鲜npm 消费者,检查准确的运出文件,运行公共运行时间固定和 编译每个 JavaScript 入口, 严格节点Next 且没有库检查 跳过。 此资格不发布 npm 发布或推动仓库 分页.

版本与发布记录

@fungi.computer/sigils 共发布 9 个版本,首次发布于 2026/10/15;过去 12 个月发布了 9 个版本。

版本发布日期距今
0.3.2latest2026/11/141 天前
0.3.12026/11/105 天前
0.3.02026/11/0213 天前
0.2.22026/11/0114 天前
0.2.12026/11/0115 天前
0.2.02026/10/2323 天前

关于 @fungi.computer/sigils 的常见问题

@fungi.computer/sigils 是什么?

真菌经批准的图示符号和视觉研究

如何安装 @fungi.computer/sigils?

在项目目录运行 npm install @fungi.computer/sigils,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.3.1 || ^19.2.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@fungi.computer/sigils 支持 TypeScript 吗?

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

@fungi.computer/sigils 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@fungi.computer/sigils 可以商用吗?

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

@fungi.computer/sigils 的下载量有多少?

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

@fungi.computer/sigils 还在维护吗?

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