This repository hosts:
- The Javascript "bridge" SDK, which allows communication from the page to the native component of Batch in iOS / Android apps.
- A development kit, which is a simple webpage that allows testing of your implementation of the SDK in your page.
See the devkit folder's README for more info - A sample template, implementing a user survey.
The sample is responsive, implements iOS specific guidelines and uses the Javascript SDK to track events back to Batch.
Seedevkit/samples/surveyfor more information.
This SDK requires a relatively modern browser that supports Promise.
On iOS/Android, it requires Batch SDK 1.17 or higher.
Add the following tag on your page:
<head>
<script src="https://cdn.jsdelivr.net/npm/@batch.com/[email protected]/build/batch-webview-sdk.min.js"></script>
As the script is very light, we encourage you to synchronously load it in <head> so that it is always available.
The SDK will be available as a global object called batchInAppSDK.
You can also host batch-webview-sdk.min.js on your own server.
Releases are published on npm: @batch.com/in-app-webview-sdk
The API reference can be found here, in the form of a Typescript definition.
Files are located in "src" and are built in "build".
src is typescript that compiles to ES5. Be careful about runtime dependencies, as Typescript doesn't polyfill them.
It's a standard typescript project so use your favourite editor. The repository comes preconfigured for IntelliJ (Webstorm/Phpstorm/Ultimate) and VSCode.
Your editor should have an eslint plugin enabled. Formatting will be handled via prettier.
npm run build-minified
This will output build/batch-webview-sdk.min.js
npm run serve
This will serve the SDK on port 9094. A devkit will also be available on http://localhost:9094
Note: This expects you to have built the SDK using npm run build-minified.
npm run watch
Combines build & serve, will automatically rebuild the SDK when changes occur.