Custom Widgets API Reference

We provide a custom library for JavaScript that includes an API for working with custom widgets. To install this library, use one of the following implementations:

Add a reference to the dashboard script on unpkg in the header of your index.html file. Wrap the reference inside a <script> tag. For example:
<script src="https://unpkg.com/hub-dashboard-addons@latest"></script>
Use the npm package manager to install the script with the npm install hub-dashboard-addons command. You can then add references to the script in your widget any way you want.

The Dashboard.registerWidget function accepts a callback that is called with the dashboardAPI and registerWidgetAPI parameters as shown in the following code sample. To view this sample in context, refer to the Custom Widget Tutorial.

// Register widget:
Dashboard.registerWidget(function (dashboardAPI, registerWidgetAPI) {
    // Load GitHub profile data
    loadAndRenderUser(USER_NAME)

    // Set the widget title
    .then(user => dashboardAPI.setTitle(`GitHub User ${user.login}`));

    // Add the refresh button.
    registerWidgetAPI({
        onRefresh: () => loadAndRenderUser(USER_NAME)
    });
});

Use the following reference to build custom widgets for your Hub dashboards and project overview pages.

Dashboard API

Use the dashboard API to communicate with the widget wrapper and the page that the widget is plugged into. All of these methods are asynchronous and return Promise objects. These methods are applied to the dashboardApi object.

setTitle(label: string, ?labelUrl: string): void
Description	Sets the text that is displayed in the widget header. If a value is specified for the `labelUrl` parameter, the text is set as a link to the target URL.
Parameters	`label`	The text string that is shown as the widget title.
Parameters	`labelURL`	The address of the target page that opens when a user clicks the widget title. If this optional parameter is not specified, the widget title is set as text only.

setLoadingAnimationEnabled(enabled: boolean): void
Description	Toggles the image rotation animation for the widget reload icon. Call this method when the widget populates data from a remote server to indicate that a process is running in the background.
Parameters	`enabled`	Determines whether the widget reload icon rotates or not.

alert(message: string, ?type: string, ?timeout: number): string
Description	Displays a system alert at the top of the page.
Parameters	`message`	Sets the text that is displayed as the system alert.
	`type`	Determines which notification style is applied to the alert. Possible values include `error`, `message`, `success`, and `warning`.
	`timeout`	The amount of time the alert is shown on the page, in seconds.

enterConfigMode(): void
Description	Invokes configuration mode. When in configuration mode, the visual presentation of the widget changes to indicate that its settings can be updated. The refresh icon is also hidden.

exitConfigMode(): void
Description	Exits configuration mode.

storeCache(cache: Object): Object
Description	Stores any object in the client-side cache. Use this method to store populated data locally and display it immediately on the dashboard, then refresh it from server. Returns a configuration object.
Parameters	`cache`	Specifies the object to be stored in the cache.

readCache(): Object
Description	Reads and returns the object that was previously stored in the cache.

storeConfig(config: Object): void
Description	Stores any object as a widget configuration. Exits configuration mode if configuration mode is active.
Parameters	`config`	Specifies the object to be stored as a widget configuration.

readConfig(): Object
Description	Reads and returns the object that was previously stored as a configuration object.

fetch(serviceID: string, url: string, fetchConfig: Object): Object
Description	Makes an authorized request to the specified service. The service must be specified in the widget manifest.
Parameters	`serviceID`	Specifies the ID of the service.
	`url`	Sets the URL to the service API endpoint. This is the path to the resource that you want to fetch. The URL is relative to the server home URL.
	`fetchConfig`	Defines an optional options object. This object contains any custom settings that you want to apply to the request.

fetchHub(url: string, fetchConfig: Object): Object
Description	Makes an authorized request to the Hub service.
Parameters	`url`	Sets the URL to the Hub service API endpoint. This is the path to the resource that you want to fetch. The URL is relative to the server home URL.
Parameters	`fetchConfig`	Defines an optional options object. This object contains any custom settings that you want to apply to the request.

removeWidget(): void
Description	Removes the custom widget from the dashboard or project overview page.

Use the widget API to manipulate the visibility of controls on your custom widget. These methods are also asynchronous and return Promise objects. These methods are applied to the widgetApi object.

onRefresh(): void
Description	Calls an action when the refresh icon is clicked in the widget header. If not set, the refresh icon is not shown in the header.

onConfigure(): void
Description	Calls an action when the Edit option is selected from the widget menu. If not set, the Edit option is not shown.

Last modified: 22 May 2018

Hub 2018.1 Help

Custom Widgets API Reference

Dashboard API

Widget API