https://github.com/axetroy/iconfont-componentized

IconFont 组件生成器
https://github.com/axetroy/iconfont-componentized

generator icon-font

Last synced: about 1 month ago
JSON representation

IconFont 组件生成器

• Host: GitHub
• URL: https://github.com/axetroy/iconfont-componentized
• Owner: axetroy
• License: other
• Created: 2023-07-31T06:55:45.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-24T15:03:49.000Z (over 1 year ago)
• Last Synced: 2024-04-28T17:22:16.534Z (9 months ago)
• Topics: generator, icon-font
• Language: TypeScript
• Homepage: https://www.npmjs.com/search?q=%40iconfont-componentized
• Size: 618 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://github.com/axetroy/iconfont-componentized/workflows/build/badge.svg)](https://github.com/axetroy/iconfont-componentized/actions)

[![996.icu](https://img.shields.io/badge/link-996.icu-red.svg)](https://996.icu)

[![LICENSE](https://img.shields.io/badge/license-Anti%20996-blue.svg)](https://github.com/996icu/996.ICU/blob/master/LICENSE)

### IconFont Componentized

IconFont Componentized 是一系列工具，用于生成 IconFont 组件用于各种框架/环境中。

### 支持生成的框架/环境

-   [React](packages/gen-react/__tests__/output.spec.1/)

-   [Taro-React](packages/gen-taro-react/__tests__/output.spec.1/)

-   [Vue](packages/gen-vue/__tests__/output.spec.1/)

-   [WebComponent](packages/gen-web-component/__tests__/output.spec.1/)

-   [DOM](packages/gen-dom/__tests__/output.spec.1/)

-   [SVG](packages/gen-svg/__tests__/output.spec.1/)

#### 使用方法

1. 安装依赖

```bash

npm install @iconfont-componentized/cli -D

```

2. 生成配置文件 `iconfont-componentized.json`

```json

{

    "$schema": "https://raw.githubusercontent.com/axetroy/iconfont-componentized/main/packages/share/src/config/schema.json",

    "defaultSize": 32,

    "classNamePrefix": "icon-font"

}

```

3. 获取 IconFont 的地址

![img](assets/1.png)

4. 添加生成脚本到 `package.json`

```json

   "script": {

       "iconfont": "iconfont-componentized --url https://at.alicdn.com/t/font_caopq7l9o8t1emi.js --config iconfont-componentized.json"

   }

```

5. 生成组件

```bash

npm run iconfont

```

### 参与贡献

```bash

git clone https://github.com/axetroy/iconfont-componentized

cd iconfont-componentized

pnpm install

pnpm test

```

### 开源许可

[ANTI-996 LICENSE](LICENSE)