JIRA Developer Documentation : Web fragments

A web fragment is a link, a section of links or an area of HTML content (or 'panel') in a particular location of the JIRA web interface. A web fragment could be a menu in JIRA's top navigation bar (which in itself may contain its own links and link sections), buttons on the issue operations bar or panels on the view issue page.

Plugin Modules Involved in Creating a Web Fragment

A web fragment can consist of three kinds of plugin module:

• A Web Item module defines an individual link that is displayed at a particular location or section of the JIRA user interface. A web item might define an individual item within a JIRA drop-down menu or a button on the issue operations bar.
• A Web Section module defines a collection of links that is displayed together at a particular location of the JIRA user interface. A web section might define a group of items within a JIRA drop-down menu (separated by lines) or a group of buttons on the issue operations bar.
• A Web Panel module defines a section of HTML content displayed on a JIRA page.

Web items or web sections are utilised in a number of different ways, depending on the location of the web fragment you are creating.

Existing Web Fragments in JIRA

You can insert custom web fragments into existing ones in JIRA (e.g. web sections which are 'built in' to JIRA). However, you cannot redefine JIRA's existing web fragments.

We recommend downloading the JIRA source (valid JIRA license required), so you can access the appropriate source files that define JIRA's existing web fragments. This will help you:

• Alter the positions of your own web fragments
• Help you ensure key values in your own <web-items> and <web-sections> remain unique.

Locations

Web fragments can be developed for a number of locations throughout the JIRA web interface. This section describes these locations and for each one:

• where you can add web fragments for your plugin
• how you implement web item, web section and web panel plugin modules to construct these web fragments

For details on how to create web fragments for the appropriate location of JIRA's user interface, refer to the appropriate documentation below:

• Administration Area Locations
• Project Configuration Locations -- including the:
  • General project administration tabs
  • Summary tab
  • Operations buttons and menu items
• User Accessible Locations -- including:
  • Top navigation bar
  • User name drop-down menu
  • Tools drop-down menu on the user profile
  • Preset issue filters drop-down menu on the project summary tab
  • Hover profile links
  • Dialog box hints
• View Issue Page Locations -- including:
  • Issue operations bar
  • Right side of the 'View Issue' page