Lightning Aura Components Developer Guide
Summer '26 (API version 67.0)
Spring '26 (API version 66.0)
Winter '26 (API version 65.0)
Summer '25 (API version 64.0)
Spring '25 (API version 63.0)
Winter '25 (API version 62.0)
Summer '24 (API version 61.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
fire()
getEventType()
getName()
getParam()
getParams()
getPhase()
getSource()
getSourceEvent()
getType()
pause()
preventDefault()
resume()
setParam()
setParams()
stopPropagation()
Newer Version Available
Event
Event contains methods to work with events. Use
an event to communicate between components.
Methods
-
fire()
Fires an event. -
getEventType()
Returns the type of the event. Possible values are 'COMPONENT' or 'APPLICATION'. -
getName()
Returns an event’s name. -
getParam()
Returns the value of an event’s parameter. -
getParams()
Returns the value of all an event’s parameters. -
getPhase()
Returns the current phase of an event. Returns undefined if the event hasn’t been fired yet. Possible return values for application and component events are "capture", "bubble", and "default" once fired. A value event returns "default" once it’s fired. -
getSource()
Returns the source component that fired an event. -
getSourceEvent()
Returns the source event that fired this event, if it was fired by an event binding, such as {!e.myEvent}. -
getType()
Returns the type of the event’s definition, such as 'c:myEvent'. -
pause()
Pauses an event. Event handlers aren’t processed until Event.resume() is called. The handling process pauses in the current position of the event handler processing sequence. If the event is already paused, this method does nothing. This method throws an error if it’s called in the "default" phase. -
preventDefault()
Prevents the default phase execution for this event. This method throws an error if it’s called in the "default" phase. -
resume()
Resumes event handling for this event from the same position in the event handler processing sequence from which it was previously paused. If the event isn’t paused, this method does nothing. This method throws an error if it’s called in the "default" phase. Any remaining event handlers might execute in the current call stack or might be deferred and executed in a new call stack. Therefore, the exact timing behavior is not predictable. -
setParam()
Sets a parameter for an event. This method doesn’t modify an event that has already been fired. -
setParams()
Sets parameters for an event. This method doesn’t modify an event that has already been fired. -
stopPropagation()
Sets whether the event can bubble or not. This method throws an error if called in the "default" phase.