mirror of
https://github.com/streamich/react-use.git
synced 2025-12-08 18:02:14 +00:00
26 lines
494 B
Markdown
26 lines
494 B
Markdown
# `useToggle`
|
|
|
|
React state hook that tracks value of a boolean.
|
|
|
|
`useBoolean` is an alias for `useToggle`.
|
|
|
|
|
|
## Usage
|
|
|
|
```jsx
|
|
import {useToggle, useBoolean} 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>
|
|
);
|
|
};
|
|
```
|