Lightning Components Developer Guide

What is the Lightning Component Framework?
Quick Start
Creating Components
Using Components
Communicating with Events
Creating Apps
App Overview
Designing App UI
Creating App Templates
Developing Secure Code
What is LockerService?
JavaScript ES5 Strict Mode Enforcement
DOM Access Containment
Secure Wrappers for Global References
JavaScript API for Secure Wrappers
Access to Supported JavaScript API Framework Methods Only
What Does LockerService Affect?
Disabling LockerService for a Component
Don’t Mix Component API Versions
LockerService Disabled for Unsupported Browsers
Content Security Policy Overview
Validations for Lightning Component Code
Styling Apps
Using JavaScript
JavaScript Cookbook
Using Apex
Lightning Data Service
Lightning Container
Controlling Access
Using Object-Oriented Development
Using the AppCache
Distributing Applications and Components
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. The API for the secure wrappers is documented in the LockerService API Viewer app or the reference doc app.

LockerService API Viewer

The LockerService API Viewer shows the DOM APIs exposed by LockerService versus the standard DOM APIs. The API Viewer app lists the API for SecureDocument, SecureElement, and SecureWindow.

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

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

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.