mirror of
https://github.com/tabler/tabler-icons.git
synced 2025-09-03 02:42:55 +02:00
Update README.md
This commit is contained in:
36
README.md
36
README.md
@@ -217,7 +217,7 @@ The default settings if you have not defined the file will be:
|
|||||||
{
|
{
|
||||||
"includeIcons": [],
|
"includeIcons": [],
|
||||||
"fontForge": "fontforge",
|
"fontForge": "fontforge",
|
||||||
"strokeWidth": 2
|
"strokeWidth": null
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -228,13 +228,13 @@ The fontforge executable needs to be in the path or you can set the path to the
|
|||||||
"fontForge": "/Applications/FontForge.app/Contents/MacOS/FontForge"
|
"fontForge": "/Applications/FontForge.app/Contents/MacOS/FontForge"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
To compile the fonts run:
|
To compile the fonts run:
|
||||||
```sh
|
```sh
|
||||||
npm run build-iconfont
|
npm run build-iconfont
|
||||||
```
|
```
|
||||||
|
|
||||||
By default the stroke width is 2. You can change the stroke width in the compile-options.json
|
By default the stroke width is 2. You can change the stroke width in the `compile-options.json`
|
||||||
|
|
||||||
```JSON
|
```JSON
|
||||||
{
|
{
|
||||||
"strokeWidth": 1.5,
|
"strokeWidth": 1.5,
|
||||||
@@ -249,6 +249,36 @@ To reduce the font file size you can choose to compile a sub set of icons. When
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Optional property `includeCategories` - an array or string of icon categories to include, category names are case-issensetive.
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"includeCategories": ["Devices", "System"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
or
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"includeCategories": "Devices System"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Optional property `excludeIcons` - an array of icon names using to exclude some category icons:
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"includeCategories": ["system"],
|
||||||
|
"excludeIcons": ["adjustments"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Complex solution:
|
||||||
|
```JSON
|
||||||
|
{
|
||||||
|
"includeIcons": ["alert-octagon", "alert-triangle"],
|
||||||
|
"includeCategories": ["devices", "system"],
|
||||||
|
"excludeIcons": ["adjustments"]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### Svelte
|
### Svelte
|
||||||
|
|
||||||
You can use [`tabler-icons-svelte`](https://github.com/benflap/tabler-icons-svelte) to use icons in your Svelte projects (see [example](https://svelte.dev/repl/e80dc63d7019431692b10a77525e7f99?version=3.31.0)):
|
You can use [`tabler-icons-svelte`](https://github.com/benflap/tabler-icons-svelte) to use icons in your Svelte projects (see [example](https://svelte.dev/repl/e80dc63d7019431692b10a77525e7f99?version=3.31.0)):
|
||||||
|
Reference in New Issue
Block a user