Class: ListToolGroup

.ui.ListToolGroup(toolbar, configopt)

new ListToolGroup(toolbar, configopt)

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.

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:
Example
// Example of a ListToolGroup
    var toolFactory = new OO.ui.ToolFactory();
    var toolGroupFactory = new OO.ui.ToolGroupFactory();
    var toolbar = new OO.ui.Toolbar( toolFactory, toolGroupFactory );

    // Configure and register two tools
    function SettingsTool() {
        SettingsTool.parent.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.parent.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
    var frame = new OO.ui.PanelLayout( {
        expanded: false,
        framed: true
    } );
    frame.$element.append(
        toolbar.$element
    );
    $( 'body' ).append( frame.$element );
    // Build the toolbar. This must be done after the toolbar has been appended to the document.
    toolbar.initialize();

For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki][1].

[1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars

Extends

Methods

destroy()

Destroy toolgroup.

Inherited From:
Source:

getClosestScrollableElementContainer() → {HTMLElement}

Get closest scrollable container.

Inherited From:
Source:
Returns:

Closest scrollable container

Type
HTMLElement

getData() → {Mixed}

Get element data.

Inherited From:
Source:
Returns:

Element data

Type
Mixed

getElementDocument() → {HTMLDocument}

Get the DOM document.

Inherited From:
Source:
Returns:

Document object

Type
HTMLDocument

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

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

getElementWindow() → {Window}

Get the DOM window.

Inherited From:
Source:
Returns:

Window object

Type
Window

getExpandCollapseTool() → {OO.ui.Tool}

Get the expand/collapse tool for this group

Source:
Returns:

Expand collapse tool

Type
OO.ui.Tool

getHorizontalAnchorEdge()

Inherited From:
Source:

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

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

getToolbar() → {OO.ui.Toolbar}

Get the toolbar that contains the toolgroup.

Inherited From:
Source:
Returns:

Toolbar that contains the toolgroup

Type
OO.ui.Toolbar

getVerticalAnchorEdge()

Inherited From:
Source:

isDisabled() → {boolean}

Check if the widget is disabled.

Inherited From:
Source:
Returns:

Widget is disabled

Type
boolean

isElementAttached() → {boolean}

Check if the element is attached to the DOM

Inherited From:
Source:
Returns:

The element is attached to the DOM

Type
boolean

isVisible() → {boolean}

Check if element is visible.

Inherited From:
Source:
Returns:

element is visible

Type
boolean

(protected) onBlur(e)

Handle focus being lost.

The event is actually generated from a mouseup/keyup, so it is not a normal blur event object.

Parameters:
Name Type Description
e MouseEvent | KeyboardEvent

Mouse up or key up event
Inherited From:
Source:

(protected) onCapturedMouseKeyUp(e)

Handle captured mouse up and key up events.

Parameters:
Name Type Description
e MouseEvent | KeyboardEvent

Mouse up or key up event
Inherited From:
Source:

(protected) onHandleMouseKeyDown(e)

Handle mouse down and key down events.

Parameters:
Name Type Description
e jQuery.Event

Mouse down or key down event
Inherited From:
Source:

(protected) onHandleMouseKeyUp(e)

Handle mouse up and key up events.

Parameters:
Name Type Description
e jQuery.Event

Mouse up or key up event
Inherited From:
Source:

(protected) onMouseKeyDown(e)

Handle mouse down and key down events.

Parameters:
Name Type Description
e jQuery.Event

Mouse down or key down event
Inherited From:
Source:

(protected) onMouseKeyUp(e)

Handle mouse up and key up events.

Parameters:
Name Type Description
e MouseEvent | KeyboardEvent

Mouse up or key up event
Overrides:
Source:

(protected) onMouseOutBlur(e)

Handle mouse out and blur events.

Parameters:
Name Type Description
e jQuery.Event

Mouse out or blur event
Inherited From:
Source:

(protected) onMouseOverFocus(e)

Handle mouse over and focus events.

Parameters:
Name Type Description
e jQuery.Event

Mouse over or focus event
Inherited From:
Source:

(protected) onToolFactoryRegister(name)

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:

populate()

Add and remove tools based on configuration.

Overrides:
Source:

(protected) restorePreInfuseState(state)

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:

scrollElementIntoView(configopt) → {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

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 Description
value boolean

The active state to set
Inherited From:
Source:

setData(data)

Set element data.

Parameters:
Name Type Description
data Mixed

Element data
Inherited From:
Source:

setDisabled(disabled)

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 Description
disabled boolean

Disable widget
Inherited From:
Source:

setElementGroup(group)

Set group element is in.

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

Group element, null if none
Inherited From:
Source:

setElementId(id)

Set the element has an 'id' attribute.

Parameters:
Name Type Description
id string
Inherited From:
Source:

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:

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

toggle(showopt)

Toggle visibility of an element.

Parameters:
Name Type Attributes Description
show boolean <optional>

Make element visible, omit to toggle visibility
Inherited From:
Source:
Fires:
  • event:visible

updateDisabled()

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

Inherited From:
Source:

updateThemeClasses()

Update the theme-provided classes.

Inherited From:
Source: