Space Tools Tab

Space Tools Tab modules enable add-ons to insert tabs into Confluence Space Tools area. These can be automatically resized to the width and height of your add-on's content. The location attribute defines which section the tab will appear.

Spaces page with the Documentation Theme do not support the Space Tools area, and instead display the legacy Space Admin area. This module will insert a tab in a pre-defined location in Space Admin (look below for a complete list of existing locations).

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "modules": {
    "spaceToolsTabs": [
      {
        "url": "/space-tools-tab?space_key={space.key}",
        "location": "contenttools",
        "name": {
          "value": "Space Tools Tab"
        },
        "key": "my-space-tools-tab"
      }
    ]
  }
}

Properties

key

Type
string
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
{
    "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
{
  "value": "My text"
}

Properties

value
Type
string
Required
Yes
Description

The human-readable default value. This will be used if no translation exists.

i18n
Type
string
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

The url to retrieve the content from. This can be absolute or relative to the add-on's baseUrl

conditions

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

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

location

Type
string
Description

The sub-section where this Space Tools Tab should appear. The primary section for Space Tabs is system.space.tools, and the location specified here will be beneath that. e.g setting a location of "contenttools" will result in a final location of system.space.tools/contenttools.

Confluence comes the following standard sections in Space Tools:

  • system.space.tools/overview
  • system.space.tools/permissions
  • system.space.tools/contenttools
  • system.space.tools/lookandfeel
  • system.space.tools/integrations
  • system.space.tools/addons

In future, Connect add-ons will be able to define new web sections, which will enable add-ons to define new sub-sections for Space Tools.

Legacy Space Admin section cannot be defined, and is always system.space.admin/spaceops

params

Type
Object
Description

This object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.

Example

1
2
3
4
5
6
{
  "params": {
    "someOtherProperty": "someValue",
    "myCustomProperty": "myValue"
  }
}

weight

Type
integer
Defaults to
100
Description

Determines the order in which the page's link appears in the menu or list.

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.

Built-in web items have weights that are incremented by numbers that leave room for additional items, such as by 10 or 100. Be mindful of the weight you choose for your item, so that it appears in a sensible order given existing items.