1.0.3 • Published 4 years ago

iconfont-transform-component v1.0.3

Weekly downloads
3
License
ISC
Repository
github
Last release
4 years ago

动机

  • 组件化 Icon,由 iconfont.cn 自动生成 Icon Component

约定

  • iconfont 的命名以实例化时配置的 {namespace} 为前缀
  • font-family 的命名必须为 iconfont
  • 命名连接符使用-
  • 样式暂时只支持生成 less 与 scss 的形式,默认值为 1(0=>less,1=>scss)
  • 仅支持使用 tsx

使用

  • 安装:yarn add iconfont-transform-component --dev OR npm install iconfont-transform-component --dev

  • 项目配置:

    • 根目录下创建 icon.js 文件
      const generate = require('iconfont-transform-component')
      const path = require('path')
      function resolve(relativePath) {
      return path.resolve(__dirname, `${relativePath}`)
      }
      const iconGenerateConfig = {
      iconCssPath: resolve('src/styles/icon.css'),  // 字体文件样式
      iconFontFilePath: resolve('src/client/static/fonts'), // 字体文件存在地址
      iconComponentPath: resolve('src/client/components/common/Icon/index.tsx'), // 生成的Icon模板
      }
      generate(iconGenerateConfig)
  • package.json 的 script 新增 "icon": "node icon.js"
  • 生成 icon:命令行输入yarn icon [iconfont.css]. e.g: yarn icon //at.alicdn.com/t/font_1076605_p8g2n70z31.css OR npm run icon //at.alicdn.com/t/font_1076605_p8g2n70z31.css

  • 直接引用组件 Icon 使用