• About Connect modules for Jira
  • Admin Page
  • Administration UI locations
  • Build
  • Dashboard Item
  • Deployment
  • Development Tool
  • Dialog
  • Entity Property
  • Feature Flag
  • Global Permission
  • Home container
  • Issue Background Script
  • Issue Content
  • Issue Field
  • Issue Glance
  • Issue view UI locations
  • Keyboard Shortcut
  • New issue view UI locations
  • Page
  • Project Admin Tab Panel
  • Project Page
  • Project Permission
  • Project settings UI locations
  • Project sidebar
  • Remote Link
  • Report
  • Search Request View
  • Tab Panel
  • Time Tracking Provider
  • User profile menu
  • Web Item
  • Web Panel
  • Web Section
  • Webhook
  • Workflow Condition
  • Workflow Post Function
  • Workflow Validator

Web Item Target

Defines the way a web item link is opened in the browser, such as in a modal or inline dialog.

Inline Dialog Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "target": {
    "type": "inlinedialog",
    "options": {
      "onHover": true,
      "offsetX": "30px",
      "offsetY": "20px"
    }
  }
}

Dialog Example

1
2
3
4
5
6
7
8
9
{
  "target": {
    "type": "dialog",
    "options": {
      "height": "100px",
      "width": "200px"
    }
  }
}

Common Dialog Module Example

1
2
3
4
5
6
7
8
{
  "target": {
    "type": "dialogmodule",
    "options": {
      "key": "dialog-module-key"
    }
  }
}

More details for this use-case can be found on the Dialog Module page.

Properties

options

Type
object
Description

An object containing options which vary based on the type of web item target you are implementing.

Currently-allowed options are:

  • Inline Dialog Options when type is "inlinedialog", and
  • Dialog Options when type is "dialog"
  • Dialog Module Options when type is "dialogmodule"


type

Type
string
Defaults to
page
Allowed values
  • page
  • PAGE
  • dialog
  • DIALOG
  • inlinedialog
  • INLINEDIALOG
  • dialogmodule
  • DIALOGMODULE
  • Description

    Defines how the web-item content should be loaded by the page. By default, the web-item is loaded in the same page. The target can be set to open the web-item url as a modal dialog or an inline dialog.


    • System status
    • Privacy
    • Developer Terms
    • Trademark
    • Cookie Preferences
    • © 2019 Atlassian