2.4.7-alpha.1 • Published 6 years ago

slider-component v2.4.7-alpha.1

Weekly downloads
6
License
-
Repository
github
Last release
6 years ago

vue-slider-component

downloads npm-version license

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

Demo

Live Demo

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 i slider-component --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

PropsTypeDefaultDescription
directionStringhorizontalset the direction of the component, optional value: 'horizontal', 'vertical'
event-typeStringautothe event type, optional value: 'auto', 'none'
widthNumber,String(in horizontal)autowidth of the component
heightNumber,String(in vertical)6height of the component
dot-sizeNumber16determines width and height of the sliders. to set different values of width & height use dot-width & dot-height props
dot-widthNumbervalue of dot-size propwidth of sliders. if specified, overrides value of dot-size
dot-heightNumbervalue of dot-size propheight of sliders. if specified, overrides value of dot-size
minNumber0the minimum value
maxNumber100the maximum value
intervalNumber1the gap between the values
showBooleantruedisplay of the component
speedNumber0.5transition time
disabledBooleanfalsewhether to disable components
piecewiseBooleanfalsewhether to display the piecewise
piecewise-label*Booleanfalsewhether to display the label. demo here
tooltipString, Booleanalwayscontrol the tooltip, optional value: 'hover', 'always', false
tooltip-dirString[,Array(in range model)top(in horizontal)or left(in vertical)set the direction of the tooltip, optional value: 'top', 'bottom', 'left', 'right'
reverseBooleanfalsewhether the component reverse (such as Right to left, Top to bottom)
valueNumber,Array0initial value (if the value for the array open range model)
dataArraynullthe custom data.
clickableBooleantrueWhether or not the slider is clickable as well as drag-able
stop-propagation*BooleanfalseAll events call stopPropagation
real-time*BooleanfalseWhether the real-time computing the layout of the components
lazy*BooleanfalseAt 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)
formatter*String,FunctionnullFormatting a tooltip values, Example: formatter='¥{value}' or formatter: (v) => `¥${v}`. demo here
bg-style*ObjectnullThe style of the background.
slider-style*Object,Array(in range model), Function<Value, Index>nullThe style of the slider.
process-style*ObjectnullThe style of the process bar.
piecewise-style*ObjectnullThe style of the piecewise dot.
piecewise-active-style*ObjectnullThe style of the piecewise dot in the activated state.
tooltip-style*Object,Array(in range model), Function<Value, Index>nullThe style of the tooltip.
label-style*ObjectnullThe style of the label.
label-active-style*ObjectnullThe style of the label in the activated state.

prop*: only support vue2

Function

NameTypeDescription
setValueParams: value , noCallbackset value of the component
setIndexParams: index*set index of the component
getValueReturn: valueget value of the component
getIndexReturn: index*get index of the component
refreshnullRefresh 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

NameTypeDescription
callbackParams: valueNumbervalues change when the callback function
drag-start  Params: contextObjectDrag the start event
drag-endParams: contextObjectDrag the end event

Slot

NameDescription
tooltipCustomize the tooltip slot. optional value: value, index(only range model)
piecewiseCustomize the piecewise slot. optional value: label, index, active, first, last
labelCustomize the label slot. optional value: label, index, active, first, last

# 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