Menubar - Add "find menu item" search feature #16597
Conversation
|
(Standard links)
|
|
So. Freakin. Cool. |
|
@twomice any chance you can give it a spin? Code passes the 'nothing looks worrying test' |
|
Sure, will give it a go. |
|
@colemanw If you can ping me when tests are passing, I'll give it a review. |
|
@twomice the 4 test failures are unrelated. Those look like flaky time-based tests which fail at certain times of the day/week/month. |
|
@colemanw When I type, an "x" control appears in the text field, but that x does nothing when I click on it. (Otherwise looks good so far.) |
|
@twomice I just noticed that too. Looks to be a side-effect of the menu's markup and the The "right" fix is somewhat elusive but for now I've just changed the input type from "search" to "text" so the non-functional |
|
test this please |
|
I know that full keyboard shortcut support is a heavy lift for Civi at the moment - but based on my use of the Coffee module for Drupal, I'm guessing that if this had a keyboard shortcut it would quickly become a favorite tool of Civi power users everywhere. |
Allows user to locate menu items by typing a few letters. Find tool is located under the "Home" (Civi logo) menu.
|
@MegaphoneJon great idea! I looked into it and actually there is already a shortcut key to the "Home" (Civi logo) menu (ALT + M) which wasn't really doing anything except opening that item. I just moved the search box to that menu item (arguably a better place for it) and now the ALT + M hotkey will take you straight to the finder. (note the hotkey could be ALT+SHIFT or something else depending on the browser/OS). |
|
One problem with using ALT+M for this is that now I can't access "hide civicrm menu" via the keyboard, nor or other sub-items of the "Civi logo" menu. Not a deal breaker as far as I'm concerned, but it does have the effect of removing all o the previous utility of this shortcut in favor of different functionality. I don't know how we could measure the potential impact of this change (we probably don't have usage stats on this shortcut key), but thought it worth mentioning. @colemanw , any thoughts? |
|
@twomice I just tried it and was able to access the "hide menu" item with |
|
I'm cool with that if you are. Reviewing now. |
| @@ -1,4 +1,9 @@ | |||
| { | |||
| "com.civibridge.quickmenu": { | |||
| "obsolete": "5.24", | |||
| "disable": true, | |||
There was a problem hiding this comment.
@colemanw Wasn't aware of "obsolete" capability. Kinda cool. Is this documented somewhere?
There was a problem hiding this comment.
No it's fairly new. So far its being used for extensions whose features have been migrated into core (Api4, KAM, ExportUI, etc.). Adding an extension to this list will:
- Automatically disable/uninstall it during the upgrade.
- Not allow it to be reenabled; label it "obsolete" in the UI.
- Resolve any dependencies (so an extension that declares a dependency on Api4 will still work)
Let me see if I can find a spot for that in the dev docs pages...
There was a problem hiding this comment.
There was a problem hiding this comment.
(CiviCRM Review Template WORD-1.2)
- General standards
- (
r-explain) Pass: Explanation is clear and thorough. - (
r-user) Pass: Minor usability impact (lost use of arrow keys to access sub-menu items with ALT+M shortcut key) is mitigated with workaround (use of Tab/Shift+Tab instead) - (
r-doc) Pass: ALT+M Shortcut key is documented in "Access Keys" help popup. - (
r-run) Pass: I used this feature on the auto-generated test website (http://core-16597-6w4xq.test-1.civicrm.org:8001/ at time of writing) and observed it works as expected.
- (
- Developer standards
|
@eileenmcnaughton See my review above. I believe this is ready to merge. |
|
I've given this merge-ready - I just want to give @aydun & @michaelmcandrew - who was the other person who was involved in usability over your way? a chance to see the notes about the keyboard shortcut changes |
|
hey @eileenmcnaughton - it was claire williams from www.visibility.org.uk - I've sent her a quick email. |
|
I like the new feature - slight concern re the arrow keys as documented above but doesn't seem a blocker to me. Occasionally it brings up duplicates: eg entering 'cam' brings up 4 links for Personal Campaign Pages, 2 each for events and contribute - but I'm guessing that is related to the underlying menu items under Contributions and Events being duplicated under Administer. Also looping in @JoeMurray re accessibility. |
|
I get the concern about the arrow keys but I'm not sure anything can be done about it. The issue is that the search input is a text field, and pretty much every UI convention says that when a text field is focused, the arrow keys are for moving the cursor, not for moving focus to a different element. FYI the quicksearch field has the exact same issue. And yes, the menubar is full of duplicates. Probably to make things easier to find... because of the lack of a search box! |
|
This looks good to me as well and will be a nice improvement |
|
@colemanw @seamuslee001 tested this and works well 👍 |
|
@colemanw Shall we merge or we waiting on more feedback/changes? |
|
I think this is ready to merge. |
|
OK - I'll merge - if we get further feedback from @michaelmcandrew's email / pings we can address |
Overview
Allows user to locate menu items by typing a few letters.
Find tool is located under the "Home" (Civi logo) menu.
Before
No finder for menu items.
After
The first item in the "Home" menu is a finder to locate menu items. Accesskey "M"
Typing a few letters reveals a sub-menu of clickable results:
Comments
This obsoletes the QuickSearch Extension.