Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jantimon/iconfont-webpack-plugin
Simple icon font handling for webpack
https://github.com/jantimon/iconfont-webpack-plugin
css icon-font postcss webpack
Last synced: 6 days ago
JSON representation
Simple icon font handling for webpack
- Host: GitHub
- URL: https://github.com/jantimon/iconfont-webpack-plugin
- Owner: jantimon
- License: mit
- Created: 2016-09-13T11:41:37.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-01-22T20:47:19.000Z (12 months ago)
- Last Synced: 2024-12-29T10:12:35.067Z (13 days ago)
- Topics: css, icon-font, postcss, webpack
- Language: JavaScript
- Size: 3.24 MB
- Stars: 112
- Watchers: 6
- Forks: 38
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- stars - jantimon/iconfont-webpack-plugin
README
# Icon Font Webpack Plugin
[](http://badge.fury.io/js/iconfont-webpack-plugin) [](https://david-dm.org/jantimon/iconfont-webpack-plugin) [](https://github.com/jantimon/iconfont-webpack-plugin/actions/)
[](https://codepen.io/jantimon/pen/YoKewb)
This plugin tries to keep the usage and maintenance of icon fonts as simple as possible.
```css
a:before {
font-icon: url('./account.svg');
}
```
Browser Support: IE9+
Preprocessor Support: All - works with sass, less, stylus, postcss, vanilla css, ...
# Requirements
This plugin requires:
+ webpack 3.x or higher
+ postcss-loader 2.x or higher
+ css-loader 3.x or higher
+ node 10 or higher
## Installation
```bash
npm i --save-dev postcss-loader webpack css-loader
npm i --save-dev iconfont-webpack-plugin
```
## Configuration
All you have to do is to add the plugin to your postcss loader plugins inside your `webpack.config.js`:
```js
const IconfontWebpackPlugin = require('iconfont-webpack-plugin');
module: {
rules: [
{
test: /\.css$/,
use: [
'css-loader',
{
loader: 'postcss-loader',
options: {
postcssOptions: (loader) => {
return {
plugins: [
new IconfontWebpackPlugin({
resolve: loader.resolve
})
]
};
}
}
}
]
}
]
}
```
## Advanced Configuration
Probably you won't need this but you can also pass some additional options.
|Name|Type|Default|Description|
|:--:|:--:|:-----:|:----------|
|**`resolve`**|`{Function}`||Required - A function which resolves the svg paths. See [resolve](https://webpack.js.org/api/loaders/#this-resolve)|
|**`fontNamePrefix`**|`{String}`|`''`| Allows to prefix the generated font name |
|**`enforcedSvgHeight`**|`{number}`|`1000`| Scales all svg to the given height |
```js
const IconfontWebpackPlugin = require('iconfont-webpack-plugin');
module: {
rules: [
{
test: /\.css$/,
use: [
'css-loader',
{
loader: 'postcss-loader',
postcssOptions: (loader) => {
return {
plugins: [
new IconfontWebpackPlugin({
resolve: loader.resolve,
fontNamePrefix: 'custom-',
enforcedSvgHeight: 3000,
})
]
};
}
}
]
}
]
}
```
## Usage
After setting up the plugin your css has now a new feature:
`font-icon` declarations
```css
a:before {
font-icon: url('./account.svg');
transition: 0.5s color;
}
a:hover:before {
color: red;
}
```
and it will be compiled into:
```css
@font-face {
font-family: i96002e;
src: url("data:application/x-font-woff;charset=utf-8;base64,d09GRgABAAAAA.....IdAA==") format('woff');
}
a:before {
font-family: i96002e;
content: '\E000';
transition: 0.5s color;
}
a:hover:before {
color: red;
}
```
## Icon sizes
Shorthand for setting the icon size and the icon:
```css
a:before {
font-icon: 80% url('./account.svg');
}
```
## SVG Requirements
The main work of the iconfont-webpack-plugin is done by [svg2ttf](https://github.com/fontello/svg2ttf) which converts svgs into fonts.
Therefore it inherits all its [limitations](https://github.com/fontello/fontello/wiki/How-to-use-custom-images#importing-svg-images).
1. Remove all fills and colors. You can probably leave black fills. In fonts, fill is defined by contour direction. Make sure that you don't have any complex rules like evenodd fills.
2. Remove all FAT line attributes. This is not supported by Fontello. In fonts, fat lines are drown by 2 nested contours.
3. Join all contours to a single outline. This is the last and the most important step. Usually editors automatically set the correct contour direction depending on nesting and black fills.
## Should you use icon fonts for everything?
No.
Icon fonts are really good for decorative icons (where the icon is purely ornamental and doesn’t incorporate core meaning or functionality).
For critical icons without fallbacks (like a hamburger menu icon) you should rather use SVGs.
But also JPEGs, PNGs and even GIFs have their use cases.
Pick the best solution for your problem - there is no silver bullet.
With this plugin it is pretty easy to use pixel images, svgs and font-icons side by side.
## When should you use icon fonts over pure SVGs?
SVGs have some disadvantages and lack certain features especially when used inside pseudo elements:
* [CSS-Transform issues in older Internet Explorer versions](http://stackoverflow.com/questions/21298338/css-transform-on-svg-elements-ie9)
* [IE9 - IE 11 scaling issues](https://gist.github.com/larrybotha/7881691)
* Fill color doesn't work for background SVG images
* Inline SVGs are resolved relative to the page not to the css
* You want to use background-clip:text
## What about all the rant on icon fonts?
Like all technologies there are disadvantages when using icon fonts.
We tried to apply best practices to solve the main issues for you.
* Screen Reader friendly: All generated icons use the [Unicode Private Use Areas](https://en.wikipedia.org/wiki/Private_Use_Areas)
* Prevents [FOUT](http://www.paulirish.com/2009/fighting-the-font-face-fout/)
# License
This project is licensed under [MIT](https://github.com/jantimon/iconfont-webpack-plugin/blob/master/LICENSE).