<!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>[38811] trunk/src/wp-includes/js/customize-preview.js: Customize: Split out link `click.preview` and form `submit.preview` event handlers from anonymous functions into named methods on `wp.customize.Preview` for extensibility.</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/38811">38811</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/38811","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>2016-10-19 02:06:00 +0000 (Wed, 19 Oct 2016)</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: Split out link `click.preview` and form `submit.preview` event handlers from anonymous functions into named methods on `wp.customize.Preview` for extensibility.
See <a href="https://core.trac.wordpress.org/ticket/30937">#30937</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesjscustomizepreviewjs">trunk/src/wp-includes/js/customize-preview.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesjscustomizepreviewjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/js/customize-preview.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/js/customize-preview.js 2016-10-18 20:04:36 UTC (rev 38810)
+++ trunk/src/wp-includes/js/customize-preview.js 2016-10-19 02:06:00 UTC (rev 38811)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -105,100 +105,125 @@
</span><span class="cx" style="display: block; padding: 0 10px"> preview.add( 'scheme', urlParser.protocol.replace( /:$/, '' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> preview.body = $( document.body );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> preview.body.on( 'click.preview', 'a', function( event ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var link, isInternalJumpLink;
- link = $( this );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ preview.handleLinkClick( event );
+ } );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // No-op if the anchor is not a link.
- if ( _.isUndefined( link.attr( 'href' ) ) ) {
- return;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ preview.body.on( 'submit.preview', 'form', function( event ) {
+ preview.handleFormSubmit( event );
+ } );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- isInternalJumpLink = ( '#' === link.attr( 'href' ).substr( 0, 1 ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ preview.window = $( window );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Allow internal jump links to behave normally without preventing default.
- if ( isInternalJumpLink ) {
- return;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( api.settings.channel ) {
+ preview.window.on( 'scroll.preview', debounce( function() {
+ preview.send( 'scroll', preview.window.scrollTop() );
+ }, 200 ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If the link is not previewable, prevent the browser from navigating to it.
- if ( ! api.isLinkPreviewable( link[0] ) ) {
- wp.a11y.speak( api.settings.l10n.linkUnpreviewable );
- event.preventDefault();
- return;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ preview.bind( 'scroll', function( distance ) {
+ preview.window.scrollTop( distance );
+ });
+ }
+ },
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If not in an iframe, then allow the link click to proceed normally since the state query params are added.
- if ( ! api.settings.channel ) {
- return;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Handle link clicks in preview.
+ *
+ * @since 4.7.0
+ *
+ * @param {jQuery.Event} event Event.
+ */
+ handleLinkClick: function( event ) {
+ var preview = this, link, isInternalJumpLink;
+ link = $( event.target );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Prevent initiating navigating from click and instead rely on sending url message to pane.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // No-op if the anchor is not a link.
+ if ( _.isUndefined( link.attr( 'href' ) ) ) {
+ return;
+ }
+
+ isInternalJumpLink = ( '#' === link.attr( 'href' ).substr( 0, 1 ) );
+
+ // Allow internal jump links to behave normally without preventing default.
+ if ( isInternalJumpLink ) {
+ return;
+ }
+
+ // If the link is not previewable, prevent the browser from navigating to it.
+ if ( ! api.isLinkPreviewable( link[0] ) ) {
+ wp.a11y.speak( api.settings.l10n.linkUnpreviewable );
</ins><span class="cx" style="display: block; padding: 0 10px"> event.preventDefault();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * Note the shift key is checked so shift+click on widgets or
- * nav menu items can just result on focusing on the corresponding
- * control instead of also navigating to the URL linked to.
- */
- if ( event.shiftKey ) {
- return;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If not in an iframe, then allow the link click to proceed normally since the state query params are added.
+ if ( ! api.settings.channel ) {
+ return;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Note: It's not relevant to send scroll because sending url message will have the same effect.
- preview.send( 'url', link.prop( 'href' ) );
- } );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Prevent initiating navigating from click and instead rely on sending url message to pane.
+ event.preventDefault();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- preview.body.on( 'submit.preview', 'form', function( event ) {
- var urlParser = document.createElement( 'a' );
- urlParser.href = this.action;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Note the shift key is checked so shift+click on widgets or
+ * nav menu items can just result on focusing on the corresponding
+ * control instead of also navigating to the URL linked to.
+ */
+ if ( event.shiftKey ) {
+ return;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If the link is not previewable, prevent the browser from navigating to it.
- if ( 'GET' !== this.method.toUpperCase() || ! api.isLinkPreviewable( urlParser ) ) {
- wp.a11y.speak( api.settings.l10n.formUnpreviewable );
- event.preventDefault();
- return;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Note: It's not relevant to send scroll because sending url message will have the same effect.
+ preview.send( 'url', link.prop( 'href' ) );
+ },
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If not in an iframe, then allow the form submission to proceed normally with the state inputs injected.
- if ( ! api.settings.channel ) {
- return;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Handle form submit.
+ *
+ * @since 4.7.0
+ *
+ * @param {jQuery.Event} event Event.
+ */
+ handleFormSubmit: function( event ) {
+ var preview = this, urlParser, form;
+ urlParser = document.createElement( 'a' );
+ form = $( event.target );
+ urlParser.href = form.prop( 'action' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * If the default wasn't prevented already (in which case the form
- * submission is already being handled by JS), and if it has a GET
- * request method, then take the serialized form data and add it as
- * a query string to the action URL and send this in a url message
- * to the customizer pane so that it will be loaded. If the form's
- * action points to a non-previewable URL, the customizer pane's
- * previewUrl setter will reject it so that the form submission is
- * a no-op, which is the same behavior as when clicking a link to an
- * external site in the preview.
- */
- if ( ! event.isDefaultPrevented() ) {
- if ( urlParser.search.length > 1 ) {
- urlParser.search += '&';
- }
- urlParser.search += $( this ).serialize();
- api.preview.send( 'url', urlParser.href );
- }
-
- // Prevent default since navigation should be done via sending url message or via JS submit handler.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If the link is not previewable, prevent the browser from navigating to it.
+ if ( 'GET' !== form.prop( 'method' ).toUpperCase() || ! api.isLinkPreviewable( urlParser ) ) {
+ wp.a11y.speak( api.settings.l10n.formUnpreviewable );
</ins><span class="cx" style="display: block; padding: 0 10px"> event.preventDefault();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- });
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- preview.window = $( window );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // If not in an iframe, then allow the form submission to proceed normally with the state inputs injected.
+ if ( ! api.settings.channel ) {
+ return;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( api.settings.channel ) {
- preview.window.on( 'scroll.preview', debounce( function() {
- preview.send( 'scroll', preview.window.scrollTop() );
- }, 200 ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * If the default wasn't prevented already (in which case the form
+ * submission is already being handled by JS), and if it has a GET
+ * request method, then take the serialized form data and add it as
+ * a query string to the action URL and send this in a url message
+ * to the customizer pane so that it will be loaded. If the form's
+ * action points to a non-previewable URL, the customizer pane's
+ * previewUrl setter will reject it so that the form submission is
+ * a no-op, which is the same behavior as when clicking a link to an
+ * external site in the preview.
+ */
+ if ( ! event.isDefaultPrevented() ) {
+ if ( urlParser.search.length > 1 ) {
+ urlParser.search += '&';
+ }
+ urlParser.search += form.serialize();
+ preview.send( 'url', urlParser.href );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- preview.bind( 'scroll', function( distance ) {
- preview.window.scrollTop( distance );
- });
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Prevent default since navigation should be done via sending url message or via JS submit handler.
+ event.preventDefault();
</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>