@witchcraft/layout
    Preparing search index...

    Function getFrameDockInfo

    • Returns a LayoutChange with the information necessary to dock a frame to a window edge.

      Changes can be applied to a window with applyFrameChanges.

      Parameters

      • win: BaseLayoutWindow
      • frameId: string
      • side: "left" | "right" | "top" | "bottom"
      • OptionalmaxPerpendicularLength: number

      Returns
          | LayoutChange
          | KnownError<"NO_FILL_CANDIDATES", {}>
          | KnownError<
              "REDISTRIBUTE_OUT_OF_BOUNDS",
              { max: number; min: number; wanted: number },
          >
          | KnownError<
              "NO_SPACE_TO_REDISTRIBUTE",
              { frameSizeNeeded: number; minFrameSize: number },
          >
          | KnownError<"CANT_UNDOCK_COLLAPSED_FRAME", { frame: string }>
          | KnownError<"CANT_LEAVE_NO_UNDOCKED_FRAMES", {}>
          | KnownError<
              "FRAME_ALREADY_DOCKED_ON_SIDE",
              { id: string; side: "left"
              | "right"
              | "top"
              | "bottom" },
          >

    Settings

    Member Visibility