Vue Switch API

The Switch is a widget that can be in two states: "On" and "Off".

import DxSwitch from "devextreme-vue/switch"
Type: DxSwitchTypes.default

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 Switch 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 () {
    $("#switch").dxSwitch({
        value: true
    });
});
<div id="switch"></div>
Angular
HTML
TypeScript
<dx-switch [value]="true"></dx-switch>
import { DxSwitchModule } from "devextreme-angular"
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxSwitchModule
    ],
    // ...
})
AngularJS
HTML
<div dx-switch="{
    value: true
}"></div>
Knockout
HTML
<div data-bind="dxSwitch: {
    value: true
}"></div>
ASP.NET MVC Controls
Razor C#
Razor VB
@(Html.DevExtreme().Switch()
    .ID("switch")
    .Value(true)
)
@(Html.DevExtreme().Switch() _
    .ID("switch") _
    .Value(True)
)

View Demo

See Also

Props

An object defining configuration options for the Switch 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.
name

The value to be assigned to the name attribute of the underlying HTML element.
onContentReady

A function that is executed when the widget's content is ready and each time the content is changed.
onDisposing

A function that is executed before the widget is disposed of.
onInitialized

A function used in JavaScript frameworks to save the widget instance.
onOptionChanged

A function that is executed after a widget option is changed.
onValueChanged

A function that is executed after the widget's value is changed.
readOnly

A Boolean value specifying whether or not the widget is read-only.
rtlEnabled

Switches the widget to a right-to-left representation.
switchedOffText

Specifies the text displayed when the widget is switched off.
switchedOnText

Specifies the text displayed when the widget is switched on.
tabIndex

Specifies the number of the element when the Tab key is used for navigating.
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

A Boolean value specifying whether the current switch state is "On" or "Off".
visible

Specifies whether the widget is visible.
width

Specifies the widget's width.

Methods

This section describes the members used to manipulate 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 Switch 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 without reloading data. Call it to update the widget's markup.
reset()

Resets the value option to the default value.

Events

This section describes events fired by this widget.

Name Description
contentReady

Raised when the widget's content is ready.
disposing

Raised before the widget is disposed of.
initialized

Raised only once, after the widget is initialized.
optionChanged

Raised after a widget option is changed.
valueChanged

Raised after the widget's value is changed.

See Also