3.0.9 • Published 2 years ago

treactr-toggle v3.0.9

Weekly downloads
2
License
MIT
Repository
github
Last release
2 years ago

An elegant, accessible toggle component for React. Also a glorified checkbox.

See usage and examples.

Props

The component takes the following props.

PropTypeDescription
checkedbooleanIf true, the toggle is checked. If false, the toggle is unchecked. Use this if you want to treat the toggle as a controlled component
defaultCheckedbooleanIf 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
onChangefunctionCallback 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.
namestringThe value of the name attribute of the wrapped \<input> element
valuestringThe value of the value attribute of the wrapped \<input> element
idstringThe value of the id attribute of the wrapped \<input> element
aria-labelledbystringThe value of the aria-labelledby attribute of the wrapped \<input> element
aria-labelstringThe value of the aria-label attribute of the wrapped \<input> element
disabledbooleanIf true, the toggle is enabled. If false, the toggle is disabled

Installation

npm install treactr-toggle

Include the component's CSS.

Development

npm install
npm run dev

Build

npm run build

License

MIT

3.0.9

2 years ago

3.0.8

7 years ago

3.0.7

7 years ago

3.0.6

7 years ago

3.0.5

7 years ago

3.0.4

7 years ago

3.0.3

7 years ago

3.0.2

7 years ago

3.0.1

7 years ago

3.0.0

7 years ago