Expand all

OO.ui.ListToolGroup

Extends

Constructor

new OO.ui.ListToolGroup(toolbar, [config]) #

ListToolGroups are one of three types of toolgroups that are used to create toolbars (the other types of groups are MenuToolGroup and BarToolGroup). The tools in a ListToolGroup are displayed by label in a dropdown menu. The title of the tool is used as the label text. The menu itself can be configured with a label, icon, indicator, header, and title.

ListToolGroups can be configured to be expanded and collapsed. Collapsed lists will have a ‘More’ option that users can select to see the full list of tools. If a collapsed toolgroup is expanded, a ‘Fewer’ option permits users to collapse the list again.

ListToolGroups are created by a toolgroup factory when the toolbar is set up. The factory requires the ListToolGroup's symbolic name, 'list', which is specified along with the other configurations. For more information about how to add tools to a ListToolGroup, please see toolgroup.

For more information about toolbars in general, please see the OOUI documentation on MediaWiki.

Example

// Example of a ListToolGroup
    const toolFactory = new OO.ui.ToolFactory();
    const toolGroupFactory = new OO.ui.ToolGroupFactory();
    const toolbar = new OO.ui.Toolbar( toolFactory, toolGroupFactory );

    // Configure and register two tools
    function SettingsTool() {
        SettingsTool.super.apply( this, arguments );
    }
    OO.inheritClass( SettingsTool, OO.ui.Tool );
    SettingsTool.static.name = 'settings';
    SettingsTool.static.icon = 'settings';
    SettingsTool.static.title = 'Change settings';
    SettingsTool.prototype.onSelect = function () {
        this.setActive( false );
    };
    SettingsTool.prototype.onUpdateState = function () {};
    toolFactory.register( SettingsTool );
    // Register two more tools, nothing interesting here
    function StuffTool() {
        StuffTool.super.apply( this, arguments );
    }
    OO.inheritClass( StuffTool, OO.ui.Tool );
    StuffTool.static.name = 'stuff';
    StuffTool.static.icon = 'search';
    StuffTool.static.title = 'Change the world';
    StuffTool.prototype.onSelect = function () {
        this.setActive( false );
    };
    StuffTool.prototype.onUpdateState = function () {};
    toolFactory.register( StuffTool );
    toolbar.setup( [
        {
            // Configurations for list toolgroup.
            type: 'list',
            label: 'ListToolGroup',
            icon: 'ellipsis',
            title: 'This is the title, displayed when user moves the mouse over the list ' +
                'toolgroup',
            header: 'This is the header',
            include: [ 'settings', 'stuff' ],
            allowCollapse: ['stuff']
        }
    ] );

    // Create some UI around the toolbar and place it in the document
    const frame = new OO.ui.PanelLayout( {
        expanded: false,
        framed: true
    } );
    frame.$element.append(
        toolbar.$element
    );
    $( document.body ).append( frame.$element );
    // Build the toolbar. This must be done after the toolbar has been appended to the document.
    toolbar.initialize();

Parameters:

Name Type Attributes Description
toolbar OO.ui.Toolbar
config Object optional

Configuration options

Properties:
Name Type Attributes Default Description
allowCollapse Array optional

Allow the specified tools to be collapsed. By default, collapsible tools will only be displayed if users click the ‘More’ option displayed at the bottom of the list. If the list is expanded, a ‘Fewer’ option permits users to collapse the list again. Any tools that are included in the toolgroup, but are not designated as collapsible, will always be displayed. To open a collapsible list in its expanded state, set #expanded to 'true'.

forceExpand Array optional

Expand the specified tools. All other tools will be designated as collapsible. Unless #expanded is set to true, the collapsible tools will be collapsed when the list is first opened.

expanded boolean optional
false

Expand collapsible tools. This config is only relevant if tools have been designated as collapsible. When expanded is set to true, all tools in the group will be displayed when the list is first opened. Users can collapse the list with a ‘Fewer’ option at the bottom.

Source:

ListToolGroups are one of three types of toolgroups that are used to create toolbars (the other types of groups are MenuToolGroup and BarToolGroup).

Properties

namestatic #

flags #

Initial value to pass to setFlags if no value is provided in config.

Properties:

Type Description
string | Array.<string> | Object.<string, boolean>
Inherited from:
Mixes in:
Source:
Initial value to pass to setFlags if no value is provided in config.

icon #

The symbolic name of the icon (e.g., ‘remove’ or ‘menu’), or a map of symbolic names. A map is used for i18n purposes and contains a default icon name and additional names keyed by language code. The default name is used when no icon is keyed by the user's language.

Example of an i18n map:

{ default: 'bold-a', en: 'bold-b', de: 'bold-f' }

Note: the static property will be overridden if the #icon configuration is used.

Properties:

Type Description
Object | string
Inherited from:
Mixes in:
Source:
The symbolic name of the icon (e.g., ‘remove’ or ‘menu’), or a map of symbolic names.

iconTitle #

The icon title, displayed when users move the mouse over the icon. The value can be text, a function that returns title text, or null for no title.

The static property will be overridden if the #iconTitle configuration is used.

Properties:

Type Description
string | function | null
Inherited from:
Mixes in:
Source:
The icon title, displayed when users move the mouse over the icon.

indicator #

Symbolic name of the indicator (e.g. ‘required’ or ‘down’). The static property will be overridden if the #indicator configuration is used.

Properties:

Type Description
string | null
Inherited from:
Mixes in:
Source:
Symbolic name of the indicator (e.g.

indicatorTitle #

A text string used as the indicator title, a function that returns title text, or null for no title. The static property will be overridden if the #indicatorTitle configuration is used.

Properties:

Type Description
string | function | null
Inherited from:
Mixes in:
Source:

A text string used as the indicator title, a function that returns title text, or null for no title.

label #

The label text. The label can be specified as a plaintext string, a function that will produce a string (will be resolved on construction time), or null for no label. The static value will be overridden if a label is specified with the #label config option.

Properties:

Type Description
string | function | null
Inherited from:
Mixes in:
Source:
The label text.

title #

The title text, a function that returns text, or null for no title. The value of the static property is overridden if the #title config option is used.

If the element has a default title (e.g. <input type=file>), null will allow that title to be shown. Use empty string to suppress it.

Properties:

Type Description
string | function | null
Inherited from:
Mixes in:
Source:
The title text, a function that returns text, or null for no title.

Methods

destroy() #

Destroy toolgroup.

Inherited from:
Source:
Destroy toolgroup.

getClosestScrollableElementContainer() → {HTMLElement} #

Get closest scrollable container.

Inherited from:
Source:

Returns:

Closest scrollable container

Type
HTMLElement
Get closest scrollable container.

getData() → {any} #

Get element data.

Inherited from:
Source:

Returns:

Element data

Type
any
Get element data.

getElementDocument() → {HTMLDocument} #

Get the DOM document.

Inherited from:
Source:

Returns:

Document object

Type
HTMLDocument
Get the DOM document.

getElementGroup() → {OO.ui.mixin.GroupElement|null} #

Get group element is in.

Inherited from:
Source:

Returns:

Group element, null if none

Type
OO.ui.mixin.GroupElement | null
Get group element is in.

getElementId() → {string} #

Ensure that the element has an 'id' attribute, setting it to an unique value if it's missing, and return its value.

Inherited from:
Source:

Returns:

Type
string

Ensure that the element has an 'id' attribute, setting it to an unique value if it's missing, and return its value.

getElementWindow() → {Window} #

Get the DOM window.

Inherited from:
Source:

Returns:

Window object

Type
Window
Get the DOM window.

getExpandCollapseTool() → {OO.ui.Tool} #

Get the expand/collapse tool for this group

Source:

Returns:

Expand collapse tool

Type
OO.ui.Tool
Get the expand/collapse tool for this group

getInputId() → {string|null} #

Get an ID of a labelable node which is part of this widget, if any, to be used for <label for> value.

If this function returns null, the widget should have a meaningful #simulateLabelClick method instead.

Inherited from:
Source:

Returns:

The ID of the labelable element

Type
string | null

Get an ID of a labelable node which is part of this widget, if any, to be used for <label for> value.

getTagName() → {string} #

Get the HTML tag name.

Override this method to base the result on instance information.

Inherited from:
Source:

Returns:

HTML tag name

Type
string
Get the HTML tag name.

getToolbar() → {OO.ui.Toolbar} #

Get the toolbar that contains the toolgroup.

Inherited from:
Source:

Returns:

Toolbar that contains the toolgroup

Type
OO.ui.Toolbar
Get the toolbar that contains the toolgroup.

highlightQuery(text, query, [compare], [combineMarks]) → {jQuery} #

Highlight the first occurrence of the query in the given text

Parameters:

Name Type Attributes Default Description
text string

Text

query string

Query to find

compare function optional

Optional string comparator, e.g. Intl.Collator().compare

combineMarks boolean optional
false

Pull combining marks into highlighted text

Inherited from:
Mixes in:
Source:

Returns:

Text with the first match of the query sub-string wrapped in highlighted span

Type
jQuery
Highlight the first occurrence of the query in the given text

isActive() → {boolean} #

Check if the tool group is active.

Inherited from:
Source:

Returns:

Tool group is active

Type
boolean
Check if the tool group is active.

isDisabled() → {boolean} #

Check if the widget is disabled.

Inherited from:
Source:

Returns:

Widget is disabled

Type
boolean
Check if the widget is disabled.

isElementAttached() → {boolean} #

Check if the element is attached to the DOM

Inherited from:
Source:

Returns:

The element is attached to the DOM

Type
boolean
Check if the element is attached to the DOM

isVisible() → {boolean} #

Check if element is visible.

Inherited from:
Source:

Returns:

element is visible

Type
boolean
Check if element is visible.

onDisable(isDisabled)protected #

Handle disable events.

Parameters:

Name Type Description
isDisabled boolean
Inherited from:
Source:
Handle disable events.

onDocumentMouseKeyUp(e)protected #

Handle document mouse up and key up events.

Parameters:

Name Type Description
e MouseEvent | KeyboardEvent

Mouse up or key up event

Inherited from:
Source:
Handle document mouse up and key up events.

onHandleMouseKeyDown(e) → {undefined|boolean}protected #

Handle mouse down and key down events.

Parameters:

Name Type Description
e jQuery.Event

Mouse down or key down event

Inherited from:
Source:

Returns:

False to prevent default if event is handled

Type
undefined | boolean
Handle mouse down and key down events.

onHandleMouseKeyUp(e) → {undefined|boolean}protected #

Handle mouse up and key up events.

Parameters:

Name Type Description
e jQuery.Event

Mouse up or key up event

Inherited from:
Source:

Returns:

False to prevent default if event is handled

Type
undefined | boolean
Handle mouse up and key up events.

onMouseKeyDown(e) → {undefined|boolean}protected #

Handle mouse down and key down events.

Parameters:

Name Type Description
e jQuery.Event

Mouse down or key down event

Inherited from:
Source:

Returns:

False to prevent default if event is handled

Type
undefined | boolean
Handle mouse down and key down events.

onMouseKeyUp(e)protected #

Handle mouse up and key up events.

Parameters:

Name Type Description
e MouseEvent | KeyboardEvent

Mouse up or key up event

Overrides:
Source:
Handle mouse up and key up events.

onMouseOutBlur(e)protected #

Handle mouse out and blur events.

Parameters:

Name Type Description
e jQuery.Event

Mouse out or blur event

Inherited from:
Source:
Handle mouse out and blur events.

onMouseOverFocus(e)protected #

Handle mouse over and focus events.

Parameters:

Name Type Description
e jQuery.Event

Mouse over or focus event

Inherited from:
Source:
Handle mouse over and focus events.

onPopupDocumentMouseKeyUp(e)protected #

Handle document mouse up and key up events.

Parameters:

Name Type Description
e MouseEvent | KeyboardEvent

Mouse up or key up event

Inherited from:
Source:
Handle document mouse up and key up events.

onToolbarResize() #

Handle resize events from the toolbar

Inherited from:
Source:
Handle resize events from the toolbar

onToolFactoryRegister(name)protected #

Handle tool registry register events.

If a tool is registered after the group is created, we must repopulate the list to account for:

  • a tool being added that may be included
  • a tool already included being overridden

Parameters:

Name Type Description
name string

Symbolic name of tool

Inherited from:
Source:
Handle tool registry register events.

populate() #

Add and remove tools based on configuration.

Overrides:
Source:
Add and remove tools based on configuration.

restorePreInfuseState(state)protected #

Restore the pre-infusion dynamic state for this widget.

This method is called after #$element has been inserted into DOM. The parameter is the return value of #gatherPreInfuseState.

Parameters:

Name Type Description
state Object
Inherited from:
Source:
Restore the pre-infusion dynamic state for this widget.

scrollElementIntoView([config]) → {jQuery.Promise} #

Scroll element into view.

Parameters:

Name Type Attributes Description
config Object optional

Configuration options

Inherited from:
Source:

Returns:

Promise which resolves when the scroll is complete

Type
jQuery.Promise
Scroll element into view.

setActive([value]) #

Switch into 'active' mode.

When active, the popup is visible. A mouseup event anywhere in the document will trigger deactivation.

Parameters:

Name Type Attributes Default Description
value boolean optional
false

The active state to set

Inherited from:
Source:

Fires:

Switch into 'active' mode.

setData(data) → {OO.ui.Element}chainable #

Set element data.

Parameters:

Name Type Description
data any

Element data

Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element
Set element data.

setDisabled([disabled]) → {OO.ui.Widget}chainable #

Set the 'disabled' state of the widget.

When a widget is disabled, it cannot be used and its appearance is updated to reflect this state.

Parameters:

Name Type Attributes Default Description
disabled boolean optional
false

Disable widget

Inherited from:
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Set the 'disabled' state of the widget.

setElementGroup(group) → {OO.ui.Element}chainable #

Set group element is in.

Parameters:

Name Type Description
group OO.ui.mixin.GroupElement | null

Group element, null if none

Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element
Set group element is in.

setElementId(id) → {OO.ui.Element}chainable #

Set the element has an 'id' attribute.

Parameters:

Name Type Description
id string
Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element
Set the element has an 'id' attribute.

setLabelledBy(id) #

Set the element with the given ID as a label for this widget.

Parameters:

Name Type Description
id string | null
Inherited from:
Source:
Set the element with the given ID as a label for this widget.

simulateLabelClick() #

Simulate the behavior of clicking on a label (a HTML <label> element) bound to this input. HTML only allows <label> to act on specific "labelable" elements; complex widgets might need to override this method to provide intuitive, accessible behavior.

By default, this does nothing. OO.ui.mixin.TabIndexedElement overrides it for focusable widgets. Individual widgets may override it too.

This method is called by OO.ui.LabelWidget and OO.ui.FieldLayout. It should not be called directly.

Inherited from:
Source:
Simulate the behavior of clicking on a label (a HTML <label> element) bound to this input.

supports(methods) → {boolean} #

Check if element supports one or more methods.

Parameters:

Name Type Description
methods string | Array.<string>

Method or list of methods to check

Inherited from:
Source:

Returns:

All methods are supported

Type
boolean
Check if element supports one or more methods.

toggle([show]) → {OO.ui.Element}chainable #

Toggle visibility of an element.

Parameters:

Name Type Attributes Description
show boolean optional

Make element visible, omit to toggle visibility

Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element

Fires:

Toggle visibility of an element.

updateDisabled() → {OO.ui.Widget}chainable #

Update the disabled state, in case of changes in parent widget.

Inherited from:
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Update the disabled state, in case of changes in parent widget.

updateThemeClasses() #

Update the theme-provided classes.

This is called in element mixins and widget classes any time state changes. Updating is debounced, minimizing overhead of changing multiple attributes and guaranteeing that theme updates do not occur within an element's constructor

Inherited from:
Source:
Update the theme-provided classes.

Events

active(The) #

An 'active' event is emitted when any popup is shown/hidden.

Parameters:

Name Type Description
The boolean

popup is visible

Inherited from:
Source:
An 'active' event is emitted when any popup is shown/hidden.

disable(disabled) #

A 'disable' event is emitted when the disabled state of the widget changes (i.e. on disable and enable).

Parameters:

Name Type Description
disabled boolean

Widget is disabled

Inherited from:
Source:

A 'disable' event is emitted when the disabled state of the widget changes (i.e.

toggle(visible) #

A 'toggle' event is emitted when the visibility of the widget changes.

Parameters:

Name Type Description
visible boolean

Widget is visible

Inherited from:
Source:
A 'toggle' event is emitted when the visibility of the widget changes.

update() #