Package Exports
- react-toggle
- react-toggle/style.css
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-toggle) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
An elegant, accessible toggle component for React. Also a glorified checkbox.
See usage and examples.
Props
The component takes the following props.
| Prop | Type | Description |
|---|---|---|
checked |
boolean | If true, the toggle is checked. If false, the toggle is unchecked. Use this if you want to treat the toggle as a controlled component |
defaultChecked |
boolean | If true on initial render, the toggle is checked. If false on initial render, the toggle is unchecked. Use this if you want to treat the toggle as an uncontrolled component |
onChange |
function | Callback function to invoke when the user clicks on the toggle. The function signature should be the following: function(e) { }. To get the current checked status from the event, use e.target.checked. |
name |
string | The value of the name attribute of the wrapped <input> element |
value |
string | The value of the value attribute of the wrapped <input> element |
id |
string | The value of the id attribute of the wrapped <input> element |
icons |
object | If false, no icons are displayed. You may also pass custom icon components in icons={{{checked: <CheckedIcon />, unchecked: <UncheckedIcon />}} |
aria-labelledby |
string | The value of the aria-labelledby attribute of the wrapped <input> element |
aria-label |
string | The value of the aria-label attribute of the wrapped <input> element |
disabled |
boolean | If true, the toggle is enabled. If false, the toggle is disabled |
Installation
npm install react-toggleInclude the component's CSS.
Development
npm install
npm run devBuild
npm run buildLicense
MIT