Expand all

ve.ui.GutterSidebarEditCheckDialog

Extends

Constructor

new ve.ui.GutterSidebarEditCheckDialog(config) #

GutterSidebarEditCheckDialog constructor.

The edit check dialog which is created when the user is on mobile. It adds a narrow gutter wide enough to show an icon. When clicked, we create (or reuse) a ve.ui.FixedEditCheckDialog instance to show the check details.

Parameters:

Name Type Description
config Object

Configuration options
Source:
GutterSidebarEditCheckDialog constructor.

Methods

findNearestActions() → {Object} #

Find nearest suggestions above and below user's current position

Returns:

Type
Object
Source:
Find nearest suggestions above and below user's current position

getSetupProcess() #

Source:

getTeardownProcess() #

Source:

initialize() #

Source:

onActionsUpdated(listener, actions, newActions, discardedActions, rejected) #

Handle updates to the list of edit check actions.

Parameters:

Name Type Description
listener string

Check listener
actions Array.<mw.editcheck.EditCheckAction>

All current actions
newActions Array.<mw.editcheck.EditCheckAction>

Newly added actions
discardedActions Array.<mw.editcheck.EditCheckAction>

Newly removed actions
rejected boolean

The last action was rejected/dismissed
Source:
Handle updates to the list of edit check actions.

onFocusAction(action, index, scrollTo) #

Handle focusAction events from the controller

Parameters:

Name Type Description
action mw.editcheck.EditCheckAction
index number
scrollTo boolean
Source:
Handle focusAction events from the controller

onPosition() #

Handle position events from the controller

Source:
Handle position events from the controller

onScrollIntoViewCloseClick() #

Handle click events from scroll-into-view's close button.

Source:
Handle click events from scroll-into-view's close button.

onScrollIntoViewShowClick() #

Handle click events from scroll-into-view's show button.

Source:
Handle click events from scroll-into-view's show button.

renderActions(actions, newActions) #

Render the edit check actions as gutter icons, grouping overlapping actions.

Parameters:

Name Type Description
actions Array.<mw.editcheck.EditCheckAction>

List of actions to render
newActions Array.<mw.editcheck.EditCheckAction>

Newly found actions, which could takeFocus
Source:
Render the edit check actions as gutter icons, grouping overlapping actions.

scrollToNearestAction() #

Scroll to the action nearest the user's current position, defaulting to above

Source:
Scroll to the action nearest the user's current position, defaulting to above

setOutsideSectionState() #

Notify the scroll-into-view widget of the state of suggestions around this section

Source:
Notify the scroll-into-view widget of the state of suggestions around this section

showDialogWithAction(action, [scrollConfig]) #

Show the edit check dialog with a specific widget's actions and 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 a specific widget's actions and a specific action focused