Expand all

OO.ui.MessageDialog

Extends

Constructor

new OO.ui.MessageDialog([config]) #

MessageDialogs display a confirmation or alert message. By default, the rendered dialog box consists of a header that contains the dialog title, a body with the message, and a footer that contains any action widgets. The MessageDialog class is the only type of dialog that is usually instantiated directly.

There are two basic types of message dialogs, confirmation and alert:

  • confirmation: the dialog title describes what a progressive action will do and the message provides more details about the consequences.
  • alert: the dialog title describes which event occurred and the message provides more information about why the event occurred.

The MessageDialog class specifies two actions: ‘accept’, the primary action (e.g., ‘ok’) and ‘reject,’ the safe action (e.g., ‘cancel’). Both will close the window, passing along the selected action.

For more information and examples, please see the [OOUI documentation on MediaWiki][1].

Example

// Example: Creating and opening a message dialog window.
    const messageDialog = new OO.ui.MessageDialog();

    // Create and append a window manager.
    const windowManager = new OO.ui.WindowManager();
    $( document.body ).append( windowManager.$element );
    windowManager.addWindows( [ messageDialog ] );
    // Open the window.
    windowManager.openWindow( messageDialog, {
        title: 'Basic message dialog',
        message: 'This is the message'
    } );

[1]: https://www.mediawiki.org/wiki/OOUI/Windows/Message_Dialogs

Parameters:

Name Type Attributes Description
config Object optional

Configuration options
Source:
MessageDialogs display a confirmation or alert message.

Properties

$focusTrapBefore #

Set focus traps

It is considered best practice to trap focus in a loop within a modal dialog, even though with 'inert' support we could allow focus to break out to the browser chrome.

Inherited from:
Source:

Set focus traps

It is considered best practice to trap focus in a loop within a modal dialog, even though with 'inert' support we could allow focus to break out to the browser chrome.

$overlay #

Overlay element to use for the $overlay configuration option of widgets that support it. Things put inside it are overlaid on top of the window and are not bound to its dimensions. See https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays.

MyDialog.prototype.initialize = function () {
  ...
  const popupButton = new OO.ui.PopupButtonWidget( {
    $overlay: this.$overlay,
    label: 'Popup button',
    popup: {
      $content: $( '<p>Popup content.</p><p>More content.</p><p>Yet more content.</p>' ),
      padded: true
    }
  } );
  ...
};

Properties:

Type Description
jQuery
Inherited from:
Source:
Overlay element to use for the $overlay configuration option of widgets that support it.

actionsstatic #

Source:

messagestatic #

The message displayed in the dialog body.

A confirmation message describes the consequences of a progressive action. An alert message describes why an event occurred.

Properties:

Type Description
jQuery | string | function | null
Source:
The message displayed in the dialog body.

namestatic #

Source:

sizestatic #

Source:

titlestatic #

Dialog title.

The title of a confirmation dialog describes what a progressive action will do. The title of an alert dialog describes which event occurred.

Properties:

Type Description
jQuery | string | function | null
Source:
Dialog title.

Methods

attachActions()protected #

Attach action actions.

Overrides:
Source:
Attach action actions.

close([data]) → {OO.ui.WindowInstance} #

Close the window.

This method is a wrapper around a call to the window manager’s closeWindow method.

The window's #getHoldProcess and #getTeardownProcess methods are called during the closing phase of the window’s lifecycle and can be used to specify closing behavior each time the window closes.

Parameters:

Name Type Attributes Description
data Object optional

Window closing data

Returns:

See OO.ui.WindowManager#closeWindow

Type
OO.ui.WindowInstance

Throws:

An error is thrown if the window is not attached to a window manager

Type
Error
Inherited from:
Source:
Close the window.

detachActions() → {OO.ui.Dialog}protectedchainable #

Detach action actions.

Returns:

The dialog, for chaining

Type
OO.ui.Dialog
Inherited from:
Source:
Detach action actions.

executeAction(action) → {jQuery.Promise} #

Execute an action.

Parameters:

Name Type Description
action string

Symbolic name of action to execute

Returns:

Promise resolved when action completes, rejected if it fails

Type
jQuery.Promise
Inherited from:
Source:
Execute an action.

focus([focusLast]) → {OO.ui.Window}chainable #

Focus the window

Parameters:

Name Type Attributes Default Description
focusLast boolean optional
 false

Focus the last focusable element in the window, instead of the first

Returns:

The window, for chaining

Type
OO.ui.Window
Inherited from:
Source:
Focus the window

getActionProcess([action]) → {OO.ui.Process} #

Get a process for taking action.

When you override this method, you can create a new OO.ui.Process and return it, or add additional accept steps to the process the parent method provides using the 'first' and 'next' methods of OO.ui.Process.

Parameters:

Name Type Attributes Description
action string optional

Symbolic name of action

Returns:

Action process

Type
OO.ui.Process
Overrides:
Source:
Get a process for taking action.

getActionWidget(config) → {OO.ui.ActionWidget} #

Get action widget from config

Override this method to change the action widget class used.

Parameters:

Name Type Description
config Object

Action widget config

Returns:

Action widget

Type
OO.ui.ActionWidget
Inherited from:
Source:

Get action widget from config

Override this method to change the action widget class used.

getActionWidgetConfig(config) → {Object} #

Get action widget config

Override this method to modify the action widget config

Parameters:

Name Type Description
config Object

Initial action widget config

Returns:

Action widget config

Type
Object
Overrides:
Source:

Get action widget config

Override this method to modify the action widget config

getActionWidgets(actions) → {Array.<OO.ui.ActionWidget>} #

Get action widgets from a list of configs

Parameters:

Name Type Description
actions Array.<Object>

Action widget configs

Returns:

Action widgets

Type
Array.<OO.ui.ActionWidget>
Inherited from:
Source:
Get action widgets from a list of configs

getActions() → {OO.ui.ActionSet} #

Get the set of actions used by the dialog.

Returns:

Type
OO.ui.ActionSet
Inherited from:
Source:
Get the set of actions used by the dialog.

getBodyHeight() → {number} #

Get the height of the window body.

To get the height of the full window contents (the window body, head, and foot together), use #getContentHeight.

When this function is called, the window will temporarily have been resized to height=1px, so .scrollHeight measurements can be taken accurately.

Returns:

Height of the window body in pixels

Type
number
Overrides:
Source:
Get the height of the window body.

getClosestScrollableElementContainer() → {HTMLElement} #

Get closest scrollable container.

Returns:

Closest scrollable container

Type
HTMLElement
Inherited from:
Source:
Get closest scrollable container.

getContentHeight() → {number} #

Get the height of the full window contents (i.e., the window head, body and foot together).

What constitutes the head, body, and foot varies depending on the window type. A message dialog displays a title and message in its body, and any actions in the foot. A process dialog displays a title and special actions in the head, and dialog content in the body.

To get just the height of the dialog body, use the #getBodyHeight method.

Returns:

The height of the window contents (the dialog head, body and foot) in pixels

Type
number
Inherited from:
Source:
Get the height of the full window contents (i.e., the window head, body and foot together).

getData() → {any} #

Get element data.

Returns:

Element data

Type
any
Inherited from:
Source:
Get element data.

getDir() → {string} #

Get the directionality of the frame (right-to-left or left-to-right).

Returns:

Directionality: 'ltr' or 'rtl'

Type
string
Inherited from:
Source:
Get the directionality of the frame (right-to-left or left-to-right).

getElementDocument() → {HTMLDocument} #

Get the DOM document.

Returns:

Document object

Type
HTMLDocument
Inherited from:
Source:
Get the DOM document.

getElementGroup() → {OO.ui.mixin.GroupElement|null} #

Get group element is in.

Returns:

Group element, null if none

Type
OO.ui.mixin.GroupElement | null
Inherited from:
Source:
Get group element is in.

