# openharmony-iconfont-cli

> 在openharmony框架中使用iconfont图标，不支持多色彩，依赖字体。

Latest version **0.3.13** (published 2022-05-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install openharmony-iconfont-cli
pnpm add openharmony-iconfont-cli
yarn add openharmony-iconfont-cli
bun add openharmony-iconfont-cli
```

Provides the commands `iconfont`, `iconfont-oh`, `iconfont-init`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.13 |
| Published | 2022-05-05 |
| First published | 2021-08-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 17.6 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | sengmitnick |
| Maintainers | sengmitnick |
| Keywords | openharmony, iconfont, iconfont-cli |

## Links

- npm: https://www.npmjs.com/package/openharmony-iconfont-cli
- Repository: https://gitee.com/vant-openharmony/iconfont-cli
- npm.io page: https://npm.io/package/openharmony-iconfont-cli

## Dependencies (11)

- [glob](https://npm.io/package/glob.md) ^7.1.4
- [tslib](https://npm.io/package/tslib.md) ^1.10.0
- [colors](https://npm.io/package/colors.md) ^1.3.3
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [rimraf](https://npm.io/package/rimraf.md) ^3.0.2
- [xml2js](https://npm.io/package/xml2js.md) ^0.4.19
- [cssjson](https://npm.io/package/cssjson.md) ^2.1.3
- [fs-extra](https://npm.io/package/fs-extra.md) ^8.1.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.5
- [umi-request](https://npm.io/package/umi-request.md) ^1.3.9

## Alternatives

- [@fortawesome/react-fontawesome](https://npm.io/package/@fortawesome/react-fontawesome.md) — 2.2M weekly downloads
- [roboto-fontface](https://npm.io/package/roboto-fontface.md) — 196.0K weekly downloads
- [@react-native-vector-icons/common](https://npm.io/package/@react-native-vector-icons/common.md) — 150.4K weekly downloads
- [stockfish](https://npm.io/package/stockfish.md) — 27.0K weekly downloads
- [@procore/core-icons](https://npm.io/package/@procore/core-icons.md) — 4.6K weekly downloads

## Recent versions

- 0.3.13 (latest) — 2022-05-05
- 0.3.11 — 2022-02-20
- 0.3.10 — 2021-09-12
- 0.3.9 — 2021-09-11
- 0.3.8 — 2021-08-31
- 0.3.7 — 2021-08-31
- 0.3.6 — 2021-08-31
- 0.3.5 — 2021-08-22
- 0.3.4 — 2021-08-22
- 0.3.3 — 2021-08-22
- 0.2.2 — 2021-08-21
- 0.2.1 — 2021-08-20
- 0.1.2 — 2021-08-20
- 0.1.1 — 2021-08-20
- 0.1.0 — 2021-08-20

## README

# openharmony-iconfont-cli

在openharmony框架中使用iconfont图标，不支持多色彩，依赖字体。

## Step 1

安装插件

```bash
# Yarn
yarn add openharmony-iconfont-cli --dev

# Npm
npm install openharmony-iconfont-cli --save-dev
```

## Step 2

生成配置文件

```bash
npx iconfont-init

# 可传入配置文件输出路径
# npx iconfont-init --output iconfont.json
```

此时项目根目录会生成一个`iconfont.json`的文件，内容如下：

```json
{
  "symbol_url": "请参考README.md，复制 http://iconfont.cn 官网提供的CSS链接",
  "save_dir": "./iconfont",
  "prefix_cls": "openharmony",
  "icon_prefix": "icon-",
  "trim_icon_prefix": true,
  "default_icon_size": 18
}
```

### 配置参数说明

#### symbol_url

请直接复制[iconfont](http://iconfont.cn)官网提供的项目链接。请务必看清是`.css`后缀而不是`.jss`后缀。如果你现在还没有创建iconfont的仓库，那么可以填入这个链接去测试：`http://at.alicdn.com/t/font_1373348_kk9y3jk2omq.css`。

#### save_dir

根据iconfont图标生成的组件存放的位置。每次生成组件之前，该文件夹都会被清空。

#### prefix_cls

生成的样式文件的class前缀

#### icon_prefix

图标前缀

#### trim_icon_prefix

如果你的图标有通用的前缀，而你在使用的时候又不想重复去写，那么可以通过配置这个选项把前缀统一去掉。

#### default_icon_size

我们将为每个生成的图标组件加入默认的字体大小，当然，你也可以通过传入props的方式改变这个size值。

## Step 3

开始生成openharmony标准组件

```bash
npx iconfont-oh
```

## 更新图标

当您在iconfont.cn中的图标有变更时，只需更改配置`symbol_url`，然后再次执行`Step 3`即可生成最新的图标组件

```bash
# 修改 symbol_url 配置后执行：
npx iconfont-oh
```

--------

欢迎使用，并给我一些反馈和建议，让这个库做的更好

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