# all files / src/widgets/ DropdownWidget.js

75% Statements 33/44
22.22% Branches 4/18
50% Functions 3/6
75% Lines 33/44

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205

    1×

    1592×

    1592×

    1592×
    1592×

    1592×
    1592×
    1592×
    1592×
    1592×

    1592×

    1592×

    1592×

    1592×

    1592×

    1592×

    1×
    1×
    1×
    1×
    1×
    1×

    1×
    21648×

    1×
    312×

    312×

    312×

    312×

    312×

    1×

    1×

    1×

     /**
     * DropdownWidgets are not menus themselves, rather they contain a menu of options created with
     * OO.ui.MenuOptionWidget. The DropdownWidget takes care of opening and displaying the menu so that
     * users can interact with it.
     *
     * If you want to use this within an HTML form, such as a OO.ui.FormLayout, use
     * OO.ui.DropdownInputWidget instead.
     *
     *     @example
     *     // Example: A DropdownWidget with a menu that contains three options
     *     var dropDown = new OO.ui.DropdownWidget( {
     *         label: 'Dropdown menu: Select a menu option',
     *         menu: {
     *             items: [
     *                 new OO.ui.MenuOptionWidget( {
     *                     data: 'a',
     *                     label: 'First'
     *                 } ),
     *                 new OO.ui.MenuOptionWidget( {
     *                     data: 'b',
     *                     label: 'Second'
     *                 } ),
     *                 new OO.ui.MenuOptionWidget( {
     *                     data: 'c',
     *                     label: 'Third'
     *                 } )
     *             ]
     *         }
     *     } );
     *
     *     $( 'body' ).append( dropDown.$element );
     *
     *     dropDown.getMenu().selectItemByData( 'b' );
     *
     *     dropDown.getMenu().getSelectedItem().getData(); // returns 'b'
     *
     * For more information, please see the [OOjs UI documentation on MediaWiki] [1].
     *
     * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
     *
     * @class
     * @extends OO.ui.Widget
     * @mixins OO.ui.mixin.IconElement
     * @mixins OO.ui.mixin.IndicatorElement
     * @mixins OO.ui.mixin.LabelElement
     * @mixins OO.ui.mixin.TitledElement
     * @mixins OO.ui.mixin.TabIndexedElement
     *
     * @constructor
     * @param {Object} [config] Configuration options
     * @cfg {Object} [menu] Configuration options to pass to {@link OO.ui.MenuSelectWidget menu select widget}
     * @cfg {jQuery} [$overlay] Render the menu into a separate layer. This configuration is useful in cases where
     *  the expanded menu is larger than its containing `<div>`. The specified overlay layer is usually on top of the
     *  containing `<div>` and has a larger area. By default, the menu uses relative positioning.
     *  See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
     */
    OO.ui.DropdownWidget = function OoUiDropdownWidget( config ) {
    	// Configuration initialization
    	config = $.extend( { indicator: 'down' }, config );

    	// Parent constructor
    	OO.ui.DropdownWidget.parent.call( this, config );

    	// Properties (must be set before TabIndexedElement constructor call)
    	this.$handle = this.$( '<span>' );
    	this.$overlay = config.$overlay || this.$element;

    	// Mixin constructors
    	OO.ui.mixin.IconElement.call( this, config );
    	OO.ui.mixin.IndicatorElement.call( this, config );
    	OO.ui.mixin.LabelElement.call( this, config );
    	OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$label } ) );
    	OO.ui.mixin.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$handle } ) );

    	// Properties
    	this.menu = new OO.ui.MenuSelectWidget( $.extend( {
    		widget: this,
    		$floatableContainer: this.$element
    	}, config.menu ) );

    	// Events
    	this.$handle.on( {
    		click: this.onClick.bind( this ),
    		keydown: this.onKeyDown.bind( this ),
    		// Hack? Handle type-to-search when menu is not expanded and not handling its own events
    		keypress: this.menu.onKeyPressHandler,
    		blur: this.menu.clearKeyPressBuffer.bind( this.menu )
    	} );
    	this.menu.connect( this, {
    		select: 'onMenuSelect',
    		toggle: 'onMenuToggle'
    	} );

    	// Initialization
    	this.$handle
    		.addClass( 'oo-ui-dropdownWidget-handle' )
    		.attr( {
    			role: 'combobox',
    			'aria-owns': this.menu.getElementId(),
    			'aria-autocomplete': 'list'
    		} )
    		.append( this.$icon, this.$label, this.$indicator );
    	this.$element
    		.addClass( 'oo-ui-dropdownWidget' )
    		.append( this.$handle );
    	this.$overlay.append( this.menu.$element );
    };

    /* Setup */

    OO.inheritClass( OO.ui.DropdownWidget, OO.ui.Widget );
    OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.IconElement );
    OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.IndicatorElement );
    OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.LabelElement );
    OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.TitledElement );
    OO.mixinClass( OO.ui.DropdownWidget, OO.ui.mixin.TabIndexedElement );

    /* Methods */

    /**
     * Get the menu.
     *
     * @return {OO.ui.MenuSelectWidget} Menu of widget
     */
    OO.ui.DropdownWidget.prototype.getMenu = function () {
    	return this.menu;
    };

    /**
     * Handles menu select events.
     *
     * @private
     * @param {OO.ui.MenuOptionWidget} item Selected menu item
     */
    OO.ui.DropdownWidget.prototype.onMenuSelect = function ( item ) {
    	var selectedLabel;

    	Iif ( !item ) {
    		this.setLabel( null );
    		return;
    	}

    	selectedLabel = item.getLabel();

    	// If the label is a DOM element, clone it, because setLabel will append() it
    	Iif ( selectedLabel instanceof jQuery ) {
    		selectedLabel = selectedLabel.clone();
    	}

    	this.setLabel( selectedLabel );
    };

    /**
     * Handle menu toggle events.
     *
     * @private
     * @param {boolean} isVisible Menu toggle event
     */
    OO.ui.DropdownWidget.prototype.onMenuToggle = function ( isVisible ) {
    	this.$element.toggleClass( 'oo-ui-dropdownWidget-open', isVisible );
    	this.$handle.attr(
    		'aria-expanded',
    		this.$element.hasClass( 'oo-ui-dropdownWidget-open' ).toString()
    	);
    };

    /**
     * Handle mouse click events.
     *
     * @private
     * @param {jQuery.Event} e Mouse click event
     */
    OO.ui.DropdownWidget.prototype.onClick = function ( e ) {
    	if ( !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT ) {
    		this.menu.toggle();
    	}
    	return false;
    };

    /**
     * Handle key down events.
     *
     * @private
     * @param {jQuery.Event} e Key down event
     */
    OO.ui.DropdownWidget.prototype.onKeyDown = function ( e ) {
    	if (
    		!this.isDisabled() &&
    		(
    			e.which === OO.ui.Keys.ENTER ||
    			(
    				!this.menu.isVisible() &&
    				(
    					e.which === OO.ui.Keys.SPACE ||
    					e.which === OO.ui.Keys.UP ||
    					e.which === OO.ui.Keys.DOWN
    				)
    			)
    		)
    	) {
    		this.menu.toggle();
    		return false;
    	}
    };