handle-sliderjs
v1.3.1
Published
A package for creating customzable sliders with handles displaying the slider value.
Downloads
75
Readme
SliderJS
So you like sliders ? Congratulations you are at the right place ! Create simple and responsive range sliders with ease thanks to SliderJS :
Getting Started
Without NodeJS
In your HTML document add these two lines of code to your header :
<link rel="stylesheet" href="./path/to/style2.min.css">
<script defer src="./path/to/slider.min.js"></script>
The first line is the stylesheet needed to render sliders properly, you can choose from various themes in the ./dist/css/ folder. The second line is the actual script needed to enable the slider object in your code. You can find it at ./dist/slider.min.js
Using NodeJS
Just add these lines in your javascript / typescript file :
import { Slider } from "handle-sliderjs";
import * as sliderStyle from "handle-sliderjs/dist/css/style2.css";
sliderStyle.default;
Note that you can choose from 6 different styles for your sliders, just change the number in the import of the stylesheet.
Creating a slider
Now in your javascript file, you can create a new Slider using this signature :
let slider = new Slider(sliderId: string, parentElement: HTMLElement, minValue: number, maxValue: number, initialValue: number, onSlideCallback: (value: number) => void);
Note that the callback function is optional and can also be defined later using :
slider.onSlide = callbackFunction;
Methods
In many cases the use of the callback function is optional, it is set to true by default.
Increment the value of your slider by one using :
slider.increment(useCallback = true): void;
Decrement the value of your slider by one using :
slider.decrement(useCallback = true): void;
Return the value of your slider using :
slider.getValue(): number;
Set the value of your slider using :
slider.setValue(newValue: number, useCallback = true): void;
Update manually the state of your slider using :
slider.update(useCallback = true): void;
Reset manually your slider to its initial state using :
slider.reset(useCallback = true): void;
Remove your slider element using :
slider.remove(): void;