Interface BeforeEventHoverArgs<T>

Arguments for the beforeEventHover event. Emitted before hover state changes on a timeline event card.

Example

onBeforeHover(args: BeforeEventHoverArgs<TaskEntity>) {
  if (args.hoverState === 'enter') {
    // Could cancel hover effects
    // args.cancel = true;
  }
}
interface BeforeEventHoverArgs<T> {
    cancel: boolean;
    domEvent?: Event;
    event: MJTimelineEvent<T>;
    group: TimelineGroup<T>;
    hoverState: "enter" | "leave";
    index: number;
}

Type Parameters

  • T = any

    The type of the source record

Hierarchy (view full)

Properties

cancel domEvent? event group hoverState index

Properties

cancel

cancel: boolean

Set to true to cancel the default behavior. Default value is false.

Optional domEvent

domEvent?: Event

The original DOM event, if applicable. May be undefined for programmatic triggers.

event

event: MJTimelineEvent<T>

The timeline event being interacted with.

group

group: TimelineGroup<T>

The source group this event belongs to.

hoverState

hoverState: "enter" | "leave"

The hover state change type.

  • enter: Mouse entering the card
  • leave: Mouse leaving the card

index

index: number

Index of this event within the flattened events array.

Settings

Member Visibility

Theme

On This Page

canceldomEventeventgrouphoverStateindex