React Slider API

The Slider is a widget that allows an end user to set a numeric value on a continuous range of possible values.

import Slider from "devextreme-react/slider"

DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.

The following code shows how to create the Slider widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.

jQuery

JavaScript

HTML

$(function () {
    $("#slider").dxSlider({
        min: 0, max: 100,
        value: 25
    });
});

<div id="slider"></div>

Angular

HTML

TypeScript

<dx-slider
    [min]="0"
    [max]="100"
    [value]="25">
</dx-slider>

import { DxSliderModule } from 'devextreme-angular'
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxSliderModule
    ],
    // ...
})

AngularJS

HTML

<div dx-slider="{
    min: 0, max: 100,
    value: 25
}"></div>

Knockout

HTML

<div data-bind="dxSlider: {
    min: 0, max: 100,
    value: 25
}"></div>

ASP.NET MVC Controls

Razor C#

Razor VB

@(Html.DevExtreme().Slider()
    .ID("slider")
    .Min(0).Max(100)
    .Value(25)
)

@(Html.DevExtreme().Slider() _
    .ID("slider") _
    .Min(0).Max(100) _
    .Value(25)
)

View Demo

Configuration

An object defining configuration options for the Slider widget.

Name	Description
accessKey	Specifies the shortcut key that sets focus on the widget.
activeStateEnabled	Specifies whether or not the widget changes its state when interacting with a user.
disabled	Specifies whether the widget responds to user interaction.
elementAttr	Specifies the attributes to be attached to the widget's root element.
focusStateEnabled	Specifies whether the widget can be focused using keyboard navigation.
height	Specifies the widget's height.
hint	Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled	Specifies whether the widget changes its state when a user pauses on it.
isValid	Specifies whether the editor's value is valid.
keyStep	Specifies the step by which a handle moves when a user presses Page Up or Page Down.
label	Configures the labels displayed at the min and max values.
max	The maximum value the widget can accept.
min	The minimum value the widget can accept.
name	The value to be assigned to the `name` attribute of the underlying HTML element.
onContentReady	A handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes.
onDisposing	A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
onInitialized	A handler for the initialized event. Executed only once, after the widget is initialized.
onOptionChanged	A handler for the optionChanged event. Executed after an option of the widget is changed.
onValueChanged	A handler for the valueChanged event.
readOnly	A Boolean value specifying whether or not the widget is read-only.
rtlEnabled	Switches the widget to a right-to-left representation.
showRange	Specifies whether to highlight the selected range.
step	Specifies the step by which the widget's value changes when a user drags a handler.
tabIndex	Specifies the number of the element when the Tab key is used for navigating.
tooltip	Configures a tooltip.
validationError	Specifies information on the validation error when using a custom validation engine. Should be changed at runtime along with the isValid option.
validationMessageMode	Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
value	The current slider value.
visible	Specifies whether the widget is visible.
width	Specifies the widget's width.

Events

This section describes events fired by this widget.

Name	Description
contentReady	Raised when the widget's content is ready.
disposing	Raised when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
initialized	Raised only once, after the widget is initialized.
optionChanged	Raised after a widget option is changed.
valueChanged	Fires when the editor value changes.

Methods

This section describes the methods that control the widget.

Name	Description
beginUpdate()	Prevents the widget from refreshing until the endUpdate() method is called.
defaultOptions(rule)	Specifies the device-dependent default configuration options for this component.
dispose()	Disposes of all the resources allocated to the Slider instance.
element()	Gets the root widget element.
endUpdate()	Refreshes the widget after a call of the beginUpdate() method.
focus()	Sets focus on the widget.
getInstance(element)	Gets the instance of a widget found using its DOM node.
instance()	Gets the widget's instance. Use it to access other methods of the widget.
off(eventName)	Detaches all event handlers from a single event.
off(eventName, eventHandler)	Detaches a particular event handler from a single event.
on(eventName, eventHandler)	Subscribes to an event.
on(events)	Subscribes to events.
option()	Gets all widget options.
option(optionName)	Gets the value of a single option.
option(optionName, optionValue)	Updates the value of a single option.
option(options)	Updates the values of several options.
registerKeyHandler(key, handler)	Registers a handler to be executed when a user presses a specific key.
repaint()	Repaints the widget. Call it if you made modifications that changed the widget's state to invalid.
reset()	Resets the value option to null.

React Slider API

jQuery

Angular

AngularJS

Knockout

ASP.NET MVC Controls

See Also

Configuration

Events

See Also

Methods