UNPKG

2.35 kBMarkdownView Raw
1# iconfont-builder
2
3## 简介
4
5我是一个通过 svg 文件生成字体文件的包，对比其他同类型的包，我们的包存在以下优势：
6
7- ~~用了以后会变帅；~~
8- 能不生成字体文件而仅产出每个 svg 压缩过后的 **d** 属性；
9- 能仅通过图标的 **d** 属性生成字体。
10
11## 安装 (通过 [npm](https://npmjs.org/package/iconfont-builder))
12
13```bash
14$ npm i --save iconfont-builder
15```
16
17## 使用
18
19### 简单案例
20
21```js
22var builder = require('iconfont-builder');
23var path = require('path');
24
25var options = {
26 // 图标信息
27 icons: [
28 {
29 name: 'www-font-o',
30 file: 'abc.svg',
31 codepoint: 61441
32 }
33 ],
34 // 图标文件夹
35 src: path.join(__dirname, 'src'),
36 // 生成字体名称
37 fontName: 'iconfont',
38 // 整体偏移量
39 descent: 0,
40 // 字体生成位置
41 dest: path.join(__dirname, 'dest')
42};
43
44builder(options)
45 .then().catch();
46```
47
48### options 参数
49
50#### icons
51
52类型: `Array<Object>`
53
54例子:
55
56```js
57{
58 name: 'www-font-o', // 图标样式名
59 file: 'abc.svg', // 图标文件名
60 codepoint: 61441 // 图标 unicode，这里是十进制，也可以用16进制
61}
62```
63
64#### writeFiles
65
66类型: `Boolean`
67
68默认值: `true`
69
70这个参数如果设定为 `true` 表示生成四个字体文件，如果设定为 `false` 则进行以下操作：
71
72- 对所有 svg 文件进行压缩（最终压缩为一个只有 d 属性的 path）
73- 返回每个 svg 对应 path 的 d 属性
74- 不生成字体文件
75
76#### readFiles
77
78类型: `Boolean`
79
80默认值: `true`
81
82这个参数表示是否通过 svg 文件来生成字体，如果为 `false`，则 `icons` 数组里的每个图标对象都必须要有 d 属性。
83
84#### fontName
85
86类型: `String`
87
88默认值: `'iconfont'`
89
90生成的字体文件名。
91
92#### startCodePoint
93
94类型: `Number`
95
96默认值: `0xF000`
97
98图标开始编码，可以是10进制或16进制。当 `options` 参数里没有 `icons` 数组的时候，将会使用这一属性作为字体开始编码，之后的字体编码将依次加一。
99
100#### src
101
102类型: `String`
103
104默认值: `'.'`
105
106svg 文件所处的文件夹。
107
108#### dest
109
110类型: `String`
111
112生成字体的目标文件夹。
113
114#### descent
115
116类型: `Number`
117
118默认值: `0`
119
120字体偏移量，可以用来修正整体字体偏移。