rangeslide.js v0.13.0

rangeslide.js

Feature rich, highly customizable range slider with labels (but without jQuery)

Table of contents

• Screenshots
• Quick start
• Usage
• Examples
• Options
• Methods
• Events
• Modes
• Browser support
• Copyright and license

Screenshots

Quick start

Several quick start options are available:

Download the latest build

Development

• rangeslide.js
• rangeslide.css

Production

• rangeslide.min.js
• rangeslide.min.css

Install From Bower

bower install rangeslide.js --save

Install From Npm

npm install rangeslide.js --save

Done!

Usage

Including files:

<link rel="stylesheet" href="/path/to/rangeslide.css">
<script src="/path/to/rangeslide.js"></script>

Using require.js:

var rangeslide = require("rangeslide"); // or whatever module name was assigned

Initialization

All you need to do is invoke rangeslide on an element:

var myRangeslide = rangeslide(domNode, options);

You can also initialize with css selector string:

var myRangeslide = rangeslide("#elementId", options);

Examples

There are some example usages that you can look at to get started. They can be found in the examples folder.

• Complete examples page

Options

rangeslide.js can accept an options object to alter the way it looks and behaves. If no options object is passed default values are used. The example of a structure of an options object is as follows:

{
  data: [
  	{ name: "example1", item: "Example text" },
  	{ name: "example2", item: "Another example text" },
  	{ name: "example3", item: function() { return "And yet another example text"; }
  ],
  showLabels: true,
  showTicks: true,
  labelsPosition: "alternate",
  startAlternateLabelsFromTop: true,
  startPosition: 0,
  thumbHeight: 16,
  thumbWidth: 16,
  handlers: {
    initialized: function(rangeslideElement) {},
    valueChanged: function(data, rangeslideElement) {},
    markerClicked: function(data, markerElement) {}
  }

Here is the explanation of options object:

Data

Data collection for rangeslide is provided during instatiation or later using "data" attribute in options. By default values for slider are taken from "value" attribute. If provided data item do not have this attribute then it is required that you specify the name of the attribute using dataSource in options. Number of steps (markers) for a slider is equal to number of items passed in data collection.

rangeslide("#element" {
	data: [
    	{ key: "data1", value: "simple string data"},
        { key: "data2", value: 2 },
        { key: "data3", value: 0.001 } },
        { key: "data4", value: { "passing": "object", "as": "data" } },
        { key: "data5", value: "more text here" }
    ]
});

Rangeslide constructed with the above data will have 5 steps (markers).

Methods

Methods are called on rangeslide instances. You shoud save the instances to variable to have further access to it.

object getValue()

Get current rangeslide value. Returns single value when in "single" mode, otherwise returns array.

var item = rangeslide.getValue();

object getMinValue()

Get current rangeslide minimum value. Returns null if in "select" mode.

var item = rangeslide.getMinValue();

object getMaxValue()

Get current rangeslide maximum value. Returns null if in "select" mode.

var item = rangeslide.getMaxValue();

object getRange()

Get current range. Returns empty array if mode is other than "range".

var item = rangeslide.getRange();

object getSelection()

Get current selection. Returns empty array if mode is other than "select".

var item = rangeslide.getSelection();

DOMNode getElement()

Gets rangeslide's DOM node object.

var node = rangeslide.getElement();

void setValue(int index)

Set rangeslide value by specifying data index.

rangeslide.setValue(2);

void setMinValue(int index)

Set rangeslide minimum value by specifying data index.

rangeslide.setMinValue(2);

void setMaxValue(int index)

Set rangeslide maximum value by specifying data index.

rangeslide.setMaxValue(2);

void setValueByAttribute(string attributeName, object attributeValue)

Set rangeslide value by specifying property and value. If multiple data items with the same names are found first one is set.

rangeslide.setValueByAttribute("id", 123456);

void setMinValueByAttribute(string attributeName, object attributeValue)

Set rangeslide minimum value by specifying property and value. If multiple data items with the same names are found first one is set.

rangeslide.setMinValueByAttribute("id", 123456);

void setMaxValueByAttribute(string attributeName, object attributeValue)

Set rangeslide maximum value by specifying property and value. If multiple data items with the same names are found first one is set.

rangeslide.setMaxValueByAttribute("id", 123456);

void setOption(string name, object value)

Gets rangeslide's DOM node object (invokes rangeslide refresh).

rangeslide.setOption("autoPlay", true);

bool isSingleMode()

Check if rangeside operates in single value mode.

rangeslide.isSingleMode();

bool isRangeMode()

Check if rangeside operates in range mode.

rangeslide.isRangeMode();

bool isSelectMode()

Check if rangeside operates in selection mode.

rangeslide.isSelectMode();

void refresh()

Refresh and redraw rangeslide.

rangeslide.refresh();

void destroy()

Destroy rangeslide instance.

rangeslide.destroy();

Events

rangeslide.js provides custom events for some of it's actions. Appropriate callbacks can be specified in options.

Event handlers are passed in rangeslide options like in the example below:

rangeslide("#element" {
	handlers: {
    	"valueChanged": [function(data, element) { console.log(data); }],
        "labelClicked": [
        	function(data, element) { console.log(data); },
            function(data, element) { return data.name; },
            function(data, element) { element.style.backroundColor = "#e2e3e4"; },
        ]
    }
})

Modes

rangeslide.js can operate in three different modes:

• single value mode ("single") - one thumb, single value, autoPlay is valid only in this mode
• range mode ("range") - two thumbs (indicating minimum and maximum value), range as value
• selection mode ("select") - no thumbs, multiple selection, values are selected/deselectef by clicking markers

Operation mode can be specified by setting mode in options during initialization (or later using setOption method)

Copyright and license

Licensed under MIT license.

^ back to top