phoenix-components-library/react/components/Switch/DOCS.md

Component library for Phoenix Frontend Projects.

# Switch

### Usage

```js
import { Switch } from 'phoenix-components-library';

render() {
  return (
    <Switch
        defaultChecked
        handleChangeCheckbox={this.someFunction()}
        disabled
    />
  );
}
```

### Live Example

<!-- STORY -->

### Properties

- `defaultChecked` - to set Switch to checked
- `small` - To show small version of Switch
- `disabled` - To disable Switch
- `handleChangeCheckbox` - Switch click callback function

| propName             | propType | defaultValue | isRequired |
| -------------------- | -------- | ------------ | ---------- |
| defaultChecked       | bool     | false        |            |
| small                | bool     | false        |            |
| disabled             | bool     | false        |            |
| handleChangeCheckbox | func     | -            |            |

### Roadmap