# @bitgo-forks/cryptocurrency-icons 中文文档

规范地址：https://npmcn.com/package/%40bitgo-forks/cryptocurrency-icons/

版本：0\.160\.0
npm 元数据更新时间：2026-11-03T03:56:41.251Z
中文译文更新时间：2026-11-08T04:21:35.967Z
软件包许可：CC0-1\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40bitgo-forks/cryptocurrency-icons
原文对照：https://npmcn.com/package/%40bitgo-forks/cryptocurrency-icons/?lang=original
项目主页：https://github.com/BitGo/cryptocurrency-icons
源码仓库：https://github.com/BitGo/cryptocurrency-icons

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：151 MB，13266 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.19\.0
- 运行依赖：0 个
- 首次发布：2025-09-16T12:36:37.978Z
- 最新版本发布：2026-11-03T03:56:41.040Z
- 近 30 天下载量：57803（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：159（近 12 个月 138 个）

## 中文简介

一套用于所有主要密码和代币的图标,其样式和大小各有不同

## 安装

```sh
npm install @bitgo-forks/cryptocurrency-icons
```

也可以使用：`pnpm add @bitgo-forks/cryptocurrency-icons`、`yarn add @bitgo-forks/cryptocurrency-icons`、`bun add @bitgo-forks/cryptocurrency-icons`

## README

# 加密货币图标

