gap-inspector 0.1.0

package/dist/measurement.d.ts

@@ -0,0 +1,79 @@
+export type GapAxis = "horizontal" | "vertical";
+export type GapPoint = {
+    x: number;
+    y: number;
+};
+export type GapContributionKind = "margin" | "padding" | "border" | "scrollbar" | "gap" | "layout" | "unknown";
+export type GapElementInfo = {
+    selector: string;
+    tagName: string;
+    className: string;
+    rect: GapRect;
+    element?: Element;
+};
+export type GapContribution = {
+    kind: GapContributionKind;
+    property: string;
+    valuePx: number;
+    cssValue?: string;
+    selector: string;
+    element: GapElementInfo;
+    note?: string;
+};
+export type GapRect = {
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+    width: number;
+    height: number;
+};
+export type GapMeasurement = {
+    axis: GapAxis;
+    totalPx: number;
+    attributedPx: number;
+    unattributedPx: number;
+    from: GapElementInfo;
+    to: GapElementInfo;
+    commonAncestor?: GapElementInfo;
+    internalSide?: Direction;
+    contributions: GapContribution[];
+    warnings: string[];
+    equation: string;
+    markdown: string;
+};
+export type PointRegion = "content" | "padding" | "border" | "margin" | "gap" | "unknown";
+export type PointInspection = {
+    kind: "point";
+    axis: GapAxis;
+    point: GapPoint;
+    region: PointRegion;
+    totalPx?: number;
+    property?: string;
+    cssValue?: string;
+    element?: GapElementInfo;
+    from?: GapElementInfo;
+    to?: GapElementInfo;
+    rect?: GapRect;
+    note?: string;
+    markdown: string;
+};
+type Direction = "after" | "before";
+export declare function inferAxis(start: GapPoint, end: GapPoint): GapAxis;
+export declare function measureGap(options: {
+    axis?: GapAxis;
+    start: GapPoint;
+    end: GapPoint;
+    document?: Document;
+    ignoreElements?: Array<Element | null | undefined>;
+    /** Set to false to skip the full-DOM boundary scan fallback (used for cheap drag previews). */
+    boundaryScan?: boolean;
+}): GapMeasurement | null;
+export declare function inspectPoint(options: {
+    axis?: GapAxis;
+    point: GapPoint;
+    document?: Document;
+    ignoreElements?: Array<Element | null | undefined>;
+}): PointInspection | null;
+export declare function resolveSelector(selector: string, doc?: Document): Element | null;
+export {};