Skip to content
develop
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

ShopGun JavaScript SDK

Build Status npm version

This SDK works both client-side in your browser but also server-side in a Node.js environment.

Creating an App

First, you need to create a ShopGun app allowing you to make API requests. You will be prompted to create a new user first.

We recommend creating 2 apps: 1 for production and another for development. This ensures environments aren't mixed.

Setup

In the Browser

The SDK makes use of both JavaScript and CSS so you need to load two resources in the browser:

<link
  href="https://d21oefkcnoen8i.cloudfront.net/sgn-sdk-3.3.0.min.css"
  rel="stylesheet"
  type="text/css"
/>
<script
  src="https://d21oefkcnoen8i.cloudfront.net/sgn-sdk-3.3.0.min.js"
  id="sgn-sdk"
  data-app-key="YOUR_APP_KEY"
  data-track-id="YOUR_TRACK_ID"
></script>

By defining your app key and track identifier as data attributes when including the JavaScript file the SDK auto-configures itself. You can find the app key and track identifier in the developer console.

In Node.js

We recommend you use npm to install the SDK. To install, simply type the following into a terminal window:

npm install shopgun-sdk

When installed you can require and configure the SDK:

SGN = require('sgn-sdk');

SGN.config.set({
  appKey: 'YOUR_APP_KEY',
  appSecret: 'YOUR_APP_SECRET'
});

We recommend using environment variables for the config to avoid having secrets in your code base:

SGN.config.set({
  appKey: process.env.SHOPGUN_APP_KEY,
  appSecret: process.env.SHOPGUN_APP_SECRET
});

Paged Publications

To provide your users with a viewing experience for PDF's you need to use our PagedPublicationKit. We've built an example that shows how it can work.

More Platforms

To learn more about integrating the same experience on iOS and Android be sure to check out the respective SDK's:

Changelog

Version 3.3.1

  • PagedPublicationKit: Will now use zoom-size images for pages prior to zooming in, when the physical pixel width of the page would be presented as over 700 pixels wide.

Version 3.1.1

  • IncitoPublicationKit: Removed sessionStorage caching due to excessive JSON.parse JSON.stringify operations, which slows down the browser.

Version 3.1.0

  • PagedPublicationKit: Add a new optional createViewer option pickHotspot, which is called when the user presses an intersection of several hotspots. This replaces the default picker popover element. API example:
var viewer = bootstrapper.createViewer(data, {
  pickHotspot: function(
    // array of hotspots
    hotspots,
    // event that contains some metadata about the clicked page, viewer and click position
    // viewerEvent.verso.x and viewerEvent.verso.y are useful for positioning a picker relative to the viewer
    viewerEvent,
    // reference to the viewer DOM mounting point, useful for inserting a picker and positioning relatively inside of
    viewerElement,
    // you can use callback(hotspot) to emit a regular clicked/pressed/contextmenu event with a chosen hotspot
    callback
  ) {
    // Example: just always pick the first hotspot and callback to regular 'hotspot*' event behavior
    callback(hotspots[0]);

    // you can optionally return a clean-up function that will be called when
    // a picker should be closed, so you can clean up after yourself.
    // This clean-up function is called once on a subsequent pickHotspot call.
    return function() {
      console.log('clean up');
    };
  }
});

Version N.E.X.T

  • Let CoreUIKit OfferDetails grow beyond the width of its anchor, with respect to on-screen position.

Version 3.0.0

  • BREAKING INCITO CHANGE Now, you need to supply the identifier of the publication rather than the Incito identifier. Plus, we've added a new event to measure how many times Incito's are opened. Anonymously.

Version 2.3.19

  • PagedPublicationKit: Let options be passed to Viewer when calling createViewer, like so: bootstrapper.createViewer(data, { pageSpreadMaxZoomScale: 1 });

Version 2.3.17

  • Make sure PagedPublicationViewer controls are destroy()'ed properly with the viewer, event handlers and all
  • Internal removal of some extraneous function binding Breaking Change: If you relied on this in bootstrapper.fetch() callback, it no longer refers to the bootstrapper instance.

Version 2.3.16

  • Fix broken PagedPublicationViewer startup

Version 2.3.15

Version 2.3.8

  • Roll back to core-js 2

Version 2.3.7

  • Update verso-browser and incito-browser
  • Fix an issue where polyfills were missing

Version 2.3.0

  • Introduce support for incito opened event in eventTracker
  • Use new incito opened event in IncitoPublicationKit
  • Add option to IncitoPublicationKit.Viewer to pass in a pagedPublicationId to be included in the incito opened event, this should be used when a user is known to already have seen the Paged Publication version of an Incito Publication.

Version 2.2.11

  • Use cross-fetch library for making requests in browsers and node.js
  • Relaxed eventTracker requirement for PagedPublicationKit

Version 2.2.8

  • Updated progress indicator for IncitoPublicationKit to be more visible and more like the one in PagedPublicationKit

Version 2.2.5

  • Set async to true for requests

Version 2.2.4

  • Added ability to use EventsKit tracker in a node.js context

Version 2.2.3

  • Added promise return values to SGN.CoreKit.request and SGN.CoreKit.request calls without callback, when supported.

Version 2.2.0

  • Changed the event tracker to use the new private event format. This also means you need to update your track identifier, which is now visible in the developer console on shopgun.com/developers.

Version 2.1.0

  • Updated Incito library. Now, it's up to you to add event delegation to Incito rather than binding e.g. view_clicked to the Incito viewer. This gives you way more flexibility
  • Split JS and CSS into separate files for Incito Publication demo
  • Removed util.isElementInViewport

Version 2.0.9

  • Added margins parameter for util.isElementInViewport
  • Updated Incito library

Version 2.0.0

  • PagedPublicationKit
    • Refactored SGN.PagedPublicationKit.initialize to SGN.PagedPublication.Bootstrapper to split fetching and rendering of the viewer
    • Made hotspots into a function instead of having a setting called showHotspots
  • Introduced IncitoPublicationKit
  • Removed unused files
  • Fixed incorrect positioning of hotspots and hotspot picker in Internet Explorer
  • Added CoreUIKit to core UI components such as a popover
You can’t perform that action at this time.