jqm-multislider

1.0.0 • Public • Published

Multislider Widget

Coverage Status npm npm npm

This is a widget for jQuery mobile. It is similar to a rangeslider, but it supports mutliple slider handlers. So you have multiple ranges. In difference to the standard rangeslider the input fields are not shown.

Preview

Multislider

Preconditions

The widget is implemented in ECMAScript 2015, so your project should support at least this version. To use the widget of course you need also jQuery and jQuery Mobile.

Installation

Installation via npm:

npm install jqm-multislider

Download built file:

Integration

Include the JS file right after jQuery JS file and jQuery mobile JS file:

<script src="javascripts/jquery.min.js"></script>
<script src="javascripts/jquery.mobile.min.js"></script>
<script src="javascripts/jqm-multislider.min.js"></script>

Usage

Definition in your HTML file

Create the multislider by adding the data-role="multislider" attribute to a div and provide the number of sliders by specifying input tags with type range (e.g. three):

<div id="multislider" data-role="multislider">
   <input type="range">
   <input type="range">
   <input type="range">
</div>

Per default the multislider has the minimum 0, the maximum 100, the step size 1 and shows the values of the sliders on the handlers. You can specify these values as attributes at the div tag:

<div id="multislider" data-role="multislider" min="10" max="90" step="10" data-show-value="false">
...
</div>

Options

You have only one functional option.

showValue

Type: Boolean

Default: true

With this option you can control if the values are shown on the handlers or not. You can specify it also as the attribute data-show-value.

// hide values
$('#multislider').multislider('option', 'showValue', false)
// show values
$('#multislider').multislider('option', 'showValue', true)

Methods

You can use following methods.

values

Get all the values of the multislider as an Array.

// get values
var values = $('#multislider').multislider('values')

value

You can get or set the value of a specific slider on the multislider. The specified index starts with 0.

// get value of second slider
var value = $('#multislider').multislider('value', 1)
 
// set value of third slider
$('#multislider').multislider('value', 2, 88)

count

Get the number of sliders you have on the multislider.

var count = $('#multislider').multislider('count')

increase

With this method you have the possibility to add a slider to the multislider.

// if you have before three sliders afterwards you will have four
$('#multislider').multislider('increase')

Attention:

The multislider widget initializes the values of the sliders using this method. It will distribute them even on the slider bar.

decrease

With this method you have the possibility to remove a slider from the multislider. It removes always the last slider.

// if you have before three sliders afterwards you will have two
$('#multislider').multislider('decrease')

Attention:

The multislider widget initializes the values of the sliders using this method. It will distribute them even on the slider bar.

Behavior

You cannot move a slider over its neighbor slider. There is always a difference of one step. Same is valid for the minimum. So your minimum is 0 then the first slider can have at least only the value 1 (assuming step size 1). But you can move the last slider to the maximum value.

Background Story

I decided to realize this multislider widget to provide a simple method of grouping. So I have a set of objects and want to group them individually (different number of groups with different number of included objects).

Example

See the manual test HTML page to get an idea how it works.

License

MIT

Package Sidebar

Install

npm i jqm-multislider

Weekly Downloads

50

Version

1.0.0

License

MIT

Unpacked Size

625 kB

Total Files

214

Last publish

Collaborators

  • vertumnus