Skip to main content

Function: listen()

listen(component, eventTarget, eventName, listener): EventBus

Defined in: packages/react-page-renderer/src/componentHelpers.ts:168

Registers the provided event listener for execution whenever an IMA.js DOM custom event of the specified name occurs at the specified event target.

Parameters

component

The component requesting the registration of the event listener.

AbstractComponent | AbstractPureComponent

eventTarget

EventTarget

The react component or event target at which the listener should listen for the event.

eventName

string

The name of the event for which to listen.

listener

(event) => void

The listener for event to register.

Returns

EventBus