svelte-range-slider-pips
@ npm
A reactive, accessible, multi-thumb, range slider for use in a svelte application; with the ability to display "pips" or "notches" along the range.
🔗 For full documentation and examples, see the Github Pages
Open your project and use the command line to install the package;
yarn add --dev svelte-range-slider-pips # or
npm install --save-dev svelte-range-slider-pips # if you prefer npm
Assuming you have a Svelte app up and running;
<script>
import RangeSlider from "svelte-range-slider-pips";
</script>
<RangeSlider />
prop | type | default | description |
---|---|---|---|
values | Array |
[50] |
Array of values to apply on the slider. Multiple values creates multiple handles. (note: A slider with range property set can only have two values max) |
min | Number |
0 |
Minimum value for the slider |
max | Number |
100 |
Maximum value for the slider |
step | Number |
1 |
Every nth value to allow handle to stop at |
range | Boolean /String |
false |
Whether to style as a range picker. Use range='min' or range='max' for min/max variants |
float | Boolean |
false |
Set true to add a floating label above focussed handles |
vertical | Boolean |
false |
Make the slider render vertically |
pips | Boolean |
false |
Whether to show pips/notches on the slider |
pipStep | Number |
1 /10 /20 |
Every nth step to show a pip for. This has multiple defaults depending on values property |
first | Boolean /String |
false |
Whether to show a pip or label for the first value on slider. Use first='label' to show a label value |
last | Boolean /String |
false |
Whether to show a pip or label for the last value on slider. Use last='label' to show a label value |
rest | Boolean /String |
false |
Whether to show a pip or label for the all other values. Use rest='label' to show a label value |
prefix | String |
"" |
A string to prefix to all displayed values |
suffix | String |
"" |
A string to suffix to all displayed values |
formatter | Function |
(v) => v |
A function to re-format values before they are displayed |
handleFormatter | Function |
formatter |
A function to re-format values on the handle/float before they are displayed. Defaults to the same function given to the formatter property |
springValues | Object |
{ stiffness: 0.15, damping: 0.4 } |
Svelte spring physics object to change the behaviour of the handle when moving |