API: submenus extension point by joaomoreno · Pull Request #102784 · microsoft/vscode

joaomoreno · 2020-07-17T13:19:36Z

This PR fixes #100172

Fix non-editor submenus, fix dropdown submenus: address SubmenuItemAction vs ContextSubMenu confusion
Fix native context menus
Support nested submenus
Prevent submenu cycles
Expand the set of menus which have submenu support
Support top-level toolbar submenus, including icon for the action item

joaomoreno · 2020-07-21T15:03:52Z

@sbatten Submenus seemed to work nicely in the editor context menu, but not across the rest of the workbench. There was some mixup with SubmenuItemAction vs ContextSubMenu. In 86ec536, I made SubmenuItemAction extends SubmenuAction which resolves the whole mess and makes submenus work everywhere else. Can you please review that commit? The interesting change is in 86ec536#diff-cc0794e8bea870179e50767a30f52d5bR233-R236

joaomoreno · 2020-07-22T09:12:23Z

@sbatten @isidorn Native submenus were yet another implementation, dependent on the bogus ContextSubMenu class, so submenus didn't work in that case either. I deleted that class.

joaomoreno · 2020-07-22T09:19:13Z

@sbatten @jrieken Recursive submenus work in custom UI:

But they break down in native UI, since the entire menu hierarchy must be given to Electron at the time of creation:

Because of the limitation and the fact that it would simply be a gimmick, I'll write some code to prevent menu cycles.

joaomoreno · 2020-07-23T14:22:35Z

@jrieken I've refactored menusExtensionPoint.ts heavily to make it easier to maintain the list of API menus, give it a look: c3cef6f

joaomoreno · 2020-07-23T14:23:05Z

Submenus now work across most menus! Check this out:

isidorn · 2020-07-28T16:32:09Z

Very cool work 👏

jrieken · 2020-08-10T09:47:05Z

src/vs/base/browser/ui/dropdown/dropdownActionViewItem.ts

+				classNames.push('codicon');
 			}

+			addClasses(this.element, ...classNames);


fyi - es6 deprecated, use this.element.classList...

Actually didn't know that!

jrieken · 2020-08-10T09:48:50Z

src/vs/workbench/api/common/menusExtensionPoint.ts

 			case 'editor/title/context': return MenuId.EditorTitleContext;
 			case 'debug/callstack/context': return MenuId.DebugCallStackContext;
-			case 'debug/toolbar': return MenuId.DebugToolBar;
 			case 'debug/toolBar': return MenuId.DebugToolBar;


API breakage?

Yeah we had both for backwards compatibility, even though debug/toolbar was "deprecated". I am not sure if there are extensions which really on this.

High risk. You could know relatively easy (telemetry, search extension usages) or just keep it given the low price of supporting it. btw: deprecated doesn't mean that we will remove it

I just searched top 1000 extensions usages on debug/toolbar usage and only one extension used the deprecated name - the extension is not that popular and I have created an issue for them IBM-Blockchain/blockchain-vscode-extension#2593
So I suggest the following: let's go with the removal, and if needed we can easily reintroduce it as part of a recovery build if somebody complains.
fyi @weinand

Great catch @jrieken, I really thought this was an oversight and failed to see the case difference. I'll leave it up to @isidorn and @weinand. Sorry all!

joaomoreno · 2020-08-10T17:34:23Z

@jrieken Thanks for the post-mergeum review! 🙏

submenus api extension point

762bb93

joaomoreno added api api-proposal labels Jul 17, 2020

joaomoreno added this to the July 2020 milestone Jul 17, 2020

joaomoreno requested a review from jrieken July 17, 2020 13:19

joaomoreno self-assigned this Jul 17, 2020

jrieken approved these changes Jul 17, 2020

View reviewed changes

joaomoreno added 2 commits July 17, 2020 15:33

fix nls

16ce08b

add runtime submenu support validation

6584270

joaomoreno force-pushed the joao/submenus branch from 29177dd to 6584270 Compare July 21, 2020 12:37

