<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[41930] trunk/src/wp-admin/js: Customize: Draw attention to "Add Items" button after creating a new menu.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/41930">41930</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/41930","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-10-18 21:59:34 +0000 (Wed, 18 Oct 2017)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Customize: Draw attention to "Add Items" button after creating a new menu.
Introduce `wp.customize.utils.highlightButton()` and `wp.customize.Menus.MenuSection#highlightNewItemButton()`.
Props bpayton, melchoyce, afercia, westonruter.
Fixes <a href="https://core.trac.wordpress.org/ticket/42114">#42114</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminjscustomizecontrolsjs">trunk/src/wp-admin/js/customize-controls.js</a></li>
<li><a href="#trunksrcwpadminjscustomizenavmenusjs">trunk/src/wp-admin/js/customize-nav-menus.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminjscustomizecontrolsjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/js/customize-controls.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/customize-controls.js 2017-10-18 21:47:39 UTC (rev 41929)
+++ trunk/src/wp-admin/js/customize-controls.js 2017-10-18 21:59:34 UTC (rev 41930)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -751,6 +751,57 @@
</span><span class="cx" style="display: block; padding: 0 10px"> };
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Highlight the existence of a button.
+ *
+ * This function reminds the user of a button represented by the specified
+ * UI element, after an optional delay. If the user focuses the element
+ * before the delay passes, the reminder is canceled.
+ *
+ * @since 4.9.0
+ *
+ * @param {jQuery} button - The element to highlight.
+ * @param {object} [options] - Options.
+ * @param {number} [options.delay=0] - Delay in milliseconds.
+ * @param {jQuery} [options.focusTarget] - A target for user focus that defaults to the highlighted element.
+ * If the user focuses the target before the delay passes, the reminder
+ * is canceled. This option exists to accommodate compound buttons
+ * containing auxiliary UI, such as the Publish button augmented with a
+ * Settings button.
+ * @returns {Function} An idempotent function that cancels the reminder.
+ */
+ api.utils.highlightButton = function highlightButton( button, options ) {
+ var animationClass = 'button-see-me',
+ canceled = false,
+ params;
+
+ params = _.extend(
+ {
+ delay: 0,
+ focusTarget: button
+ },
+ options
+ );
+
+ function cancelReminder() {
+ canceled = true;
+ }
+
+ // Remove animation class in case it was already applied.
+ button.removeClass( animationClass );
+
+ params.focusTarget.on( 'focusin', cancelReminder );
+ setTimeout( function() {
+ params.focusTarget.off( 'focusin', cancelReminder );
+
+ if ( ! canceled ) {
+ button.addClass( animationClass );
+ }
+ }, params.delay );
+
+ return cancelReminder;
+ };
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Get current timestamp adjusted for server clock time.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Same functionality as the `current_time( 'mysql', false )` function in PHP.
</span></span></pre></div>
<a id="trunksrcwpadminjscustomizenavmenusjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/js/customize-nav-menus.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/customize-nav-menus.js 2017-10-18 21:47:39 UTC (rev 41929)
+++ trunk/src/wp-admin/js/customize-nav-menus.js 2017-10-18 21:59:34 UTC (rev 41930)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1142,6 +1142,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> };
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> api.Section.prototype.onChangeExpanded.call( section, expanded, args );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ },
+
+ /**
+ * Highlight how a user may create new menu items.
+ *
+ * This method reminds the user to create new menu items and how.
+ * It's exposed this way because this class knows best which UI needs
+ * highlighted but those expanding this section know more about why and
+ * when the affordance should be highlighted.
+ *
+ * @since 4.9.0
+ *
+ * @returns {void}
+ */
+ highlightNewItemButton: function() {
+ api.utils.highlightButton( this.contentContainer.find( '.add-new-menu-item' ), { delay: 2000 } );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1325,6 +1341,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> name = nameInput.val(),
</span><span class="cx" style="display: block; padding: 0 10px"> menuSection,
</span><span class="cx" style="display: block; padding: 0 10px"> customizeId,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ editMenuSection,
</ins><span class="cx" style="display: block; padding: 0 10px"> placeholderId = api.Menus.generatePlaceholderAutoIncrementId();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! name ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1383,7 +1400,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp.a11y.speak( api.Menus.data.l10n.menuAdded );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Focus on the new menu section.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- api.section( customizeId ).focus(); // @todo should we focus on the new menu's control and open the add-items panel? Thinking user flow...
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ editMenuSection = api.section( customizeId );
+ editMenuSection.focus( {
+ completeCallback: function() {
+ editMenuSection.highlightNewItemButton();
+ }
+ } ); // @todo should we focus on the new menu's control and open the add-items panel? Thinking user flow...
</ins><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre>
</div>
</div>
</body>
</html>