Need private packages and team management tools?Check out npm Teams »

coffeekraken-s-icon-component

1.0.8 • Public • Published

Coffeekraken s-icon-component

Easily integrate icons using various driver like "img", "fonticon", "svg", "fontawesome", "material" and "foundation"

View demo

Table of content

  1. Demo
  2. Install
  3. Get Started
  4. Drivers
  5. Global configuration
  6. Javascript API
  7. Sugar Web Components Documentation
  8. Browsers support
  9. Code linting
  10. Contribute
  11. Who are Coffeekraken?
  12. Licence

Install

npm install coffeekraken-s-icon-component --save

Get Started

First, import the component into your javascript file like so:

import SIconComponent from "coffeekraken-s-icon-component"

Then simply use it inside your html like so:

<s-icon icon="address-book" driver="fontawesome"></s-icon>
<s-icon icon="my-cool-icon" driver="svg" icons-path="/icons"></s-icon>

Drivers

Here the list of drivers available and how they work:

  1. fonticon : This driver assume that you have a fonticon in yout project.
  • Generate a <i> with class of icon-{icon}
  1. img : This driver create an <img> tag and load your svg icon inside it
  • Depend on the iconsPath property
  • Generate an <img> tag with the source {iconsPath}/{icon}.svg
  1. svg : This driver load the svg and put it inline in the page
  • Depend on the iconsPath property
  • Inline the svg loaded from {iconsPath}/{icon}.svg
  1. fontawesome : Load fontawesome and generate an <i> tag with the proper fontawesome class
  2. material : Load material icons and generate an <i> tag with the proper material class
  3. foundation : Load foundation icons and generate an <i> tag with the proper foundation class

Global configuration

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:

import SWebComponent from "coffeekraken-sugar/js/core/SWebComponent"
SWebComponent.setDefaultProps(
  {
    driver: "svg",
    iconsPath: "/icons"
  },
  "s-icon"
)

This code need to be run BEFORE you import the coffeekraken-s-icon-component.

You can then use your component with ease like so:

<s-icon icon="my-cool-icon"></s-icon>

Browsers support

IE / Edge
IE / Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
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.

Code linting

This package uses some code linting rules. Here's the list:

  1. StandardJS for javascript files
  2. Stylelint with stylelint-config-standard for scss files

Your commits will not been accepted if the code style is not respected!

Contribute

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:

  1. Share the love ❤️
  2. Declare issues
  3. Fix issues
  4. Add features
  5. Build web component

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.

More on who we are

License

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...

Install

npm i coffeekraken-s-icon-component

DownloadsWeekly Downloads

3

Version

1.0.8

License

MIT

Unpacked Size

1.2 MB

Total Files

181

Last publish

Collaborators

  • avatar