core/dispatcher

Provides methods to add and remove global event listeners.

Import Usage

import dispatcher from '@enact/core/dispatcher';

Members

off   Function

off( name, fn, target ) → undefined

Removes a global event listener.

3 Params

name String

Event name

fn Function

Event handler

target Node

 default: `document`

Event listener target

Returns

 undefined

on   Function

on( name, fn, target ) → undefined

Adds a new global event listener. Duplicate event handlers will be discarded.

3 Params

name String

Event name

fn Function

Event handler

target Node

 default: 'document'

Event listener target

Returns

 undefined

once   Function

once( name, fn, {target} ) → Function

Adds a new global event listener that removes itself after handling one event.

3 Params

name String

Event name

fn Function

Event handler

Optional • target Node

Event listener target

Returns

 Function

The single-use handler. To remove the handler manually, call the off() function with this as the 2nd parameter.