StateBeginnerFully SSR-safehooks/state/useBoolean.ts

useBoolean

Named true/false/toggle helpers for flags.

Import

TypeScript
import { useBoolean } from '@/hooks';

API

Signature

useBoolean(initial?) → [value, { setTrue, setFalse, toggle, setValue }]

When to use

Use useBoolean instead of re-implementing the same pattern in multiple components.

SSR / Next.js

Fully SSR-safe. Pure React state.

Live playground

Edit the example and see it run against the real @/hooks package in this app.

Live playgroundEdit · run with real @/hooks · useBoolean
Editor
function Flag() {
  const [on, { setTrue, setFalse, toggle }] = useBoolean(false);
  return (
    <div>
      <p>{on ? 'On' : 'Off'}</p>
      <button onClick={setTrue}>On</button>
      <button onClick={setFalse}>Off</button>
      <button onClick={toggle}>Toggle</button>
    </div>
  );
}
Preview

Implementation source

Full library source for useBoolean — copy into your project when you are not installing a package yet.

hooks/state/useBoolean.ts
import { useCallback, useState } from 'react';

export interface UseBooleanActions {
  setTrue: () => void;
  setFalse: () => void;
  toggle: () => void;
  setValue: (value: boolean | ((prev: boolean) => boolean)) => void;
}

export type UseBooleanReturn = [boolean, UseBooleanActions];

/** Explicit boolean flag API (open/close style). */
export function useBoolean(initialValue = false): UseBooleanReturn {
  const [value, setValue] = useState(initialValue);

  const actions: UseBooleanActions = {
    setTrue: useCallback(() => setValue(true), []),
    setFalse: useCallback(() => setValue(false), []),
    toggle: useCallback(() => setValue((v) => !v), []),
    setValue,
  };

  return [value, actions];
}

Copy-paste example

useBoolean.example.tsx
'use client';

import { useBoolean } from '@/hooks';

export function Flag() {
  const [on, { setTrue, setFalse, toggle }] = useBoolean(false);
  return (
    <div>
      <p>{on ? 'On' : 'Off'}</p>
      <button onClick={setTrue}>On</button>
      <button onClick={setFalse}>Off</button>
      <button onClick={toggle}>Toggle</button>
    </div>
  );
}

Production checklist

  • Called only from Client Components or other custom hooks
  • Type parameters filled in (e.g. useFetch<User[]>)
  • Tip: Keep state setters stable; prefer action helpers over manual setState spreads.
  • Source of truth: open hooks/state/useBoolean.ts for implementation details