Dialog Options

Options for a modal dialog web item target or common module.

These options are a subset of those available via the JavaScript API.

Web Item Example

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

Dialog Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "modules": {
    "dialogs": [
      {
        "url": "/my-dialog-content",
        "options": {
          "size": "fullscreen",
          "header": {
            "value": "Example Dialog"
          }
        },
        "key": "dialog-module-key"
      }
    ]
  }
}

Properties

chrome
Type
Defaults to
true
Description

Whether the dialog should contain the AUI header and buttons.

header
Type
Description

The header text for the dialog, if chrome is enabled.

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

height
Type
Max length
10
Description

Sets how high the dialog is in pixels

size
Type
Allowed values
  • small
  • SMALL
  • medium
  • MEDIUM
  • large
  • LARGE
  • x-large
  • X-LARGE
  • fullscreen
  • FULLSCREEN
  • maximum
  • MAXIMUM
Description

Sets the size of the dialog.

This option is used instead of the 'height' and 'width' options.

width
Type
Max length
10
Description

Sets how wide the dialog is in pixels.

Rate this page: