@aninest/extensions / Snap / setSnapGrid

setSnapGrid()

function setSnapGrid<Animating>(anim, gridSize): unsubscribe

Adds a grid to snap to.

Type Parameters

• Animating extends RecursiveAnimatable<unknown>

Parameters

• anim: Animation<Animating>

• gridSize: PartialRecursive<number, Animating>

A dictionary of the size of each grid square for each variable. Ex: {x: 1, y: 1}

Returns

unsubscribe

a function to remove the snap grid

Example

setSnapGrid(anim, {x: 1, y: 1}) // will snap to integer values before ending

Defined in

../../extensions/src/snap.ts:44