Dockview
    Preparing search index...

    Interface SmartGuidesOptions

    Options for the Smart Guides module: Figma-style alignment guides + magnetic snapping while dragging a floating group. Omit smartGuides entirely to leave float dragging unchanged: the module is then inert and the drag loop is a byte-for-byte pass-through.

    interface SmartGuidesOptions {
        className?: string;
        disableSnapModifier?: false | SnapModifier;
        enabled?: boolean;
        releaseDistance?: number;
        showGuides?: boolean;
        snapDistance?: number;
        snapTargets?: SmartGuidesSnapTargets;
        snapTogether?: boolean;
    }
    Index

    Properties

    className? disableSnapModifier? enabled? releaseDistance? showGuides? snapDistance? snapTargets? snapTogether?

    Properties

    className?: string

    Extra class applied to the guide overlay layer, for theming.

    disableSnapModifier?: false | SnapModifier

    Hold this modifier while dragging to temporarily suspend snapping + guides (Figma/Keynote parity). false disables the gate. Default 'alt'.

    enabled?: boolean

    Master switch. Defaults to true when smartGuides is present.

    releaseDistance?: number

    Extra px beyond snapDistance the pointer must travel before an engaged snap releases; asymmetric hysteresis that stops boundary oscillation. Default 4.

    showGuides?: boolean

    Render the alignment guide lines while snapping. Default true.

    snapDistance?: number

    Distance, in px, within which a dragged edge/center engages a snap. Default 8.

    snapTargets?: SmartGuidesSnapTargets

    Which alignment sources to snap against (floats + container by default).

    snapTogether?: boolean

    Detect a dock/merge intent when the dragged float comes flush against another float (edge-adjacency) or overlaps its tab strip (tabset merge), and commit it on drop. Opt-in: Smart Guides is an alignment-only tool by default and never merges floating groups unless this is set. Default false.

    Settings

    Member Visibility

    On This Page

    Properties