@tremendous/help
    Preparing search index...

    Function useToggle

    Custom hook to toggle between two items. By default, it toggles between false and true. But you can pass in any two items to toggle between.

    The type of items to toggle between.

    The two items to toggle between.

    The initial item.

    A tuple containing the current item and a function to toggle between the items, optionally going to a specific item.

    const [open, setOpen] = useToggle();
    const [answer, toggleAnswer] = useToggle(["yes", "no"], "no");
    • Type Parameters

      • T

      Parameters

      • items: [T, T]
      • OptionalinitialState: T

      Returns readonly [T, (item?: unknown) => void]

    • Parameters

      • Optionalitems: [boolean, boolean]
      • OptionalinitialState: boolean

      Returns readonly [boolean, (item?: unknown) => void]