Expand all

ve.ui

Namespace for all VisualEditor UserInterface classes, static methods and static properties.

Classes

MWAceEditorWidget

Text input widget which use an Ace editor instance when available

For the most part this can be treated just like a TextInputWidget with a few extra considerations:

  • For performance it is recommended to destroy the editor when you are finished with it, using #teardown.
MWAddParameterPage
Placeholder page for a currently unnamed parameter.
MWAdvancedPageSettingsDialogTool
MediaWiki UserInterface advanced page settings tool.
MWAdvancedSettingsPage
MediaWiki meta dialog advanced settings page.
MWAlienAnnotationContextItem
Context item for a MWAlienAnnotation
MWAlienExtensionContextItem
Context item for a MWAlienExtension.
MWAlienExtensionInspector
Inspector for editing alienated MediaWiki extensions.
MWAnnotationContextItem
Context item for a MWAnnotation
MWAriaDescribe
Mixin for adding descriptive ARIA support to elements.
MWCategoriesDialogTool
MediaWiki UserInterface categories tool.
MWCategoriesPage
MediaWiki meta dialog categories page.
MWCategoryInputWidget
Creates an ve.ui.MWCategoryInputWidget object.
MWCategoryItemWidget
Creates an ve.ui.MWCategoryItemWidget object.
MWCategoryPopupWidget
Creates an ve.ui.MWCategoryPopupWidget object.
MWCategoryWidget
Creates an ve.ui.MWCategoryWidget object.
MWCommandHelpDialog
Dialog listing all command keyboard shortcuts.
MWCommentInspector
Inspector for editing MediaWiki comments.
MWDefinedTransclusionContextItem
Context item for a defined MWTransclusion.
MWEditModeSourceTool
MediaWiki UserInterface edit mode source tool.
MWEditModeTool
MediaWiki UserInterface edit mode tool.
MWEditModeVisualTool
MediaWiki UserInterface edit mode visual tool.
MWEditSummaryWidget

Multi line text input for edit summary, with auto completion based on the user's previous edit summaries.

MWEducationPopupWidget
UserInterface education popup.
MWExpandableContentElement
Container for textual elements, which should be collapsed to one line by default.
MWExpandableErrorElement
MediaWiki expandable error element.
MWExportWikitextDialog
Dialog for exportWikitexting CollabTarget pages
MWExtensionDialog
Dialog for editing generic MediaWiki extensions.
MWExtensionInspector
Inspector for editing generic MediaWiki extensions.
MWExtensionPreviewDialog
Dialog for editing generic MediaWiki extensions with a preview.
MWExtensionWindow
Mixin for windows for editing generic MediaWiki extensions.
MWExternalLinkAnnotationWidget
Creates an ve.ui.MWExternalLinkAnnotationWidget object.
MWFeedbackDialogTool
Feedback dialog tool.
MWFloatingHelpDialog
Popup help dialog launched by a {@see ve.ui.MWFloatingHelpElement}
MWFloatingHelpElement

Question-mark button which floats over content, currently used in the template dialog.

MWGalleryContextItem
Context item for a MWGallery.
MWGalleryDialog
Dialog for editing MediaWiki galleries.
MWGalleryDialogTool
MediaWiki UserInterface gallery tool.
MWGalleryGroupWidget
Draggable group widget for reordering images in the MWGalleryDialog.
MWGalleryItemWidget
Draggable item widget for the MWGalleryGroupWidget
MWHeading1FormatTool
MediaWiki UserInterface heading 1 tool.
MWHeading2FormatTool
MediaWiki UserInterface heading 2 tool.
MWHeading3FormatTool
MediaWiki UserInterface heading 3 tool.
MWHeading4FormatTool
MediaWiki UserInterface heading 4 tool.
MWHeading5FormatTool
MediaWiki UserInterface heading 5 tool.
MWHeading6FormatTool
MediaWiki UserInterface heading 6 tool.
MWHelpListToolGroup
MediaWiki UserInterface edit mode tool.
MWIncludesContextItem
Context item for a MWIncludesContextItem.
MWInternalLinkAnnotationWidget
Creates an ve.ui.MWInternalLinkAnnotationWidget object.
MWInternalLinkContextItem
Context item for a MWInternalLink.
MWLanguageVariantDisabledInspector
Editor for "disabled" rules.
MWLanguageVariantFilterInspector
Editor for "filter" rules.
MWLanguageVariantInspector
Inspector for a ve.dm.MWLanguageVariantNode.
MWLanguageVariantNameInspector
Editor for "name" rules.
MWLanguageVariantNodeContextItem
Context item for a ve.dm.MWLanguageVariantNode.
MWLanguageVariantOneWayInspector
Editor for "one-way" rules.
MWLanguageVariantTwoWayInspector
Editor for "two-way" rules.
MWLanguagesDialogTool
MediaWiki UserInterface languages tool.
MWLanguagesPage
MediaWiki meta dialog Languages page.
MWLazyMultilineTextInputWidget
Creates a ve.ui.MWLazyMultilineTextInputWidget object.
MWLinkAction
Link action.
MWLinkAnnotationInspector
Inspector for applying and editing labeled MediaWiki internal and external links.
MWLinkInspectorTool
UserInterface link tool.
MWLinkNodeInspector
Inspector for editing unlabeled MediaWiki external links.
MWLiveExtensionInspector
Inspector for editing generic MediaWiki extensions with dynamic rendering.
MWMagicLinkNodeContextItem
Context item for a MWMagicLinkNode.
MWMagicLinkNodeInspector
Inspector for editing MediaWiki magic links (RFC/ISBN/PMID).
MWMediaContextItem
Context item for a MWImageNode.
MWMediaDialog
Dialog for inserting and editing MediaWiki media.
MWMediaDialogTool
MediaWiki UserInterface media edit tool.
MWMediaInfoFieldWidget
MWMediaInfoFieldWidget widget for displaying media information from the API.
MWMediaTransferHandler
Media transfer handler.
MWMetaDialog
Dialog for editing MediaWiki page information.
MWMetaDialogTool
MediaWiki UserInterface meta dialog tool.
MWMobileLinkInspectorTool
UserInterface mobile link tool
MWMobileSaveDialog
Dialog for saving MediaWiki pages in mobile.
MWNoticesPopupTool
MediaWiki UserInterface notices popup tool.
MWNumberedExternalLinkNodeContextItem
Context item for a MWNumberedExternalLinkNode.
MWPageSettingsDialogTool
MediaWiki UserInterface page settings tool.
MWParameterCheckboxInputWidget
Checkbox input for a parameter value which can only contain boolean values.
MWParameterPage

Container for editing the value of a parameter in the template dialog content pane.

MWPopupTool
MediaWiki UserInterface popup tool.
MWPreContextItem
Context item for a MWPre.
MWPreDialog
Dialog for editing MediaWiki preformatted text using <pre> tags.
MWPreTextInputWidget
Text input widget which hides but preserves a single leading and trailing newline.
MWPreformattedFormatTool
MediaWiki UserInterface preformatted tool.
MWPreviewElement
Creates an ve.ui.MWPreviewElement object.
MWRequiredParamBlankConfirmDialog
Dialog for letting the user confirm that they really want to insert a template/citation with blank required parameters.
MWSaveCommand
Command which can only execute when the document is saveable
MWSaveDialog
Dialog for saving MediaWiki pages.
MWSaveDialogAction
Save action.
MWSaveTool
MediaWiki save tool
MWSettingsPage
MediaWiki meta dialog settings page.
MWSignatureContextItem
Context item for a MWSignature.
MWSignatureTool
MediaWiki UserInterface signature tool.
MWSurface
MWTableDialog
Dialog for table properties.
MWTargetWidget
Creates an ve.ui.MWTargetWidget object.
MWTemplateDialog
Abstract base class for dialogs that allow to insert and edit MediaWiki transclusions, i.e.
MWTemplatePage
Template dialog content pane header for a template.
MWTemplatePlaceholderPage

The placeholder is shown in the template dialog content pane, and allows the user to enter a template name.

MWTemplateTitleInputWidget

Input field for entering a template title, for example when adding a template in the template dialog.

MWTemplatesUsedDialogTool
MediaWiki UserInterface TemplatesUsed tool.
MWTemplatesUsedPage
MediaWiki meta dialog TemplatesUsed page.
MWTocWidget
Creates a ve.ui.MWTocWidget object.
MWTransclusionContentPage
Template dialog content pane input for a raw wikitext snippet.
MWTransclusionContextItem
Context item for a MWTransclusion.
MWTransclusionDialog
Dialog for inserting and editing MediaWiki transclusions, i.e.
MWTransclusionDialogTool
MediaWiki UserInterface transclusion tool.
MWTransclusionOutlineButtonWidget

Generic button-like widget for top-level parts in the template dialog sidebar.

MWTransclusionOutlineControlsWidget
Toolbar at the bottom of the template dialog sidebar.
MWTransclusionOutlineParameterSelectWidget

List of template parameters, each of which can be added or removed using a checkbox.

MWTransclusionOutlineParameterWidget
A widget that represents a template parameter, with a checkbox to add/remove the parameter.
MWTransclusionOutlinePartWidget
Common base class for top-level items (a.k.a.
MWTransclusionOutlinePlaceholderWidget

Sidebar item for a template which has yet to be added, its name is not yet given.

MWTransclusionOutlineTemplateWidget
Container for a template as rendered in the template dialog sidebar.
MWTransclusionOutlineToggleUnusedWidget

Button widget to toggle unused fields in the template dialog sidebar, appears at the top of any template with more than the threshold number of parameters.

MWTransclusionOutlineWidget

Container for the entire transclusion dialog sidebar, may contain a single or multiple templates or raw wikitext snippets.

MWTransclusionOutlineWikitextWidget

Top-level part in the template dialog sidebar, representing a raw wikitext snippet.

MWTwoPaneTransclusionDialogLayout

Specialized layout forked from and similar to {@see OO.ui.BookletLayout}, but to synchronize the sidebar and content pane of the transclusion dialog.

MWUserGuideTool
User guide tool.
MWVeOnlyDialogTool
MediaWiki UserInterface VE only dialog tool.
MWWikitextAction
Content action.
MWWikitextCommandRegistry
Command registry.
MWWikitextDataTransferHandlerFactory
Drop handler Factory.
MWWikitextLinkAnnotationInspector
Inspector for applying and editing labeled MediaWiki internal and external links.
MWWikitextPasteContextItem
Context item shown after a rich text paste.
MWWikitextPlainTextStringTransferHandler
Detect an attempt to paste plain text or wikitext, and allow it to be directly pasted without escaping it.
MWWikitextStringTransferHandler

Detect an attempt to paste wikitext, and convert it to proper HTML.

MWWikitextSurface
MWWikitextWarningCommand
Wikitext warning command.

Properties

mwWikitextTransferRegistrystatic #

Heuristic patterns which attempts to discover wikitext, without incurring too many false positives.

Rules can be regular expressions or strings

Source:

Heuristic patterns which attempts to discover wikitext, without incurring too many false positives.

Methods

MWBackTool()static #

Back tool

MWExportTool()static #

Export tool

MWVerticalLayout()static #

Container for a vertical series of PageLayouts, similar to OO.ui.HorizontalLayout

Source:
Container for a vertical series of PageLayouts, similar to OO.ui.HorizontalLayout