Type Alias ToolBehaviorCallback<TargetType>

ToolBehaviorCallback: (
    event: Event,
    target: TargetType,
    options?: ToolBehaviorOptions,
) => Propagation | any

Type Parameters

TargetType extends Node = Node

Type Declaration

- (
      event: Event,
      target: TargetType,
      options?: ToolBehaviorOptions,
  ): Propagation | any
- Parameters
  - event: Event
    The original DOM/Gradum event.
  - target: TargetType
    The node the behavior should operate on (the object or its embedded target).
  - Optionaloptions: ToolBehaviorOptions
    Additional info (embedded context, etc.).
  Returns Propagation | any
  Whether to stop the propagation.

Description

Function signature for a tool behavior. Returning true marks the behavior as handled/consumed, leading to stopping the propagation of the event.