Switch

import {Switch} from 'cx/widgets';

Switch is a two-state toggle widget. Switch is often used instead of a Checkbox, as it offers the same functionality with addition of modern appearance.

Default	OFF
Disabled
Read-only
Styled	Label

Switches

<div layout={LabelsLeftLayout}>
    <Switch label="Default" on-bind="$page.check" text-expr="{$page.check} ? 'ON' : 'OFF'" />
    <Switch label="Disabled" value-bind="$page.check" disabled/>
    <Switch label="Read-only" off-bind="$page.check" readOnly/>
    <Switch
        label="Styled"
        off-bind="$page.check"
        handleStyle="background:white"
        rangeStyle="background:lightsteelblue"
    >
        <span style="color:red">Label</span>
    </Switch>
</div>

Copied!Cx Fiddle

Configuration

Property	Description	Type
off	Value indicating that switch is off.	boolean
on value	Value indicating that switch is on.	boolean
baseClass	Base CSS class to be applied to the field. Defaults to `switch`.	string
class className	Additional CSS classes to be applied to the element. If an object is provided, all keys with a "truthy" value will be added to the CSS class list.	string/object
disabled	Defaults to `false`. Set to `true` to disable the field.	boolean
emptyText	Text to be rendered in view mode when the field is empty.	string
enabled	The opposite of `disabled`.	boolean
error	Used for validation. If error evaluates to non-null, the field is marked in red.	string
handleStyle	Style object to be applied on the switch handle.	string/object
help	Additional content to be displayed next to the field. This is commonly used for presenting additional information or validation errors.	string/config
helpPlacement	Set to `material` to use custom help placement instruction. Used in Material theme to implement absolutely positioned validation messages.	string
helpSpacer	Indicates that `help` should be separated from the input with a whitespace. Default is `true`.	boolean
id	Id to be used on rendered input.	string
inputAttrs	Additional attributes that should be rendered on the input element. E.g. `inputAttrs={{ autoComplete: "off" }}`.	object
inputClass	Additional CSS class applied to the input element. Used for setting visual elements, such as borders and backgrounds.	string/object
inputStyle	Style object applied to the input element. Used for setting visual elements, such as borders and backgrounds.	string/object
label	Field label. For advanced use cases, see Labels.	string/config
labelClass	Additional CSS class to be passed to the label object.	string
labelPlacement	Set to `material` to use custom label placement instruction. Used in Material theme to implement animated labels.	string
labelStyle	Additional CSS styles to be passed to the label object.	string/object
mod	Appearance modifier. For example, `mod="big"` will add the CSS class `.cxm-big` to the block element.	string/array
mode	Either `view` or `edit` (default). In view mode, the field is displayed as plain text.	string
outerLayout	Defines the outer layout which wraps the widget.	widget
placeholder	Default text displayed when the field is empty.	string
putInto contentFor	Used with outer layouts. Specifies the name of the content placeholder which should render the widget.	string
rangeStyle	Style object to be applied on the axis range when the switch is on.	string/object
readOnly	Defaults to `false`. Used to make the field read-only.	boolean
required	Defaults to `false`. Used to make the field required.	boolean
style	Style object applied to the wrapper div. Used for setting the dimensions of the element.	string/object
tabIndex	Custom tab index to be set on the field.	string
tabOnEnterKey	Set to `true` to move focus to the next field if `Enter` key is pressed.	boolean
text	Text description.	string
tooltip	Tooltip configuration. For more info see Tooltips.	string/object
trackFocus	If set to `true` top level element will get additional CSS class indicating that input is focused. Used for adding special effects on focus. Default is `false`.	boolean
validationMode	Defines how to present validation errors. Default mode is `tooltip`. Other options are `help` and `help-block`. See Validation Options for more information.	string
validationParams	An structured binding for additional validation parameters. Useful if validation depends on values from other fields, e.g. confirm password. Calculated value is passed as the third argument to `onValidate`.	structure
vdomKey	Key that will be used as the key when rendering the React component.	string
viewMode	Set to `true` to switch into view mode. Same as `mode="view"`.	boolean
visible if	Visibility of the widget. Defaults to `true`.	boolean
visited	Validation errors are not shown until the user visits the field. Setting this field to `true` will cause that validation error indicators become visible immediately.	boolean

Documentation

Switch