Skip to content
This repository has been archived by the owner on Dec 20, 2024. It is now read-only.

Latest commit

 

History

History
72 lines (47 loc) · 1.76 KB

README.md

File metadata and controls

72 lines (47 loc) · 1.76 KB
Raw

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

See usage and examples.

Props

The component takes the following props.

  • checked: bool

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: bool

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: js 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

  • 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: bool

If true, the toggle is enabled. If false, the toggle is disabled

  • hasFocus: bool

If true, the toggle is focused. If false, the toggle does not have focus

Installation

npm install react-toggle

Include the component's CSS.

Development

npm install
npm run dev

index.es6.js transpiles to index.js.

Build

npm run build

License

MIT