Webcomponent wrapper around the freaking cool [Swiper](http://idangero.us/swiper/) library
Table of content
- Get Started
- SASS API
- Sugar Web Components Documentation
- Browsers support
- Code linting
- Who are Coffeekraken?
npm install coffeekraken-s-swiper-component --save
Then simply use it inside your html like so:
<!-- filled by swiper --><!-- skin this as you want... --><!-- skin this as you want... -->
Generate the styles for the pagination if wanted like so:
This will gives you access to classes:
s-swiper: default color
s-swiper[color="primary"]: primary color
s-swiper[color="secondary"]: secondary color
This use the sugar colors system
This webcomponent support every options that Swiper has to offer. You can set them using the html attributes or by using the
setDefaultProps like so:
<!-- your swiper here... -->
To keep the package size as small as possible, the webcomponent does not load all the Swiper modules. Here's the ones that are loaded and we think this is more than enough:
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:
- Stylelint with stylelint-config-standard for
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...