@witchcraft/layout
    Preparing search index...

    Function getFrameUncollapseInfo

    • Returns a LayoutChange with the information necessary to uncollapse a docked frame.

      Changes can be applied to a window with applyFrameChanges.

      Uncollapsing restores the frame to its pre-collapse size, shrinking neighboring frames to make room.

      Parameters

      • win: BaseLayoutWindow
      • frameId: string
      • __namedParameters: { restoreSize?: { height: number; width: number } } = {}
        • OptionalrestoreSize?: { height: number; width: number }

          Override the size to restore the frame to.

      Returns
          | LayoutChange
          | KnownError<
              "REDISTRIBUTE_OUT_OF_BOUNDS",
              { max: number; min: number; wanted: number },
          >
          | KnownError<
              "NO_SPACE_TO_REDISTRIBUTE",
              { frameSizeNeeded: number; minFrameSize: number },
          >
          | KnownError<
              "REDISTRIBUTE_WOULD_RESULT_IN_INVALID_FRAMES",
              { problemEdgeCoordinates: number[] },
          >
          | KnownError<"CANT_RESIZE_SINGLE_FRAME", { frame: LayoutFrame }>
          | KnownError<"CANT_UNCOLLAPSE_NOT_COLLAPSED", { frame: LayoutFrame }>

    Settings

    Member Visibility