getElementId() → {string} #

Ensure that the element has an 'id' attribute, setting it to an unique value if it's missing, and return its value.

Returns:

Type
string
Inherited from:
Source:

Ensure that the element has an 'id' attribute, setting it to an unique value if it's missing, and return its value.

getElementWindow() → {Window} #

Get the DOM window.

Returns:

Window object

Type
Window
Inherited from:
Source:
Get the DOM window.

getEscapeAction() → {string|null} #

The current action to perform if the Escape key is pressed.

The empty string action closes the dialog (see #getActionProcess). The make the escape key do nothing, return null here.

Returns:

Action name, or null if unescapable

Type
string | null
Inherited from:
Source:
The current action to perform if the Escape key is pressed.

getHoldProcess([data]) → {OO.ui.Process} #

Get the 'hold' process.

The hold process is used to keep a window from being used in a particular context, based on the data argument. This method is called during the closing phase of the window’s lifecycle (before the closing animation). You can close dropdowns of elements in the window in this process, if they do not get closed automatically.

Override this method to add additional steps to the 'hold' process the parent method provides using the first and next methods of OO.ui.Process.

Parameters:

Name Type Attributes Description
data Object optional

Window closing data

Returns:

Hold process

Type
OO.ui.Process
Inherited from:
Source:
Get the 'hold' process.

getManager() → {OO.ui.WindowManager} #

Get the window manager.

All windows must be attached to a window manager, which is used to open and close the window and control its presentation.

Returns:

Manager of window

Type
OO.ui.WindowManager
Inherited from:
Source:
Get the window manager.

getReadyProcess([data]) → {OO.ui.Process} #

Get the ‘ready’ process.

The ready process is used to ready a window for use in a particular context, based on the data argument. This method is called during the opening phase of the window’s lifecycle, after the window has been setup (after the opening animation). You can focus elements in the window in this process, or open their dropdowns.

Override this method to add additional steps to the ‘ready’ process the parent method provides using the first and next methods of OO.ui.Process.

Parameters:

Name Type Attributes Description
data Object optional

Window opening data

Returns:

Ready process

Type
OO.ui.Process
Overrides:
Source:
Get the ‘ready’ process.

getSetupProcess([data]) → {OO.ui.Process} #

Get the 'setup' process.

The setup process is used to set up a window for use in a particular context, based on the data argument. This method is called during the opening phase of the window’s lifecycle (before the opening animation). You can add elements to the window in this process or set their default values.

Override this method to add additional steps to the ‘setup’ process the parent method provides using the first and next methods of OO.ui.Process.

To add window content that persists between openings, you may wish to use the #initialize method instead.

Parameters:

Name Type Attributes Description
data Object optional

Window opening data

Returns:

Setup process

Type
OO.ui.Process
Overrides:
Source:
Get the 'setup' process.

getSize() → {string} #

Get the symbolic name of the window size (e.g., small or medium).

Returns:

Symbolic name of the size: small, medium, large, larger, full

Type
string
Inherited from:
Source:
Get the symbolic name of the window size (e.g., small or medium).

getSizeProperties() → {Object} #

Get the size properties associated with the current window size

Returns:

Size properties

Type
Object
Inherited from:
Source:
Get the size properties associated with the current window size

getTagName() → {string} #

Get the HTML tag name.

Override this method to base the result on instance information.

Returns:

HTML tag name

Type
string
Inherited from:
Source:
Get the HTML tag name.

getTeardownProcess([data]) → {OO.ui.Process} #

Get the ‘teardown’ process.

The teardown process is used to teardown a window after use. During teardown, user interactions within the window are conveyed and the window is closed, based on the data argument. This method is called during the closing phase of the window’s lifecycle (after the closing animation). You can remove elements in the window in this process or clear their values.

Override this method to add additional steps to the ‘teardown’ process the parent method provides using the first and next methods of OO.ui.Process.

Parameters:

Name Type Attributes Description
data Object optional

Window closing data

Returns:

Teardown process

Type
OO.ui.Process
Inherited from:
Source:
Get the ‘teardown’ process.

hold([data]) → {jQuery.Promise} #

Hold window.

This is called by OO.ui.WindowManager during window closing (before the animation), and should not be called directly by other systems.

Parameters:

Name Type Attributes Description
data Object optional

Window closing data

Returns:

Promise resolved when window is held

Type
jQuery.Promise
Inherited from:
Source:
Hold window.

initialize() → {OO.ui.Window}chainable #

Initialize window contents.

Before the window is opened for the first time, #initialize is called so that content that persists between openings can be added to the window.

To set up a window with new content each time the window opens, use #getSetupProcess.

Returns:

The window, for chaining

Type
OO.ui.Window

Throws:

An error is thrown if the window is not attached to a window manager

Type
Error
Overrides:
Source:
Initialize window contents.

isClosing() → {boolean} #

Check if the window is closing.

This method is a wrapper around the window manager's isClosing method.

Returns:

Window is closing

Type
boolean
Inherited from:
Source:
Check if the window is closing.

isElementAttached() → {boolean} #

Check if the element is attached to the DOM

Returns:

The element is attached to the DOM

Type
boolean
Inherited from:
Source:
Check if the element is attached to the DOM

isInitialized() → {boolean} #

Check if the window has been initialized.

Initialization occurs when a window is added to a manager.

Returns:

Window has been initialized

Type
boolean
Inherited from:
Source:
Check if the window has been initialized.

isOpened() → {boolean} #

Check if the window is opened.

This method is a wrapper around the window manager's isOpened method.

Returns:

Window is opened

Type
boolean
Inherited from:
Source:
Check if the window is opened.

isOpening() → {boolean} #

Check if the window is opening.

This method is a wrapper around the window manager's isOpening method.

Returns:

Window is opening

Type
boolean
Inherited from:
Source:
Check if the window is opening.

isVisible() → {boolean} #

Check if the window is visible.

Returns:

Window is visible

Type
boolean
Inherited from:
Source:
Check if the window is visible.

onFocusTrapFocused(event) #

Called when someone tries to focus the hidden element at the end of the dialog. Sends focus back to the start of the dialog.

Parameters:

Name Type Description
event jQuery.Event

Focus event
Inherited from:
Source:
Called when someone tries to focus the hidden element at the end of the dialog.

open([data]) → {OO.ui.WindowInstance} #

Open the window.

This method is a wrapper around a call to the window manager’s openWindow method.

To customize the window each time it opens, use #getSetupProcess or #getReadyProcess.

Parameters:

Name Type Attributes Description
data Object optional

Window opening data

Returns:

See OO.ui.WindowManager#openWindow

Type
OO.ui.WindowInstance

Throws:

An error is thrown if the window is not attached to a window manager

Type
Error
Inherited from:
Source:
Open the window.

ready([data]) → {jQuery.Promise} #

Ready window.

This is called by OO.ui.WindowManager during window opening (after the animation), and should not be called directly by other systems.

Parameters:

Name Type Attributes Description
data Object optional

Window opening data

Returns:

Promise resolved when window is ready

Type
jQuery.Promise
Inherited from:
Source:
Ready window.

restorePreInfuseState(state)protected #

Restore the pre-infusion dynamic state for this widget.

This method is called after #$element has been inserted into DOM. The parameter is the return value of #gatherPreInfuseState.

Parameters:

Name Type Description
state Object
Inherited from:
Source:
Restore the pre-infusion dynamic state for this widget.

scrollElementIntoView([config]) → {jQuery.Promise} #

Scroll element into view.

Parameters:

Name Type Attributes Description
config Object optional

Configuration options

Returns:

Promise which resolves when the scroll is complete

Type
jQuery.Promise
Inherited from:
Source:
Scroll element into view.

setData(data) → {OO.ui.Element}chainable #

Set element data.

Parameters:

Name Type Description
data any

Element data

Returns:

The element, for chaining

Type
OO.ui.Element
Inherited from:
Source:
Set element data.

setDimensions(dim) → {OO.ui.Window}chainable #

Set window dimensions. This method is called by the window manager when the window is opening. In general, setDimensions should not be called directly.

To set the size of the window, use the #setSize method.

Parameters:

Name Type Description
dim Object

CSS dimension properties

Properties:
Name Type Attributes Default Description
width string | number optional
 ''

Width
minWidth string | number optional
 ''

Minimum width
maxWidth string | number optional
 ''

Maximum width
height string | number optional

Height, omit to set based on height of contents
minHeight string | number optional
 ''

Minimum height
maxHeight string | number optional
 ''

Maximum height

Returns:

The window, for chaining

Type
OO.ui.Window
Overrides:
Source:
Set window dimensions.

setElementGroup(group) → {OO.ui.Element}chainable #

Set group element is in.

Parameters:

Name Type Description
group OO.ui.mixin.GroupElement | null

Group element, null if none

Returns:

The element, for chaining

Type
OO.ui.Element
Inherited from:
Source:
Set group element is in.

setElementId(id) → {OO.ui.Element}chainable #

Set the element has an 'id' attribute.

Parameters:

Name Type Description
id string

Returns:

The element, for chaining

Type
OO.ui.Element
Inherited from:
Source:
Set the element has an 'id' attribute.

setManager(manager) → {OO.ui.Window}chainable #

Set the window manager.

This will cause the window to initialize. Calling it more than once will cause an error.

Parameters:

Name Type Description
manager OO.ui.WindowManager

Manager for this window

Returns:

The window, for chaining

Type
OO.ui.Window

Throws:

An error is thrown if the method is called more than once

Type
Error
Inherited from:
Source:
Set the window manager.

setSize(size) → {OO.ui.Window}chainable #

Set the window size by symbolic name (e.g., 'small' or 'medium')

Parameters:

Name Type Description
size string

Symbolic name of size: small, medium, large, larger or full

Returns:

The window, for chaining

Type
OO.ui.Window
Inherited from:
Source:
Set the window size by symbolic name (e.g., 'small' or 'medium')

setup([data]) → {jQuery.Promise} #

Setup window.

This is called by OO.ui.WindowManager during window opening (before the animation), and should not be called directly by other systems.

Parameters:

Name Type Attributes Description
data Object optional

Window opening data

Returns:

Promise resolved when window is setup

Type
jQuery.Promise
Inherited from:
Source:
Setup window.

supports(methods) → {boolean} #

Check if element supports one or more methods.

Parameters:

Name Type Description
methods string | Array.<string>

Method or list of methods to check

Returns:

All methods are supported

Type
boolean
Inherited from:
Source:
Check if element supports one or more methods.

teardown([data]) → {jQuery.Promise} #

Teardown window.

This is called by OO.ui.WindowManager during window closing (after the animation), and should not be called directly by other systems.

Parameters:

Name Type Attributes Description
data Object optional

Window closing data

Returns:

Promise resolved when window is torn down

Type
jQuery.Promise
Inherited from:
Source:
Teardown window.

toggle([show]) → {OO.ui.Element}chainable #

Toggle visibility of an element.

Parameters:

Name Type Attributes Description
show boolean optional

Make element visible, omit to toggle visibility

Returns:

The element, for chaining

Type
OO.ui.Element

Fires:

Inherited from:
Source:
Toggle visibility of an element.

updateSize() → {OO.ui.Window}chainable #

Update the window size.

Returns:

The window, for chaining

Type
OO.ui.Window

Throws:

An error is thrown if the window is not attached to a window manager

Type
Error
Inherited from:
Source:
Update the window size.

updateThemeClasses() #

Update the theme-provided classes.

This is called in element mixins and widget classes any time state changes. Updating is debounced, minimizing overhead of changing multiple attributes and guaranteeing that theme updates do not occur within an element's constructor

Inherited from:
Source:
Update the theme-provided classes.