Class DragControls

Can manually trigger a drag gesture on one or more drag-enabled motion components.

const dragControls = useDragControls()

function startDrag(event) {
  dragControls.start(event, { snapToCursor: true })
}

return (
  <>
    <div onPointerDown={startDrag} />
    <motion.div drag="x" dragControls={dragControls} />
  </>
)

Constructors

constructor

Properties

componentControls

Methods

start

Constructors

constructor

Properties

Private componentControls

componentControls: any

Methods

start

  • start(event, options?): void

  • Start a drag gesture on every motion component that has this set of drag controls passed into it via the dragControls prop.

    dragControls.start(e, {
      snapToCursor: true
    })

    Parameters

    • event: PointerEvent | PointerEvent<Element>

      PointerEvent

    • Optional options: DragControlOptions

      Options

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc