mur-slider

v1.6.9

Published

3 years ago

A modern, customizable slider built entirely in Vue.js 3 with TypeScript in under 5KB (gzipped) and dependency free. (horizontal, vertical and circular slider)

Downloads

0High
0Medium
0Low

chris_s

vue vue3 vuejs slider range component ui keyboard support customizable typescript circular circle vertical horizontal 0 dependencies

Horizontal, vertical and circular sliders! Fully responsive, touch screen and keyboard control support!

Table of Contents 📰

Demo (Live Demo)

Demo

Installation

# with npm
npm install vue3-slider

# with yarn
yarn add vue3-slider

Getting Started 👍

Import component

import slider from "vue3-slider"

export default {
  ...
  components: {
    "vue3-slider": slider
  }
  ...
}

How to use

<vue3-slider v-model="myNumber" color="#FB278D" track-color="#FEFEFE" />

Props

| Name | Type | ---------------- | -------- | v-model | Number | ✔️ | width | String | | height | Number | | color | String | | trackColor | String | | max | Number | | min | Number | | step | Number | | tooltip | Boolean | | tooltipText | String | | tooltipColor | String | | tooltipTextColor | String | | formatTooltip | Function | | orientation | String | | repeat | Boolean | | sticky | Boolean | | flip | Boolean | | circleOffset | Number | | Required | Default | Rules | | -------- | ---------- | ------------------------------------------------------------- | | | | | 100% | must be valid css length | | 6 | | | #FB2727 | must be a valid hex, rgb, rgba or html color value | | #F1F6F8 | ^^^ | | 100 | cannot be less than min | | 0 | cannot be greater than max | | 1 | | | false | | | "%v" | must contain %v (%v is replaced with slider's value) | | #FFFFFF | must be a valid hex, rgb, rgba or html color value | | #000000 | ^^^ | | null | function must take one parameter (number) and return a string | | horizontal | restricted choice (horizontal, vertical, circular) | | false | | | false | | | false | | | 0 | must be between 0 and 360 (inclusive) |

NOTE: When using the circular slider width is the diameter of the circle and height is the stroke width

NOTE: When using the circular slider it is advised to use absolute units for width to avoid issues

NOTE: circleOffset is calculated in degrees clockwise from the top of the circle (anti-clockwise with flip set to true)

Events

change

Arguments: (value: number)
Usage: The event is fired when the slider value changes

drag-start

Arguments: (value: number, event: MouseEvent | TouchEvent)
Usage: The event is fired when the user presses the slider

drag-end

Arguments: (value: number, event: MouseEvent | TouchEvent)
Usage: The event is fired when the user releases the slider

dragging

Arguments: (value: number, event: MouseEvent | TouchEvent)
Usage: The event is fired when the user drags the slider

Contributing

Prerequisites

node (latest version)
yarn (1.^22.10)

Setup

# clone repo
git clone https://github.com/freddie-nelson/vue3-slider
cd vue3-slider

# install deps
npm i
# with yarn
yarn

# start dev server
npm run serve
# with yarn
yarn serve

License

MIT