Expand all

ve.ui.CommandHelpRegistry

Extends

Constructor

new ve.ui.CommandHelpRegistry() #

Command help registry.

Source:
Command help registry.

Methods

lookupByGroup(groupName) → {Object} #

Get data for a given group of commands.

Parameters:

Name Type Description
groupName string

Group name
Source:

Returns:

Commands associated with the group

Type
Object
Get data for a given group of commands.

register(groupName, commandHelpName, details) #

Register a command for display in the dialog.

Parameters:

Name Type Description
groupName string

Dialog-category in which to display this
commandHelpName string

Name of the command help item.
details Object

Details about the command

Properties:
Name Type Attributes Description
label function | string

Label describing the command. String or deferred message function.
trigger string optional

Symbolic name of trigger this for this command
shortcuts Array.<string> optional

Keyboard shortcuts if this is not a real trigger (e.g. copy/paste)
sequences Array.<string> optional

Symbolic names of sequences, if this is a sequence, not a trigger
Source:
Register a command for display in the dialog.