# bpk-component-switch

> Backpack switch component.

## Installation

```sh
npm install bpk-component-switch --save-dev
```

## Usage

```js
import React from 'react';
import BpkSwitch from 'bpk-component-switch';

export default () => (
  <div>
    <BpkSwitch label="Switched on" checked />
    <BpkSwitch label="Turned off" />
  </div>
)
```

## Props

| Property  | PropType | Required | Default Value |
| --------- | -------- | -------- | ------------- |
| label     | Node     | true     | -             |
| className | string   | false    | null          |
| type      | oneOf(SWITCH_TYPES.primary, SWITCH_TYPES.event) | false | SWITCH_TYPES.primary

This component uses a hidden [`<input type="checkbox" />`](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox), so it supports all the same properties as it (for example `checked`).

## Theme props

* `switchCheckedColor`