# @aligov/icon

> 默认引入政务自定义 Icon 的组件

Latest version **1.0.12** (published 2021-09-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install @aligov/icon
pnpm add @aligov/icon
yarn add @aligov/icon
bun add @aligov/icon
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.12 |
| Published | 2021-09-27 |
| First published | 2020-06-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 2.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | liunian, tao1991123, itrip, xiazhiqiang, zhousufa, mo.zhou, guoliang.hgl, zwhu, daip, baizhao |
| Keywords | ice, react, component |

## Links

- npm: https://www.npmjs.com/package/@aligov/icon
- Homepage: https://unpkg.com/@aligov/icon@1.0.12/build/index.html
- npm.io page: https://npm.io/package/@aligov/icon

## Dependencies (2)

- [prop-types](https://npm.io/package/prop-types.md) ^15.5.8
- [@alifd/next](https://npm.io/package/@alifd/next.md) 1.x

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.12 (latest) — 2021-09-27
- 1.0.6 (next) — 2020-09-21
- 1.0.11 — 2021-09-27
- 1.0.10 — 2021-08-18
- 1.0.9 — 2021-03-05
- 1.0.8 — 2020-11-27
- 1.0.7 — 2020-11-09
- 1.0.5 — 2020-09-21
- 1.0.4 — 2020-09-21
- 1.0.3 — 2020-09-09
- 1.0.3-beta.5 — 2020-09-08
- 1.0.3-beta.4 — 2020-09-08
- 1.0.3-beta.3 — 2020-09-08
- 1.0.3-beta.2 — 2020-09-08
- 1.0.3-beta.1 — 2020-09-01
- … 3 more at https://npm.io/package/@aligov/icon/versions

## README

# 政务扩展图标

@aligov/icon

支持同时使用 Fusion 内置图标以及[数字政务图标系统][gov-icon-collection] 的图标组件，除了 `custom` 属性外，其他属性和 [Fusion Icon][fusion-icon] 的用法一致。

## API

| 参数名 | 说明               | 必填 | 类型    | 默认值 | 备注                     |
| ------ | ------------------ | ---- | ------- | ------ | ------------------------ |
| custom | 是否使用自定义图标 |      | boolean | false  | 默认使用 fusion 内置图标 |
| type   | 图标编码代号       |      | string  |        |                          |

## 其他事项

新增图标后，需要更新[图标项目][gov-icon-project]里 `Symbol` 链接，并更新该组件 package.json 里的 `iconScriptUrl`。

在无法更新组件的情况下，可以通过在组件加载前设置全局变量来定制。

执行`npm start` 和 `npm publish` 时，会前置执行`npm run updateIcon`，来下载`iconScriptUrl`指向的资源至本地，打包时会用本地资源进行构建。

`npm run updateIcon` 依赖 `curl`命令。

执行命令后请检查`iconfont.js`是否有内容，如果没有则有可能是`curl`命令缺失，请手动复制`iconScriptUrl`指向的资源内容至`iconfont.js`，或安装`curl`并重新执行`npm run updateIcon` 。

### 全局变量

- `CUSTOM_ICONFONT_JS`：iconfont Symbol js 地址，如 `//at.alicdn.com/t/font_1432938_9mhelv05j69.js`
- `CUSTOM_ICON_FIEFIX`：自定义图标 symbol 前缀，如 `gov-icon-`。这样对于图标 `gov-icon-yiju`，在使用时 `type` 设为 `yiju`。

> 数字政务图标系统及 iconfont 项目由设计师维护，图标系统（collection）是可公开访问的，图标可能比项目中的少一些（放到主题中了）。该组件中使用的是项目（project）中的所有图标。

[fusion-icon]: https://fusion.design/pc/component/basic/icon
[gov-icon-collection]: https://www.iconfont.cn/collections/detail?cid=18867
[gov-icon-project]: https://www.iconfont.cn/manage/index?manage_type=myprojects&projectId=1432938

---
_Source: https://npm.io/package/@aligov/icon · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._