Lightning Aura Components Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introducing Aura Components
Quick Start
Creating Components
Using Components
Communicating with Events
Communicating Across the DOM with Lightning Message Service
Creating Apps
Styling Apps
Developing Secure Code
Using JavaScript
Working with Salesforce Data
Testing Components
Debugging
Performance
Reference
Component Library
System Tag Reference
aura:application
aura:dependency
aura:event
aura:interface
aura:method
aura:set
JavaScript API
PDF

aura:dependency

The <aura:dependency> tag enables you to declare dependencies, which improves their discoverability by the framework.

The framework automatically tracks dependencies between definitions, such as components, defined in markup. This enables the framework to send the definitions to the browser. However, if a component’s JavaScript code dynamically instantiates another component or fires an event that isn’t directly referenced in the component’s markup, use <aura:dependency> in the component’s markup to explicitly tell the framework about the dependency. Adding the <aura:dependency> tag ensures that a definition, such as a component, and its dependencies are sent to the client, when needed.

For example, adding this tag to a component marks the sampleNamespace:sampleComponent component as a dependency.

<aura:dependency resource="markup://sampleNamespace:sampleComponent" />

Add this tag to component markup to mark the event as a dependency.

<aura:dependency resource="markup://force:navigateToComponent" type="EVENT"/>

Use the <aura:dependency> tag if you fire an event in JavaScript code and you’re not registering the event in component markup using <aura:registerEvent>. Using an <aura:registerEvent> tag is the preferred approach.

The <aura:dependency> tag includes these system attributes.

System Attribute Description
resource The resource that the component depends on, such as a component or event. For example, resource="markup://sampleNamespace:sampleComponent" refers to the sampleComponent in the sampleNamespace namespace.

Using an asterisk (*) for wildcard matching is deprecated. Instead, add an <aura:dependency> tag for each resource that’s not directly referenced in the component’s markup. Wildcard matching can cause save validation errors when no resources match. Wildcard matching can also slow page load time because it sends more definitions than needed to the client.

Note
type The type of resource that the component depends on. The default value is COMPONENT.

Using an asterisk (*) for wildcard matching is deprecated. Instead, add an <aura:dependency> tag for each resource that’s not directly referenced in the component’s markup. Be as selective as possible in the types of definitions that you send to the client.

Note

The most commonly used values are:

  • COMPONENT
  • EVENT
  • INTERFACE
  • APPLICATION
  • MODULE—Use this type to add a dependency for a Lightning web component

Use a comma-separated list for multiple types; for example: COMPONENT,APPLICATION.