<!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>[43352] trunk/src/js/_enqueues/admin/link.js: Docs: Improve JSDoc for `admin/link.js`.</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 { white-space: pre-line; 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/43352">43352</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/43352","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>atimmer</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-06-16 10:11:57 +0000 (Sat, 16 Jun 2018)</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'>Docs: Improve JSDoc for `admin/link.js`.
Props andg.
Fixes <a href="https://core.trac.wordpress.org/ticket/44362">#44362</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcjs_enqueuesadminlinkjs">trunk/src/js/_enqueues/admin/link.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcjs_enqueuesadminlinkjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/_enqueues/admin/link.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/_enqueues/admin/link.js 2018-06-16 10:08:10 UTC (rev 43351)
+++ trunk/src/js/_enqueues/admin/link.js 2018-06-16 10:11:57 UTC (rev 43352)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -12,7 +12,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // postboxes
</span><span class="cx" style="display: block; padding: 0 10px"> postboxes.add_postbox_toggles('link');
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // category tabs
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Adds event that opens a particular category tab.
+ *
+ * @ignore
+ *
+ * @return {boolean} Always returns false to prevent the default behavior.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $('#category-tabs a').click(function(){
</span><span class="cx" style="display: block; padding: 0 10px"> var t = $(this).attr('href');
</span><span class="cx" style="display: block; padding: 0 10px"> $(this).parent().addClass('tabs').siblings('li').removeClass('tabs');
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -29,7 +35,24 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Ajax Cat
</span><span class="cx" style="display: block; padding: 0 10px"> newCat = $('#newcat').one( 'focus', function() { $(this).val( '' ).removeClass( 'form-input-tip' ); } );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * After adding a new category, focus on the category add input field.
+ *
+ * @return {void}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $('#link-category-add-submit').click( function() { newCat.focus(); } );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Synchronize category checkboxes.
+ *
+ * This function makes sure that the checkboxes are synced between the all
+ * categories tab and the most used categories tab.
+ *
+ * @since 2.5.0
+ *
+ * @return {void}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> syncChecks = function() {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( noSyncChecks )
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,6 +62,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> noSyncChecks = false;
</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">+ /**
+ * Adds event listeners to an added category.
+ *
+ * This is run on the addAfter event to make sure the correct event listeners
+ * are bound to the DOM elements.
+ *
+ * @since 2.5.0
+ *
+ * @param {string} r Raw XML response returned from the server after adding a
+ * category.
+ * @param {Object} s List manager configuration object; settings for the Ajax
+ * request.
+ *
+ * @return {void}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> catAddAfter = function( r, s ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $(s.what + ' response_data', r).each( function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var t = $($(this).text());
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -50,18 +88,43 @@
</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">+ /*
+ * Instantiates the list manager.
+ *
+ * @see js/_enqueues/lib/lists.js
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $('#categorychecklist').wpList( {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // CSS class name for alternate styling.
</ins><span class="cx" style="display: block; padding: 0 10px"> alt: '',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // The type of list.
</ins><span class="cx" style="display: block; padding: 0 10px"> what: 'link-category',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // ID of the element the parsed Ajax response will be stored in.
</ins><span class="cx" style="display: block; padding: 0 10px"> response: 'category-ajax-response',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Callback that's run after an item got added to the list.
</ins><span class="cx" style="display: block; padding: 0 10px"> addAfter: catAddAfter
</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">+ // All categories is the default tab, so we delete the user setting.
</ins><span class="cx" style="display: block; padding: 0 10px"> $('a[href="#categories-all"]').click(function(){deleteUserSetting('cats');});
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Set a preference for the popular categories to cookies.
</ins><span class="cx" style="display: block; padding: 0 10px"> $('a[href="#categories-pop"]').click(function(){setUserSetting('cats','pop');});
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'pop' == getUserSetting('cats') )
</span><span class="cx" style="display: block; padding: 0 10px"> $('a[href="#categories-pop"]').click();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Adds event handler that shows the interface controls to add a new category.
+ *
+ * @ignore
+ *
+ * @param {Event} event The event object.
+ * @returns {boolean} Always returns false to prevent regular link
+ * functionality.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $('#category-add-toggle').click( function() {
</span><span class="cx" style="display: block; padding: 0 10px"> $(this).parents('div:first').toggleClass( 'wp-hidden-children' );
</span><span class="cx" style="display: block; padding: 0 10px"> $('#category-tabs a[href="#categories-all"]').click();
</span></span></pre>
</div>
</div>
</body>
</html>