# iconfont-cli

**Repository Path**: vant-openharmony/iconfont-cli

## Basic Information

- **Project Name**: iconfont-cli
- **Description**: 在openharmony框架中使用iconfont图标，支持多色彩，不依赖字体。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2021-08-19
- **Last Updated**: 2022-05-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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
```

--------

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