Skip to content

Switch

A switch component.

Importing

ts
import "@tapsioss/web-components/switch";
ts
import { Switch } from "@tapsioss/react-components/Switch";

Component Usage

html
<tapsi-switch></tapsi-switch>
tsx
<Switch />

Properties

NameDescriptionTypeDefault Value
selectedIndicates whether the switch is selected.booleanfalse
disabledIndicates whether the switch is disabled.booleanfalse
valueThe value of the switch when it is checked.string"on"
labelDefines a string value that can be used to name switch input.
https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-label
string-
labelledbyIdentifies the element (or elements) that labels the switch input.
https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes/aria-labelledby
string-
requiredIndicates that the user must specify a value for the input before the owning form can be submitted and will render an error state when reportValidity() is invoked when value is empty.
https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/required
booleanfalse
autofocusIndicates that the element should be focused on page load. https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocusbooleanfalse