Skip to main content

Class: PointerDrag

Defined in: src/ui/drag/index.ts:30

Turns pressing and dragging on an element into changes of a value: dragging right or up gives positive deltas, left or down negative ones (see dragDelta), in whole pixels (keeping any fraction for the next move). With a threshold, the press only becomes a drag once the pointer has moved that far from where it was pressed, so a press that barely moves can still be a tap (e.g. to focus a field).

The element is given the pointer while dragging, so the drag carries on outside it.

Example​

const drag = new PointerDrag((delta) => brush.resize(delta));
html`<div @pointerdown=${drag.start} @pointermove=${drag.move} @pointerup=${drag.end} @pointercancel=${drag.end}></div>`

Constructors​

Constructor​

new PointerDrag(onDelta, threshold?): PointerDrag

Defined in: src/ui/drag/index.ts:44

Parameters​

onDelta​

(delta) => void

threshold?​

number = 0

Returns​

PointerDrag

Accessors​

dragging​

Get Signature​

get dragging(): boolean

Defined in: src/ui/drag/index.ts:50

Whether the press has become a drag

Returns​

boolean

Methods​

end()​

readonly end(): boolean

Defined in: src/ui/drag/index.ts:90

End the press (on pointerup or pointercancel). Returns whether it was a drag.

Returns​

boolean


move()​

readonly move(event): void

Defined in: src/ui/drag/index.ts:67

Give the change since the last move, once the press has become a drag (on pointermove).

Parameters​

event​

PointerEvent

Returns​

void


start()​

readonly start(event): void

Defined in: src/ui/drag/index.ts:57

Start a press (on pointerdown).

Parameters​

event​

PointerEvent

Returns​

void