Modular Slider aims to deliver just what you want, while using the best of EcmaScript goodies. Here are some of its features:
this package ships as an esm module.
Modular Slider consists of Mixins, Plugins and a Setup function:
Mixins are objects that provide basic functionalities of the slider (i.e. touch/mouse events handling, transtions). Their names are PascalCase Currently, there are three mixins:
Plugins are functions that enrich your slider with non critical features. Their names are all lowercase. Here are the currently available plugins:
the setup function is used to combine mixins - basically this is the function that puts it all together!
First of all download the package:
npm i modular-slider
pnpm i modular-slider
yarn add modular-slider
Once you've done that, take a look at an example setup:
<!-- the markup must include:-->
<!-- an OUTER CONTAINER with .MS-wrapper MS-fixed class-->
<!-- an INNER CONTAINER with .MS-con class-->
<!-- and some slides inside - their class DOES NOT matter -->
<section class="your-slider MS-wrapper MS-fixed">
<ul id="first-slider" class="MS-con">
<li class="nested-item">1</li>
<li class="nested-item">2</li>
<li class="nested-item">3</li>
<li class="nested-item">4</li>
<li class="nested-item">5</li>
<li class="nested-item">6</li>
</ul>
</section>
<!-- add buttons for the purpose of the example -->
<section class="slider-btn">
<button id="prev">prev</button>
<button id="next">next</button>
</section>
@import "~modular-slider/dist/modular-slider.css";
.your-slider {
--number-of-slides: 6; // the number of the slides, total
--slides-per-view: 2; // the number of how many slides are displayed at once
// your css...
}
// import all the components you need
import { setup, SlideHandler, Carousel, buttons } from "modular-slider";
// merge the mixins with the setup functions
const Slider = setup(Carousel, SlideHandler);
// create a new instance
new Slider({
// pass the ID of the slider container
// pass only the name of the ID as the getElementByID methods is used
container: "slider",
// initiate selected plugins
plugins: [
// the button plugin uses the querySelector method,
// hence the # at the beginning
buttons({ nextBtn: "#next", prevBtn: "#prev" }),
],
});
You can find more examples here
by default modular slider provides two css options. They both require some css variables that you may put either in the :root or .MS-wrapper element.
e.g. the container has width set to 30rem or 80% whereas slides have width set to 50%
.your-slider.MS-wrapper {
// you DON'T have to set --number-of-slides - it's just a fallback value just in case something goes wrong
--number-of-slides: 6; // the number of the slides, total
--slides-per-view: 2; // the number of how many slides are displayed at once
--slide-margin: 25px; // the left and right margin of each element
width: 80%; // add some width
}
e.g. the container does not have a set width whereas slides have width set to 15rem
.your-slider.MS-fixed.MS-wrapper {
--slide-width: 15rem; // the width of each slide
--slide-margin: 25px; // the left and right margin of each element
--slides-per-view: 2; // the number of how many slides are displayed at once
// don't specify the width - it will be calculated based on the variables above
}
by default --slide-margin is set to 0px.
Modular Slider by design encourages users to enhance it. Don't like the event handlers? Write a mixin and change it. Want the buttons/pagination to automatically generate themselves? Write a plugin that will do that. If you have created such an improvement, fell free to share it. PRs are welcome! :fire:
These are the early days of this project, it hasn't reached v1 (stable version) yet, therefore there might be some breaking changes before releasing 1.0.0. :monocle_face::adhesive_bandage::boom: