Dialog

The Dialog module provides a mechanism for launching an add-on's modules as modal dialogs from within an add-on's iframe.

A modal dialog displays information without requiring the user to leave the current page.

The dialog is opened over the entire window, rather than within the iframe itself.

Styling your dialog to look like a standard Atlassian dialog

By default the dialog iframe is undecorated. It's up to you to style the dialog.

In order to maintain a consistent look and feel between the host application and the add-on, we encourage you to style your dialogs to match Atlassian's Design Guidelines for modal dialogs.

To do that, you'll need to add the AUI styles to your dialog.

For more information, read about the Atlassian User Interface dialog component.

Methods

create (options)

Creates a dialog for a common dialog, page or web-item module key.

Parameters

NameTypeDescription
optionsDialog~DialogOptions

configuration object of dialog options.

Returns

Dialog~Dialog

Dialog object allowing for callback registrations

Example

1
2
3
4
5
6
7
8
9
10
11
12
AP.dialog.create({
  key: 'my-module-key',
  width: '500px',
  height: '200px',
  chrome: true,
  buttons: [
    {
      text: 'my button',
      identifier: 'my_unique_identifier'
    }
  ]
}).on("close", callbackFunc);

close (data)

Closes the currently open dialog. Optionally pass data to listeners of the dialog.close event. This will only close a dialog that has been opened by your add-on. You can register for close events using the dialog.close event and the events module.

Parameters

NameTypeDescription
data

Object

An object to be emitted on dialog close.

Example

1
AP.dialog.close({foo: 'bar'});

getCustomData (callback)

Passes the custom data Object to the specified callback function.

Parameters

NameTypeDescription
callback

function

Callback method to be executed with the custom data.

Example

1
2
3
AP.dialog.getCustomData(function (customData) {
  console.log(customData);
});

getButton()

Returns the button that was requested (either cancel or submit). If the requested button does not exist, an empty Object will be returned instead.

Returns

Dialog~DialogButton

Example

1
AP.dialog.getButton('submit');

disableCloseOnSubmit()

Stop the dialog from closing when the submit button is clicked

Example

1
2
3
4
5
6
AP.dialog.disableCloseOnSubmit();
AP.events.on('dialog.button.click', function(data){
  if(data.button.name === 'submit') {
    console.log('submit button pressed');
  }
}

createButton()

Creates a dialog button that can be controlled with javascript

Returns

Dialog~DialogButton

Example

1
2
3
4
AP.dialog.createButton({
  text: 'button text',
  identifier: 'button.1'
}).bind(function mycallback(){});

isCloseOnEscape (callback)

Queries the value of the 'closeOnEscape' property.

If this property is true then the dialog should close if ESC is pressed.

Parameters

NameTypeDescription
callback

function

function to receive the 'closeOnEscape' value.

Example

1
2
3
4
5
AP.dialog.isCloseOnEscape(function(enabled){
  if(enabled){
    // close on escape is true
  }
});

Rate this page: