<!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>[43346] trunk/src/js/_enqueues/lib/pointer.js: Docs: Improve JSDoc for `pointer.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/43346">43346</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/43346","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-14 15:13:19 +0000 (Thu, 14 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 `pointer.js`.
Props maartenleenders, dfangstrom.
Fixes <a href="https://core.trac.wordpress.org/ticket/44325">#44325</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcjs_enqueueslibpointerjs">trunk/src/js/_enqueues/lib/pointer.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcjs_enqueueslibpointerjs"></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/lib/pointer.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/_enqueues/lib/pointer.js 2018-06-14 14:46:49 UTC (rev 43345)
+++ trunk/src/js/_enqueues/lib/pointer.js 2018-06-14 15:13:19 UTC (rev 43346)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,14 +1,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /* global wpPointerL10n */
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Pointer jQuery widget.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Initializes the wp-pointer widget using jQuery UI Widget Factory.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> (function($){
</span><span class="cx" style="display: block; padding: 0 10px"> var identifier = 0,
</span><span class="cx" style="display: block; padding: 0 10px"> zindex = 9999;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /**
- * @class $.widget.wp.pointer
- */
</del><span class="cx" style="display: block; padding: 0 10px"> $.widget('wp.pointer',/** @lends $.widget.wp.pointer.prototype */{
</span><span class="cx" style="display: block; padding: 0 10px"> options: {
</span><span class="cx" style="display: block; padding: 0 10px"> pointerClass: 'wp-pointer',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -37,6 +35,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> document: document
</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">+ /**
+ * A class that represents a WordPress pointer.
+ *
+ * @since 3.3.0
+ * @private
+ *
+ * @constructs $.widget.wp.pointer
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> _create: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var positioning,
</span><span class="cx" style="display: block; padding: 0 10px"> family;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -59,6 +65,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> .appendTo( this.options.document.body );
</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">+ /**
+ * Sets an option on the pointer instance.
+ *
+ * There are 4 special values that do something extra:
+ *
+ * - `document` will transfer the pointer to the body of the new document
+ * specified by the value.
+ * - `pointerClass` will change the class of the pointer element.
+ * - `position` will reposition the pointer.
+ * - `content` will update the content of the pointer.
+ *
+ * @since 3.3.0
+ * @private
+ *
+ * @param {string} key The key of the option to set.
+ * @param {*} value The value to set the option to.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> _setOption: function( key, value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var o = this.options,
</span><span class="cx" style="display: block; padding: 0 10px"> tip = this.pointer;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,15 +108,45 @@
</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">+ /**
+ * Removes the pointer element from of the DOM.
+ *
+ * Makes sure that the widget and all associated bindings are destroyed.
+ *
+ * @since 3.3.0
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> destroy: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> this.pointer.remove();
</span><span class="cx" style="display: block; padding: 0 10px"> $.Widget.prototype.destroy.call( this );
</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">+ /**
+ * Returns the pointer element.
+ *
+ * @since 3.3.0
+ *
+ * @return {Object} Pointer The pointer object.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> widget: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> return this.pointer;
</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">+ /**
+ * Updates the content of the pointer.
+ *
+ * This function doesn't update the content of the pointer itself. That is done
+ * by the `_update` method. This method will make sure that the `_update` method
+ * is called with the right content.
+ *
+ * The content in the options can either be a string or a callback. If it is a
+ * callback the result of this callback is used as the content.
+ *
+ * @since 3.3.0
+ *
+ * @param {Object} event The event that caused the update.
+ *
+ * @return {Promise} Resolves when the update has been executed.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> update: function( event ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var self = this,
</span><span class="cx" style="display: block; padding: 0 10px"> o = this.options,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -124,8 +177,15 @@
</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">- * Update is separated into two functions to allow events to defer
- * updating the pointer (e.g. fetch content with ajax, etc).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Updates the content of the pointer.
+ *
+ * Will make sure that the pointer is correctly positioned.
+ *
+ * @since 3.3.0
+ * @private
+ *
+ * @param {Object} event The event that caused the update.
+ * @param {*} content The content object. Either a string or a jQuery tree.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> _update: function( event, content ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var buttons,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -134,7 +194,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! content )
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- this.pointer.stop(); // Kill any animations on the pointer.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Kill any animations on the pointer.
+ this.pointer.stop();
</ins><span class="cx" style="display: block; padding: 0 10px"> this.content.html( content );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> buttons = o.buttons.call( this.element[0], event, this._handoff() );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -145,6 +206,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> this.reposition();
</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">+ /**
+ * Repositions the pointer.
+ *
+ * Makes sure the pointer is the correct size for its content and makes sure it
+ * is positioned to point to the right element.
+ *
+ * @since 3.3.0
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> reposition: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var position;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -166,6 +235,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> this.repoint();
</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">+ /**
+ * Sets the arrow of the pointer to the correct side of the pointer element.
+ *
+ * @since 3.3.0
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> repoint: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var o = this.options,
</span><span class="cx" style="display: block; padding: 0 10px"> edge;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -182,6 +256,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> this.pointer.addClass( 'wp-pointer-' + edge );
</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">+ /**
+ * Calculates the correct position based on a position in the settings.
+ *
+ * @since 3.3.0
+ * @private
+ *
+ * @param {string|Object} position Either a side of a pointer or an object
+ * containing a pointer.
+ *
+ * @return {Object} result An object containing position related data.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> _processPosition: function( position ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var opposite = {
</span><span class="cx" style="display: block; padding: 0 10px"> top: 'bottom',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -218,6 +303,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return result;
</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">+ /**
+ * Opens the pointer.
+ *
+ * Only opens the pointer widget in case it is closed and not disabled, and
+ * calls 'update' before doing so. Calling update makes sure that the pointer
+ * is correctly sized and positioned.
+ *
+ * @since 3.3.0
+ *
+ * @param {Object} event The event that triggered the opening of this pointer.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> open: function( event ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var self = this,
</span><span class="cx" style="display: block; padding: 0 10px"> o = this.options;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -230,6 +326,14 @@
</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">+ /**
+ * Opens and shows the pointer element.
+ *
+ * @since 3.3.0
+ * @private
+ *
+ * @param {Object} event An event object.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> _open: function( event ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var self = this,
</span><span class="cx" style="display: block; padding: 0 10px"> o = this.options;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -248,6 +352,13 @@
</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">+ /**
+ * Closes and hides the pointer element.
+ *
+ * @since 3.3.0
+ *
+ * @param {Object} event An event object.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> close: function( event ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !this.active || this.options.disabled )
</span><span class="cx" style="display: block; padding: 0 10px"> return;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -263,11 +374,23 @@
</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">+ /**
+ * Puts the pointer on top by increasing the z-index.
+ *
+ * @since 3.3.0
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> sendToTop: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( this.active )
</span><span class="cx" style="display: block; padding: 0 10px"> this.pointer.css( 'z-index', zindex++ );
</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">+ /**
+ * Toggles the element between shown and hidden.
+ *
+ * @since 3.3.0
+ *
+ * @param {Object} event An event object.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> toggle: function( event ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( this.pointer.is(':hidden') )
</span><span class="cx" style="display: block; padding: 0 10px"> this.open( event );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -275,6 +398,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> this.close( event );
</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">+ /**
+ * Extends the pointer and the widget element with the supplied parameter, which
+ * is either an element or a function.
+ *
+ * @since 3.3.0
+ * @private
+ *
+ * @param {Object} extend The object to be merged into the original object.
+ *
+ * @return {Object} The extended object.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> _handoff: function( extend ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $.extend({
</span><span class="cx" style="display: block; padding: 0 10px"> pointer: this.pointer,
</span></span></pre>
</div>
</div>
</body>
</html>