useControllableState

Support both controlled and uncontrolled usage of a stateful value from a single hook.

Installation

npx shadcn@latest add @redpanda/use-controllable-state

pnpm dlx shadcn@latest add @redpanda/use-controllable-state

yarn dlx shadcn@latest add @redpanda/use-controllable-state

bunx shadcn@latest add @redpanda/use-controllable-state

nubx shadcn@latest add @redpanda/use-controllable-state

aube dlx shadcn@latest add @redpanda/use-controllable-state

useControllableState lets a component work in either controlled or uncontrolled mode from one hook. When a prop is provided the value is controlled and changes are reported through onChange; when it’s omitted the hook holds its own state seeded from defaultProp. This is the pattern behind value/defaultValue pairs across the registry’s form and disclosure components.

In development it warns if a component flips between controlled and uncontrolled between renders.

Usage

import { useControllableState } from "@/hooks/use-controllable-state";

function Toggle({
  pressed,
  defaultPressed = false,
  onPressedChange,
}: {
  pressed?: boolean;
  defaultPressed?: boolean;
  onPressedChange?: (pressed: boolean) => void;
}) {
  const [value, setValue] = useControllableState({
    prop: pressed,
    defaultProp: defaultPressed,
    onChange: onPressedChange,
    caller: "Toggle",
  });

  return (
    <button type="button" aria-pressed={value} onClick={() => setValue((p) => !p)}>
      {value ? "On" : "Off"}
    </button>
  );
}

API

useControllableState<T>({ prop, defaultProp, onChange?, caller? })

Returns [value, setValue] — a useState-compatible tuple. setValue accepts a next value or an updater function.

Credits

Adapted from Radix UI’s useControllableState.