https://github.com/iconfont-cli/remax-iconfont-cli
在RemaxJs框架中使用iconfont图标，支持多端，支持多色彩，不依赖字体。
https://github.com/iconfont-cli/remax-iconfont-cli
iconfont iconfont-remax iconfont-remaxjs remax-iconfont remaxjs remaxjs-iconfont
Last synced: 11 months ago
JSON representation
在RemaxJs框架中使用iconfont图标，支持多端，支持多色彩，不依赖字体。
- Host: GitHub
- URL: https://github.com/iconfont-cli/remax-iconfont-cli
- Owner: iconfont-cli
- License: mit
- Created: 2020-04-08T12:26:51.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-10T19:58:01.000Z (almost 3 years ago)
- Last Synced: 2025-04-11T14:19:55.352Z (about 1 year ago)
- Topics: iconfont, iconfont-remax, iconfont-remaxjs, remax-iconfont, remaxjs, remaxjs-iconfont
- Language: JavaScript
- Homepage:
- Size: 62.5 KB
- Stars: 31
- Watchers: 3
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# remax-iconfont-cli
在RemaxJs框架中使用iconfont图标，不依赖字体，支持多色彩。
# 支持平台
* 微信小程序
* 支付宝小程序
* 头条小程序
# 特性
1、一键生成标准组件，多端支持
2、使用方便，import即可
3、支持多色彩
4、支持自定义颜色
5、支持es6和typescript两种模式
# Step 1
安装插件
```bash
# Yarn
yarn add remax-iconfont-cli --dev
# Npm
npm install remax-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 官网提供的JS链接",
"save_dir": "./src/components/iconfont",
"use_typescript": false,
"platforms": "*",
"use_rpx": true,
"trim_icon_prefix": "icon",
"default_icon_size": 18
}
```
### 配置参数说明：
### symbol_url
请直接复制[iconfont](http://iconfont.cn)官网提供的项目链接。请务必看清是`.js`后缀而不是.css后缀。如果你现在还没有创建iconfont的仓库，那么可以填入这个链接去测试：`http://at.alicdn.com/t/font_1373348_kk9y3jk2omq.js`
### save_dir
根据iconfont图标生成的组件存放的位置。每次生成组件之前，该文件夹都会被清空。
### use_typescript
如果您的项目使用Typescript编写，请设置为true。这个选项将决定生成的图标组件是`.tsx`还是`.js`后缀。
当该值为false时，我们会为您的图标生成`.js`和`.d.ts`两个文件，以便您能享受到最好的开发体验。
### platforms
选择需要支持的平台，默认是`*`，意味着所有平台都需要支持（如果有）。如果你只想支持部分平台，也可以设置成数组：
```json5
{
// 选择你需要的平台
"platforms": ["wechat", "ali", "toutiao"]
}
```
### use_rpx
是否使用[尺寸单位rpx](https://developers.weixin.qq.com/miniprogram/dev/framework/view/wxss.html#%E5%B0%BA%E5%AF%B8%E5%8D%95%E4%BD%8D)还是普通的像素单位`px`。默认值为true，与RemaxJs保持一致的缩放。您也可以设置为false，强制使用`px`
--------
**注意：** 无论您是否设置了use_rpx，传入的size值都是`px单位`。如果开启了use_rpx，组件内部会帮您自动转换。
### trim_icon_prefix
如果你的图标有通用的前缀，而你在使用的时候又不想重复去写，那么可以通过这种配置这个选项把前缀统一去掉。
### default_icon_size
我们将为每个生成的图标组件加入默认的字体大小，当然，你也可以通过传入props的方式改变这个size值。
# Step 3
开始生成RemaxJs标准组件
```bash
npx iconfont-remax
# 可传入配置文件路径
# npx iconfont-remax --config iconfont.json
```
生成后查看您设置的保存目录中是否含有所有的图标
-------
在生成代码之前，你可以顺便参考[snapshots目录](https://github.com/iconfont-cli/remax-iconfont-cli/tree/master/snapshots)自动生成的快照文件。
# 使用
在Page中使用图标
```jsx harmony
import React, { Component } from 'react';
import IconFont from '../components/iconfont';
class App extends Component {
render() {
return ;
}
}
export default App;
```
更多用法：
```jsx harmony
// 原色彩
// 单色：红色
// 多色：红色+橘色
// 不同格式的颜色写法
// 与文字对齐
Hello
```
# 更新图标
当您在iconfont.cn中的图标有变更时，只需更改配置`symbol_url`，然后再次执行`Step 3`即可生成最新的图标组件
```bash
# 修改 symbol_url 配置后执行：
npx iconfont-remax
```
# 扩展
|平台|库|
|----|---|
|小程序|[mini-program-iconfont-cli](https://github.com/fwh1990/mini-program-iconfont-cli)|
|React Native|[react-native-iconfont-cli](https://github.com/fwh1990/react-native-iconfont-cli)|
|React H5|[react-iconfont-cli](https://github.com/fwh1990/react-iconfont-cli)|
|Flutter|[flutter-iconfont-cli](https://github.com/fwh1990/flutter-iconfont-cli)|
|Taro|[taro-iconfont-cli](https://github.com/fwh1990/taro-iconfont-cli)|
--------
欢迎使用，并给我一些反馈和建议，让这个库做的更好