react-use/docs/useToggle.md
2019-10-07 14:14:02 +11:00

25 lines
473 B
Markdown

# `useToggle`
React state hook that tracks value of a boolean.
`useBoolean` is an alias for `useToggle`.
## Usage
```jsx
import {useToggle} from 'react-use';
const Demo = () => {
const [on, toggle] = useToggle(true);
return (
<div>
<div>{on ? 'ON' : 'OFF'}</div>
<button onClick={toggle}>Toggle</button>
<button onClick={() => toggle(true)}>set ON</button>
<button onClick={() => toggle(false)}>set OFF</button>
</div>
);
};
```