Expand all

mw.editcheck.EditCheckGutterSectionWidget

Constructor

new mw.editcheck.EditCheckGutterSectionWidget(config) #

EditCheckGutterSectionWidget

Parameters:

Name Type Description
config Object

Configuration options

Properties:
Name Type Description
controller
actions Array.<mw.editcheck.EditCheckAction>
Source:
EditCheckGutterSectionWidget

Methods

getPrimaryAction() → {mw.editcheck.EditCheckAction} #

Get the primary action for this section (the focused one, or the first one)

Returns:

Type
mw.editcheck.EditCheckAction
Source:
Get the primary action for this section (the focused one, or the first one)

isFocused() → {boolean} #

Check if any of the actions in this section are focused

Returns:

Type
boolean
Source:
Check if any of the actions in this section are focused

onClick() #

Handle click events

Source:
Handle click events

setPosition(rect) #

Set the position of the gutter section

Parameters:

Name Type Description
rect DOMRect | Object

DOMRect or DOMRect-like object describing rectangle
Source:
Set the position of the gutter section

showDialogWithAction(action, [scrollConfig]) #

Show the edit check dialog with this widget's actions and with a specific action focused

Parameters:

Name Type Attributes Description
action mw.editcheck.EditCheckAction

Action to focus
scrollConfig Object optional

Configuration for scrolling
Source:
Show the edit check dialog with this widget's actions and with a specific action focused

teardown() #

Teardown the widget

Source:
Teardown the widget

update() #

Update the rendering of the gutter section

Source:
Update the rendering of the gutter section

updateSticky() #

Keep this section's icon in view as the section scrolls past. Call after moving the section, or when the viewport has changed.

Source:
Keep this section's icon in view as the section scrolls past.