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
Salesforce Lightning CLI
Styling Apps
Using JavaScript
JavaScript Cookbook
Using Apex
Lightning Data Service (Beta)
Lightning Container (Developer Preview)
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. The API Viewer app lists the API for SecureDocument, SecureElement, and SecureWindow.

The current UI for the API Viewer is unpolished. Bear with us while we improve it. There’s a lot of information but the main takeaway is that a background green color means that the DOM method is supported.

Use the Salesforce Lightning CLI tool to scan your code for Lightning-specific issues.

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.