Interface ISmartGuidesService

interface ISmartGuidesService {
    enabled: boolean;
    onDidSnapFloat: DockviewEvent<SmartGuidesSnapEvent>;
    onDidSnapTogether: DockviewEvent<SmartGuidesSnapTogetherEvent>;
    dispose(): void;
    setEnabled(enabled: boolean): void;
    transformFloatingGroupDrag(
        context: FloatingGroupDragContext,
    ): void | { left: number; top: number };
    updateOptions(options: Partial<SmartGuidesOptions>): void;
}

Hierarchy (View Summary)

DockviewIDisposable
- ISmartGuidesService

Index

Properties

enabled onDidSnapFloat onDidSnapTogether

Methods

dispose setEnabled transformFloatingGroupDrag updateOptions

Properties

`Readonly`enabled

enabled: boolean

Whether snapping is currently active (option present + enabled).

`Readonly`onDidSnapFloat

onDidSnapFloat: DockviewEvent<SmartGuidesSnapEvent>

`Readonly`onDidSnapTogether

onDidSnapTogether: DockviewEvent<SmartGuidesSnapTogetherEvent>

Methods

dispose

dispose(): void
Returns void
Inherited from DockviewIDisposable.dispose
- Defined in lifecycle.ts:2

setEnabled

setEnabled(enabled: boolean): void
Toggle snapping at runtime (overrides smartGuides.enabled).
Parameters
- enabled: boolean
Returns void
- Defined in dockview/moduleContracts.ts:413

transformFloatingGroupDrag

transformFloatingGroupDrag(
context: FloatingGroupDragContext,
): void | { left: number; top: number }
Snap the proposed drag position against the other floating groups, drawing an alignment guide on the snapped edge. Returns an adjusted top-left, or nothing to leave the proposed position unchanged, which is also the pass-through when smartGuides is unset / disabled.
Parameters
- context: FloatingGroupDragContext
Returns void | { left: number; top: number }
- Defined in dockview/moduleContracts.ts:407

updateOptions

updateOptions(options: Partial<SmartGuidesOptions>): void
Merge a partial option override in at runtime.
Parameters
- options: Partial<SmartGuidesOptions>
Returns void
- Defined in dockview/moduleContracts.ts:415