TextControl

Defines a text field which may appear in control extension points such as the property panel

Example

1
2
3
4
5
6
7
8
{
  "type": "button",
  "label": {
    "value": "My Custom Control 0"
  },
  "key": "my-custom-control-0"
}

Properties

key
Type
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:

{ "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.


macroParameter
Type
Max length
100
Required
Yes
Description

The Macro Parameter identifier used to store the text


type
Type
Required
Yes
Allowed values
  • text
  • TEXT
Description

The type field must be set to 'text'