Class DragActionHandler<TRawDragActions, TDragActions>

constructor

• new DragActionHandler<
      TRawDragActions extends IDragAction[],
      TDragActions extends
          RecordFromArray<TRawDragActions, "name"> = RecordFromArray<
          TRawDragActions,
          "name",
      >,
  >(
      defaultOnDragChange: DragChangeHandler,
      actions: TRawDragActions,
      hooks?: {
          onEnd?: (context: { applied: boolean; cancelled: boolean }) => void;
          onEvent?: (
              e: undefined | PointerEvent | KeyboardEvent,
              cancel: () => void,
          ) => void;
          onRecalculate?: () => void;
          onRequestChange?: (type: undefined | keyof TDragActions) => void;
      },
  ): DragActionHandler<TRawDragActions, TDragActions>

  Type Parameters

  • TRawDragActions extends IDragAction[]
  • TDragActions extends RecordFromArray<TRawDragActions, "name"> = RecordFromArray<TRawDragActions, "name">

  Parameters

  • defaultOnDragChange: DragChangeHandler

    Default onDragChange handler for when no action can handle the request.

    Should return true to allow the edges to be moved, or false to prevent it.

  • actions: TRawDragActions
  • hooks: {
        onEnd?: (context: { applied: boolean; cancelled: boolean }) => void;
        onEvent?: (
            e: undefined | PointerEvent | KeyboardEvent,
            cancel: () => void,
        ) => void;
        onRecalculate?: () => void;
        onRequestChange?: (type: undefined | keyof TDragActions) => void;
    } = {}

    • OptionalonEnd?: (context: { applied: boolean; cancelled: boolean }) => void

      Called when the drag action ends either because it was completed or cancelled.

    • OptionalonEvent?: (e: undefined | PointerEvent | KeyboardEvent, cancel: () => void) => void

      Called before searching for a matching action. Useful for re-initializing state.

      Is passed a cancel function if you want to cancel the current drag action.

    • OptionalonRecalculate?: () => void

      Called while dragging during dragChange events. You can use this to update the dragging edges.

    • OptionalonRequestChange?: (type: undefined | keyof TDragActions) => void

      Called when the action requested changes.

  Returns DragActionHandler<TRawDragActions, TDragActions>

actions

OptionalactiveAction

boundCancel

defaultOnDragChange

eventCanceller

hooks

cancel

• cancel(): void

  Returns void

eventHandler

• eventHandler(
      e: PointerEvent | KeyboardEvent,
      state: DragState,
      forceRecalculateEdges: () => void,
  ): undefined

  Parameters

  • e: PointerEvent | KeyboardEvent
  • state: DragState
  • forceRecalculateEdges: () => void

  Returns undefined

onDragApply

• onDragApply(state: DragState, forceRecalculateEdges: () => void): boolean

  Parameters

  • state: DragState
  • forceRecalculateEdges: () => void

  Returns boolean

onDragChange

• onDragChange<T extends "start" | "move" | "end">(
      type: T,
      e: T extends "end" ? undefined | PointerEvent : PointerEvent,
      state: DragState,
      forceRecalculateEdges: () => void,
      cancel?: () => void,
  ): undefined | boolean

  Type Parameters

  • T extends "start" | "move" | "end"

  Parameters

  • type: T
  • e: T extends "end" ? undefined | PointerEvent : PointerEvent
  • state: DragState
  • forceRecalculateEdges: () => void
  • Optionalcancel: () => void

  Returns undefined | boolean