🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

treactr-toggle

Package Overview
Dependencies
Maintainers
1
Versions
10
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

treactr-toggle

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

3.0.9
latest
Source
npm
Version published
Weekly downloads
2
-66.67%
Maintainers
1
Weekly downloads
 
Created
Source

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

Keywords

toggle

FAQs

Package last updated on 18 Feb 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts