We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 592f6be commit f92fa17Copy full SHA for f92fa17
docs/useToggle.md
@@ -0,0 +1,35 @@
1
+# `useToggle`
2
+
3
+Tracks value of a boolean
4
5
+## Usage
6
7
+```jsx
8
+import { useToggle } from 'use-haki';
9
10
+const App = () => {
11
+ const { on, toggle } = useToggle();
12
13
+ return (
14
+ <div>
15
+ <span>{on && 'Hi there 👋'}</span>
16
+ <button onClick={toggle}>toggle me 👀</button>
17
+ </div>
18
+ );
19
+};
20
+```
21
22
+## Reference
23
24
+```ts
25
+const { on, toggle } = useToggle(initialOn);
26
27
28
+- **initialValue** - initialOn by default is false
29
+- **on** - toggle state
30
+- **toggle** - function that toggle `on` state
31
32
+### Returns
33
34
+- **toggle**
35
+- **on**
0 commit comments