dijit/form/VerticalSlider

Authors: Becky Gibson
Doug Hays
Nikolai Onken
since:1.3

Introduction

A dijit/form/VerticalSlider is a scale with a handle you can drag up/down to select a value. It is based on module dijit/form/HorizontalSlider.

Usage

require(["dijit/form/VerticalSlider", "dojo/domReady!"], function(VerticalSlider){
    var slider = new VerticalSlider({}, "mySlider");
    slider.startup();
});

Here are some of the constructor parameters:

Parameter Type Description
value integer Initial value of the slider (0)
showButtons boolean Whether to show or not buttons at each end of the slider (true)
minimum integer Minimum value of the slider (0)
maximum integer Maximum value of the slider (100)
discreteValues integer Number of "steps" in the slider. For example if discreteValues is 3, you'll have 3 steps: minimum, maximum and a value in the middle

Examples

Programmatic example of a vertical slider

One way you could show the user the value of your slider is to create a textbox that the slider fills when the user moves the slider. The following code fills in a simple textbox called sliderValue. The similar example but with a vertical slider and a simple rule (tick marks) created programmatically.

require([
    "dijit/form/VerticalSlider",
    "dijit/form/VerticalRule",
    "dojo/dom",
    "dijit/form/TextBox", // this we only include to make an example with TextBox
    "dojo/parser",
    "dojo/domReady!"
], function(VerticalSlider, VerticalRule, dom, TextBox, parser){
    parser.parse();

    var rulesNode = document.createElement('div');
    vertical.appendChild(rulesNode);
    var sliderRules = new VerticalRule({
        count: 11,
        style: "width:5px;"
    }, rulesNode);
    sliderRules.startup();

    var slider = new VerticalSlider({
        name: "vertical",
        value: 6,
        minimum: -10,
        maximum: 10,
        intermediateChanges: true,
        style: "height:300px;",
        onChange: function(value){
            dom.byId("sliderValue").value = value;
        }
    }, "vertical");
    slider.startup();
});
<div id="vertical"></div>
<p><input type="text" id="sliderValue" data-dojo-type="dijit/form/TextBox"></p>

Declarative markup example with discrete values

And here we will create a vertical slider declaratively. Note that we set the value of the "discreteValues" attribute to 11, meaning that the slider will have 11 focus points. This example also shows the end buttons removed.

require(["dojo/parser", "dijit/form/VerticalSlider", "dijit/form/VerticalRule", "dijit/form/VerticalRuleLabels"]);
<div id="verticalSlider" data-dojo-type="dijit/form/VerticalSlider"
    value="6" minimum="-10" maximum="10" discreteValues="11"
    intermediateChanges="true"
    showButtons="false" style="height:400px;" name="verticalSlider">
    <ol data-dojo-type="dijit/form/VerticalRuleLabels" container="leftDecoration"
        style="width:1.5em;font-size:75%;color:gray;">
        <li> </li>
        <li>20%</li>
        <li>40%</li>
        <li>60%</li>
        <li>80%</li>
        <li> </li>
    </ol>
    <div data-dojo-type="dijit/form/VerticalRule" container="rightDecoration"
        count="11" style="width:5px;"></div>
    <ol data-dojo-type="dijit/form/VerticalRuleLabels" container="rightDecoration"
        style="width:1em;font-size:75%;color:gray;">
        <li>0%</li>
        <li>50%</li>
        <li>100%</li>
    </ol>
</div>

Accessibility

Keyboard

Action Key
Interact with the slider The slider handle is in the tab order of the page. Press tab key to set focus to the slider handle.
Increase slider value by single increment With focus on slider handle press right or up arrow.
Decrease slider value by single increment With focus on slider handle press left or down arrow.
Increase slider value by multiple increments With focus on slider handle press PageUp. The amount of increment is determined by the pageIncrement parameter.
Decrease slider value by multiple increments With focus on slider handle press PageDown. The amount of decrement is determined by the pageIncrement parameter.
Set slider to minimum value With focus on slider handle press Home.
Set slider to maximum value With focus on slider handle press End.

Known Issues

Currently the text labels of a slider are not spoken by screen readers. Firefox 3 provides the infrastructure necessary for spoken text labels so the slider will be updated to support them in a future Dojo release. Developers should take care when using text labels since a screen reader user will hear only a numeric interpretation.

There is currently no way to dynamically add labels into the Horizontal or VerticalRuleLabels, without destroying and recreating the label dijit.

Workarounds

By default the VerticalSlider's display is set to table. In order to stack 2 Vertical slider's side-by-side, you can override the .dijitSliderV style and specify inline-table instead.