coffeekraken-s-button-component

Full stack button styling for your website with buttons like outline, link, etc...


Keywords
button, webcomponent, component, html, sugar, coffee, kraken, coffeekraken
License
MIT
Install
npm install coffeekraken-s-button-component@1.0.3

Documentation

Coffeekraken s-button-component

Full stack button styling for your website with buttons like outline, link, etc...

View demo

Table of content

  1. Demo
  2. Features
  3. Install
  4. Get Started
  5. SASS API
  6. Browsers support
  7. Contribute
  8. Who are Coffeekraken?
  9. Licence

Features

  1. Full button stack with styles
    • Normal buttons
    • Outlined buttons
    • "Links" style buttons
    • disabled buttons
    • Colored buttons

Install

npm install coffeekraken-s-button-component --save

Get Started

First, import and init sugar into your project.

Then, import the component into your scss file like so:

@import 'node_modules/coffeekraken-s-button-component/index';

Then simply use it using the mixins like so to generate the classes:

@include s-button-classes(
	$colors: default primary secondary
);

And use your buttons like so:

<a class="btn" href="#" title="...">Hello world</a>
<a class="btn btn--primary" href="#" title="...">Hello world</a>
<a class="btn btn--outline" href="#" title="...">Hello world</a>
<a class="btn btn" href="#" title="...">Hello world</a>
<button class="btn" disabled>Hello world</button>
<!-- etc... -->

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.

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