Skip to content

useBoolean

A hook that toggles between true and false.

Parameters

  • an initial value (default is false).

Return Values

It returns a tuple of 2 values:

IndexNameTypeDescription
0valueBooleanthe current value.
1toggleFunctiontoggle between true and false.

Example Usage

tsx
import { useBoolean } from 'react-pre-hooks';

export default function Example() {
  const [value, toggle] = useBoolean();

  return (
    <main>
      <button onClick={() => toggle()}>{value ? 'On' : 'Off'}</button>
    </main>
  );
}
import { useBoolean } from 'react-pre-hooks';

export default function Example() {
  const [value, toggle] = useBoolean();

  return (
    <main>
      <button onClick={() => toggle()}>{value ? 'On' : 'Off'}</button>
    </main>
  );
}

Released under the MIT License.