Module lib/hooks/useDrag

Index

Type Aliases

Interfaces

DragOptions

Functions

useDrag

Type Aliases

OnDragStart

OnDragStart: ((event: MouseEvent | TouchEvent, setPosition: ((pos: Position) => void)) => void)

Type declaration

- (event: MouseEvent | TouchEvent, setPosition: ((pos: Position) => void)): void
- Parameters
  - event: MouseEvent | TouchEvent
  - setPosition: ((pos: Position) => void)
    - - (pos: Position): void
      - Parameters
        pos: Position
        Returns void
  Returns void

OnDragEnd

OnDragEnd: ((event: MouseEvent | TouchEvent) => void)

Type declaration

- (event: MouseEvent | TouchEvent): void
- Parameters
  - event: MouseEvent | TouchEvent
  Returns void

Functions

useDrag

useDrag(dragOpts: DragOptions): [boolean, number, number]

- Defined in src/lib/hooks/useDrag/index.ts:25
Handles updating on mouse/touch movement while dragging a target element.

Parameters
- dragOpts: DragOptions
Returns [boolean, number, number]

Generated using TypeDoc