mw.widgets

OOUI widgets specific to MediaWiki. Initially empty. To expand the amount of available widgets the mediawiki.widget module can be loaded.

Example

mw.loader.using('mediawiki.widget').then(() => {
  OO.ui.getWindowManager().addWindows( [ new mw.widget.AbandonEditDialog() ] );
});

Namespaces

datetime
OOUI widgets specific to MediaWiki for inputting date and time.

Classes

APIResultsProvider
API Results Provider object.
APIResultsQueue
API Results Queue object.
AbandonEditDialog
Confirm dialog shown when the users is leaving an editor without saving.
CalendarWidget
Creates an mw.widgets.CalendarWidget object.
CategoryMultiselectWidget

mw.widgets.CategoryMultiselectWidget

.
CategoryTagItemWidget

mw.widgets.CategoryTagItemWidget

.
CheckMatrixWidget
A JavaScript version of CheckMatrixWidget.
ComplexNamespaceInputWidget
Namespace input widget.
ComplexTitleInputWidget
Like TitleInputWidget, but the namespace has to be input through a separate dropdown field.
CopyTextLayout
Extends CopyTextLayout with MediaWiki notifications.
DateInputWidget
Creates an mw.widgets.DateInputWidget object.
ExpiryWidget

mw.widgets.ExpiryWidget

.
MediaResourceProvider
MediaWiki media resource provider.
MediaResourceQueue
MediaWiki media resource queue.
MediaResultWidget
Creates an mw.widgets.MediaResultWidget object.
MediaSearchProvider
MediaWiki media search provider.
MediaSearchQueue
MediaWiki media resource queue.
MediaSearchWidget
Creates an mw.widgets.MediaSearchWidget object.
MediaUserUploadsProvider
MediaWiki media search provider.
MediaUserUploadsQueue
MediaWiki media resource queue.
NamespaceInputWidget
Namespace input widget.
NamespacesMenuOptionWidget
Creates an mw.widgets.NamespacesMenuOptionWidget object.
NamespacesMultiselectWidget
Creates an mw.widgets.NamespacesMultiselectWidget object.
RowWidget

A RowWidget is used in conjunction with table widgets and should not be instantiated by themselves.

RowWidgetModel
RowWidget model.
SearchInputWidget
Creates a mw.widgets.SearchInputWidget object.
SelectWithInputWidget

mw.widgets.SelectWithInputWidget

.
SizeFilterWidget

mw.widgets.SizeFilterWidget

.
StashedFileWidget

Accepts a stashed file and displays the information for purposes of publishing the file at the behest of the user.

TableWidget

A TableWidget groups row widgets together to form a bidimensional grid of text inputs.

TableWidgetModel
TableWidget model.
TagMultiselectWidget

TagMultiselectWidget can be used to input list of tags in a single line.

TitleInputWidget
Creates an mw.widgets.TitleInputWidget object.
TitleOptionWidget
Creates a mw.widgets.TitleOptionWidget object.
TitleSearchWidget
Creates an mw.widgets.TitleSearchWidget object.
TitleWidget
Mixin for title widgets.
TitlesMultiselectWidget
Creates an mw.widgets.TitlesMultiselectWidget object.
ToggleSwitchWidget

This extends ToggleSwitchWidget by adding an invisible checkbox element which will be used to submit the value.

UserInputWidget
Creates a mw.widgets.UserInputWidget object.
UsersMultiselectWidget

UsersMultiselectWidget can be used to input list of users in a single line.

Methods

visibleByteLimit(textInputWidget, limit, filterFunction)static #

Add a visible byte limit label to a TextInputWidget.

Loaded from mediawiki.widgets.visibleLengthLimit module.

Uses jQueryPlugins.byteLimit to enforce the limit.

Parameters:

Name Type Attributes Description
textInputWidget OO.ui.TextInputWidget
limit number optional

Byte limit, defaults to input's maxlength attribute
filterFunction function optional

Function to call on the string before assessing the length
Source:
Add a visible byte limit label to a TextInputWidget.

visibleByteLimitWithDropdown(textInputWidget, dropdownInputWidget, limit)static #

Add a visible byte limit label to a TextInputWidget, assuming that the value of the DropdownInputWidget will be added as a prefix. MediaWiki formats the comment fields for many actions that way, e.g. for page deletion.

Loaded from mediawiki.widgets.visibleLengthLimit module.

Uses jQueryPlugins.byteLimit to enforce the limit.

Parameters:

Name Type Attributes Description
textInputWidget OO.ui.TextInputWidget
dropdownInputWidget OO.ui.DropdownInputWidget
limit number optional

Code point limit, defaults to input's maxlength attribute
Source:

Add a visible byte limit label to a TextInputWidget, assuming that the value of the DropdownInputWidget will be added as a prefix.

visibleCodePointLimit(textInputWidget, limit, filterFunction)static #

Add a visible codepoint (character) limit label to a TextInputWidget.

Loaded from mediawiki.widgets.visibleLengthLimit module.

Uses jQueryPlugins.codePointLimit to enforce the limit.

Parameters:

Name Type Attributes Description
textInputWidget OO.ui.TextInputWidget
limit number optional

Code point limit, defaults to input's maxlength attribute
filterFunction function optional

Function to call on the string before assessing the length
Source:
Add a visible codepoint (character) limit label to a TextInputWidget.

visibleCodePointLimitWithDropdown(textInputWidget, dropdownInputWidget, limit)static #

Add a visible codepoint (character) limit label to a TextInputWidget, assuming that the value of the DropdownInputWidget will be added as a prefix. MediaWiki formats the comment fields for many actions that way, e.g. for page deletion.

Loaded from mediawiki.widgets.visibleLengthLimit module.

Uses jQueryPlugins.codePointLimit to enforce the limit.

Parameters:

Name Type Attributes Description
textInputWidget OO.ui.TextInputWidget
dropdownInputWidget OO.ui.DropdownInputWidget
limit number optional

Code point limit, defaults to input's maxlength attribute
Source:

Add a visible codepoint (character) limit label to a TextInputWidget, assuming that the value of the DropdownInputWidget will be added as a prefix.