Home

Awesome

<div align="center"> <a href="https://www.npmjs.com/package/@vueform/slider" target="_blank"> <img alt="npm" src="https://img.shields.io/npm/dm/@vueform/slider?color=%2353ca2f"> </a> <img alt="CircleCI" src="https://img.shields.io/circleci/build/github/vueform/slider"> <a href="https://codecov.io/gh/vueform/slider" target="_blank"> <img src="https://img.shields.io/codecov/c/github/vueform/slider"/> </a> <a href="https://www.npmjs.com/package/@vueform/slider" target="_blank"> <img alt="npm bundle size (scoped version)" src="https://img.shields.io/bundlephobia/minzip/@vueform/slider?color=53ca2f"> </a> <a href="https://discord.gg/WhX2nG6GTQ" target="_blank"> <img alt="Discord" src="https://img.shields.io/discord/787237947635793940"> </a> <a href="https://www.npmjs.com/package/@vueform/slider" target="_blank"> <img alt="npm" src="https://img.shields.io/npm/v/@vueform/slider"> </a> <h1>Vue 3 Slider</h1> <a href="https://vueform.com?cid=toggle" target="_blank"> <br> <img align="center" src="https://github.com/vueform/slider/raw/main/assets/logo.svg" width="110"> <br> </a> <br> <br> <a href="https://www.npmjs.com/package/@vueform/slider" target="_blank"> <img align="center" src="https://github.com/vueform/slider/raw/main/assets/screenshot-1.png"> </a> <br> </div>

Sponsors

<div align="center"><br> <a href="https://vueform.com?cid=toggle"><img src="https://github.com/vueform/slider/raw/main/assets/logo-horizontal.svg" width="200"></a> </div>

About Vueform

<a href="https://vueform.com?cid=slider"> <img align="center" src="https://github.com/vueform/multiselect/raw/main/assets/vueform-banner.png" alt="Vueform" title="Vueform"> </a> <br> <br>

Vueform is comprehensive form development framework for Vue.js. It supercharges and standardizes the entire form building process and takes care of everything from rendering to validation and processing. With our latest tool, the Drag and Drop Form Builder, you can allow your developers & non-tech workforce to build the most complex forms without coding.

Feature highlights:

<a href="https://builder.vueform.com/demo?cid=slider"> <img align="center" src="https://github.com/vueform/multiselect/raw/main/assets/builder-banner.png" alt="Vueform Builder" title="Vueform Builder"> </a> <br> <br>

Learn more:

Other libraries

Slider features

Sections

Demo

Check out our demo.

Installation

npm install @vueform/slider

Using with Vue 3

<template>
  <div>
    <Slider v-model="value" />
  </div>
</template>

<script>
  import Slider from '@vueform/slider'

  export default {
    components: {
      Slider,
    },
    data() {
      return {
        value: 20
      }
    }
  }
</script>

<style src="@vueform/slider/themes/default.css"></style>

Using with Vue 2

<template>
  <div>
    <Slider v-model="value" />
  </div>
</template>

<script>
  import Slider from '@vueform/slider/dist/slider.vue2.js'

  export default {
    components: {
      Slider,
    },
    data() {
      return {
        value: 20
      }
    }
  }
</script>

<style src="@vueform/slider/themes/default.css"></style>

Using with < Vue 2.7

Switch to <= 2.0.10 to use the Slider with Vue.js < 2.7.

Support

Join our Discord channel or open an issue.

Configuration

Basic props

NameTypeDefaultDescription
idstringsliderThe id attribute of slider container DOM.
lazybooleantrueWhether to update v-model only when the slider value is set and not while dragging. If disabled you must not use inline objects as props (eg. format, options, classes) but outsource them to a data property.
disabledbooleanfalseWhether the slider should be disabled.
minnumber0Minimum value of the slider.
maxnumber100Maximum value of the slider.
stepnumber1The jump between intervals. If -1 it enables fractions (eg. 1.23).
tooltipsbooleantrueWhether tooltips should show above handlers.
showTooltipstring'always'When tooltips should be shown. Possible values: always|focus|drag.
mergenumber-1The step distance between two handles when their tooltips should be merged (when step is -1 then 1 is assumed). Eg: <br><br> { merge: 5, step: 10 } <br> -> values: 0, <=50 will merge <br> -> values: 0, 60 will not merge <br><br> { merge: 5, step: -1 } <br> -> values: 0, <=5 will merge <br> -> values: 0, 5.01 will not merge
formatobject|functionFormats the tooltip. It can be either a function that receives a value param and expects a string or number as return or an object with the following properties: <br> prefix - eg $ -> $100 <br> suffix - eg USD -> 100USD <br> decimals - eg 2 -> 100.00 <br> thousand - eg , - 1,000
orientationstring'horizontal'The orientation of the slider. Possible values: horizontal|vertical
directionstring'ltr'The direction of the slider. By default value increases left-to-right and top-to-bottom, which is reversed when using rtl. Possible values: ltr|rtl
tooltipPositionstringnullThe position of the slider tooltips. Possible values: null|'top'|'bottom'|'left'|'right' depending on orientation prop. When null it equals to orientation default ('top' for 'horizontal' and 'left' for 'vertical').
ariaobjectAn object containing aria attributes to be added for each handle.
ariaLabelledbystringnullSets the aria-labelledby attribute of handles.
optionsobject{}Additional options for noUiSlider.
classesobjectAn object of class names that gets merged with the default values. Default:<br>{<br>  target: 'slider-target',<br>  ltr: 'slider-ltr',<br>  rtl: 'slider-rtl',<br>  horizontal: 'slider-horizontal',<br>  vertical: 'slider-vertical',<br>  textDirectionRtl: 'slider-txt-dir-rtl',<br>  textDirectionLtr: 'slider-txt-dir-ltr',<br>  base: 'slider-base',<br>  connects: 'slider-connects',<br>  connect: 'slider-connect',<br>  origin: 'slider-origin',<br>  handle: 'slider-handle',<br>  handleLower: 'slider-handle-lower',<br>  handleUpper: 'slider-handle-upper',<br>  touchArea: 'slider-touch-area',<br>  tooltip: 'slider-tooltip',<br>  tooltipTop: 'slider-tooltip-top',<br>  tooltipBottom: 'slider-tooltip-bottom',<br>  tooltipLeft: 'slider-tooltip-left',<br>  tooltipRight: 'slider-tooltip-right',<br>  active: 'slider-active',<br>  draggable: 'slider-draggable',<br>  tap: 'slider-state-tap',<br>  drag: 'slider-state-drag'<br>}
<a href="https://vueform.com?ref=ghb"> <img align="center" src="https://github.com/vueform/multiselect/raw/main/assets/vueform-banner.png" alt="Vueform" title="Vueform"> </a>

