limestone/Switch

Provides a Limestone-themed pill-shaped toggle switch component.

Loading Live Preview

Import Usage

import Switch from '@enact/limestone/Switch';

Members

Switch   Component

A Limestone-styled component that looks like a toggle switch.

Switch will manage its selected state via ui/Toggleableui/Toggleable unless set directly.

Import Usage

import Switch from '@enact/limestone/Switch';

Extends: limestone/Switchlimestone/Switch.SwitchBase
Wrapped with: limestone/Switchlimestone/Switch.SwitchDecorator

SwitchBase   Component

Renders the base level DOM structure of the component.

Import Usage

import {SwitchBase} from '@enact/limestone/Switch';

Properties

disabled

Boolean

Disables Switch and becomes non-interactive.

Default: false

---

noAnimation

Boolean

Disables animation.

Default: false

---

selected

Boolean

Sets whether this control is in the 'on' or 'off' state. true for 'on', false for 'off'.

Default: false

SwitchDecorator   Higher-Order Component

Adds interactive functionality to Switch.

Import Usage

import {SwitchDecorator} from '@enact/limestone/Switch';

Includes: ui/Toggleableui/Toggleable.Toggleable
Includes: spotlight/Spottablespotlight/Spottable.Spottable