Jira dashboard background script

The jira:dashboardBackgroundScript module adds an invisible container to the Dashboards page.

Unlike dashboard gadgets, the dashboard background script is not influenced by the dashboard page navigation changes. This makes it the perfect candidate for:

• distributing shared data
• making heavy calculations
• other optimizations

Examples

Use the events API for communication between dashboard background scripts and dashboard gadgets. Because modules may be rendered in a different order, we recommend that you handle both scenarios.

Dashboard background script:

1
2
import { events } from '@forge/bridge';

// Emit the data to already rendered dashboard gadgets
events.emit('app.data-change', 'initial-data');

// Listen to data change requests from dashboard gadgets
events.on('app.request-data', (payload) => {
  events.emit('app.data-change', 'initial-or-changed-data');
});

Dashboard gadget:

1
2
import { events } from '@forge/bridge';

// Request the data in case the dashboard background script is already rendered
events.emit('app.request-data');

// Listen to data change
events.on('app.data-change', (payload) => {
  console.log('The data has changed:', payload)
});

Manifest

1
2
modules:
  jira:dashboardBackgroundScript:
    - key: dashboard-bg-script
      resource: dashBgScriptResource
      render: native
  jira:dashboardGadget:
    - key: dashboard-bg-script-gadget
      title: Hello world!
      description: Gadget that talks with background script.
      thumbnail: https://developer.atlassian.com/platform/forge/images/icons/issue-panel-icon.svg
      resource: gadgetResource
      render: native

Properties

Extension context