Hooks / useDisclosure

useDisclosure

Open or closed, for a menu, a popover, a dialog or the palette, from a button or a key.

import { useDisclosure } from "@forgeron/ui";
/01 → From anywhere
// One state for something that opens, passed whole to the component: the button, the O key and
// the palette's own Escape all drive the same palette.
import { Button, CommandPalette, useDisclosure, useShortcuts } from "@forgeron/ui";

export default function FromAnywhere() {
  const palette = useDisclosure();
  useShortcuts({ o: palette.onOpen });
  return (
    <>
      <Button size="sm" kbd="O" onClick={palette.toggle}>
        {palette.open ? "Close" : "Open"} palette
      </Button>
      <CommandPalette
        {...palette.props}
        onSelect={() => {}}
        groups={[
          {
            label: "Go to",
            items: [
              { id: "inbox", label: "Inbox" },
              { id: "issues", label: "My issues" },
            ],
          },
        ]}
      />
    </>
  );
}
API → Props
PropTypeDefaultDescription
options{ open?, defaultOpen?, onOpenChange? }—Controlled or not, like the components.
returnsDisclosure—open, setOpen, onOpen, onClose, toggle, and props: { open, onOpenChange } to spread.