<!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>[41799] trunk/src/wp-admin/js/customize-controls.js: Customize: Add jsdoc for `api.panel`, `api.section`, `api.control`, and `api.notifications` collections.</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/41799">41799</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/41799","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-09 18:55:44 +0000 (Mon, 09 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: Add jsdoc for `api.panel`, `api.section`, `api.control`, and `api.notifications` collections.
Props shramee, westonruter.
Fixes <a href="https://core.trac.wordpress.org/ticket/39930">#39930</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminjscustomizecontrolsjs">trunk/src/wp-admin/js/customize-controls.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-09 16:34:50 UTC (rev 41798)
+++ trunk/src/wp-admin/js/customize-controls.js 2017-10-09 18:55:44 UTC (rev 41799)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -5584,12 +5584,167 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Change objects contained within the main customize object to Settings.
</span><span class="cx" style="display: block; padding: 0 10px"> api.defaultConstructor = api.Setting;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Create the collections for Controls, Sections and Panels.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Callback for resolved controls.
+ *
+ * @callback deferredControlsCallback
+ * @param {wp.customize.Control[]} Resolved controls.
+ */
+
+ /**
+ * Collection of all registered controls.
+ *
+ * @since 3.4.0
+ *
+ * @type {Function}
+ * @param {...string} ids - One or more ids for controls to obtain.
+ * @param {deferredControlsCallback} [callback] - Function called when all supplied controls exist.
+ * @returns {wp.customize.Control|undefined|jQuery.promise} Control instance or undefined (if function called with one id param), or promise resolving to requested controls.
+ *
+ * @example <caption>Loop over all registered controls.</caption>
+ * wp.customize.control.each( function( control ) { ... } );
+ *
+ * @example <caption>Getting `background_color` control instance.</caption>
+ * control = wp.customize.control( 'background_color' );
+ *
+ * @example <caption>Check if control exists.</caption>
+ * hasControl = wp.customize.control.has( 'background_color' );
+ *
+ * @example <caption>Deferred getting of `background_color` control until it exists, using callback.</caption>
+ * wp.customize.control( 'background_color', function( control ) { ... } );
+ *
+ * @example <caption>Get title and tagline controls when they both exist, using promise (only available when multiple IDs are present).</caption>
+ * promise = wp.customize.control( 'blogname', 'blogdescription' );
+ * promise.done( function( titleControl, taglineControl ) { ... } );
+ *
+ * @example <caption>Get title and tagline controls when they both exist, using callback.</caption>
+ * wp.customize.control( 'blogname', 'blogdescription', function( titleControl, taglineControl ) { ... } );
+ *
+ * @example <caption>Getting setting value for `background_color` control.</caption>
+ * value = wp.customize.control( 'background_color ').setting.get();
+ * value = wp.customize( 'background_color' ).get(); // Same as above, since setting ID and control ID are the same.
+ *
+ * @example <caption>Add new control for site title.</caption>
+ * wp.customize.control.add( new wp.customize.Control( 'other_blogname', {
+ * setting: 'blogname',
+ * type: 'text',
+ * label: 'Site title',
+ * section: 'other_site_identify'
+ * } ) );
+ *
+ * @example <caption>Remove control.</caption>
+ * wp.customize.control.remove( 'other_blogname' );
+ *
+ * @example <caption>Listen for control being added.</caption>
+ * wp.customize.control.bind( 'add', function( addedControl ) { ... } )
+ *
+ * @example <caption>Listen for control being removed.</caption>
+ * wp.customize.control.bind( 'removed', function( removedControl ) { ... } )
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> api.control = new api.Values({ defaultConstructor: api.Control });
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Callback for resolved sections.
+ *
+ * @callback deferredSectionsCallback
+ * @param {wp.customize.Section[]} Resolved sections.
+ */
+
+ /**
+ * Collection of all registered sections.
+ *
+ * @since 3.4.0
+ *
+ * @type {Function}
+ * @param {...string} ids - One or more ids for sections to obtain.
+ * @param {deferredSectionsCallback} [callback] - Function called when all supplied sections exist.
+ * @returns {wp.customize.Section|undefined|jQuery.promise} Section instance or undefined (if function called with one id param), or promise resolving to requested sections.
+ *
+ * @example <caption>Loop over all registered sections.</caption>
+ * wp.customize.section.each( function( section ) { ... } )
+ *
+ * @example <caption>Getting `title_tagline` section instance.</caption>
+ * section = wp.customize.section( 'title_tagline' )
+ *
+ * @example <caption>Expand dynamically-created section when it exists.</caption>
+ * wp.customize.section( 'dynamically_created', function( section ) {
+ * section.expand();
+ * } );
+ *
+ * @see {@link wp.customize.control} for further examples of how to interact with {@link wp.customize.Values} instances.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> api.section = new api.Values({ defaultConstructor: api.Section });
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Callback for resolved panels.
+ *
+ * @callback deferredPanelsCallback
+ * @param {wp.customize.Panel[]} Resolved panels.
+ */
+
+ /**
+ * Collection of all registered panels.
+ *
+ * @since 4.0.0
+ *
+ * @type {Function}
+ * @param {...string} ids - One or more ids for panels to obtain.
+ * @param {deferredPanelsCallback} [callback] - Function called when all supplied panels exist.
+ * @returns {wp.customize.Panel|undefined|jQuery.promise} Panel instance or undefined (if function called with one id param), or promise resolving to requested panels.
+ *
+ * @example <caption>Loop over all registered panels.</caption>
+ * wp.customize.panel.each( function( panel ) { ... } )
+ *
+ * @example <caption>Getting nav_menus panel instance.</caption>
+ * panel = wp.customize.panel( 'nav_menus' );
+ *
+ * @example <caption>Expand dynamically-created panel when it exists.</caption>
+ * wp.customize.panel( 'dynamically_created', function( panel ) {
+ * panel.expand();
+ * } );
+ *
+ * @see {@link wp.customize.control} for further examples of how to interact with {@link wp.customize.Values} instances.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> api.panel = new api.Values({ defaultConstructor: api.Panel });
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Create the collection for global Notifications.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Callback for resolved notifications.
+ *
+ * @callback deferredNotificationsCallback
+ * @param {wp.customize.Notification[]} Resolved notifications.
+ */
+
+ /**
+ * Collection of all global notifications.
+ *
+ * @since 4.9.0
+ *
+ * @type {Function}
+ * @param {...string} codes - One or more codes for notifications to obtain.
+ * @param {deferredNotificationsCallback} [callback] - Function called when all supplied notifications exist.
+ * @returns {wp.customize.Notification|undefined|jQuery.promise} notification instance or undefined (if function called with one code param), or promise resolving to requested notifications.
+ *
+ * @example <caption>Check if existing notification</caption>
+ * exists = wp.customize.notifications.has( 'a_new_day_arrived' );
+ *
+ * @example <caption>Obtain existing notification</caption>
+ * notification = wp.customize.notifications( 'a_new_day_arrived' );
+ *
+ * @example <caption>Obtain notification that may not exist yet.</caption>
+ * wp.customize.notifications( 'a_new_day_arrived', function( notification ) { ... } );
+ *
+ * @example <caption>Add a warning notification.</caption>
+ * wp.customize.notifications.add( new wp.customize.Notification( 'midnight_almost_here', {
+ * type: 'warning',
+ * message: 'Midnight has almost arrived!',
+ * dismissible: true
+ * } ) );
+ *
+ * @example <caption>Remove a notification.</caption>
+ * wp.customize.notifications.remove( 'a_new_day_arrived' );
+ *
+ * @see {@link wp.customize.control} for further examples of how to interact with {@link wp.customize.Values} instances.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> api.notifications = new api.Notifications();
</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>