@tremendous/help
    Preparing search index...

    Function useCycle

    • Custom hook to toggle between two items. The default toggles between true and false. But you can pass in any two items to toggle between.

      Type Parameters

      • T

        The type of items to toggle between.

      Parameters

      • items: T[]

        The two items to toggle between.

      • OptionalinitialItem: T

        The initial state item.

      Returns UseCycleReturn<T>

      An object containing the current item and functions to navigate between items.

      const {currentItem: currentPage, next, prev} = useCycle(["Data input", "Contract", "Review"])
      next() // currentPage is now "Contract"
      next() // currentPage is now "Review"
      prev() // currentPage is now "Review"