Lion Logo Lion Guides Components Docs Blog Toggle darkmode

Switch: Overview

A web component that is used to toggle a property or feature on or off. Toggling the component on or off should have immediate action and should not require pressing any additional buttons (submit) to confirm what just happened. Switch is not a Checkbox in disguise and should not be used as part of a form.

Features

  • Get or set the checked state (boolean) - checked boolean attribute
  • Pre-select an option by setting the checked boolean attribute
  • Get or set the value of the choice - choiceValue()

Installation

npm i --save @lion/switch
import { LionSwitch } from '@lion/switch';
// or
import '@lion/switch/define';