Svelte Range Slider v3

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.

📔🔍	Docs	Full Documentation & Examples
📝⚙	REPL	Svelte component demo
❤✒	Codepen	Plain JS component demo

Features

• ✨ fully customisable
• ♿ accessible
• 👍🏽 multi-thumb
• 🎚 ranges
• 🏷 floating labels
• 📏 ruler values (pips)
• 🏷 labels for values
• 🧮 step function
• 🖍 formatter
• 🎭 animated
• 🖋 css variables

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 4/5 project

Assuming you have a Svelte app up and running;

• see test folder for examples of usage with Svelte 4
• or Svelte 5

In a svelte 3 project

⚠ Version 3 of Range Slider Pips is not compatible with Svelte 3. see below

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 `

<ul>
  <li><img alt="JS Icon" src="./public/icons/js-svgrepo-com.png" height="16"> <em>see examples of <a href="./tests/vanilla/">usage with Vanilla JS </a></em>
  </li>
  <li><img alt="jQuery Icon" src="./public/icons/jquery-svgrepo-com.png" height="16"> <em>or <a href="./tests/jquery/index.jquery.js">running with jQuery </a></em>
  </li>
</ul>

---

### As a JS module, or with Vue &amp; React

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

```js
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 }
});

• see examples of usage with ES modules
• or usage with VueJS
• or importing with ReactJS

Props (options)

Slider props

📔🔍 | Documentation for Options

Slider events (dispatched)

📔🔍 | 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

Notes

Svelte 3

Because of the code in Range Slider Pips 3, it is now incompatible with Svelte version 3.

If you are unable to upgrade your project, then I suggest looking for Svelte-Range-Slider-Pips version 2.3.1 which will not be upgraded, but it's still pretty robust. You can install it like so;

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

Support / Tip

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

		£1 GBP Tip
		£5 GBP Tip
		£10 GBP Tip