<!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>[39928] trunk: Menus: trigger an event when menu items are added or removed.</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/39928">39928</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/39928","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>adamsilverstein</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-01-20 16:14:23 +0000 (Fri, 20 Jan 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'>Menus: trigger an event when menu items are added or removed.
Fire a `menu-item-added` event after a menu item is added to the DOM. Fire a `menu-removing-item` event before a menu item is removed from the DOM. Enables hooking into and responding to menu changes.
Props welcher, adamsilverstein.
Fixes <a href="https://core.trac.wordpress.org/ticket/31218">#31218</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminjsnavmenujs">trunk/src/wp-admin/js/nav-menu.js</a></li>
<li><a href="#trunktestsqunitindexhtml">trunk/tests/qunit/index.html</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsqunitwpadminjsnavmenujs">trunk/tests/qunit/wp-admin/js/nav-menu.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminjsnavmenujs"></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/nav-menu.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/nav-menu.js 2017-01-20 05:59:32 UTC (rev 39927)
+++ trunk/src/wp-admin/js/nav-menu.js 2017-01-20 16:14:23 UTC (rev 39928)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1003,21 +1003,33 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Process the add menu item request response into menu list item.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Process the add menu item request response into menu list item. Appends to menu.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string menuMarkup The text server response of menu item markup.
- * @param object req The request arguments.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param {string} menuMarkup The text server response of menu item markup.
+ *
+ * @fires document#menu-item-added Passes menuMarkup as a jQuery object.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> addMenuItemToBottom : function( menuMarkup ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $(menuMarkup).hideAdvancedMenuItemFields().appendTo( api.targetList );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var $menuMarkup = $( menuMarkup );
+ $menuMarkup.hideAdvancedMenuItemFields().appendTo( api.targetList );
</ins><span class="cx" style="display: block; padding: 0 10px"> api.refreshKeyboardAccessibility();
</span><span class="cx" style="display: block; padding: 0 10px"> api.refreshAdvancedAccessibility();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $( document ).trigger( 'menu-item-added', [ $menuMarkup ] );
</ins><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">+ /**
+ * Process the add menu item request response into menu list item. Prepends to menu.
+ *
+ * @param {string} menuMarkup The text server response of menu item markup.
+ *
+ * @fires document#menu-item-added Passes menuMarkup as a jQuery object.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> addMenuItemToTop : function( menuMarkup ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $(menuMarkup).hideAdvancedMenuItemFields().prependTo( api.targetList );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var $menuMarkup = $( menuMarkup );
+ $menuMarkup.hideAdvancedMenuItemFields().prependTo( api.targetList );
</ins><span class="cx" style="display: block; padding: 0 10px"> api.refreshKeyboardAccessibility();
</span><span class="cx" style="display: block; padding: 0 10px"> api.refreshAdvancedAccessibility();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $( document ).trigger( 'menu-item-added', [ $menuMarkup ] );
</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"> attachUnsavedChangesListener : function() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1243,9 +1255,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wrapper.removeClass( 'has-no-menu-item' );
</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">+ /**
+ * Remove a menu item.
+ * @param {object} el The element to be removed as a jQuery object.
+ *
+ * @fires document#menu-removing-item Passes the element to be removed.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> removeMenuItem : function(el) {
</span><span class="cx" style="display: block; padding: 0 10px"> var children = el.childMenuItems();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $( document ).trigger( 'menu-removing-item', [ el ] );
</ins><span class="cx" style="display: block; padding: 0 10px"> el.addClass('deleting').animate({
</span><span class="cx" style="display: block; padding: 0 10px"> opacity : 0,
</span><span class="cx" style="display: block; padding: 0 10px"> height: 0
</span></span></pre></div>
<a id="trunktestsqunitindexhtml"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/qunit/index.html</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/index.html 2017-01-20 05:59:32 UTC (rev 39927)
+++ trunk/tests/qunit/index.html 2017-01-20 16:14:23 UTC (rev 39928)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -66,6 +66,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <script src="wp-admin/js/customize-nav-menus.js"></script>
</span><span class="cx" style="display: block; padding: 0 10px"> <script src="wp-admin/js/customize-widgets.js"></script>
</span><span class="cx" style="display: block; padding: 0 10px"> <script src="wp-admin/js/word-count.js"></script>
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <script src="wp-admin/js/nav-menu.js"></script>
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> <!-- Customizer templates for sections -->
</span><span class="cx" style="display: block; padding: 0 10px"> <script type="text/html" id="tmpl-customize-section-default">
</span></span></pre></div>
<a id="trunktestsqunitwpadminjsnavmenujs"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/qunit/wp-admin/js/nav-menu.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/qunit/wp-admin/js/nav-menu.js (rev 0)
+++ trunk/tests/qunit/wp-admin/js/nav-menu.js 2017-01-20 16:14:23 UTC (rev 39928)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,80 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/*global wpNavMenu */
+( function( QUnit, $ ) {
+ QUnit.module( 'nav-menu' );
+ var assert,
+ eventsExpected = 3,
+ eventsFired = 0;
+
+ // Fail if we don't see the expected number of events triggered in 1500 ms.
+ setTimeout( function() {
+ assert.equal(
+ eventsFired,
+ eventsExpected,
+ eventsExpected + ' wpNavMenu events should fire.'
+ );
+ }, 1500 );
+
+ QUnit.test( 'Testing wpNavMenu event triggers.', function( assertPassed ) {
+ assert = assertPassed;
+
+ assert.expect( 3 );
+
+ var testString = '<div>Hello World</div>';
+
+ // Mock the internal function calls so the don't fail.
+ $.fn.hideAdvancedMenuItemFields = function() {
+ return {
+ 'appendTo': function() { return true; },
+ 'prependTo': function() { return true; }
+ };
+ };
+
+ $.fn.extend( {
+ 'childMenuItems': function() { return $(); },
+ 'shiftDepthClass': function() { return $(); }
+ } );
+
+ // Set up the events we should test.
+ var eventsToTest = [
+ {
+ 'event': 'addMenuItemToBottom',
+ 'data': testString,
+ 'expect': $( testString ),
+ 'shouldTrigger': 'menu-item-added'
+ },
+ {
+ 'event': 'addMenuItemToTop',
+ 'data': testString,
+ 'expect': $( testString ),
+ 'shouldTrigger': 'menu-item-added'
+ },
+ {
+ 'event': 'removeMenuItem',
+ 'data': $( testString ),
+ 'expect': $( testString ),
+ 'shouldTrigger': 'menu-removing-item'
+ }
+ ];
+
+ // Test each of the events.
+ _.each( eventsToTest, function( theEvent ) {
+
+ var done = assert.async();
+
+ $( document ).on( theEvent.shouldTrigger, function( evt, passed ) {
+ assert.equal(
+ passed.html(),
+ theEvent.expect.html(),
+ 'The ' + theEvent.event + ' should trigger ' + theEvent.shouldTrigger + '.'
+ );
+ eventsFired++;
+ done();
+ } );
+ wpNavMenu[ theEvent.event ]( theEvent.data );
+ $( document ).off( theEvent.shouldTrigger );
+ } );
+
+ } );
+
+
+} )( window.QUnit, jQuery );
</ins></span></pre>
</div>
</div>
</body>
</html>