Skip to main content

Interface: DraggableHandleProps

Props for DraggableHandle component.

See

DraggableHandle

Extends

  • HTMLAttributes<HTMLDivElement>

Properties

PropertyTypeDescription

axis?

"all" | "x" | "y"

Drag axis to receive difference in drag position:

  • x: receive only dx non-zero value in handler;
  • y: receive only dy non-zero value in handler;
  • all: receive both dx and dy non-zero values in handler.

Default

"all"

dock?

DockDirection

Placement styling for the handle for a side or a corner.

If not specified, the handle will be rendered without any built-in styling.

onBeginDragHandle

(e: MouseEvent<HTMLDivElement, MouseEvent>) => void

Handler for the start of dragging the handle.

onDragHandle

(e: MouseEvent, dx: number, dy: number) => void

Handler for each drag movement for the duration of a dragging the handle.

onEndDragHandle?

(e: MouseEvent) => void

Handler for the end of dragging the handle.