core/dispatcher
Provides methods to add and remove global event listeners.
import dispatcher from '@enact/core/dispatcher';Members
offFunction
off( name, fn, target )undefinedRemoves a global event listener.
3 Params
- name String
Event name
- fn Function
Event handler
- target Node
- default: `document`
Event listener target
Returns
- undefined
onFunction
on( name, fn, target )undefinedAdds 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
onceFunction
once( name, fn, {target} )FunctionAdds a new global event listener that removes itself after handling one event.
2 or more Params
- name String
Event name
- fn Function
Event handler
- target Node
- optional
Event listener target
Returns
- Function
The single-use handler. To remove the handler manually, call the
off()function with this as the 2nd parameter.
ArrayBooleanFunctionModuleNumberObjectString