Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

rc-switch

react-component6.1mMIT4.1.0TypeScript support: included

switch ui component for react

react, react-component, react-switch, switch

readme

rc-switch


Switch ui component for react.

NPM version npm download build status Test coverage bundle size

Install

rc-switch

Usage

import Switch from 'rc-switch';

export default () => <Switch />;

Compatibility

IE / Edge
IE / Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
Electron
Electron
IE11, Edge last 2 versions last 2 versions last 2 versions last 2 versions

API

Property Type Default Description
prefixCls String rc-switch
className String '' additional class name of root node
checked boolean false whether switch is checked
defaultChecked boolean false whether switch is checked on init
onChange Function(checked, event) | called when switch is checked or unchecked
tabIndex number | tab-index of switch node
onClick Function(checked, event) | called when switch is clicked
autoFocus boolean | get focus when mounts
disabled boolean false whether switch is disabled
loadingIcon React.ReactNode | specific the extra node. generally used in loading icon.

Development

npm install
npm start

Online demo: http://react-component.github.io/switch/

License

rc-switch is released under the MIT license.

changelog

2.0.0

  • Remove react-lifecycles-compat.

1.9.0

  • onChange and onClick support pass event as argument.

1.7.0

  • Add loadingIcon.

1.6.0

  • Add focus() blur() and autoFocus.

1.5.0

  • Add onClick and tabIndex.
  • Add es library and module field in package.json.

1.4.0

  • Add focus style
  • Add keyboard support