@witchcraft/layout
    Preparing search index...

    Type Alias DragState

    type DragState = {
        dragDirections: Record<Orientation, Direction | undefined>;
        draggingEdges: Edge[];
        draggingIntersection?: IntersectionEntry;
        dragHoveredFrame: LayoutFrame | undefined;
        dragPoint?: Point;
        frames: Record<string, LayoutFrame>;
        intersections: IntersectionEntry[];
        isDragging: boolean;
        isDraggingFromWindowEdge: boolean;
        touchingFrames: Record<string, LayoutFrame>[];
        touchingFramesArrays: LayoutFrame[][];
        visualEdges: Edge[];
        win: LayoutWindow;
    }
    Index

    Properties

    dragDirections draggingEdges draggingIntersection? dragHoveredFrame dragPoint? frames intersections isDragging isDraggingFromWindowEdge touchingFrames touchingFramesArrays visualEdges win

    Properties

    dragDirections: Record<Orientation, Direction | undefined>

    The current directions in the corresponding orientations that the user is dragging in.

    draggingEdges: Edge[]

    The edges that are currently being dragged. There are multiple edges if they drag an intersection since what's actually happening is we're just dragging the closest horizontal and vertical edges.

    draggingIntersection?: IntersectionEntry

    The intersection that is currently being dragged.

    dragHoveredFrame: LayoutFrame | undefined

    The frame that is currently being hovered over (according to whether dragPoint in in the frame or not).

    dragPoint?: Point

    The curren point (in scaled window coordinates) the user is dragging at.

    frames: Record<string, LayoutFrame>

    All the frames, with/without the currently dragged frames depending on if showDragging is true.

    intersections: IntersectionEntry[]

    A list of corner intersections. Frames can also be dragged by these.

    isDragging: boolean

    Whether the user is currently dragging. Is true during all drag events.

    isDraggingFromWindowEdge: boolean

    Whether the drag was initiated from a point along the window edge.

    touchingFrames: Record<string, LayoutFrame>[]

    The frames touching the currently dragged edges. Each entry corresponds to the frames touching the corresponding dragging edge.

    So you can use the index in draggingEdges to get the corresponding frames.

    touchingFramesArrays: LayoutFrame[][]

    Same as touchingFrames, but with the frames in an array.

    visualEdges: Edge[]

    The "visual" edges that can be displayed for dragging. See getVisualEdges

    win: LayoutWindow

    Settings

    Member Visibility

    On This Page

    Properties