2.3.1 โ€ข Published 1 month ago

svelte-range-slider-pips v2.3.1

Weekly downloads
649
License
MPL-2.0
Repository
github
Last release
1 month ago

A reactive, accessible, multi-thumb, range slider with the ability to display "pips" or "notches" along the range.
Importable as a svelte-component, or able to be used directly in any javascript application / framework.

Svelte Range Slider; focussed with pips and labels prop set

๐Ÿ“”๐Ÿ”DocsFull Documentation & Examples
๐Ÿ“โš™REPLSvelte component demo
โคโœ’CodepenPlain JS component demo

Features

Features of the range slider plugin (written below)

  • โœจ fully customisable, stylable & accessible
  • ๐Ÿ‘๐Ÿฝ multi-thumb
  • ๐ŸŽš range (min/max)
  • ๐Ÿท floating labels
  • ๐Ÿ“ ruler notches
  • ๐Ÿท labels for notches
  • ๐Ÿงฎ step function
  • ๐Ÿ– formatter
  • ๐ŸŽญ animated

Install

Open your project and use the command line to install the package;

yarn add svelte-range-slider-pips --dev          # or
npm install svelte-range-slider-pips --save-dev  # if you prefer npm

Usage

In a svelte project

Assuming you have a Svelte app up and running;

<script>
	import RangeSlider from 'svelte-range-slider-pips';
</script>

<RangeSlider values="{[50]}" pips />

As a regular JS file

If you're not building a svelte-app, you can use the /dist/ version of the script /dist/svelte-range-slider-pips.js and include it with a regular <script> tag. This should even work with jQuery.

<script src="./js/vendor/svelte-range-slider-pips.js" />

<div id="my-slider"></div>

<script>
	var mySlider = new RangeSliderPips({
		target: document.querySelector('#my-slider'),
		props: { values: [50], pips: true }
	});
</script>

As a JS module

If you're building a bleeding-edge JS application (maybe Vue or React), you might want to use js imports (import)

import RangeSlider from './node_modules/svelte-range-slider-pips/dist/svelte-range-slider-pips.mjs';

var mySlider = new RangeSlider({
	target: node, // js reference to a DOM element
	props: { values: [50], pips: true }
});

Props (options)

Slider props

proptypedefaultdescription
valuesArray[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)
minNumber0Minimum value for the slider (should be < max)
maxNumber100Maximum value for the slider (should be > min)
stepNumber1Every nth value to allow handle to stop at (should be a positive value)
rangeBoolean/StringfalseWhether to style as a range picker. Use range='min' or range='max' for min/max variants
pushyBooleanfalseIf range is true, then this boolean decides if one handle will push the other along
floatBooleanfalseSet true to add a floating label above focussed handles
verticalBooleanfalseMake the slider render vertically (lower value on bottom)
pipsBooleanfalseWhether to show pips/notches on the slider
pipstepNumber1/10/20Every nth step to show a pip for. This has multiple defaults depending on values property
firstBoolean/StringfalseWhether to show a pip or label for the first value on slider. Use first='label' to show a label value
lastBoolean/StringfalseWhether to show a pip or label for the last value on slider. Use last='label' to show a label value
restBoolean/StringfalseWhether to show a pip or label for all other values. Use rest='label' to show a label value
allBoolean/StringfalseWhether to show a pip or label for all values. Same as combining first, last and rest. Use all='label' to show a label value
prefixString""A string to prefix to all displayed values
suffixString""A string to suffix to all displayed values
reversedBooleanfalseReverse the orientation of min/max
hoverableBooleantrueWhether hover styles are enabled for both handles and pips/values
disabledBooleanfalseDetermine if the slider is disabled, or enabled (only disables interactions, and events)
idString""Give the slider a unique ID for use in styling
ariaLabelsArray[]Array of strings to use for the aria-label attribute on the handles.
formatterFunction(v,i,p) => vA function to re-format values before they are displayed (v = value, i = pip index, p = percent)
handleFormatterFunctionformatterA function to re-format values on the handle/float before they are displayed. Defaults to the same function given to the formatter property (v = value, i = handle index, p = percent)
springValuesObject{ stiffness: 0.15, damping: 0.4 }Svelte spring physics object to change the behaviour of the handle when moving
sliderElementundefinedDOM reference for binding to the main <div /> of the component (bind:slider='ref')

๐Ÿ“”๐Ÿ” | Documentation for Options

Slider events (dispatched)

eventexampleevent.detaildescription
starton:start={(e) => { ... }}{ activeHandle: Integer, value: Float, values: Array }Event fired when the user begins interaction with the slider
changeon:change={(e) => { ... }}{ activeHandle: Integer, startValue: Float, previousValue: Float, value: Float, values: Array }Event fired when the user changes the value; returns the previous value, also
stopon:stop={(e) => { ... }}{ activeHandle: Integer, startValue: Float, value: Float, values: Array }Event fired when the user stops interacting with slider; returns the beginning value, also

๐Ÿ“”๐Ÿ” | Documentation for Events

Styling

Styling should mostly be done with CSS.
There's a bunch of css variables for controlling the colors of the elements. And the slider is fluid horizontally, with the size of things controlled by font-size. So you may change the font-size on the .rangeSlider base element to change the scale of everything.

If you require more fine control of the widths, heights, etc, then you may override the default css. This can be easier by using the id prop to give your slider a unique id.

Values of labels can be styled with CSS, and the format can be modified with the formatter() function prop. And animation of the handles is controlled by the springValues object prop.

๐Ÿ“”๐Ÿ” | Documentation for Styling

Contribute

I am very happy to accept;

  • ๐ŸŒŸ suggestions/requests for new features or changes
  • ๐Ÿ›  pull-requests for bug fixes, or issue resolution
  • ๐Ÿงช help with creating a proper test-suite

Read the CONTRIBUTING.md


Support / Donate

I'd be super excited if you find this project useful and wish to donate a small amount for my efforts!

ยฃ1 One Pound Donationยฃ1 GBP donation
ยฃ5 Five Pounds Donationยฃ5 GBP donation
ยฃ10 Ten Pounds Donationยฃ10 GBP donation
3.0.0-beta.5

1 month ago

3.0.0-beta.3

2 months ago

2.3.1

2 months ago

2.3.0

2 months ago

2.2.1

8 months ago

2.2.0

8 months ago

2.2.3

6 months ago

2.2.2

8 months ago

2.1.1

1 year ago

2.1.0

1 year ago

2.0.3

2 years ago

2.0.2

2 years ago

2.0.1

2 years ago

2.0.0

2 years ago

1.8.1

3 years ago

1.8.0

3 years ago

1.7.2

3 years ago

1.7.0

3 years ago

1.6.1

3 years ago

1.6.0

3 years ago

1.5.3

3 years ago

1.5.2

3 years ago

1.5.0

3 years ago

1.4.0

4 years ago

1.3.1

4 years ago

1.2.1

4 years ago

1.2.0

4 years ago

1.1.0

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago