Add menu item order control #12362

codebytere · 2018-03-20T05:34:46Z

This PR reworks the way that we approach menu item ordering by porting an approximation of the solution devised in atom/atom with atom/atom#16661 to Electron.

Fixes #11668.

To-Do:

Fix two failing tests
Documentation

This PR would hopefully be a breaking change in 3-0-x.

codebytere · 2018-03-25T03:10:17Z

spec/api-menu-spec.js

          }
        ])
        assert.equal(menu.items[0].label, '1')
        assert.equal(menu.items[1].label, '2')
        assert.equal(menu.items[2].label, '3')
      })

-      it('should position after existing item', () => {
+      it.only('should position after existing item', () => {


i need to remove this i know; i'll do it with the next commit

MarshallOfSound · 2018-03-28T00:46:56Z

lib/browser/api/menu-utils.js

@@ -0,0 +1,169 @@
+function splitArray (arr, predicate) {


I really want this to be a reduce (not a fan of a forEach creating a new array)

const result = arr.reduce((multi, item) => { const current = multi[multi.length - 1] if (predicate(item)) { if (current.length > 0) multi.push([]) } else { current.push(item) } return multi }, [[]]) if (result[result.length - 1].length === 0) { return result.slice(0, result.length - 1) } return result

Not sure if that's ^^ the best way to do it but would love to see the forEach go away 😄

MarshallOfSound · 2018-03-28T00:50:24Z

lib/browser/api/menu-utils.js

+  return multiArr
+}
+
+function joinArrays (arrays, joiner) {


This is better as a reduce

return arrays.reduce((joined, arr, i) => { if (i > 0 && arr.length > 0) { joined.push(joiner) } return joined.concat(arr) }, []);

zeke

Left a few comments.

I find the afterGroupContaining and beforeGroupContaining descriptions difficult to understand. Can you take a shot at rewording them?

It might help to have some illustrative examples. Maybe it's high time we had a Menu tutorial 🤔

zeke · 2018-05-02T17:34:35Z

lib/browser/api/menu-utils.js

+function joinArrays (arrays, joiner) {
+  const joinedArr = []
+  arrays.forEach((arr, i) => {
+    if (i > 0 && arr.length > 0) {


0 is falsy, so you could just do && arr.length

But this is more explicit. I don't care! Just a note.

zeke · 2018-05-02T17:36:40Z

docs/api/menu.md

@@ -302,27 +302,20 @@ browser windows.

 ## Menu Item Position

-You can make use of `position` and `id` to control how the item will be placed
-when building a menu with `Menu.buildFromTemplate`.
+You can make use of `before/after`, `beforeGroupContaining/afterGroupContaining` and `id` to control how the item will be placed when building a menu with `Menu.buildFromTemplate`.


I would break out before/after into before, after

zeke · 2018-05-02T17:37:19Z

docs/api/menu.md

-an existing item in the menu:
-
-* `before` - Inserts this item before the id referenced item. If the
+* `before` - Inserts this item before the label referenced item. If the


"before the label referenced item"? Not sure I understand this.

revised to after the item with the specified label

zeke · 2018-05-02T17:39:05Z

docs/api/menu.md

-the first item.
+  the menu. Also implies that the menu item in question should be placed in the same “group” as the item
+* `beforeGroupContaining` - Provides a means for a single context menu to declare
+  the placement of their containing group after to the containing group of the label specified item.


typo: "after to the containing"

zeke · 2018-05-02T17:39:26Z

docs/api/menu.md

+* `afterGroupContaining` Provides a means for a single context menu to declare
+  the placement of their containing group before the containing group of the label specified item.
+
+By default, items will be inserted in the order they exist in the template unless one of the specified positioning keywords is utilized. 


utilized => used

zeke · 2018-05-04T19:53:58Z

docs/api/menu.md

-an existing item in the menu:
-
-* `before` - Inserts this item before the id referenced item. If the
+* `before` - Inserts this item before the item with the specified label.. If the


zeke · 2018-05-04T19:54:54Z

docs/api/menu.md

-the first item.
+  the menu. Also implies that the menu item in question should be placed in the same “group” as the item.
+* `beforeGroupContaining` - Provides a means for a single context menu to declare
+  the placement of their containing group after the containing group of the item with the specified label.


s/after/before/

zeke · 2018-05-04T19:55:32Z

lib/browser/api/menu-utils.js

+}
+
+function attemptToMergeAGroup (groups) {
+  for (let i = 0; i < groups.length; i++) {


i can be a const here

won't that not let me increment i?

BREAKING CHANGE For reference, see electron/electron#12362.

codebytere requested a review from a team March 20, 2018 05:34

codebytere changed the title ~~Add context menu order control~~ Add menu item order control Mar 20, 2018

codebytere commented Mar 25, 2018

View reviewed changes

codebytere force-pushed the context-menu-order-control branch from 917ae54 to f413ace Compare March 25, 2018 05:31

codebytere requested a review from a team March 25, 2018 14:29

MarshallOfSound added the pending-major-release label Mar 28, 2018

ckerr added semver/major incompatible API changes and removed pending-major-release labels Apr 14, 2018

MarshallOfSound reviewed Apr 24, 2018

View reviewed changes

zeke suggested changes May 2, 2018

View reviewed changes

zeke reviewed May 4, 2018

View reviewed changes

zeke approved these changes May 5, 2018

View reviewed changes

codebytere added 15 commits May 5, 2018 08:02

initial spike on solution for menu item positioning

74c7695

sort by label, not command

9a0b940

extract utils to new file

6b4e5c9

add some new test and fix some old ones

479cdf0

add merging groups tests

cfb1af3

add sorting tests and reorder

39c8bcb

more test fixup

70157c6

remove unused methods

fb09e20

menu item default sort by ids

165916e

switch to id sorting to retain prio behavior

6c300d7

update docs

6487db1

update docs for clarity

d5b74dd

remove forEach loops

4c9cb87

appease the linter

bc7de6f

fix typos

a99625f

codebytere force-pushed the context-menu-order-control branch from d3d6f86 to a99625f Compare May 5, 2018 15:04

remove extra symbol

c60a928

MarshallOfSound approved these changes May 5, 2018

View reviewed changes

codebytere merged commit 9c8952a into master May 5, 2018

codebytere deleted the context-menu-order-control branch May 5, 2018 16:37

dev01d mentioned this pull request Aug 20, 2018

System tray icon not showing in ubuntu communitheme liberodark/ODrive#37

Closed

felixrieseberg mentioned this pull request Sep 6, 2018

fix: position is dead, long live before/after electron/typescript-definitions#108

Merged

MarshallOfSound mentioned this pull request Sep 8, 2018

fix: position is dead, long live before/after electron/typescript-definitions#110

Merged

MarshallOfSound added a commit to electron/typescript-definitions that referenced this pull request Sep 8, 2018

fix: position is dead, long live before/after (#110)

541f414

BREAKING CHANGE For reference, see electron/electron#12362.

This was referenced Sep 19, 2018

Update electron in / from 2.0.9 to 3.0.0 JetBrains/ring-ui#417

Merged

Update electron in /packages/generator/app/templates from 2.0.10 to 3.0.0 JetBrains/ring-ui#418

Merged

codebytere mentioned this pull request Oct 12, 2018

menu.getMenuItemById() doesn't work for separators #15119

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add menu item order control #12362

Add menu item order control #12362

codebytere commented Mar 20, 2018 •

edited

Loading

codebytere Mar 25, 2018

MarshallOfSound Mar 28, 2018

MarshallOfSound Mar 28, 2018

zeke left a comment

zeke May 2, 2018

zeke May 2, 2018

zeke May 2, 2018

zeke May 2, 2018

codebytere May 4, 2018

zeke May 2, 2018

zeke May 2, 2018

zeke May 4, 2018

zeke May 4, 2018

zeke May 4, 2018

codebytere May 4, 2018

zeke May 5, 2018

Add menu item order control #12362

Add menu item order control #12362

Conversation

codebytere commented Mar 20, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zeke left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codebytere commented Mar 20, 2018 •

edited

Loading