Lightning Aura Components Developer Guide

Introducing Aura Components
Quick Start
Creating Components
Component Names
Create Aura Components in the Developer Console
Create Aura Components Using Salesforce CLI
Component Markup
Component Namespace
Component Bundles
Component IDs
HTML in Components
CSS in Components
Component Attributes
Using Expressions
Component Composition
Component Body
Component Facets
Controlling Access
Using Object-Oriented Development
Best Practices for Conditional Markup
Aura Component Versioning for Managed Packages
Base Components with Minimum API Version Requirements
Validations for Aura Component Code
Validation When You Save Code Changes
Validation During Development Using ESLint
Aura Component Validation Rules
Validation Rules Used at Save Time
Validate JavaScript Intrinsic APIs ( ecma-intrinsics ) )
Validate Aura API ( aura-api ) )
Validate Aura Component Public API ( secure-component ) )
Validate Secure Document Public API ( secure-document ) )
Validate Secure Window Public API ( secure-window ) )
Disallow Use of caller and and callee ( ( no-caller ) )
Disallow Script URLs ( no-script-url ) )
Disallow Extending Native Objects ( no-extend-native ) )
Disallow Calling Global Object Properties as Functions ( no-obj-calls ) )
Disallow Use of __iterator__ Property ( Property ( no-iterator ) )
Disallow Use of __proto__ ( ( no-proto ) )
Disallow with Statements ( Statements ( no-with ) )
Using Labels
Localization
Working with Lightning Base Components
Supporting Accessibility
Writing Documentation for the Component Library
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
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Validate Aura API ( aura-api ) )

This rule verifies that use of the framework APIs is according to the published documentation. The use of undocumented or private features is disallowed.

When Lightning Locker is enabled, the framework prevents the use of unsupported API objects or calls. That means your Aura components code is allowed to use:

  • Features built into JavaScript (“intrinsic” features)
  • Published, supported features built into the Aura Components programming model.
  • Published, supported features built into Lightning Locker SecureObject objects

This rule deals with the supported, public framework APIs, for example, those available through the framework global $A.

Why is this rule called “Aura API”? Because the core of the Aura Components programming model is the open source Aura Framework. And this rule verifies permitted uses of that framework, rather than anything specific to Lightning Components.

Rule Details

The following patterns are considered problematic:
1Aura.something(); // Use $A instead
2$A.util.fake(); // fake is not available in $A.util

Further Reading

For details of all of the methods available in the framework, including $A, see the JavaScript API documentation.