Forge Developer

Beta

Forge Developer

Beta

Rate this page:

Resources

Using custom UI, you can define your own user interface using static resources, such as HTML, CSS, JavaScript, and images. The Forge platform hosts your static resources, enabling your app to display custom UI on Atlassian products. Custom UI apps inherit modern security features to ensure high trust between Atlassian, developers, and users.

Properties

The resources section of your manifest.yml controls the configuration of the static assets that you want to display in your app.

PropertyTypeRequiredDescription
key

string

Yes

A key for the resource, which other modules can refer to. Must be unique within the manifest and have a maximum of 23 characters.

Regex: ^[a-zA-Z0-9_-]+$

path

string

Yes

The relative path from the top-level directory of your app to the directory that contains the resources your app is using.

Example

1
2
3
4
5
resources: # list below the static resources entries for your app
  - key: my-resource-1
    path: relative/path/to/resource/one/directory
  - key: my-resource-2
    path: relative/path/to/resource/two/directory

A full example of a module using resources would look like:

1
2
3
4
5
6
7
8
9
10
11
12
modules:
  jira:issuePanel:
    - key: hello-world-panel
      title: Custom UI App
      description: A Forge app with resources
      resource: my-resource-1 # link to the resources listed below
app:
  id: "<your app id>"
  name: app-with-resources
resources: # list below the resource entries for your app
  - key: my-resource-1
    path: relative/path/to/resource/one/directory

See the following step-by-step tutorial to start building a custom UI app in Jira.

Usage with modules

You can only use the optional resource property with modules that display a user interface. See modules to know which modules have a user interface. See Custom UI for more details.

Rate this page: