TInputListener¶

Overview¶

The main type interface for input listeners.

Refer to Input.ts for documentation on the event types.

@author Jonathan Olson <jonathan.olson@colorado.edu>

Type TInputListener¶

import type { TInputListener } from 'scenerystack/scenery';

• interrupt?: () => void
• cursor?: string | null
• listener?: unknown
• createPanTargetBounds?: ( () => Bounds2 ) | null
  Function that returns the Bounds2 for AnimatedPanZoomListener to keep in view during drag input. Bounds are in the global coordinate frame. While dragging, the AnimatedPanZoomListener will try to keep these bounds in view. Intended to be called from a listener attached to a Pointer so that the API is compatible with multi-touch.
• hotkeys?: Hotkey[]
  Hotkeys that will be available whenever a node with this listener is in a focused trail.
• focus?: SceneryListenerFunction<FocusEvent>
  ////////////////////////////////////////////// //////////////////////////////////////////// Only actual events below here
• blur?: SceneryListenerFunction<FocusEvent>
• focusin?: SceneryListenerFunction<FocusEvent>
• focusout?: SceneryListenerFunction<FocusEvent>
• keydown?: SceneryListenerFunction<KeyboardEvent>
• keyup?: SceneryListenerFunction<KeyboardEvent>
• globalkeydown?: SceneryListenerFunction<KeyboardEvent>
• globalkeyup?: SceneryListenerFunction<KeyboardEvent>
• click?: SceneryListenerFunction<MouseEvent>
• input?: SceneryListenerFunction<Event | InputEvent>
• change?: SceneryListenerFunction
• down?: SceneryListenerFunction<MouseEvent | TouchEvent | PointerEvent>
• mousedown?: SceneryListenerFunction<MouseEvent | PointerEvent>
• touchdown?: SceneryListenerFunction<TouchEvent | PointerEvent>
• pendown?: SceneryListenerFunction<PointerEvent>
• up?: SceneryListenerFunction<MouseEvent | TouchEvent | PointerEvent>
• mouseup?: SceneryListenerFunction<MouseEvent | PointerEvent>
• touchup?: SceneryListenerFunction<TouchEvent | PointerEvent>
• penup?: SceneryListenerFunction<PointerEvent>
• cancel?: SceneryListenerFunction<TouchEvent | PointerEvent>
• mousecancel?: SceneryListenerFunction<PointerEvent>
• touchcancel?: SceneryListenerFunction<TouchEvent | PointerEvent>
• pencancel?: SceneryListenerFunction<PointerEvent>
• move?: SceneryListenerFunction<MouseEvent | TouchEvent | PointerEvent>
• mousemove?: SceneryListenerFunction<MouseEvent | PointerEvent>
• touchmove?: SceneryListenerFunction<TouchEvent | PointerEvent>
• penmove?: SceneryListenerFunction<PointerEvent>
• wheel?: SceneryListenerFunction<WheelEvent>
• mousewheel?: SceneryListenerFunction<WheelEvent>
• touchwheel?: SceneryListenerFunction<WheelEvent>
• penwheel?: SceneryListenerFunction<WheelEvent>
• enter?: SceneryListenerFunction<MouseEvent | TouchEvent | PointerEvent>
• mouseenter?: SceneryListenerFunction<MouseEvent | PointerEvent>
• touchenter?: SceneryListenerFunction<TouchEvent | PointerEvent>
• penenter?: SceneryListenerFunction<PointerEvent>
• exit?: SceneryListenerFunction<MouseEvent | TouchEvent | PointerEvent>
• mouseexit?: SceneryListenerFunction<MouseEvent | PointerEvent>
• touchexit?: SceneryListenerFunction<TouchEvent | PointerEvent>
• penexit?: SceneryListenerFunction<PointerEvent>
• over?: SceneryListenerFunction<MouseEvent | TouchEvent | PointerEvent>
• mouseover?: SceneryListenerFunction<MouseEvent | PointerEvent>
• touchover?: SceneryListenerFunction<TouchEvent | PointerEvent>
• penover?: SceneryListenerFunction<PointerEvent>
• out?: SceneryListenerFunction<MouseEvent | TouchEvent | PointerEvent>
• mouseout?: SceneryListenerFunction<MouseEvent | PointerEvent>
• touchout?: SceneryListenerFunction<TouchEvent | PointerEvent>
• penout?: SceneryListenerFunction<PointerEvent>

Type SceneryListenerFunction¶

import type { SceneryListenerFunction } from 'scenerystack/scenery';

( event: SceneryEvent<T> ) => void

Type SceneryNullableListenerFunction¶

import type { SceneryNullableListenerFunction } from 'scenerystack/scenery';

( event: SceneryEvent<T> | null ) => void

Type SupportedEventTypes¶

Exclude all but the actual browser events

import type { SupportedEventTypes } from 'scenerystack/scenery';

keyof StrictOmit<TInputListener, 'interrupt' | 'cursor' | 'listener' | 'createPanTargetBounds'>

Source Code¶

See the source for TInputListener.ts in the scenery repository.