@vueform/slider
v2.1.10TypeScript
Vue 3 slider component with multihandles, tooltips merging and formatting.
0/weekUpdated 2 years agoMITUnpacked: 225.0 KB
Published by Adam Berecz
npm install @vueform/slider
Vue 3 Slider
Sponsors
About Vueform
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:
- integrate Vueform Drag and Drop Form Builder into any application
- save forms in database as a JSON
- use your own form elements with custom configuration options
- a complete theming and templating system with Tailwind support
- 25+ form elements with multi-file uploads, date pickers and rich text editor
- element nesting and repeating
- 50+ validators with async, dependent and custom rules
- conditional logic on element & form level
- breaking forms into steps with form wizard
- translating form content and global i18n support.
Learn more:
- Builder: https://builder.vueform.com
- Framework: https://vueform.com
Other libraries
* @vueform/multiselect - Vue 3 multiselect component with single select, multiselect and tagging options.
* @vueform/toggle - Vue 3 toggle component with labels, custom slots and styling options.
Slider features
* Vue 2 & 3 support
* 100% coverage
* TypeScript support
* ESM support
* Fully configurable
* Single slider
* Multiple sliders
* Tooltips
* Formatting
* CSS vars support
* Accessibility support
* Tailwind & utility class support
* Based on noUiSlider
Sections
* Demo
* Installation
* Using with Vue 3
* Using with Vue 2
* Support
* Configuration
* Basic props
* Events
* Styling
* Styling with CSS vars
* Styling with Tailwind CSS
* Examples
* Single slider
* Multiple slider
* Tooltip formatting
* Tooltip merging
* License
Demo
Check out our demo.
Installation
``
npm install @vueform/slider
$3
` vue
`
$3
` vue
`
#### 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
$3
| Name | Type | Default | Description |
| --- | --- | --- | --- |
| id | string | slider | The id attribute of slider container DOM. |boolean
| lazy | | true | Whether 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. |boolean
| disabled | | false | Whether the slider should be disabled. |number
| min | | 0 | Minimum value of the slider. |number
| max | | 100 | Maximum value of the slider. |number
| step | | 1 | The jump between intervals. If -1 it enables fractions (eg. 1.23). |boolean
| tooltips | | true | Whether tooltips should show above handlers. |string
| showTooltip | | 'always' | When tooltips should be shown. Possible values: always\|focus\|drag. |number
| merge | | -1 | The step distance between two handles when their tooltips should be merged (when step is -1 then 1 is assumed). Eg: { merge: 5, step: 10 }
0, <=50
-> values: will merge 0, 60
-> values: will not merge { merge: 5, step: -1 }
0, <=5
-> values: will merge 0, 5.01
-> values: will not merge |object\|function
| format | | | Formats 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: prefix
- eg $ -> $100 suffix
- eg USD -> 100USD decimals
- eg 2 -> 100.00 thousand
- eg , - 1,000 |string
| orientation | | 'horizontal' | The orientation of the slider. Possible values: horizontal\|vertical |string
| direction | | '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 |string
| tooltipPosition | | null | The 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'). |object
| aria | | | An object containing aria attributes to be added for each handle. |string
| ariaLabelledby | | null | Sets the aria-labelledby attribute of handles. |object
| options | | {} | Additional options for noUiSlider. |object
| classes | | | An object of class names that gets merged with the default values. Default:{
|
$3
| Event | Attributes | Description |
| --- | --- | --- |
| @change | value | Emitted when dragging the slider is finished or it's value changed by clicking, keyboard or programmatical set. |value
| @update | | Emitted in the same scenarios as in @change, but also when the slider is being dragged if lazy option is disabled. |value
| @set | | Emitted in the same scenarios as in @change, but also when the slider's .set() method is called. |value
| @slide | | Emitted while the slider moves. |value
| @drag | | Emitted the slider connect moves while dragging. |value
| @start | | Emitted when the handle is activated and dragging started. |value
| @end | | Emitted when the dragging ended. |
Styling
$3
The following CSS variables can be used to customize slider when using default.css:
` 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:
` css`
:root {
--slider-connect-bg: #3B82F6;
--slider-tooltip-bg: #3B82F6;
--slider-handle-ring-color: #3B82F630;
}
Or on instance level:
` vue
class="slider-red"
/>
class="slider-blue"
/>
`
` css
.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;
}
`
$3
To use the slider with Tailwind CSS you must add it as a plugin to tailwind.config.js:
` 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:
` vue
`
#### 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):
` vue`
There are certain variants that help detecting different states/config of the slider:
* h - applied when the slider is horizontalv
* - applied when the slider is verticalmerge-h
* - applied when the slider is horizontal and tooltips are mergedmerge-v
* - applied when the slider is horizontal and tooltips are mergeddisabled
* - applied when the slider is disabledtxt-rtl-h
* - applied when the slider is horizontal and text direction is set to rtl
* - applied when the slider bar is being taped to jump to certain positiontt-focus
* - applied when the slider should only display tooltips on focus (showToolip: 'focus') and the slider is not focusedtt-focused
* - applied when the slider should only display tooltips on focus and the slider is focusedtt-drag
* - applied when the slider should only display tooltips on drag (showToolip: 'drag') and the slider is not being draggedtt-dragging
* - applied when the slider should only display tooltips on drag and the slider is being dragged
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
* Multiple slider
* Tooltip formatting
* Tooltip mergin
* Vertical slider
$3
` vue
/>
`
$3
` vue
/>
`
$3
` vue
:format="format"
/>
`
$3
` vue
:merge="merge"
:format="format"
/>
`
$3
` vue
/>
``