Events

EventAttributesDescription
@changevalueEmitted when dragging the slider is finished or it's value changed by clicking, keyboard or programmatical set.
@updatevalueEmitted in the same scenarios as in @change, but also when the slider is being dragged if lazy option is disabled.
@setvalueEmitted in the same scenarios as in @change, but also when the slider's .set() method is called.
@slidevalueEmitted while the slider moves.
@dragvalueEmitted the slider connect moves while dragging.
@startvalueEmitted when the handle is activated and dragging started.
@endvalueEmitted when the dragging ended.

Styling

Styling with CSS vars

The following CSS variables can be used to customize slider when using default.css:

--slider-bg: #D1D5DB;
--slider-connect-bg: #10B981;
--slider-connect-bg-disabled: #9CA3AF;
--slider-height: 6px;
--slider-vertical-height: 300px;
--slider-radius: 9999px;

--slider-handle-bg: #fff;
--slider-handle-border: 0;
--slider-handle-width: 16px;
--slider-handle-height: 16px;
--slider-handle-radius: 9999px;
--slider-handle-shadow: 0.5px 0.5px 2px 1px rgba(0,0,0,.32);
--slider-handle-shadow-active: 0.5px 0.5px 2px 1px rgba(0,0,0,.42);
--slider-handle-ring-width: 3px;
--slider-handle-ring-color: #10B98130;

--slider-tooltip-font-size: 0.875rem;
--slider-tooltip-line-height: 1.25rem;
--slider-tooltip-font-weight: 600;
--slider-tooltip-min-width: 20px;
--slider-tooltip-bg: #10B981;
--slider-tooltip-bg-disabled: #9CA3AF;
--slider-tooltip-color: #fff;
--slider-tooltip-radius: 5px;
--slider-tooltip-py: 2px;
--slider-tooltip-px: 6px;
--slider-tooltip-arrow-size: 5px;
--slider-tooltip-distance: 3px;

Override them globally:

:root {
  --slider-connect-bg: #3B82F6;
  --slider-tooltip-bg: #3B82F6;
  --slider-handle-ring-color: #3B82F630;
}

Or on instance level:

<Slider
  v-model="value"
  class="slider-red"
/>

<Slider
  v-model="value"
  class="slider-blue"
/>
.slider-red {
  --slider-connect-bg: #EF4444;
  --slider-tooltip-bg: #EF4444;
  --slider-handle-ring-color: #EF444430;
}

.slider-blue {
  --slider-connect-bg: #3B82F6;
  --slider-tooltip-bg: #3B82F6;
  --slider-handle-ring-color: #3B82F630;
}

Styling with Tailwind CSS

To use the slider with Tailwind CSS you must add it as a plugin to tailwind.config.js:

// tailwind.config.js

module.exports = {
  // ...
  plugins: [
    require('@vueform/slider/tailwind'),
  ]
}

This plugin adds certain utilities and variants which are neccessary for the slider but Tailwind does not provide by default.

After that you need to import themes/tailwind.scss to you main component:

<template>
  <div id="app">
    <Slider ... />
  </div>
</template>

<script>
  // ...
</script>

<style lang="scss">
  @import 'path/to/node_modules/@vueform/slider/themes/tailwind.scss'
</style>

Using :classes prop

Alternatively you can define class names directly by passing them to the Slider component via classes property. When using this approach you don't need to import tailwind.scss. Here's a default styling for Tailwind CSS (the same included in tailwind.scss):

