widget

The dashboards:widget and dashboards:backgroundScript modules are generally available for new Jira dashboards and replace the legacy jira:dashboardGadget and jira:dashboardBackgroundScript modules.

If you don't already see the dual-create option on your Jira development or test site, you can enroll the site in the Developer Canary Program to enable creation of either a classic Jira dashboard or a new dashboard. For rollout, migration, and deprecation details, see the Jira Dashboards announcement.

Use the widget APIs for dashboard widget view operations.

For module configuration and setup instructions, see Dashboard widget.

Setting preview configuration

Sets the preview configuration for the widget that appears when selected in the widget list. The configuration object replaces config in useWidgetConfig when the widget is rendered as a preview.

Usage

1
2
3
4
5
6
7
import { widget } from "@forge/dashboards-bridge";

widget.setPreviewConfig({
  title: "Preview Title",
  description: "This is a preview configuration",
});

Parameters:

previewConfig (WidgetConfig): The preview configuration object

Method signature

1
2
3
4
function setPreviewConfig(previewConfig: WidgetConfig): void;

type WidgetConfig = Record<string, unknown>;