键入叉 [密码-货币](https://github.com/spothq/cryptocurrency-icons) 用于生成 BitGo 应用程序中使用的 SVG 图标和反应组件.

## 安装

```bash
npm install @bitgo-forks/cryptocurrency-icons
```

## 使用量

### SVG 图标

直接从软件包导入 SVG 文件 :

```javascript
// Color icons (recommended)
import btcIcon from '@bitgo-forks/cryptocurrency-icons/svg/color/btc.svg';

// Monochrome variants
import btcWhite from '@bitgo-forks/cryptocurrency-icons/svg/white/btc.svg';
import btcBlack from '@bitgo-forks/cryptocurrency-icons/svg/black/btc.svg';
import btcOutline from '@bitgo-forks/cryptocurrency-icons/svg/icon/btc.svg';
```

### 反应组件

导入并使用带有 `prefixId` iD 命名间隔的道具 :

```jsx
import BtcIcon from '@bitgo-forks/cryptocurrency-icons/react/btc';

function MyComponent() {
  return (
    <BtcIcon 
      prefixId="unique-id" 
      width={32} 
      height={32} 
    />
  );
}
```

这个 `prefixId` 道克在同一页上渲染多图标时可以防止CSS/ID相撞.

### PNG 图标

预先交付的PNG图标有多个大小:

-   `32/` - 32x32像素
-   `32@2x/` - 64x64像素(视网膜)
-   `128/` - 128x128 像素

这些传统道路仍然可供现有消费者使用。 只新建光栅 没有 SVG 表示式的图标使用明文 `png/` 路径 :

```javascript
import faiIcon from '@bitgo-forks/cryptocurrency-icons/png/128/color/baseethfai.png';
```

仅使用鼠标身份声明 `formats: ["png"]` 内 `manifest.json`。 。 。 . 它们不是作为 SVG 或 React 组件生成的. 运行时间消费者应当 使用 PNG CDN 元数据,而不是假设每个显示的条目都有 SVG .

### 声明

这个 `manifest.json` 文件包含所有图标的元数据 :

```json
{
  "symbol": "BTC",
  "name": "Bitcoin",
  "color": "#f7931a",
  "formats": ["svg"]
}
```

用于程序访问图标元数据、颜色、显示名称和 现有陈述。 使用现有矢量图标 `formats: ["svg"]`· ; 仅使用光栅例外 `formats: ["png"]`。 。 。 .

## 添加新图标

1.  将您的 SVG 添加到 `svg/color/` 目录( 小写文件名)
2.  将符号添加到 `manifest.json`
3.  运行生成脚本 :

```bash
npm install
npm run manifest
npm run generate
```

4.  提交 SVG 和生成的 React 组件

### 添加 PNG 仅限图标

用于不适合忠实矢量化的艺术作品 。 PNG-仅限图标是一种添加型格式,不创建SVG或生成的React组件.

1.  增加核定巴布亚新几内亚产出 `png/`数字 :
    
    ```text
    png/128/color/{symbol}.png
    png/32/color/{symbol}.png
    png/32@2x/color/{symbol}@2x.png
    ```
    
2.  添加 `formats: ["png"]` 到图标 `manifest.json` 记录.
3.  运行 :
    
    ```bash
    npm run manifest
    npm run cdn-manifest
    npm run sync-check
    npm run test:pack
    ```
    
4.  在光明和黑暗的消费者背景下审查图标.

不添加 PNG 身份到 `svg/color/`, (中文(简体) ), `react/`,或生成的 SVG 反应枪管。 只有SVG的消费者会使用他们通常的通用回落;光栅意识的消费者使用PNG CDN元数据或 `png/*` 软件包路径.

这个 `cdn-manifest.json` 文件在源控件中生成并被忽略。 它包含现有的 SVG 变体地图外加可选 `png` 散列 PNG 资产的命名空间.

### SVG需求

-   **最大文件大小**: 100KB(建议: < 20KB)
-   **格式**: 适当的向量 SVG(无嵌入式PNG/JPEG Base64数据)
-   **视图框**: 必须包含 `viewBox` 属性
-   **类名**: 避免类似通用名称 `cls-1` 或者说 `st0` (将自动前置)

见 [捐款额](https://npmcn.com/package/%40bitgo-forks/cryptocurrency-icons/CONTRIBUTING.md) 详细指南.

## 脚本

| 脚本 | 说明 |
| --- | --- |
| `npm run generate` | 从 SVG 生成反应组件 |
| `npm run manifest` | 更新硬币名称和颜色的明细表.json |
| `npm run cdn-manifest` | 生成散列的 SVG/PNG CDN 资产和元数据 |
| `npm run clean` | 用 svgo 优化 SVG |
| `npm run validate` | 检查 SVG 大小并检测嵌入式图像 |
| `npm run sync-check` | 验证 SVG/反应/明显对等 |
| `npm run test:pack` | 验证已公布的软件包内容和导出 |
| `npm run preflight` | 执行前运行全部验证 |
| `npm run storybook` | 用于图标库/预览的 Dev 服务器( 端口 6006) |
| `npm run build-storybook` | 静态故事书的建立 – `storybook-static/` |
| `npm run test:storybook` | 图片库单元测试 + 静态故事书构建( smoke) |

## 故事本( PR 预览)

触摸图标或故事本运行的 PR **故事本 PR 预览** 在 GitHub 动作中: 更改的 SVG 路径写入 `stories/changed-icons.json`,然后将静态构建同步到 dev **自动测试报告** 脚下 `cryptocurrency-icons-ci/pr-<number>/` (模式与 Playwright 报告相同;而非制作) `cdn.bitgo.com`) (中文(简体) ). 见 [WEB-718 (英语)](https://linear.app/bitgo/issue/WEB-718/add-svg-preview-with-lightdark-mode-support) / CE-9917 (英语).

当地:

```bash
npm install
npm run storybook
# or verify a production build:
npm run test:storybook
```

## 测试

`npm test` 运行 SVG 验证、同步检查、 CDN 包检查,以及 **故事书画廊逻辑** 单位测试(`scripts/test-storybook-gallery-logic.mjs`) (中文(简体) ). 这些测试包括显示文件名的正常化、显示搜索和匹配的 PR 路径更改为 `svg/<variant>/<file>.svg` (规则与 `stories/helpers.ts`已执行 `scripts/storybook-gallery-logic.mjs`) (中文(简体) ).

用于故事书UI和捆绑,运行 `npm run test:storybook` (进行画廊测试) `build-storybook`) (中文(简体) ). 见 [试验. md](https://npmcn.com/package/%40bitgo-forks/cryptocurrency-icons/TESTING.md) 用于更广泛的验证和发布清单.

## 仓库结构

```
cryptocurrency-icons/
├── svg/
│   ├── color/      # Full-color icons (primary)
│   ├── white/      # White monochrome
│   ├── black/      # Black monochrome
│   └── icon/       # Outline icons
├── react/          # Generated React components
├── 32/             # 32px PNG exports
├── 32@2x/          # 64px PNG exports (retina)
├── 128/            # 128px PNG exports
├── png/            # New PNG-only icon outputs
├── manifest.json   # Icon metadata, including optional formats
├── .storybook/     # Storybook config (dev + PR preview builds)
├── stories/        # Storybook stories + `changed-icons.json` (CI-filled on PRs)
└── scripts/        # Generation, validation, and tests
```

## 捐款

见 [捐款额](https://npmcn.com/package/%40bitgo-forks/cryptocurrency-icons/CONTRIBUTING.md) 提交指南.

## 维护者

见 [维持状态](https://npmcn.com/package/%40bitgo-forks/cryptocurrency-icons/MAINTAINING.md) 用于维护工作流程.

## 许可证

[CC0-1.0 (英语)](https://npmcn.com/package/%40bitgo-forks/cryptocurrency-icons/LICENSE) - 公共领域

## 常见问题

### @bitgo-forks/cryptocurrency-icons 是什么？

一套用于所有主要密码和代币的图标,其样式和大小各有不同

### 如何安装 @bitgo-forks/cryptocurrency-icons？

在项目目录运行 npm install @bitgo-forks/cryptocurrency-icons，或使用 pnpm add / yarn add / bun add。

### @bitgo-forks/cryptocurrency-icons 支持 TypeScript 吗？

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

### @bitgo-forks/cryptocurrency-icons 支持 ESM 还是 CommonJS？

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

### @bitgo-forks/cryptocurrency-icons 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.19\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @bitgo-forks/cryptocurrency-icons 可以商用吗？

@bitgo-forks/cryptocurrency-icons 使用 CC0-1\.0 许可。作者放弃著作权，可不受限制地使用。以上为概括，不构成法律意见，请以许可原文为准。

### @bitgo-forks/cryptocurrency-icons 的下载量有多少？

根据 npm 官方下载统计，@bitgo-forks/cryptocurrency-icons 在 2026/10/08 – 2026/11/06 这 30 天内被下载 57,803 次，日均约 1,927 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @bitgo-forks/cryptocurrency-icons 还在维护吗？

最新版本 0\.160\.0 发布于 2026/11/03（5 天前）；至今共发布 159 个版本，其中过去 12 个月发布了 138 个；首次发布于 2025/09/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。