{"id":20463713,"url":"https://github.com/iconfont-cli/mini-program-iconfont-cli","last_synced_at":"2025-04-07T05:14:09.314Z","repository":{"id":35088472,"uuid":"205117266","full_name":"iconfont-cli/mini-program-iconfont-cli","owner":"iconfont-cli","description":"把iconfont图标批量转换成多个平台小程序的标准组件。支持多色彩，支持自定义颜色","archived":false,"fork":false,"pushed_at":"2022-03-24T17:23:37.000Z","size":152,"stargazers_count":330,"open_issues_count":22,"forks_count":64,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-13T22:47:10.896Z","etag":null,"topics":["iconfont","iconfont-cli","micro-app","mini-program"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iconfont-cli.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-08-29T08:30:21.000Z","updated_at":"2024-04-05T06:39:43.000Z","dependencies_parsed_at":"2022-08-08T05:00:39.170Z","dependency_job_id":null,"html_url":"https://github.com/iconfont-cli/mini-program-iconfont-cli","commit_stats":null,"previous_names":["fwh1990/mini-program-iconfont-cli"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iconfont-cli%2Fmini-program-iconfont-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iconfont-cli%2Fmini-program-iconfont-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iconfont-cli%2Fmini-program-iconfont-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iconfont-cli%2Fmini-program-iconfont-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iconfont-cli","download_url":"https://codeload.github.com/iconfont-cli/mini-program-iconfont-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247595335,"owners_count":20963943,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["iconfont","iconfont-cli","micro-app","mini-program"],"created_at":"2024-11-15T13:12:49.247Z","updated_at":"2025-04-07T05:14:09.291Z","avatar_url":"https://github.com/iconfont-cli.png","language":"TypeScript","readme":"# mini-program-iconfont-cli\n\n把iconfont图标批量转换成多个平台小程序的组件。不依赖字体，支持多色彩。\n\n![](https://github.com/fwh1990/mini-program-iconfont-cli/blob/master/images/multi-color-icon.jpg?raw=true)\n\n# 支持平台：\n- 微信小程序\n- 支付宝小程序\n- 百度小程序\n- 头条小程序（字节跳动）\n- 快手小程序\n- QQ小程序\n- ...\n\n# 特性\n1、纯组件\n\u003cbr\u003e\n2、不依赖字体文件\n\u003cbr\u003e\n3、支持px和rpx两种格式\n\u003cbr\u003e\n4、原样渲染多色彩图标\n\u003cbr\u003e\n5、图标颜色可定制\n\n# Step 1\n安装插件\n```bash\n# Yarn\nyarn add mini-program-iconfont-cli --dev\n\n# Npm\nnpm install mini-program-iconfont-cli --save-dev\n```\n\n# Step 2\n生成配置文件\n```bash\nnpx iconfont-init\n\n# 可传入配置文件输出路径\n# npx iconfont-init --output iconfont.json\n```\n\n此时项目根目录会生成一个`iconfont.json`的文件，内容如下：\n```json\n{\n  \"symbol_url\": \"请参考README.md，复制 http://iconfont.cn 官网提供的JS链接\",\n  \"save_dir\": \"./iconfont\",\n  \"use_rpx\": false,\n  \"trim_icon_prefix\": \"icon\",\n  \"default_icon_size\": 18\n}\n```\n\n### 配置参数说明：\n#### symbol_url\n请直接复制[iconfont](http://iconfont.cn)官网提供的项目链接。请务必看清是`.js`后缀而不是`.css`后缀。如果你现在还没有创建iconfont的仓库，那么可以填入这个链接去测试：`http://at.alicdn.com/t/font_1373348_kk9y3jk2omq.js`。\n\n![](https://github.com/fwh1990/mini-program-iconfont-cli/blob/master/images/symbol-url.png?raw=true)\n\n#### save_dir\n根据iconfont图标生成的组件存放的位置。每次生成组件之前，该文件夹都会被清空。\n\n#### use_rpx\n使用微信提供的[尺寸单位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`。默认值为false，即使用`px`。\n\n#### trim_icon_prefix\n如果你的图标有通用的前缀，而你在使用的时候又不想重复去写，那么可以通过配置这个选项把前缀统一去掉。\n\n#### default_icon_size\n我们将为每个生成的图标组件加入默认的字体大小，当然，你也可以通过传入props的方式改变这个size值。\n\n# Step 3\n生成小程序标准组件\n```bash\n# 可传入配置文件路径\n# npx iconfont-XXXXX --config iconfont.json\n\n# 微信小程序\nnpx iconfont-wechat\n\n# 支付宝小程序\nnpx iconfont-alipay\n\n# 百度小程序\nnpx iconfont-baidu\n\n# 头条小程序\nnpx iconfont-toutiao\n\n# 快手小程序\nnpx iconfont-kuaishou\n\n# QQ小程序\nnpx iconfont-qq\n```\n生成后查看您设置的保存目录中是否含有所有的图标\n\n-------\n\n在生成代码之前，你可以顺便参考[snapshots目录](https://github.com/iconfont-cli/mini-program-iconfont-cli/tree/master/snapshots)自动生成的快照文件。\n\n# Step 4\n#### 微信小程序 | QQ小程序\n在根目录的`app.json`文件中引入全局图标组件，避免每个page都引入（麻烦）。\n```json5\n// 绝对路径\n{\n    \"usingComponents\": {\n        \"iconfont\": \"/iconfont/iconfont\"\n    }\n}\n```\n\n#### 支付宝小程序 | 百度小程序 | 头条小程序 ｜ 快手小程序\n不支持全局引入，您需要在各自page的`.json`文件中引入。\n```json5\n// 绝对路径\n{\n  \"usingComponents\": {\n    \"iconfont\": \"/iconfont/iconfont\"\n  }\n}\n```\n\n# 使用\n在page中使用图标。\n```jsx harmony\n// 原色彩\n\u003ciconfont name=\"alipay\" /\u003e\n\n// 单色：红色\n\u003ciconfont name=\"alipay\" color=\"red\" /\u003e\n\n// 多色：红色+橘色\n\u003ciconfont name=\"alipay\" color=\"{{['red', 'orange']}}\" size=\"300\" /\u003e\n\n// 不同格式的颜色写法\n\u003ciconfont name=\"alipay\" color=\"{{['#333', 'rgb(50, 124, 39)']}}\" /\u003e\n\n// 与文字对齐\n\u003cview style=\"display: flex; alignItems: center;\"\u003e\n  \u003ctext\u003eHello\u003c/text\u003e\n  \u003ciconfont name=\"alipay\" /\u003e\n\u003c/view\u003e\n```\n\n# 更新图标\n当您在iconfont.cn中的图标有变更时，只需更改配置`symbol_url`，然后再次执行`Step 3`即可生成最新的图标组件。\n```bash\n# 修改 symbol_url 配置后执行：\n\n# 微信小程序\nnpx iconfont-wechat\n\n# 支付宝小程序\nnpx iconfont-alipay\n\n# 百度小程序\nnpx iconfont-baidu\n\n# 头条小程序\nnpx iconfont-toutiao\n\n# 快手小程序\nnpx iconfont-kuaishou\n\n# QQ小程序\nnpx iconfont-qq\n```\n\n--------\n\n欢迎使用，并给我一些反馈和建议，让这个库做的更好。\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficonfont-cli%2Fmini-program-iconfont-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ficonfont-cli%2Fmini-program-iconfont-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ficonfont-cli%2Fmini-program-iconfont-cli/lists"}