Project Page

On This Page

    Want to quickly build your UI?

    Jira project pages in Forge let you quickly build user interfaces consistent to Atlassian Design using pre-built components.

    Already have a Connect app? Start adding Forge features in less than an hour.

    This module represents a page with a project sidebar.

    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "modules": { "jiraProjectPages": [ { "url": "/iframe-content-url?projectId=${project.id}", "iconUrl": "/logo-url-or-inline-svg", "weight": 100, "name": { "value": "My Project Page" }, "key": "my-project-page" } ] } }

    Properties

    key
    Type
    string
    Max length
    100
    Required
    Yes
    Pattern
    ^[a-zA-Z0-9-]+$
    Description

    A key to identify this module.

    This key must be unique relative to the add on, with the exception of Confluence macros: Their keys need to be globally unique.

    Keys must only contain alphanumeric characters and dashes.

    The key is used to generate the url to your add-on's module. The url is generated as a combination of your add-on key and module key. For example, an add-on which looks like:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    {
        "key": "my-addon",
        "modules": {
            "configurePage": {
                "key": "configure-me",
            }
        }
    }
    

    Will have a configuration page module with a URL of /plugins/servlet/ac/my-addon/configure-me.


    name
    Type
    i18n Property
    Required
    Yes
    Description

    A human readable name.

    Represents a string that can be resolved via a localization properties file. You can use the same i18n Property key and value in multiple places if you like, but identical keys must have identical values.

    Example

    1
    2
    3
    4
    {
      "value": "My text"
    }
    

    Properties

    value
    Type
    string
    Max length
    1500
    Required
    Yes
    Description

    The human-readable default value. This will be used if no translation exists. Only the following HTML tags are supported: b, i, strong, em, and code.

    i18n
    Type
    string
    Max length
    300
    Description

    The localization key for the human-readable value. Translations for the keys are defined at the top level of the add-on descriptor.


    url
    Type
    string
    Format
    uri-template
    Required
    Yes
    Description

    Specifies the URL targeted by the page. The URL is relative to the add-on's base URL.


    conditions
    Type
    [Single Condition, Composite Condition, ...]
    Description

    Conditions can be added to display only when all the given conditions are true.


    iconUrl
    Type
    string
    Format
    uri
    Description

    Specifies an icon URL that will displayed alongside the link to the project page in the project sidebar.

    The icon resource provided in this field should be larger or equals to 16x16 pixels.


    weight
    Type
    integer
    Defaults to
    100
    Description

    Specifies the ordering of the link in the project sidebar.

    The "lightest" weight (i.e., lowest number) appears first, rising relative to other items, while the "heaviest" weights sink to the bottom of the menu or list.


    Rate this page: