Lightning Components Developer Guide

What is the Lightning Component Framework?
Quick Start
Creating Components
Using Components
Communicating with Events
Creating Apps
Styling Apps
Developing Secure Code
What is Locker Service?
JavaScript ES5 Strict Mode Enforcement
DOM Access Containment
Secure Wrappers
JavaScript API for Secure Wrappers
Access to Supported JavaScript API Framework Methods Only
What Does Locker Service Affect?
Disabling Locker Service for a Component
Don’t Mix Component API Versions
Locker Service Disabled for Unsupported Browsers
Content Security Policy Overview
Using JavaScript
Using Apex
Lightning Data Service
Testing Components with Lightning Testing Service
Debugging
Fixing Performance Warnings
Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

JavaScript API for Secure Wrappers

The secure wrappers, such as SecureWindow, expose a subset of the API of the objects that they wrap. This subset is documented in the Locker Service API Viewer app or the reference doc app.

Locker Service API Viewer

The Locker Service API Viewer shows the DOM APIs exposed by Locker Service versus the standard DOM APIs for the most complex wrappers: SecureDocument, SecureElement, and SecureWindow.

The API Viewer lets you quickly see the difference between the standard DOM APIs and the Locker Service APIs.

  • An orange row indicates an API that behaves differently in Locker Service.
  • A red row means the API isn’t supported in Locker Service.

There are several ways to validate your code to ensure compatibility with Lightning component APIs. For more information, see Validations for Lightning Component Code.

Reference Doc App

The reference doc app lists the API for SecureComponent under JavaScript API | Component.

SecureAura is the wrapper for $A.

Access the reference doc app at:

https://<myDomain>.lightning.force.com/auradocs/reference.app, where <myDomain> is the name of your custom Salesforce domain.