Allow custom menu to be passed in to OO.ui.ButtonMenuSelectWidget
Closed, ResolvedPublic3 Estimated Story Points
Actions

Assigned To

Authored By

	Tchanders
	Aug 15 2022, 3:56 PM

Description

OO.ui.ButtonMenuSelectWidget currently constructs its own menu (an OO.ui.MenuSelectWidget) in its constructor: https://gerrit.wikimedia.org/g/oojs/ui/+/1d4e6ba5e8f0d541dd847059eef271da469ae082/src/widgets/ButtonMenuSelectWidget.js#62

Since T261862, Special:Investigate uses an OO.ui.ButtonMenuSelectWidget with a custom menu with custom event handlers.

We did this by subclassing OO.ui.ButtonMenuSelectWidget and adding our custom menu widget in the constructor of this subclass.

A less fragile long-term solution would be to allow a custom menu to be passed to OO.ui.ButtonMenuSelectWidget.

Acceptance Criteria

OO.ui.ButtonMenuSelectWidget adds a menu passed through the config. If none is passed, it behaves as before.

Details

Subject	Repo	Branch	Lines +/-
Update OOUI to v0.45.0	mediawiki/core	master	+265 -96
Allow custom menu class to be passed in to OO.ui.ButtonMenuSelectWidget	oojs/ui	master	+5 -1
WIP: Allow custom menu to be passed in to OO.ui.ButtonMenuSelectWidget	oojs/ui	master	+5 -0

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Resolved		• AGueyte	T315241 Remove InvestigateButtonMenuSelectWidget
		Resolved		Tchanders	T315240 Allow custom menu to be passed in to OO.ui.ButtonMenuSelectWidget

Event Timeline

Tchanders created this task.Aug 15 2022, 3:56 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptAug 15 2022, 3:56 PM

Tchanders mentioned this in T315241: Remove InvestigateButtonMenuSelectWidget.Aug 15 2022, 4:01 PM

Tchanders added a parent task: T315241: Remove InvestigateButtonMenuSelectWidget.Aug 15 2022, 4:05 PM

Tchanders mentioned this in T261862: CU 2.0: Cannot use tab to dismiss tools menu, submits instead.

• TThoabala moved this task from Triage/To be Estimated to Cards ready for development on the Anti-Harassment board.Aug 15 2022, 5:26 PM

• TThoabala set the point value for this task to 3.

• AGueyte claimed this task.Aug 16 2022, 3:35 PM

• AGueyte moved this task from Cards ready for development to AHaT Sprint 13: The Magikarp Hat on the Anti-Harassment board.Aug 16 2022, 3:39 PM

• AGueyte edited projects, added Anti-Harassment (AHaT Sprint 13: The Magikarp Hat); removed Anti-Harassment.

• AGueyte moved this task from Ready 🎬 (ONLY IF YOU HAVE NO MORE CODE TO REVIEW) to In Progress 💪 on the Anti-Harassment (AHaT Sprint 13: The Magikarp Hat) board.

ARamirez_WMF edited projects, added Anti-Harassment (AHaT Sprint 14: The Umbrella Hat); removed Anti-Harassment (AHaT Sprint 13: The Magikarp Hat).Aug 16 2022, 4:19 PM

ARamirez_WMF moved this task from Ready 🎬 (ONLY IF YOU HAVE NO MORE CODE TO REVIEW) to In Progress 💪 on the Anti-Harassment (AHaT Sprint 14: The Umbrella Hat) board.

Change 824296 had a related patch set uploaded (by AGueyte; author: AGueyte):

[mediawiki/extensions/CheckUser@master] WIP:Allow custom menu to be passed in to OO.ui.ButtonMenuSelectWidget

https://gerrit.wikimedia.org/r/824296

gerritbot added a project: Patch-For-Review.Aug 17 2022, 9:20 PM

Change 824298 had a related patch set uploaded (by AGueyte; author: AGueyte):

[oojs/ui@master] WIP: Allow custom menu to be passed in to OO.ui.ButtonMenuSelectWidget

https://gerrit.wikimedia.org/r/824298

Change 825759 had a related patch set uploaded (by Tchanders; author: Tchanders):

[oojs/ui@master] Allow custom menu class to be passed in to OO.ui.ButtonMenuSelectWidget

https://gerrit.wikimedia.org/r/825759

Tchanders claimed this task.Aug 24 2022, 12:21 PM

Tchanders moved this task from In Progress 💪 to Code Review 🔍 on the Anti-Harassment (AHaT Sprint 14: The Umbrella Hat) board.

Tchanders added a subscriber: • AGueyte.

Change 824298 abandoned by AGueyte:

[oojs/ui@master] WIP: Allow custom menu to be passed in to OO.ui.ButtonMenuSelectWidget

Reason:

Duplicate

https://gerrit.wikimedia.org/r/824298

• AGueyte moved this task from Code Review 🔍 to QA/Testing 🐞 on the Anti-Harassment (AHaT Sprint 14: The Umbrella Hat) board.Aug 24 2022, 6:21 PM

Change 825759 merged by jenkins-bot:

[oojs/ui@master] Allow custom menu class to be passed in to OO.ui.ButtonMenuSelectWidget

https://gerrit.wikimedia.org/r/825759

To test this change with the Special:Investigate tools menu, I copy and pasted the changes into resources/lib/ooui/oojs-ui-widgets.js and pulled the patch https://gerrit.wikimedia.org/r/c/mediawiki/extensions/CheckUser/+/824296 (as suggested here). I could use the tools menu with both keyboard and mouse and tabbing closes the menu (as it did before).

In case of regression, I tried to find a UI element using ButtonMenuSelectWidget but without passing a custom menu. CampaignEvents uses a dropdown menu on Special:MyEvents which inherits from ButtonMenuSelectWidget (see here). It worked with mouse and keyboard and pressing tab submits (as it did before).

Test environment: local docker CheckUser 2.5 (e72bc67) 15:41, 24 August 2022.

• Niharika closed this task as Resolved.Sep 2 2022, 8:48 PM

@Volker_E Is there a plan to make a new OOUI release?

Change 836237 had a related patch set uploaded (by Jforrester; author: Jforrester):

[mediawiki/core@master] Update OOUI to v0.45.0

https://gerrit.wikimedia.org/r/836237

Change 836237 merged by jenkins-bot: