vue-slider-component

What is vue-slider-component?

The vue-slider-component is a highly customizable slider component for Vue.js. It allows developers to create sliders with a wide range of features, including custom styles, tooltips, and various configurations for different use cases.

What are vue-slider-component's main functionalities?

Basic Slider

This code demonstrates a basic slider component with a default value of 50. The slider is imported and used within a Vue component.

<template>
  <vue-slider v-model="value"></vue-slider>
</template>

<script>
import VueSlider from 'vue-slider-component'
import 'vue-slider-component/theme/default.css'

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

Range Slider

This code demonstrates a range slider with a minimum value of 0, a maximum value of 100, and an interval of 1. The tooltip is always visible, and the initial range is set to [20, 80].

<template>
  <vue-slider v-model="value" :min="0" :max="100" :interval="1" :tooltip="'always'"></vue-slider>
</template>

<script>
import VueSlider from 'vue-slider-component'
import 'vue-slider-component/theme/default.css'

export default {
  components: { VueSlider },
  data() {
    return {
      value: [20, 80]
    }
  }
}
</script>

Custom Tooltip

This code demonstrates a slider with a custom tooltip formatter. The tooltip always shows and displays the value prefixed with 'Value: '.

<template>
  <vue-slider v-model="value" :tooltip="'always'" :formatter="formatter"></vue-slider>
</template>

<script>
import VueSlider from 'vue-slider-component'
import 'vue-slider-component/theme/default.css'

export default {
  components: { VueSlider },
  data() {
    return {
      value: 50
    }
  },
  methods: {
    formatter(val) {
      return `Value: ${val}`;
    }
  }
}
</script>

Other packages similar to vue-slider-component

vue-range-component

The vue-range-component is another Vue.js component for creating sliders. It offers similar functionalities such as range selection, custom tooltips, and various configurations. However, it may not be as feature-rich or customizable as vue-slider-component.

vue-slider

The vue-slider package provides a simple and easy-to-use slider component for Vue.js. It supports basic slider functionalities and is suitable for simpler use cases. It may lack some of the advanced customization options available in vue-slider-component.

README

vue-slider-component

Can use the slider in vue1.x and vue2.x. (No longer update vue1.x, but still can be normal use)

Live Demo

Changelog

Todo

• Basis
• Display maximum value & minimum value
• piecewise style
• Compatible with PC and mobile terminal
• Tooltip
• The custom data
• Range
• The vertical component

Install

npm install vue-slider-component@stable --save

Exceptions

if the component initialization in a v-show="false" / display: none container or use transform / animation / margin to change the location of the component, there may be an exception ( The slider cannot be used, because the component can not initialize the size or slider position ).

The solution:

1. using v-if instead of v-show or display: none.
2. use prop show to control display.
3. After the component appears, to call the refresh method.

Example: https://jsfiddle.net/2xy72dod/254/

Run example

cd example/

# install dependencies
npm install

# serve with hot reload at localhost:9000
npm run dev

Usage

Use in vue1.x:

<template>
  <div>
    <vue-slider v-ref:slider :value.sync="value"></vue-slider>
  </div>
</template>
<script>
// Used only in vue1.x version
import vueSlider from 'vue-slider-component/src/vue-slider.vue';

new Vue({
  el: '#app',
  components: {
    vueSlider
  },
  data: {
    value: 1
  }
});
</script>

Use in vue2.x:

<template>
  <div>
    <vue-slider ref="slider" v-model="value"></vue-slider>
  </div>
</template>
<script>
// Used only in vue2.x version
import vueSlider from 'vue-slider-component'
// or
// import vueSlider from 'vue-slider-component/src/vue2-slider.vue'

new Vue({
  el: '#app',
  components: {
    vueSlider
  },
  data: {
    value: 1
  }
});
</script>

Use with Browserify (vueify):

import vueSlider from 'vue-slider-component/src/vue2-slider.vue'

Options

Props

Props	Type	Default	Description
direction	String	horizontal	Set the direction of the component, optional value: ['horizontal', 'vertical']
event-type	String	auto	The event type, optional value: ['auto', 'none']
width	Number[,String(in horizontal)]	auto	Width of the component
height	Number[,String(in vertical)]	6	Height of the component
dot-size	Number	16	Determines width and height of the sliders. to set different values of width & height use dot-width & dot-height props
dot-width	Number	value of dot-size prop	Width of sliders. If specified, overrides value of dot-size
dot-height	Number	value of dot-size prop	Height of sliders. If specified, overrides value of dot-size
min	Number	0	The minimum numerical value that can be selected
max	Number	100	The maximum numerical value that can be selected
interval	Number	1	The gap between the values
show	Boolean	true	Display of the component
speed	Number	0.5	Transition time
disabled	Boolean[, Array(in range model)]	false	Whether to disable the component
debug	Boolean	true	If you do not need to print errors in the production environment, can be set to process.env.NODE_ENV !== 'production'
piecewise	Boolean	false	Whether to display sub-values as as piecewise nodes
piecewise-label*	Boolean	false	Whether to display the label.
piecewise-filter*	Function	null	Used to filter piecewise, it works well when the data is large
tooltip	String, Boolean	always	Control the tooltip, optional value: ['hover', 'always', false]
tooltip-dir	String[,Array(in range model)	top(in horizontal)or left(in vertical)	Set the direction of the tooltip, optional value: ['top', 'bottom', 'left', 'right']
reverse	Boolean	false	Whether the component reverse (such as Right to left, Top to bottom)
value	Number, String, Array, Object	0	Initial value (if the value for the array open range model)
data	Array	null	The custom data.
clickable	Boolean	true	Whether or not the slider is clickable as well as drag-able
static-value*	Number, String	undefined	Whether to display a static dot. (valid only in single mode)
static-label*	String	undefined	Custom tooltip text for the static-value.
enable-cross*	Boolean	true	Whether to allow crossover in range mode
start-animation*	Boolean	false	Whether to enable the initial animation
tooltip-merge*	Boolean	true	Whether to merge with tooltip overlap
merge-formatter*	String, Function	null	Formatting of the merged value, for example: merge-formatter="¥{value1} ~ ¥{value2}" or merge-formatter: (v1, v2) => `¥${v1} ~ ¥${v2}`.
stop-propagation*	Boolean	false	All events call stopPropagation
real-time*	Boolean	false	Whether the real-time computing the layout of the components
lazy*	Boolean	false	At the end of the drag and drop, to synchronization value (if each update to high consumption of operation (such as Ajax), it is more useful)
fixed*	Boolean	false	Fixed distance between two values (valid only in range mode). [Example]
min-range*	Number	null	Minimum range in range mode
max-range*	Number	null	Maximum range in range mode
process-dragable*	Boolean	false	Whether the process bar is draggable (valid only in range mode).
formatter*	String,Function	null	Formatting of a tooltip's values, for example: formatter='¥{value}' or formatter: (v) => `¥${v}`.
use-keyboard*	Boolean	false	Whether to open the keyboard control (Only support the arrow keys).
actions-keyboard*	Array	[(i) => i - 1, (i) => i + 1]	In the keyboard control mode, reduce(←, ↓) and increase(→, ↑) the calling method.(i is the index value)
bg-style*	Object	null	The style of the background.
slider-style*	Object[, Array(in range model), Function<Value, Index>]	null	The style of the slider.
disabled-style*	Object	null	The style of the slider in disabled state.
disabled-dot-style*	Object, Array, Function<Value, Index>]	null	The style of the dot in disabled state.
process-style*	Object	null	The style of the process bar.
process-class*	String	null	The class of the process bar.
piecewise-style*	Object	null	The style of the piecewise dot.
piecewise-active-style*	Object	null	The style of the piecewise dot in the activated state.
tooltip-style*	Object[, Array(in range model), Function<Value, Index>]	null	The style of the tooltip.
tooltip-class*	String	null	The class of the tool tip.
label-style*	Object	null	The style of the label.
label-active-style*	Object	null	The style of the label in the activated state.
focus-style*	Object[, Array(in range model), Function<Value, Index>]	null	The style of the slider when it is focused. (Works only when use-keyboard is true)

prop*: [only supported in vue2]

Function

Name	Type	Description
setValue	Params: value [, noCallback: boolean, speed: number]	set value of the component
setIndex	Params: index*	set index of the component
getValue	Return: value	get value of the component
getIndex	Return: index*	get index of the component
refresh	null	Refresh the component

• [ index ] is the index to the array in the custom data model *
• [ index ] is equal to (( value - min ) / interval ) in normal mode *

Events

Name	Type	Description
callback	Params: value[Number | Array]	values change when the callback function. (Changes in the direct assignment value will not trigger the callback, it is recommended to use setValue method)
drag-start	Params: context[Object]	Drag the start event
drag	Params: context[Object]	Drag event
drag-end	Params: context[Object]	Drag the end event
on-keypress	Params: value[Number | Array]	keyboard event

Slot

Name	Description
dot	Customize the dot slot. optional value: [value, disabled, index(only range model)]
tooltip	Customize the tooltip slot. optional value: [value, disabled(only range model), index(only range model), merge(only tooltipMerge is true)]
piecewise	Customize the piecewise slot. optional value: [value, label, index, active, first, last, total]
label	Customize the label slot. optional value: [value, label, index, active, first, last, total]

# When using the template element as a slot, can add special properties scope or slot-scope to get the value.

e.g.

<vue-slider v-model="value">
  <template slot="tooltip" scope="{ value }">
    <div class="diy-tooltip">
      {{ value }}
    </div>
  </template>
</vue-slider>

<!-- In vue2.5 above, please use slot-scope instead of scope -->
<vue-slider v-model="value">
  <div class="diy-tooltip" slot="tooltip" slot-scope="{ value }">
    {{ value }}
  </div>
</vue-slider>

Using it with NUXT.js

This hack is just to avoid the server side 'document' error when using it with Nuxt.js. Use it if you don't need to have this component rendered on the server side.

1. Install this and add it to the variable components. i.e.

import NoSSR from 'vue-no-ssr'

let components = {
    /**
     * Add No Server Side Render component
     * to make client DOM math the server DOM
     */
    'no-ssr': NoSSR
}

1. In your template, encapsulate 'vue-slider-component' into the 'no-ssr' component to avoid redner the html on the server like this:

<no-ssr>
    <vue-slider ref="slider"></vue-slider>
</no-ssr>

1. Require the library just for client side and add the 'vue-slider-component' component to the template component list

if (process.browser) {
    // in older versions of nuxt, it's process.BROWSER_BUILD
    let VueSlider = require('vue-slider-component')
    components['vue-slider'] = VueSlider
}

1. Apply the components

export default {
    components
}

License

MIT