Expand all

OO.ui.PopupWidget

Extends

Constructor

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

PopupWidget is a container for content. The popup is overlaid and positioned absolutely. By default, each popup has an anchor that points toward its origin. Please see the OOUI documentation on MediaWiki.org for more information and examples.

Unlike most widgets, PopupWidget is initially hidden and must be shown by calling #toggle.

Example

// A PopupWidget.
    const popup = new OO.ui.PopupWidget( {
        $content: $( '<p>Hi there!</p>' ),
        padded: true,
        width: 300
    } );

    $( document.body ).append( popup.$element );
    // To display the popup, toggle the visibility to 'true'.
    popup.toggle( true );

Parameters:

Name Type Attributes Description
config Object optional

Configuration options

Properties:
Name Type Attributes Default Description
width number | null optional
 320

Width of popup in pixels. Pass null to use automatic width.
height number | null optional
 null

Height of popup in pixels. Pass null to use automatic height.
anchor boolean optional
 true

Show anchor pointing to origin of popup
position string optional
 'below'

Where to position the popup relative to $floatableContainer 'above': Put popup above $floatableContainer; anchor points down to the horizontal center of $floatableContainer 'below': Put popup below $floatableContainer; anchor points up to the horizontal center of $floatableContainer 'before': Put popup to the left (LTR) / right (RTL) of $floatableContainer; anchor points endwards (right/left) to the vertical center of $floatableContainer 'after': Put popup to the right (LTR) / left (RTL) of $floatableContainer; anchor points startwards (left/right) to the vertical center of $floatableContainer
align string optional
 'center'

How to align the popup to $floatableContainer 'forwards': If position is above/below, move the popup as far endwards (right in LTR, left in RTL) as possible while still keeping the anchor within the popup; if position is before/after, move the popup as far downwards as possible. 'backwards': If position is above/below, move the popup as far startwards (left in LTR, right in RTL) as possible while still keeping the anchor within the popup; if position is before/after, move the popup as far upwards as possible. 'center': Horizontally (if position is above/below) or vertically (before/after) align the center of the popup with the center of $floatableContainer. 'force-left': Alias for 'forwards' in LTR and 'backwards' in RTL 'force-right': Alias for 'backwards' in RTL and 'forwards' in LTR
autoFlip boolean optional
 true

Whether to automatically switch the popup's position between 'above' and 'below', or between 'before' and 'after', if there is not enough space in the desired direction to display the popup without clipping
$container jQuery optional

Constrain the popup to the boundaries of the specified container. See the [OOUI docs on MediaWiki][3] for an example. [3]: https://www.mediawiki.org/wiki/OOUI/Widgets/Popups#containerExample
containerPadding number optional
 10

Padding between the popup and its container, specified as a number of pixels.
$content jQuery optional

Content to append to the popup's body
$footer jQuery optional

Content to append to the popup's footer
autoClose boolean optional
 false

Automatically close the popup when it loses focus.
$autoCloseIgnore jQuery optional

Elements that will not close the popup when clicked. This config option is only relevant if #autoClose is set to true. See the [OOUI documentation on MediaWiki][2] for an example. [2]: https://www.mediawiki.org/wiki/OOUI/Widgets/Popups#autocloseExample
head boolean optional
 false

Show a popup header that contains a #label (if specified) and close button.
hideCloseButton boolean optional
 false
padded boolean optional
 false

Add padding to the popup's body
Mixes in:
Source:
PopupWidget is a container for content.

Properties

icon #

The symbolic name of the icon (e.g., ‘remove’ or ‘menu’), or a map of symbolic names. A map is used for i18n purposes and contains a default icon name and additional names keyed by language code. The default name is used when no icon is keyed by the user's language.

Example of an i18n map:

{ default: 'bold-a', en: 'bold-b', de: 'bold-f' }

Note: the static property will be overridden if the #icon configuration is used.

Properties:

Type Description
Object | string
Mixes in:
Source:
The symbolic name of the icon (e.g., ‘remove’ or ‘menu’), or a map of symbolic names.

iconTitle #

The icon title, displayed when users move the mouse over the icon. The value can be text, a function that returns title text, or null for no title.

The static property will be overridden if the #iconTitle configuration is used.

Properties:

Type Description
string | function | null
Mixes in:
Source:
The icon title, displayed when users move the mouse over the icon.

label #

The label text. The label can be specified as a plaintext string, a function that will produce a string (will be resolved on construction time), or null for no label. The static value will be overridden if a label is specified with the #label config option.

Properties:

Type Description
string | function | null
Mixes in:
Source:
The label text.

Methods

computePosition() #

Source:

getAlignment() → {string} #

Get popup alignment

Source:

Returns:

Alignment of the popup, center, force-left, force-right, backwards or forwards.

Type
string
Get popup alignment

getBodyId() → {string} #

Get an ID of the body element, this can be used as the aria-describedby attribute for an input field.

Source:

Returns:

The ID of the body element

Type
string

Get an ID of the body element, this can be used as the aria-describedby attribute for an input field.

getClosestScrollableElementContainer() → {HTMLElement} #

Get closest scrollable container.

Inherited from:
Source:

Returns:

Closest scrollable container

Type
HTMLElement
Get closest scrollable container.

getData() → {any} #

Get element data.

Inherited from:
Source:

Returns:

Element data

Type
any
Get element data.

getElementDocument() → {HTMLDocument} #

Get the DOM document.

Inherited from:
Source:

Returns:

Document object

Type
HTMLDocument
Get the DOM document.

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

Get group element is in.

Inherited from:
Source:

Returns:

Group element, null if none

Type
OO.ui.mixin.GroupElement | null
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.

Inherited from:
Source:

Returns:

Type
string

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.

Inherited from:
Source:

Returns:

Window object

Type
Window
Get the DOM window.

getInputId() → {string|null} #

Get an ID of a labelable node which is part of this widget, if any, to be used for <label for> value.

If this function returns null, the widget should have a meaningful #simulateLabelClick method instead.

Inherited from:
Source:

Returns:

The ID of the labelable element

Type
string | null

Get an ID of a labelable node which is part of this widget, if any, to be used for <label for> value.

getPosition() → {string} #

Get popup positioning.

Source:

Returns:

'above', 'below', 'before' or 'after'

Type
string
Get popup positioning.

getTagName() → {string} #

Get the HTML tag name.

Override this method to base the result on instance information.

Inherited from:
Source:

Returns:

HTML tag name

Type
string
Get the HTML tag name.

hasAnchor() → {boolean} #

Check if the anchor is visible.

Source:

Returns:

Anchor is visible

Type
boolean
Check if the anchor is visible.

highlightQuery(text, query, [compare], [combineMarks]) → {jQuery} #

Highlight the first occurrence of the query in the given text

Parameters:

Name Type Attributes Default Description
text string

Text
query string

Query to find
compare function optional

Optional string comparator, e.g. Intl.Collator().compare
combineMarks boolean optional
 false

Pull combining marks into highlighted text
Mixes in:
Source:

Returns:

Text with the first match of the query sub-string wrapped in highlighted span

Type
jQuery
Highlight the first occurrence of the query in the given text

isDisabled() → {boolean} #

Check if the widget is disabled.

Inherited from:
Source:

Returns:

Widget is disabled

Type
boolean
Check if the widget is disabled.

isElementAttached() → {boolean} #

Check if the element is attached to the DOM

Inherited from:
Source:

Returns:

The element is attached to the DOM

Type
boolean
Check if the element is attached to the DOM

isVisible() → {boolean} #

Check if element is visible.

Inherited from:
Source:

Returns:

element is visible

Type
boolean
Check if element is visible.

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
Inherited from:
Source:

Returns:

Promise which resolves when the scroll is complete

Type
jQuery.Promise
Scroll element into view.

setAlignment([align]) #

Set popup alignment

Parameters:

Name Type Attributes Default Description
align string optional
 center

Alignment of the popup, center, force-left, force-right, backwards or forwards.
Source:
Set popup alignment

setAnchorEdge(edge) #

Change which edge the anchor appears on.

Parameters:

Name Type Description
edge string

'top', 'bottom', 'start' or 'end'
Source:
Change which edge the anchor appears on.

setAutoCloseIgnore($autoCloseIgnore) #

Set which elements will not close the popup when clicked.

For auto-closing popups, clicks on these elements will not cause the popup to auto-close.

Parameters:

Name Type Description
$autoCloseIgnore jQuery

Elements to ignore for auto-closing
Source:
Set which elements will not close the popup when clicked.

setAutoFlip([autoFlip]) #

Set popup auto-flipping.

Parameters:

Name Type Attributes Default Description
autoFlip boolean optional
 false

Whether to automatically switch the popup's position between 'above' and 'below', or between 'before' and 'after', if there is not enough space in the desired direction to display the popup without clipping
Source:
Set popup auto-flipping.

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

Set element data.

Parameters:

Name Type Description
data any

Element data
Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element
Set element data.

setDisabled([disabled]) → {OO.ui.Widget}chainable #

Set the 'disabled' state of the widget.

When a widget is disabled, it cannot be used and its appearance is updated to reflect this state.

Parameters:

Name Type Attributes Default Description
disabled boolean optional
 false

Disable widget
Inherited from:
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Set the 'disabled' state of the widget.

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
Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element
Set group element is in.

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

Set the element has an 'id' attribute.

Parameters:

Name Type Description
id string
Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element
Set the element has an 'id' attribute.

setLabelledBy(id) #

Set the element with the given ID as a label for this widget.

Parameters:

Name Type Description
id string | null
Inherited from:
Source:
Set the element with the given ID as a label for this widget.

setPosition(position) #

Change the positioning of the popup.

Parameters:

Name Type Description
position string

'above', 'below', 'before' or 'after'
Source:
Change the positioning of the popup.

setSize([width], [height], [transition])chainable #

Set the size of the popup.

Changing the size may also change the popup's position depending on the alignment.

Parameters:

Name Type Attributes Default Description
width number | null optional
 320

Width in pixels. Pass null to use automatic width.
height number | null optional
 null

Height in pixels. Pass null to use automatic height.
transition boolean optional
 false

Use a smooth transition
Source:
Set the size of the popup.

simulateLabelClick() #

Simulate the behavior of clicking on a label (a HTML <label> element) bound to this input. HTML only allows <label> to act on specific "labelable" elements; complex widgets might need to override this method to provide intuitive, accessible behavior.

By default, this does nothing. OO.ui.mixin.TabIndexedElement overrides it for focusable widgets. Individual widgets may override it too.

This method is called by OO.ui.LabelWidget and OO.ui.FieldLayout. It should not be called directly.

Inherited from:
Source:
Simulate the behavior of clicking on a label (a HTML <label> element) bound to this input.

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
Inherited from:
Source:

Returns:

All methods are supported

Type
boolean
Check if element supports one or more methods.

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
Overrides:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element

Fires:

Toggle visibility of an element.

toggleAnchor([show]) #

Show, hide, or toggle the visibility of the anchor.

Parameters:

Name Type Attributes Description
show boolean optional

Show anchor, omit to toggle
Source:
Show, hide, or toggle the visibility of the anchor.

updateDimensions([transition])chainable #

Update the size and position.

Only use this to keep the popup properly anchored. Use #setSize to change the size, and this will be called automatically.

Parameters:

Name Type Attributes Default Description
transition boolean optional
 false

Use a smooth transition
Source:
Update the size and position.

updateDisabled() → {OO.ui.Widget}chainable #

Update the disabled state, in case of changes in parent widget.

Inherited from:
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Update the disabled state, in case of changes in parent widget.

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.

Events

closing() #

The popup is no longer visible.

Source:
The popup is no longer visible.

disable(disabled) #

A 'disable' event is emitted when the disabled state of the widget changes (i.e. on disable and enable).

Parameters:

Name Type Description
disabled boolean

Widget is disabled
Inherited from:
Source:

A 'disable' event is emitted when the disabled state of the widget changes (i.e.

ready() #

The popup is ready: it is visible and has been positioned and clipped.

Source:
The popup is ready: it is visible and has been positioned and clipped.

toggle(visible) #

A 'toggle' event is emitted when the visibility of the widget changes.

Parameters:

Name Type Description
visible boolean

Widget is visible
Inherited from:
Source:
A 'toggle' event is emitted when the visibility of the widget changes.