Skip to content

chastel/iconfont-webpack-plugin

 
 

Repository files navigation

ALPHA

This release is rather for feedback purpose than for production usage.

Icon Font Webpack Plugin

This plugin tries to keep the usage and maintainance of icon fonts as simple as possible.

Installation

npm i --save-dev iconfont-webpack-plugin

Configuration

var path = require('path');

var IconfontWebpackPlugin = require('iconfont-webpack-plugin');

  // make sure you use the postcss loader:
  module: {
    loaders: [
      {
        test: /\.css$/,
        loader: 'css-loader!postcss-loader'
      }
    ]
  },
  // add the plugin
  plugins: [
    new IconfontWebpackPlugin()
  ]

Usage

If you set this plugin up properly you can finely use a font-icon declarations in your css/scss/sass/less/...:

a:before {
  font-icon: url('./account.svg');
  transition: 0.5s color;
}

a:hover:before {
  color: red;
}

and it will be compiled into:

@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;
}

Why shouldn't I just use SVGs instead?

SVGs have some disadvantages and lack certain features especially when using inside pseudo elements.

Should I 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 or even GIFs have their use cases.

Pick the best solution for your problem - there is no silver bullet.

License

This project is licensed under MIT.

About

Simple icon font handling for webpack

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 98.4%
  • CSS 1.1%
  • HTML 0.5%