Getting started

Thanks for being interested in using Sliderm. If you are looking for a simple slider library, you got a right place. The packed size of sliderm.js is less than 19 KB, extremely lightweight and flexible, easy to extend it for your needs.


npm install sliderm

Once you have installed Sliderm via NPM, you can import the JavaScript and CSS code.

import Sliderm from 'sliderm';
import 'sliderm/src/assets/scss/index.scss';

Or, just put the JavaScript and CSS into your HTML.

<link rel="stylesheet" href="node_modules/sliderm/dist/css/sliderm.css">
<script src="node_modules/sliderm/dist/js/sliderm.js"></script>


<link rel="stylesheet" href="">
<script src=""></script>

This documentation webiste is hosted on GitHub Page, the library is available to use directly as well.

HTML makeup

The HTML makeup is required for intializing Sliderm.

<div id="exampe-slider" class="sliderm">
    <div class="sliderm__slider">
        <div class="sliderm__slides">
            <div class="sliderm__slide"><img src="./demo/1.jpg" /></div>
            <div class="sliderm__slide"><img src="./demo/2.jpg" /></div>
            <div class="sliderm__slide"><img src="./demo/3.jpg" /></div>
            <div class="sliderm__slide"><img src="./demo/4.jpg" /></div>
            <div class="sliderm__slide"><img src="./demo/5.jpg" /></div>

How to use

Initializing the Sliderm is quite simple, the first parameter is the CSS selector of the slider you want to activate, the second parameter is the configuration options.

const sliderm = new Sliderm('#exampe-slider', {
  arrow: true,
  pagination: true,
  grouping: false,
  loop: true,
  preview: false,
  columns: 4,
  duration: 1000,
  spacing: 10,
  align: 'center',


sliderm.on('slide.start', () => {
  console.log('Just starting to slide!');

sliderm.on('slide.end', () => {
  console.log('The slider is stopped.');

That’s it.