<Slider v-model="value" :classes="{
  target: 'relative box-border select-none touch-none tap-highlight-transparent touch-callout-none disabled:cursor-not-allowed',
  focused: 'slider-focused',
  tooltipFocus: 'slider-tooltip-focus',
  tooltipDrag: 'slider-tooltip-drag',
  ltr: 'slider-ltr',
  rtl: 'slider-rtl',
  horizontal: 'slider-horizontal h-1.5',
  vertical: 'slider-vertical w-1.5 h-80',
  textDirectionRtl: 'slider-txt-rtl',
  textDirectionLtr: 'slider-txt-ltr',
  base: 'w-full h-full relative z-1 bg-gray-300 rounded',
  connects: 'w-full h-full relative overflow-hidden z-0 rounded',
  connect: 'absolute z-1 top-0 right-0 transform-origin-0 transform-style-flat h-full w-full bg-green-500 cursor-pointer tap:duration-300 tap:transition-transform disabled:bg-gray-400 disabled:cursor-not-allowed',
  origin: 'slider-origin absolute z-1 top-0 right-0 transform-origin-0 transform-style-flat h-full w-full h:h-0 v:-top-full txt-rtl-h:left-0 txt-rtl-h:right-auto v:w-0 tap:duration-300 tap:transition-transform',
  handle: 'absolute rounded-full bg-white border-0 shadow-slider cursor-grab focus:outline-none h:w-4 h:h-4 h:-top-1.5 h:-right-2 txt-rtl-h:-left-2 txt-rtl-h:right-auto v:w-4 v:h-4 v:-top-2 v:-right-1.25 disabled:cursor-not-allowed focus:ring focus:ring-green-500 focus:ring-opacity-30',
  handleLower: 'slider-hande-lower',
  handleUpper: 'slider-hande-upper',
  touchArea: 'h-full w-full',
  tooltip: 'absolute block text-sm font-semibold whitespace-nowrap py-1 px-1.5 min-w-5 text-center text-white rounded border border-green-500 bg-green-500 transform h:-translate-x-1/2 h:left-1/2 v:-translate-y-1/2 v:top-1/2 disabled:bg-gray-400 disabled:border-gray-400 merge-h:translate-x-1/2 merge-h:left-auto merge-v:-translate-x-4 merge-v:top-auto tt-focus:hidden tt-focused:block tt-drag:hidden tt-dragging:block',
  tooltipTop: 'bottom-6 h:arrow-bottom merge-h:bottom-3.5',
  tooltipBottom: 'top-6 h:arrow-top merge-h:top-5',
  tooltipLeft: 'right-6 v:arrow-right merge-v:right-1',
  tooltipRight: 'left-6 v:arrow-left merge-v:left-7',
  tooltipHidden: 'slider-tooltip-hidden',
  active: 'slider-active shadow-slider-active cursor-grabbing',
  draggable: 'cursor-ew-resize v:cursor-ns-resize',
  tap: 'slider-state-tap',
  drag: 'slider-state-drag',
}" />

There are certain variants that help detecting different states/config of the slider:

The target class receives ltr, rtl, horizontal, vertical, textDirectionRtl, textDirectionLtr, focused, tooltipFocus, tooltipDrag, tap, and drag classes when the related state is applied.

Certain classes do not define any styles (like .slider-horizontal, .slider-vertical) but only required to detect certain states. If you are changing the class list for any class name make sure to always keep the ones that start with slider- to be able to use the utilities mentioned above (h, v, etc).

In case you need to override the same type of utility you might use @neojp/tailwind-important-variant and use eg. bg-green-500!.

Examples

Single slider

<template>
  <Slider
    v-model="value"
  />
</template>

<script>
  import Slider from '@vueform/slider'

  export default {
    components: { Slider },
    data: () => ({
      value: 20
    })
  }
</script>

JSFiddle - Example #1

Multiple slider

<template>
  <Slider
    v-model="value"
  />
</template>

<script>
  import Slider from '@vueform/slider'

  export default {
    components: { Slider },
    data: () => ({
      value: [20, 40]
    })
  }
</script>

JSFiddle - Example #2

Tooltip formatting

<template>
  <Slider
    v-model="value"
    :format="format"
  />
</template>

<script>
  import Slider from '@vueform/slider'

  export default {
    components: { Slider },
    data: () => ({
      value: 20,
      format: function (value) {
        return `€${Math.round(value)}`
      }
    })
  }
</script>

JSFiddle - Example #3

Tooltip merging

<template>
  <Slider
    v-model="value"
    :merge="merge"
    :format="format"
  />
</template>

<script>
  import Slider from '@vueform/slider'

  export default {
    components: { Slider },
    data: () => ({
      value: [20, 30, 40],
      merge: 10,
      format: {
        prefix: '$',
        decimals: 2
      }
    })
  }
</script>

JSFiddle - Example #4

Vertical slider

<template>
  <Slider
    v-model="value"
  />
</template>

<script>
  import Slider from '@vueform/slider'

  export default {
    components: { Slider },
    data: () => ({
      value: 50,
      orientation: 'vertical',
      direction: 'rtl'
    })
  }
</script>

JSFiddle - Example #5

License

MIT