WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 4 years ago

Last modified 4 years ago

#32683 closed feature request (fixed)

Custom Menu widget should include a shortcut to load selected menu inside the customiser

Reported by: paulwilde Owned by: westonruter
Milestone: 4.6 Priority: normal
Severity: normal Version: 4.3
Component: Customize Keywords: has-patch commit
Focuses: javascript Cc:

Description

Similar to the "Original" link that loads the selected menu item inside the website preview there should be a shortcut inside the "Custom Menu" widget that loads the selected menu directly inside the customiser.

Such a shortcut would save travelling through 4 sections:

  1. Back to widgets
  2. Back to home
  3. Menus
  4. Select menu

Attachments (6)

32683-button.PNG (16.4 KB) - added by celloexpressions 4 years ago.
32683.diff (1.1 KB) - added by celloexpressions 4 years ago.
32683.gif (738.9 KB) - added by celloexpressions 4 years ago.
32683.1.diff (2.3 KB) - added by celloexpressions 4 years ago.
Restructure JS, show/hide the edit button when a menu is selected.
32683.2.diff (3.7 KB) - added by celloexpressions 4 years ago.
Change the back button to go back to the widget when closing the menu section. Adds a reusable function for this to the wp.customize.Control object, as well as passing the widget control as a second parameter to the widget-added event, for additional context where needed.
32683.3.diff (3.8 KB) - added by westonruter 4 years ago.

Download all attachments as: .zip

Change History (19)

#1 @valendesigns
5 years ago

  • Keywords needs-patch added

Sounds cool, are you able to create a patch?

#2 @celloexpressions
5 years ago

  • Focuses javascript added
  • Milestone changed from Awaiting Review to Future Release

Will be as easy as api.section( menu section id ).focus(), but yes, needs a patch for 4.3.

This ticket was mentioned in Slack in #core-customize by celloexpressions. View the logs.


4 years ago

#4 @celloexpressions
4 years ago

  • Keywords has-patch added; needs-patch removed
  • Milestone changed from Future Release to 4.6

32683.diff is a first-pass at adding an "edit menu" button to the nav menu widget when used in the customizer, which links directly to the associated nav menu section. This is great for user flow, and the button updates when the selected menu is changed.

In the patch, the JS is included fairly hickily, but without a JS API for widgets, I think this approach could work. It's scoped specifically to the ids of each widget so it should be fine. If anyone has an idea for a better approach, would love to see it.

#5 @celloexpressions
4 years ago

  • Owner set to westonruter
  • Status changed from new to reviewing

@westonruter how does this look? I'm not thrilled with the placement of the JS but it works pretty well in terms of a usability enhancement.

#6 @westonruter
4 years ago

@celloexpressions thanks for that. This is definitely a good starting point. I agree that the JS needs better placement, but it provides the prototype for what is needed. Adding a link from the widget to the menu section is indeed a huge usability improvement. One improvement that I see is the behavior of the back button. A user would probably expect after clicking “back” that they would be taken back to editing the widget and not be taken to the list of menus. If a user doesn't expect this (such as we who have gotten so used to navigating around panels so much), then they probably should.

I've been thinking about this a bit this week and I think we could very nicely override the back button here to serve as a breadcrumb/history navigation rather than a structural navigation in particular cases. For example, when clicking on Edit Menu, it could invoke this JS logic instead of just expanding the section. Consider this logic:

/**
 * Focus (expand) another construct and return to this control when it is collapsed.
 *
 * @param {wp.customize.Section|wp.customize.Panel} construct - The thing to expand.
 * @this {wp.customize.Control}
 */
function focusConstructAndRturnToControlWhenCollapsed( construct ) {
        var control = this;

        construct.focus();
        function onceCollapsed( isExpanded ) {
                if ( ! isExpanded ) {
                        construct.expanded.unbind( onceCollapsed );
                        control.focus();
                }
        }
        construct.expanded.bind( onceCollapsed );
}

To simulate from your browser console:

  1. Open the Site Title and Tagline section.
  2. Paste in the above function into your console.
  3. Focus on the blogname and pretend there is a button to expand a given menu section.
  4. Paste this into your console: focusConstructAndRturnToControlWhenCollapsed.call( wp.customize.control( 'blogname' ), wp.customize.section( 'nav_menu[87]' ) );
  5. Notice that you are now in the given nav menu section (adapt the ID as needed in your example).
  6. Click on Back and notice that instead of being navigated to the Menus panel that you are instead brought back to the blogname control with focus applied.

This would be a great improvement to usability I think.

This ticket was mentioned in Slack in #core-customize by celloexpressions. View the logs.


4 years ago

#8 @celloexpressions
4 years ago

  • Keywords needs-patch added; has-patch removed
  • Owner changed from westonruter to celloexpressions

Needs an updated patch per slack conversation and Weston's comment above.

@celloexpressions
4 years ago

Restructure JS, show/hide the edit button when a menu is selected.

@celloexpressions
4 years ago

Change the back button to go back to the widget when closing the menu section. Adds a reusable function for this to the wp.customize.Control object, as well as passing the widget control as a second parameter to the widget-added event, for additional context where needed.

#9 @celloexpressions
4 years ago

  • Keywords has-patch added; needs-patch removed
  • Owner changed from celloexpressions to westonruter

32683.2.diff includes the updates discussed in Slack and above, improving the placement and structure of the JS and letting users navigate directly back to the widget after editing the associated menu.

This is really great for UX and also facilitates a couple of API improvements as noted in the patch descriptions. Should be close to ready now.

@westonruter
4 years ago

#10 @westonruter
4 years ago

  • Keywords commit added

@celloexpressions I did another pass in 32683.3.diff. I removed the additional control arg being passed to the widget-added here because this is the same event that is being used on the widgets admin page, and there the arg wouldn't be available. I think adding it does make sense, but I think we should do that in another ticket to consider any implications to JS written specifically for the widgets admin page.

Also, I moved focusConstructAndReturnToControlWhenCollapsed into private scope and renamed to focusConstructWithBreadcrumb. Since this is the only instance of us needing this functionality so far, and because the name is unwieldily, I decided to make it private for now. We can make it public in another ticket once we have a second use case and can agree on a better API for it (I just came up with that verbose name for illustration purposes).

I'll commit this unless you have any further feedback.

#12 @westonruter
4 years ago

  • Resolution set to fixed
  • Status changed from reviewing to closed

In 37437:

Customize: Include shortcut button in Custom Menu widget to edit the selected menu in the Customizer.

Clicking on the Edit Menu button focuses on the corresponding nav menu section. Upon collapsing the nav menu section, the focus is returned to the Custom Menu widget instead of taking the user to the menus root panel. In this way, the back button behavior is modified once to serve as breadcrumb/history navigation. The Edit Menu button with the breadcrumb back button behavior greatly reduce the number of UI interactions needed to edit a menu referenced in a Custom Menu widget.

Props celloexpressions, westonruter.
Fixes #32683.

This ticket was mentioned in Slack in #core-customize by celloexpressions. View the logs.


4 years ago

Note: See TracTickets for help on using tickets.