Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

svelte-range-slider-pips

Package Overview
Dependencies
Maintainers
0
Versions
37
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

svelte-range-slider-pips

Multi-Thumb, Accessible, Beautiful Range Slider with Pips

  • 3.1.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
9.7K
increased by7.61%
Maintainers
0
Weekly downloads
 
Created
Source

Svelte Range Slider Logo

Svelte Range Slider v3

Code Version NPM version NPM Downloads / Month

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
  • ♿ 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 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.

<!-- in the <head> of your html -->
<script src="./js/vendor/svelte-range-slider-pips.js" />

<!-- in the <body> of your html -->
<div id="my-slider"></div>

<script>
  // this script will be run when the DOM is ready
  // and the slider is initialised
  document.addEventListener('DOMContentLoaded', () => {
    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

Keywords

FAQs

Package last updated on 29 Aug 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc