UIBeginnerSSR-safehooks/ui/useDisclosure.ts

useDisclosure

isOpen / open / close / toggle.

Import

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

API

Signature

useDisclosure(options?) → { isOpen, open, close, toggle }

When to use

Any open/close UI primitive before layering accessibility.

SSR / Next.js

DOM extras (scroll lock, focus trap) run only in effects.

Live playground

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

Live playgroundEdit · run with real @/hooks · useDisclosure
Editor
function Panel() {
  const { isOpen, open, close, toggle } = useDisclosure();
  return (
    <>
      <button onClick={toggle}>Toggle</button>
      {isOpen && (
        <div>
          Content <button onClick={close}>Close</button>
        </div>
      )}
    </>
  );
}
Preview

Implementation source

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

hooks/ui/useDisclosure.ts
import { useCallback, useState } from 'react';

export interface UseDisclosureOptions {
  defaultOpen?: boolean;
  onOpen?: () => void;
  onClose?: () => void;
}

export interface UseDisclosureReturn {
  isOpen: boolean;
  open: () => void;
  close: () => void;
  toggle: () => void;
  setIsOpen: (open: boolean) => void;
}

/** Generic open/close/toggle state for dialogs, menus, etc. */
export function useDisclosure(
  options: UseDisclosureOptions = {},
): UseDisclosureReturn {
  const { defaultOpen = false, onOpen, onClose } = options;
  const [isOpen, setIsOpenRaw] = useState(defaultOpen);

  const setIsOpen = useCallback(
    (open: boolean) => {
      setIsOpenRaw(open);
      if (open) onOpen?.();
      else onClose?.();
    },
    [onOpen, onClose],
  );

  const open = useCallback(() => setIsOpen(true), [setIsOpen]);
  const close = useCallback(() => setIsOpen(false), [setIsOpen]);
  const toggle = useCallback(() => setIsOpen(!isOpen), [isOpen, setIsOpen]);

  return { isOpen, open, close, toggle, setIsOpen };
}

Copy-paste example

useDisclosure.example.tsx
'use client';

import { useDisclosure } from '@/hooks';

export function Panel() {
  const { isOpen, open, close, toggle } = useDisclosure();
  return (
    <>
      <button onClick={toggle}>Toggle</button>
      {isOpen && (
        <div>
          Content <button onClick={close}>Close</button>
        </div>
      )}
    </>
  );
}

Production checklist

  • Called only from Client Components or other custom hooks
  • Type parameters filled in (e.g. useFetch<User[]>)
  • Tip: These are headless — you own the markup and styles.
  • Source of truth: open hooks/ui/useDisclosure.ts for implementation details