StateBeginnerFully SSR-safehooks/state/useToggle.ts

useToggle

Boolean state with toggle(), toggle(true), and toggle(false).

Import

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

API

Signature

useToggle(initial?: boolean) → [value, toggle]

When to use

Modals, drawers, accordion singles, feature flags UI.

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 · useToggle
Editor
function Drawer() {
  const [isOpen, toggle] = useToggle(false);

  return (
    <>
      <button onClick={() => toggle()}>Menu</button>
      <button onClick={() => toggle(true)}>Force open</button>
      <button onClick={() => toggle(false)}>Force close</button>
      {isOpen && <aside>Drawer content</aside>}
    </>
  );
}
Preview

Implementation source

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

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

export type UseToggleActions = {
  toggle: (value?: boolean) => void;
  setTrue: () => void;
  setFalse: () => void;
  set: (value: boolean) => void;
};

export type UseToggleReturn = [boolean, UseToggleActions['toggle'] & UseToggleActions];

/**
 * Boolean state with a flexible toggle helper.
 * `toggle()` flips; `toggle(true|false)` sets explicitly.
 */
export function useToggle(initialValue = false): [
  boolean,
  ((value?: boolean) => void) & UseToggleActions,
] {
  const [value, setValue] = useState(initialValue);

  const toggle = useCallback((next?: boolean) => {
    setValue((prev) => (typeof next === 'boolean' ? next : !prev));
  }, []) as ((value?: boolean) => void) & UseToggleActions;

  toggle.setTrue = useCallback(() => setValue(true), []);
  toggle.setFalse = useCallback(() => setValue(false), []);
  toggle.set = useCallback((v: boolean) => setValue(v), []);
  toggle.toggle = toggle;

  return [value, toggle];
}

Copy-paste example

useToggle.example.tsx
'use client';

import { useToggle } from '@/hooks';

export function Drawer() {
  const [isOpen, toggle] = useToggle(false);

  return (
    <>
      <button onClick={() => toggle()}>Menu</button>
      <button onClick={() => toggle(true)}>Force open</button>
      <button onClick={() => toggle(false)}>Force close</button>
      {isOpen && <aside>Drawer content</aside>}
    </>
  );
}

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/useToggle.ts for implementation details