/reactuse

useBoolean

Manages a boolean state with a toggle helper.

Usage

import { useBoolean } from "@siberiacancode/reactuse";

const [value, toggle] = useBoolean();

Example

import { useBoolean } from "@siberiacancode/reactuse";

export const Toggle = () => {
  const [value, toggle] = useBoolean();
  return <button onClick={() => toggle()}>{String(value)}</button>;
};

initialValue:

const [value, toggle] = useBoolean(true);

Type Declarations

export type UseBooleanReturn = [
  value: boolean,
  toggle: (value?: boolean) => void
];
export declare const useBoolean: (initialValue?: boolean) => UseBooleanReturn;