JavaScript/jQuery Switch API

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

import Switch from "devextreme/ui/switch"
Type:

Object

View Demo Read Guides

See Also

Options

An object defining configuration properties for the Switch UI component.

Name Description
accessKey

Specifies the shortcut key that sets focus on the UI component.
activeStateEnabled

Specifies whether or not the UI component changes its state when interacting with a user.
disabled

Specifies whether the UI component responds to user interaction.
elementAttr

Specifies the global attributes to be attached to the UI component's container element.
focusStateEnabled

Specifies whether the UI component can be focused using keyboard navigation.
height

Specifies the UI component's height.
hint

Specifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.
isValid

Specifies or indicates 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 UI component's content is ready and each time the content is changed.
onDisposing

A function that is executed before the UI component is disposed of.
onInitialized

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

A function that is executed after a UI component property is changed.
onValueChanged

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

Specifies whether the editor is read-only.
rtlEnabled

Switches the UI component to a right-to-left representation.
switchedOffText

Specifies the text displayed when the UI component is switched off.
switchedOnText

Specifies the text displayed when the UI component is switched on.
tabIndex

Specifies the number of the element when the Tab key is used for navigating.
validationError

Information on the broken validation rule. Contains the first item from the validationErrors array.
validationErrors

An array of the validation rules that failed.
validationMessageMode

Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.
validationStatus

Indicates or specifies the current validation status.
value

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

Specifies whether the UI component is visible.
width

Specifies the UI component's width.

See Also

Methods

This section describes the members used to manipulate the UI component.

Name Description
beginUpdate()

Prevents the UI component from refreshing until the endUpdate() method is called.
defaultOptions(rule)

Specifies the device-dependent default configuration properties for this component.
dispose()

Disposes of all the resources allocated to the Switch instance.
element()

Gets the root UI component element.
endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.
focus()

Sets focus on the UI component.
getInstance(element)

Gets the instance of a UI component found using its DOM node.
instance()

Gets the UI component's instance. Use it to access other methods of the UI component.
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 UI component properties.
option(optionName)

Gets the value of a single property.
option(optionName, optionValue)

Updates the value of a single property.
option(options)

Updates the values of several properties.
registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.
repaint()

Repaints the UI component without reloading data. Call it to update the UI component's markup.
reset()

Resets the value property to the default value.
resetOption(optionName)

Resets an property to its default value.

Events

This section describes events fired by this UI component.

Name Description
contentReady

Raised when the UI component's content is ready.
disposing

Raised before the UI component is disposed of.
initialized

Raised only once, after the UI component is initialized.
optionChanged

Raised after a UI component property is changed.
valueChanged

Raised after the UI component's value is changed.

See Also