react-use-toggle
Version:
React hook for toggle state.
63 lines (42 loc) • 1.13 kB
Markdown
# react-use-toggle
[](https://circleci.com/gh/bsonntag/react-use-toggle)
React hook for toggle state.
## Installation
Using npm:
```sh
$ npm install --save react-use-toggle
```
Using yarn:
```sh
$ yarn add react-use-toggle
```
Since this module uses React's new [Hooks feature](https://reactjs.org/docs/hooks-intro.html),
to try this out you'll need to install at least version `16.8.0`
of `react` and `react-dom`:
```sh
$ yarn add react@^16.8.0 react-dom@^16.8.0
```
## Usage
```js
import React from 'react';
import useToggle from 'react-use-toggle';
function Example() {
const [checked, toggle] = useToggle(false);
return (
<label>
<input checked={checked} onChange={toggle} type={'checkbox'} />
Are you hooked?
</label>
);
}
```
## API
```js
useToggle(initialState?: boolean): [boolean, () => void]
```
Receives an optional initial state and returns a tuple with the current state
and a function to toggle the state.
## Contributing
Please feel free to submit any issues or pull requests.
## License
MIT