@witchcraft/layout
    Preparing search index...

    Function closeFrame

    • Type Parameters

      • T extends "edge" | "dir"

      Parameters

      • win: BaseLayoutWindow
      • visualEdges: { endX: number; endY: number; startX: number; startY: number }[]
      • frame: LayoutFrame
      • closeDirOrSide: T extends "dir"
            ? "up"
            | "down"
            | "left"
            | "right"
            : "left" | "right" | "top" | "bottom"

        See getCloseFrameInfo

      • closeBy: T = ...
      • force: boolean = false
      • minSize: { height: number; width: number } = ...

      Returns
          | LayoutFrame[]
          | KnownError<
              | "CANT_CLOSE_NO_DRAG_EDGE"
              | "CANT_CLOSE_NEARBY_FRAMES_TOO_SMALL"
              | "CANT_CLOSE_SINGLE_FRAME"
              | "CANT_CLOSE_WITHOUT_FORCE",
              | { frame: LayoutFrame }
              | {
                  frame: LayoutFrame;
                  minSize: { height: number; width: number };
                  nearbyFrames: LayoutFrame[];
              }
              | { frame: LayoutFrame }
              | { frame: LayoutFrame; framesRequiredToBeDeleted: LayoutFrame[] },
          >

    Settings

    Member Visibility