joaomoreno added 4 commits July 21, 2020 14:39

Merge remote-tracking branch 'origin/master' into joao/submenus

18e9e7f

move SubmenuAction to common

af15adf

move Separator down to actions

375bdea

fix submenus across workbench

86ec536

joaomoreno requested a review from sbatten July 21, 2020 15:04

Merge branch 'master' into joao/submenus

d3cd7bc

joaomoreno mentioned this pull request Jul 22, 2020

Bad submenu layout at window limits #103078

Closed

fix native submenus, delete ContextSubMenu

eed2e95

joaomoreno added 7 commits July 22, 2020 14:20

fix compile error

26aa8ee

submenus always support submenus

0528d12

proper SubmenuAction.id

5b2e422

prevent submenu cycles

c2e4add

fix submenus in scm/sourceControl

095c690

fix submenus in extension/context menu

6f77c06

fix submenus in view/item/context menu

f49561e

sbatten approved these changes Jul 22, 2020

View reviewed changes

isolate action view items, delete duplicate IActionViewItem interface

e7279b1

joaomoreno added 15 commits July 23, 2020 10:46

wip: submenu icons

8488049

strict null checks

f0252d2

delete ContextAwareMenuEntryActionViewItem

cfd8266

delete unused code

6d2a2f0

SubmenuEntryActionViewItem

e6f3f16

ViewPane knows about menu items

83662c9

missing unused code

7465af9

unused code

ab3e5f9

reduce usage of MenuEntryActionViewItem

d683e21

fix submenus in editor title control

642adf0

fix submenus in peek

ce389f3

redundant code

10a0727

spread SubmenuEntryActionViewItem all over

fca1e0f

update menu extension point schema for submenus

28d97ae

make menusExtensionPoint.ts easier to edit

c3cef6f

joaomoreno added 4 commits July 23, 2020 16:37

fix submenu json schema, add proposed disclaimers

42d6c1f

Merge branch 'master' into joao/submenus

187e9dd

fix activitybarPart import error

1f5ece2

fix import errors

a7fdaf4

joaomoreno merged commit a7fdaf4 into master Jul 23, 2020

joaomoreno deleted the joao/submenus branch July 23, 2020 14:56

joaomoreno mentioned this pull request Aug 3, 2020

Test: Submenu API #103832

Closed

3 tasks

rebornix mentioned this pull request Aug 3, 2020

Test unified undo/redo/copy/paste/find actions in Notebook #103860

Closed

2 tasks

jrieken reviewed Aug 10, 2020

View reviewed changes

mjcrouch mentioned this pull request Aug 10, 2020

Use Sub Menus mjcrouch/vscode-perforce#178

Closed

github-actions bot locked and limited conversation to collaborators Sep 6, 2020

Conversation

joaomoreno commented Jul 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joaomoreno commented Jul 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joaomoreno commented Jul 22, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

joaomoreno commented Jul 22, 2020

Uh oh!

joaomoreno commented Jul 23, 2020

Uh oh!

joaomoreno commented Jul 23, 2020

Uh oh!

isidorn commented Jul 28, 2020

Uh oh!

jrieken Aug 10, 2020

Choose a reason for hiding this comment

Uh oh!

joaomoreno Aug 10, 2020

Choose a reason for hiding this comment

Uh oh!

jrieken Aug 10, 2020

Choose a reason for hiding this comment

Uh oh!

isidorn Aug 10, 2020

Choose a reason for hiding this comment

Uh oh!

jrieken Aug 10, 2020

Choose a reason for hiding this comment

Uh oh!

isidorn Aug 10, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joaomoreno Aug 10, 2020

Choose a reason for hiding this comment

Uh oh!

joaomoreno commented Aug 10, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

joaomoreno commented Jul 17, 2020 •

edited

Loading

joaomoreno commented Jul 21, 2020 •

edited

Loading

joaomoreno commented Jul 22, 2020 •

edited

Loading

isidorn Aug 10, 2020 •

edited

Loading