Core concepts

Widget set

A widget set is a Compass resource that represents versions of custom frontend code. Each widget set version can include multiple widgets, and each widget has its own entry point. Widget sets make it easier to manage and publish several widgets that share the same code or assets from a single code repository.

Widget

A widget is an individual component within a widget set, designed to perform a specific function or display particular content. Widgets are permissioned based on the widget set to which it belongs and declare a configuration shape to interact with its host application (such as Workshop).

Parameters

Parameters are configurable for each widget, and are designed to allow the host application (such as Workshop) to pass data into the widget. Parameters can currently be passed as primitive values (for example: a string, number, or Boolean).

Events

Events are configurable for each widget, and allow widgets a mechanism for updating parameters or signaling that the host application (such as Workshop) should perform some action.