Last updated Sep 17, 2025

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
{
  "target": {
    "type": "dialog",
    "options": {
      "height": "100px",
      "width": "200px"
    }
  }
}

Dialog Example

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

Typei18n-property
DescriptionRepresents 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

{ "value": "My text" }

Properties

height

Typestring
Max length10

size

Typestring

width

Typestring
Max length10

Rate this page: