Events
up.emit(eventName, [eventProps], [eventProps.$element], [eventProps.message])
function
experimental
This feature is experimental and not part of Unpoly's stable API.
It may be removed or changed without prior notice or deprecation.
Emits a event with the given name and properties.
The event will be triggered as a jQuery event on document.
Other code can subscribe to events with that name using
up.on() or by binding a jQuery event listener to document.
Example
up.on('my:event', function(event) {
console.log(event.foo);
});
up.emit('my:event', { foo: 'bar' });
# Prints "bar" to the console
Parameters
eventName
String
The name of the event.
[eventProps={}]
Object
optional
A list of properties to become part of the event object
that will be passed to listeners. Note that the event object
will by default include properties like preventDefault()
or stopPropagation().
[eventProps.$element=$(document)]
jQuery
optional
The element on which the event is triggered.
[eventProps.message]
String or Array
optional
A message to print to the console when the event is emitted.
If omitted, a default message is printed.
Set this to false to prevent any console output.