Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 902 Bytes

README.md

File metadata and controls

37 lines (26 loc) · 902 Bytes

bpk-component-switch

Backpack switch component.

Installation

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

Usage

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" />, so it supports all the same properties as it (for example checked).

Theme props

  • switchCheckedColor