@witchcraft/layout
    Preparing search index...

    Function getFrameShrinkInfo

    • Returns a LayoutChange with the information necessary to shrink a frame touching a window edge by a given amount.

      Changes can be applied to a window with applyFrameChanges.

      It shrinks the frame by redistributing the freed space to neighboring frames.

      Parameters

      • win: BaseLayoutWindow
      • frameId: string
      • amount: number
      • shrinkSide: "left" | "right" | "top" | "bottom"
      • __namedParameters: { allowOutOfBounds?: boolean } = {}
        • OptionalallowOutOfBounds?: boolean

          Allow the resize span to exceed window bounds.

      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 }>

    Settings

    Member Visibility