hellosign-embedded

hellosign-embedded

A JavaScript library required for using embedded signing and templates from within your application. For more information, see our API documentation.

##Getting started

You can include this library in your projects in one of three ways:

• From our CDN
• Built from source
• Bundled with webpack, etc.

###Loading from CDN

You can load this library from our global CDN using a <script> tag:

<script type="text/javascript" src="https://s3.amazonaws.com/cdn.hellosign.com/public/js/hellosign-embedded.LATEST.min.js"></script>
<!-- Alternately, omit the "min" for the unminified version -->

This will always use the latest published version of the library.

If you'd prefer to use a specific version, you can specify that version in the URL:

<script type="text/javascript" src="https://s3.amazonaws.com/cdn.hellosign.com/public/js/hellosign-embedded.0.1.6.min.js"></script>
<!-- Alternately, omit the "min" for the unminified version -->

###Building from source You'll need to clone this repository, and have npm and webpack installed. From your command line, run

# In the project directory
npm install --dev
webpack

which will build both the minified and the unminified versions of the script. You can find these products under the dist directory in the project:

# In the project directory
> ls dist
# unminified
hellosign-embedded.0.1.1.js
# minified
hellosign-embedded.0.1.1.min.js

These resultant libraries can be referenced from a <script> tag in your HTML.

###Webpack You can require the hellosign-embedded package in your front-end code when using a bundler like browserify or webpack.

First, npm install hellosign-embedded to add to your node_modules directory, then attach to a variable or the global window:

window.HelloSign = require('hellosign-embedded');

If transpiling for ES6, you can also use the import statement:

import HelloSign from 'hellosign-embedded';
window.HelloSign = HelloSign;

##Usage

Basic usage of hellosign-embedded requires initializing the library, then using the HelloSign.open function to open a URL you've fetched through the HelloSign API in an iFrame on your page.

Initialize on the page using your HelloSign API client ID:

HelloSign.init('MY_AWESOME_API_CLIENT_ID');

If you don't have one yet, head on over to the API settings for your account on HelloSign and create an API App. This will provide you with a client ID.

Make a call using your favorite client library on our api for an embedded signature request or template, then use the signer URL you get back with hellosign-embedded:

HelloSign.open({
    url: "SIGN_URL",
    // other options
});

See the Embedded Signing Walkthrough to learn more.

##Tests

The current test suite can be run with npm tests. Tests are a work in progress, built with Mocha and Chai, and using jsdom-global