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)
createComponent()
createComponents()
enqueueAction()
error()
get()
getCallback()
getComponent()
getReference()
getRoot()
getToken()
log()
reportError()
run()
set()
warning()
Newer Version Available
$A namespace
The $A namespace is the entry point for using
the framework in JavaScript code.
Methods
-
createComponent()
Create a component from a type and a set of attributes. This method accepts the name of a type of component, a map of attributes, and a callback to notify the caller. -
createComponents()
Create an array of components from a list of types and attributes. This method accepts a list of component names and attribute maps, and a callback to notify the caller. -
enqueueAction()
Queue a call to an Apex action . The framework queues up actions before sending them to the server. This mechanism is largely transparent to you when you’re writing code but it enables the framework to minimize network traffic by batching multiple actions into one request (XHR). -
error()
Deprecated. For a serious error that has no recovery path, throw a standard JavaScript error instead by using throw new Error(msg). -
get()
Returns a value from the specified global value provider using property syntax. -
getCallback()
Use $A.getCallback() to wrap any code that modifies a component outside the normal rerendering lifecycle, such as in a setTimeout() call. The $A.getCallback() call ensures that the framework rerenders the modified component and processes any enqueued actions. -
getComponent()
Gets an instance of a component from either a global ID or a DOM element that was created by a rendered component. -
getReference()
Returns a live reference to the global value requested using property syntax. -
getRoot()
Gets the root component or application. For example, $A.getRoot().get("v.attrName") returns the value of the attrName attribute from the root component. -
getToken()
Returns an application configuration token referenced by name. A tokens file is configured with the tokens attribute in the <aura:application> tag. -
log()
Deprecated. Logs to the browser's JavaScript console, if it is available. This method doesn't log in production or debug modes so it’s only useful for internal usage by the framework. -
reportError()
Report an error to the server after handling it. Note that the method should be used only if the try-catch mechanism of error handling is not desired or not functional, such as in nested promises. -
run()
Deprecated. Use getCallback() instead. -
set()
Sets a value on the specified global value provider using property syntax. -
warning()
Deprecated. Logs a warning to the browser's JavaScript console, if it is available.