Canvas Developer Guide

Introducing Canvas
Quick Start
Quick Start—Advanced
Canvas SDK
Referencing the Canvas SDK
Authentication
Getting Context in Your Canvas App
Cross-Domain XHR
Alternatives to Cookies for User Tracking
Resizing a Canvas App
Implementing Canvas App Events
Using Streaming API in a Canvas App
Debugging in a Canvas App
Using the <select> Tag in a Canvas App
Canvas Apps and Visualforce Pages
Lightning Component Code Examples
Canvas Apps in a Page Layout or a Mobile Card
Canvas Apps in the Publisher
Canvas Apps in the Chatter Feed
Canvas in the Salesforce Mobile App
Customizing Your App Lifecycle
Objects
Canvas Limits
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.

Referencing the Canvas SDK

The Canvas SDK is available on GitHub, and you have two options for referencing it from your canvas app.
  • Host the SDK on your own Web server and access it there
  • Access the SDK hosted on the Salesforce server
For example, here’s what the include statement looks like if you host the SDK on your own Web server:
1<script type="text/javascript" src="/sdk/js/canvas-all.js"></script>
Here’s what the include statement looks like if you reference the hosted SDK:
1<script type="text/javascript" src="https://<instance>.salesforce.com/canvas/sdk/js/67.0/canvas-all.js"></script>

The ability to reference the SDK on the Salesforce server is useful when you want to include one of the SDK files in a Web app or from a Visualforce page.