npm

Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript.Learn more »

coffeekraken-s-chip-component

1.0.1 • Public • Published

Coffeekraken s-chip-component

Provide a nice and simple chip element

View demo

Table of content

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

Install

npm install coffeekraken-s-chip-component --save

Get Started

First, import the component into your sass file and generate the classes like so:

@import 'node_modules/coffeekraken-s-chip-component/index';
@include s-chip-classes( 
  $colors: default primary secondary
);

Then simply use it inside your html like so:

<!-- default chip -->
<span class="chip">
  <span class="chip__text">Hello World</span>
  <span class="chip__addon">
    <i class="fa fa-user"></i>
  </span>
</span>
 
<!-- colored one -->
<span class="chip--primary">
  <span class="chip__addon">
    <i class="fa fa-user"></i>
  </span>
  <span class="chip__text">Hello World</span>
</span>

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-chip-component

Downloadsweekly downloads

4

version

1.0.1

license

MIT

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability