Package Exports

@rmwc/switch
@rmwc/switch/README.md

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@rmwc/switch) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Switches

On/off switches toggle the state of a single settings option. The option that the switch controls, as well as the state it’s in, should be made clear from the corresponding inline label. Switches take on the same visual properties of the radio button.

Module @rmwc/switch
Import styles:
- import '@material/switch/dist/mdc.switch.css'
- import '@material/form-field/dist/mdc.form-field.css'
- import '@material/ripple/dist/mdc.ripple.css'
MDC Docs: https://material.io/develop/web/components/input-controls/switches/

Switches are identical in function to the Checkbox component, they just present a different UI / UX paradigm.

<Switch defaultChecked label="Pizza" />

function Example() {
  const [checked, setChecked] = React.useState(false);

  return (
    <Switch
      checked={checked}
      onChange={evt => setChecked(!!evt.currentTarget.checked)}
      label="Cookies"
    />
  );
}

<Switch>Icecream</Switch>

<>
  <Switch disabled label="Disabled" />
  <Switch disabled defaultChecked label="Disabled" />
</>

Switch

A Switch component.

Props

Name	Type	Description
`checked`	`undefined \| false \| true`	Toggle the control on and off.
`disabled`	`undefined \| false \| true`	Disables the control.
`id`	`undefined \| string`	A DOM ID for the toggle.
`inputRef`	`React.Ref<HTMLInputElement>`	A reference to the native input.
`label`	`React.ReactNode`	A label for the control.
`ripple`	`RipplePropT`	Adds a ripple effect to the component
`rootProps`	`React.HTMLProps<any>`	By default, all props except className and style spread to the input. These are additional props for the root of the checkbox.
`value`	`string \| number \| string[]`	The value of the control.