@esoptra/zaza-bridge-sdk

ZAZA.rocks Bridge SDK

The ZAZA bridge SDK allows a ZAZA.rocks website-in-a-bag to interact with the ZAZA.rocks framework. This provides you with information about the currently active view and allows you to access built-in functionality such as file previewer and feedback mechanisms.

Browser

The latest Bridge SDK is hosted at: https://zaza.rocks/sdk/v1/bridge/bridge.js

When creating a website-in-a-bag you can easily import the SDK using the following script tag:

<script src="/sdk/v1/bridge/bridge.js" charset="utf-8"></script>

Once the Bridge SDK is included it becomes available as a global Bridge object. A common use-case for the bridge SDK is to figure out the active view QID. This is done as follows:

const viewId = await Bridge.View.getId()

NPM

You can also install the library using NPM:

npm i @esoptra/zaza-bridge-sdk

This allows you to import each object separately:

import { View } from '@esoptra/zaza-bridge-sdk'

const viewId = await View.getId()

Alternatively, you can emulate the browser API by importing the entire package:

import * as Bridge from '@esoptra/zaza-bridge-sdk'

const viewId = await Bridge.View.getId()

Examples

Please refer to the esoptra/zaza-examples repository for examples of both the ZAZA and ZAZA Bridge SDKs.

Documentation

The ZAZA.rocks documentation is available at https://help.zaza.rocks.