@witchcraft/layout
    Preparing search index...

    Function getFrameCollapseInfo

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

      Changes can be applied to a window with applyFrameChanges.

      Collapsing shrinks the frame to the configured collapse size and redistributes the freed space to neighboring frames. The pre-collapse size is stored in collapsed so it can be restored later.

      Parameters

      • win: BaseLayoutWindow
      • frameId: string
      • __namedParameters: { collapseSizeScaled?: { height: number; width: number } } = {}
        • OptionalcollapseSizeScaled?: { height: number; width: number }

          Override the target collapse size. If provided, the frame will collapse to this size instead of settings.collapseSizeScaled.

      Returns
          | LayoutChange
          | 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_COLLAPSE_NOT_DOCKED", { frame: LayoutFrame }>

    Settings

    Member Visibility