Type Alias DraggableProps

Type Declaration

• OptionalxPerPixel?: number | (() => number)

  Amount by which to change xValue for each pixel the mouse moves horizontally (default 1)

• OptionalxValue?: Holder<number>

• OptionalyPerPixel?: number | (() => number)

  Amount by which to change yValue for each pixel the mouse moves vertically (default 1)

• OptionalyValue?: Holder<number>

• hasMovedEnough?: function

  • hasMovedEnough?(deltaX: number, deltaY: number): boolean

    If provided, xValue / yValue are not modified until this function returns true.

    Parameters

    • deltaX: number
    • deltaY: number

    Returns boolean

• onClick?: function

  • onClick?(event: PointerEvent): void

    Called when the left mouse button is released without sufficient movement to initiate a drag.

    Parameters

    • event: PointerEvent

    Returns void

• onDragButtonDown?: function

  • onDragButtonDown?(event: PointerEvent<HTMLDivElement>): void

    Called after the left mouse button is clicked

    Parameters

    • event: PointerEvent<HTMLDivElement>

    Returns void

• onStartDrag?: function

  • onStartDrag?(): void

    Called when dragging starts (and the mouse pointer moved enough to detect that dragging started).

    Returns void

• onStopDrag?: function

  • onStopDrag?(event?: PointerEvent | KeyboardEvent): void

    Called when dragging stops (and the mouse pointer moved enough to detect that dragging started), either because the left mouse button is released or the user pressed Escape or mouse capture was lost.

    Parameters

    • Optionalevent: PointerEvent | KeyboardEvent

    Returns void