A JavaScript SDK used to integrate applications with the Canvas framework
Last updated 3 years ago by mpsenn .
BSD-3-Clause · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install salesforce-canvas-javascript-sdk 
SYNC missed versions from official npm registry.


A JavaScript SDK used to integrate applications with the Canvas framework

Status of this SDK

This SDK has moved to the @salesforce/canvas-js-sdk npm package. This version will no longer be maintained. Version 2.0.0 of this package aligns with version 1.40.1 of that package.

For any questions, please open an issue on GitHub.

Introduction Canvas is a mechanism for consuming third-party applications within Salesforce. Its goal is to connect applications at a UI level instead of just an API level. The purpose of this GitHub repository is to provide third-party applications with a JavaScript SDK so you can easily integrate canvas-style applications into Salesforce, while developing in the technology and platform of your choice.

The best place to get started building canvas applications is the online developer's guide.

Currently, we provide Java and Ruby examples, but you can develop in whatever language you prefer. Most of the integration with Salesforce is through JavaScript and REST. You can also run and test your application locally from your own host, or from Heroku. For a quick example of how to create a Java Canvas application, please see the SalesforceCanvasFrameworkSDK GitHub project.

How to install the SDK (using npm)

npm install @salesforce/canvas-js-sdk

Then add a <script> to your index.html:

<script src="node_modules/%40salesforce/canvas-js-sdk/js/canvas-all.js">

Or from React:

import '@salesforce/canvas-js-sdk';

How to clone the SDK repository

git clone

How to use the Canvas JavaScript SDK

To use this SDK, simply include the canvas-all.js file in your page.


You can find JSDoc generated documentation for the JavaScript function in the docs directory.

Current Tags

  • 2.0.0                                ...           latest (3 years ago)

2 Versions

  • 2.0.0                                ...           3 years ago
  • 1.0.0                                ...           4 years ago
Maintainers (2)
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (0)
Dev Dependencies (0)
Dependents (0)

Copyright 2014 - 2016 © |