Easily integrate icons using various driver like "img", "fonticon", "svg", "fontawesome", "material" and "foundation"
Table of content
- Get Started
- Global configuration
- Sugar Web Components Documentation
- Browsers support
- Code linting
- Who are Coffeekraken?
npm install coffeekraken-s-icon-component --save
Then simply use it inside your html like so:
Here the list of drivers available and how they work:
fonticon: This driver assume that you have a fonticon in yout project.
- Generate a
<i>with class of
img: This driver create an
<img>tag and load your svg icon inside it
- Depend on the
- Generate an
<img>tag with the source
svg: This driver load the svg and put it inline in the page
- Depend on the
- Inline the svg loaded from
fontawesome: Load fontawesome and generate an
<i>tag with the proper fontawesome class
material: Load material icons and generate an
<i>tag with the proper material class
foundation: Load foundation icons and generate an
<i>tag with the proper foundation class
In order to avoid writing each time
driver="fontawesome" etc, you can configure your component globally one time then use it quicker. Here how to do that:
This code need to be run BEFORE you import the
You can then use your component with ease like so:
IE / Edge
|IE11+||last 2 versions||last 2 versions||last 2 versions|
As browsers are automatically updated, we will keep as reference the last two versions of each but this component can work on older ones as well.
The webcomponent API (custom elements, shadowDOM, etc...) is not supported in some older browsers like IE10, etc... In order to make them work, you will need to integrate the corresponding polyfill.
This package uses some code linting rules. Here's the list:
Your commits will not been accepted if the code style is not respected!
This is an open source project and will ever be! You are more that welcomed to contribute to his development and make it more awesome every day. To do so, you have several possibilities:
Who are Coffeekraken
We try to be some cool guys that build some cool tools to make our (and yours hopefully) every day life better.
The code is available under the MIT license. This mean that you can use, modify, or do whatever you want with it. This mean also that it is shipped to you for free, so don't be a hater and if you find some issues, etc... feel free to contribute instead of sharing your frustrations on social networks like an asshole...