active-slider
v1.0.2
Published
Library for CSS masters. Build whatever you need with the append active class
Downloads
4
Maintainers
Readme
Active Slider
Did you ever happen when trying to build a carousel slider with a js library, and lost control over your slider design?
Active-Slider will give you the freedom to build and design whatever you need by only adding an active class. By that, you are not limited to only building a slider, but you can also build cards or even 3D elements (Examples at the end of the page).
- The Active Class - Active-Slider library has one job, adding an "active" class for your desired HTML tags.
- Keep your HTML beautiful - Active Slider library will not inject HTML, CSS or JS code.
- Full control - As a CSS master, you'll have full control over your slider with no injected Html or Css.
There is one rule, active-elements group must have the same number of elements. For example: .slide-image elements must have the same number of .bullet elements.
NPM
npm install active-slider
import ActiveSlider from 'active-slider';
new ActiveSlider({
wrapper: '.slider-wrapper',
activeElements: ['.slide-image', '.bullet'],
});
<div class="slider-wrapper">
<div>
<img class="slide-image" src="https://bit.ly/2HrOv0p">
<img class="slide-image" src="https://bit.ly/2SL9ccV">
<img class="slide-image" src="https://bit.ly/38whADW">
</div>
<div>
<div class="bullet"></div>
<div class="bullet"></div>
<div class="bullet"></div>
</div>
</div>
Options
wrapper (string)(required) - Select the wrapper element. Example: '.slider'
activeElements (array|string)(required) - Select elements to add the active class. Example: ['.slide-image', '.bullet']
swipeArea (string)(optional) - Select the element that will be the swipe area. Example: '.slide-images-container'
clickableElements (array|string)(optional) - Add the active class to the clicked element. Example: '.bullet'
prevNextButtons (array)(optional) - Select the previous and next buttons. Example: ['.prev', '.next']
autoplay (boolean)(optional) - Is autoplay. Default: true
autoplaySpeed (number)(optional) - Autoplay duration in milliseconds. Default: 3500
stopAutoPlayOnClick (string|array)(optional) - Select the elements to be the listeners for the click event in order to stop the autoplay. Example: ['.prev', '.next']
loop (boolean)(optional) - Loop elements. Default: true
firstElementActive (boolean)(optional) - Set to false in order to remove the active class from the first elements as default. Default: true
Methods
Get more control with the object methods.
import ActiveSlider from 'active-slider';
var mySlider = new ActiveSlider({
wrapper: '.slider-wrapper',
activeSlider: ['.slide-image', '.bullet'],
});
// Set the first element as active.
mySlider.first();
// Set the last element as active.
mySlider.last();
// Set the next element as active.
mySlider.next();
// Set the previous element as active.
mySlider.prev();
// Remove the active Class from all slides.
mySlider.removeAll();
// Start autoplay.
mySlider.autoplay();
// stop autoplay.
mySlider.stopAutoplay();
Examples
Slider - https://codepen.io/guycohen85/pen/GRJoxvw
Cards - https://codepen.io/guycohen85/pen/YzXqOPJ
Rubik's Cube - https://codepen.io/guycohen85/pen/MWwjwKO