Kmenger has uploaded a new change for review.
https://gerrit.wikimedia.org/r/193004
Change subject: MenuSelectWidget: Add description and mark protected method
......................................................................
MenuSelectWidget: Add description and mark protected method
Change-Id: I9f9b7d6475500329adaa08ea8aa320aae355380b
---
M src/widgets/MenuSelectWidget.js
1 file changed, 17 insertions(+), 4 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/oojs/ui refs/changes/04/193004/1
diff --git a/src/widgets/MenuSelectWidget.js b/src/widgets/MenuSelectWidget.js
index 2ec1f00..24d7e97 100644
--- a/src/widgets/MenuSelectWidget.js
+++ b/src/widgets/MenuSelectWidget.js
@@ -1,10 +1,22 @@
/**
- * Overlaid menu of options.
+ * MenuSelectWidget is a {@link OO.ui.SelectWidget select widget} that
contains options and
+ * is used together with OO.ui.MenuOptionWidget. See {@link
OO.ui.DropdownWidget DropdownWidget} and
+ * {@link OO.ui.ComboBoxWidget ComboBoxWidget} for examples of interfaces that
contain menus.
+ * MenuSelectWidgets themselves are not designed to be instantiated directly,
rather subclassed
+ * and customized to be opened, closed, and displayed as needed.
*
- * Menus are clipped to the visible viewport. They do not provide a control
for opening or closing
- * the menu.
+ * By default, menus are clipped to the visible viewport and are not visible
when a user presses the
+ * mouse outside the menu.
*
- * Use together with OO.ui.MenuOptionWidget.
+ * Menus also have support for keyboard interaction:
+ *
+ * - Enter/Return key: choose and select a menu option
+ * - Up-arrow key: highlight the previous menu option
+ * - Down-arrow key: highlight the next menu option
+ * - Esc key: hide the menu
+ *
+ * Please see the [OOjs UI documentation on MediaWiki][1] for more information.
+ * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
*
* @class
* @extends OO.ui.SelectWidget
@@ -55,6 +67,7 @@
/**
* Handles document mouse down events.
*
+ * @protected
* @param {jQuery.Event} e Key down event
*/
OO.ui.MenuSelectWidget.prototype.onDocumentMouseDown = function ( e ) {
--
To view, visit https://gerrit.wikimedia.org/r/193004
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: I9f9b7d6475500329adaa08ea8aa320aae355380b
Gerrit-PatchSet: 1
Gerrit-Project: oojs/ui
Gerrit-Branch: master
Gerrit-Owner: Kmenger <kmen...@wikimedia.org>
_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
