Interface UseGuidesReturn

Return shape for useGuides.

interface UseGuidesReturn {
    addGuide: (guide: Guide) => void;
    clearGuides: () => void;
    getGuides: () => Guide[];
    guides: Guide[];
    removeGuide: (id: string) => void;
}

Properties

addGuide: (guide: Guide) => void

Add a guide. If a guide with the same id already exists it is replaced.

clearGuides: () => void

Drop all guides.

getGuides: () => Guide[]

Stable getter; reads the latest list without forcing a re-render. Pass to guideSnapStrategy and createGuidesLayer.

guides: Guide[]

Live list (state). Re-renders when guides change.

removeGuide: (id: string) => void

Remove a guide by id. No-op when missing.