1.1.0 • Published 3 years ago

@pmwcs/switch v1.1.0

Weekly downloads
5
License
MIT
Repository
github
Last release
3 years ago

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.

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

NameTypeDescription
checkedundefined \| false \| trueToggle the control on and off.
disabledundefined \| false \| trueDisables the control.
foundationRefReact.Ref<MDCSwitchFoundation>Advanced: A reference to the MDCFoundation.
idundefined \| stringA DOM ID for the toggle.
inputRefReact.Ref<HTMLInputElement>A reference to the native input.
labelReact.ReactNodeA label for the control.
rippleRipplePropTAdds a ripple effect to the component
rootPropsReact.HTMLProps<any>By default, all props except className and style spread to the input. These are additional props for the root of the checkbox.
valuestring \| number \| string[]The value of the control.