/build-react-svg

build simple svg icon (almost from sketch) to react component

Primary LanguageJavaScript

用途

自动化把 简单的svg icons（具体要求见下面的压缩规则）批量构建为react组件，并对svg进行内容压缩

const getCode = require('build-react-svg');
genCode(originDir, compsDir, demoFilePath, { defaultClass: 'lls-cc-svg-icon' });
  1. originsDir: 原始svg所在文件夹，里面的svg文件只能有一层， 不能存在 originsDir/xx/yy.svg, 只能是originsDir/yy.svg
  2. compsDir: 组件文件目录， react组件将会自己写入这个文件夹
  3. demoFilePath: 会生成一个 DemoComp, 包含所有的svg icons(样式可能需要自己写)
  4. options:
  • defaultClass, 默认是lls-svg-icon. 每个react svg 组件会加 className, 命名规则是 defaultClass + ' ' + 和fileName 的className
  • compTplStr, 生成 react component 的njk模板，默认为src/react.njk. 你可以根据需要进行微调。
  • demoTplStr, 生成 demo component 的njk模板。 用来展示所有生成的svg组件的，默认为src/demo.njk. 你可以根据需要进行微调。
  • svgo, svgo 实例，用来进行svg内容的压缩，具体参考 svgo 项目
  • force, 如果react component 已经存在，默认不覆盖，force 设为true， 强制覆盖

压缩规则

见 代码