Home

Welcome to the widget-sdk wiki!

Check out the sidebar for deep dive into the documentation for each client.

Overview

The widget SDK is a collection of developer tools that allow for rapid development of widget platforms that are built over the native HTML's iframe and it's .postMessage() method.

Features

• Two clients
  • A widget client meant for web applications intended to be consumed as widgets by another app.
  • A container client meant for a platform that intends to host many externally deployed widgets.
• State management and synchronization between a widget and its container via widgetClient.setState() and containerClient.setState() methods.
• post() method for sending events from a widget to the container, as well as sending events from the container to specific widgets.
• postForward() method for widgets to send events intended for other widgets. These go through the container, and are forwarded to the designated recipient widget.
• .on() method to subscribe to specific events or methods and trigger call backs.