blob: 35cb00cdc32f6ba18e7f6089401562561923c400 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
import { useCallback, useState } from 'react';
export type UseBooleanReturn = {
/**
* Set state as true.
*/
activate: () => void;
/**
* Set state as false.
*/
deactivate: () => void;
/**
* Current state.
*/
state: boolean;
/**
* Switch state.
*/
toggle: () => void;
};
/**
* React hook to deal with boolean states.
*
* @param {boolean} [initialState] - The initial state.
* @returns {UseBooleanReturn} The state and utility functions to update it.
*/
export const useBoolean = (initialState = false): UseBooleanReturn => {
const [state, setState] = useState(initialState);
const activate = useCallback(() => {
setState(true);
}, []);
const deactivate = useCallback(() => {
setState(false);
}, []);
const toggle = useCallback(() => {
setState((prevState) => !prevState);
}, []);
return { activate, deactivate, state, toggle };
};
|
