<!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>[27892] trunk/src: Widget Customizer: Use postMessage to highlight widgets in preview or sections/controls in Customizer.</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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/27892">27892</a></dd>
<dt>Author</dt> <dd>ocean90</dd>
<dt>Date</dt> <dd>2014-04-01 15:25:56 +0000 (Tue, 01 Apr 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Widget Customizer: Use postMessage to highlight widgets in preview or sections/controls in Customizer.
fixes <a href="http://core.trac.wordpress.org/ticket/27622">#27622</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminjscustomizewidgetsjs">trunk/src/wp-admin/js/customize-widgets.js</a></li>
<li><a href="#trunksrcwpincludesjscustomizepreviewwidgetsjs">trunk/src/wp-includes/js/customize-preview-widgets.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminjscustomizewidgetsjs"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/js/customize-widgets.js (27891 => 27892)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/js/customize-widgets.js 2014-04-01 12:37:43 UTC (rev 27891)
+++ trunk/src/wp-admin/js/customize-widgets.js 2014-04-01 15:25:56 UTC (rev 27892)
</span><span class="lines">@@ -140,6 +140,12 @@
</span><span class="cx"> */
</span><span class="cx"> self.init = function () {
</span><span class="cx"> this.availableWidgetsPanel.setup();
</span><ins>+
+ // Highlight widget control
+ this.previewer.bind( 'highlight-widget-control', self.highlightWidgetFormControl );
+
+ // Open and focus widget control
+ this.previewer.bind( 'focus-widget-control', self.focusWidgetFormControl );
</ins><span class="cx"> };
</span><span class="cx"> wp.customize.bind( 'ready', function () {
</span><span class="cx"> self.init();
</span><span class="lines">@@ -924,13 +930,14 @@
</span><span class="cx">
</span><span class="cx"> // Highlight whenever hovering or clicking over the form
</span><span class="cx"> control.container.on( 'mouseenter click', function () {
</span><del>- control.highlightPreviewWidget();
</del><ins>+ control.setting.previewer.send( 'highlight-widget', control.params.widget_id );
+ //control.highlightPreviewWidget();
</ins><span class="cx"> } );
</span><span class="cx">
</span><span class="cx"> // Highlight when the setting is updated
</span><span class="cx"> control.setting.bind( function () {
</span><del>- control.scrollPreviewWidgetIntoView();
- control.highlightPreviewWidget();
</del><ins>+ control.setting.previewer.send( 'highlight-widget', control.params.widget_id );
+ //control.highlightPreviewWidget();
</ins><span class="cx"> } );
</span><span class="cx">
</span><span class="cx"> // Highlight when the widget form is expanded
</span><span class="lines">@@ -1482,16 +1489,6 @@
</span><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Inverse of WidgetCustomizer.getControlInstanceForWidget
- * @return {jQuery}
- */
- getPreviewWidgetElement: function () {
- var control = this,
- widget_customizer_preview = self.getPreviewWindow().wp.customize.WidgetCustomizerPreview;
- return widget_customizer_preview.getWidgetElement( control.params.widget_id );
- },
-
- /**
</del><span class="cx"> * Inside of the customizer preview, scroll the widget into view
</span><span class="cx"> */
</span><span class="cx"> scrollPreviewWidgetIntoView: function () {
</span><span class="lines">@@ -1515,21 +1512,6 @@
</span><span class="cx"> setTimeout( function () {
</span><span class="cx"> target_element.removeClass( 'widget-customizer-highlighted' );
</span><span class="cx"> }, 500 );
</span><del>- },
-
- /**
- * Add the widget-customizer-highlighted-widget class to the widget for 500ms
- */
- highlightPreviewWidget: function () {
- var control = this, widget_el, root_el;
-
- widget_el = control.getPreviewWidgetElement();
- root_el = widget_el.closest( 'html' );
- root_el.find( '.widget-customizer-highlighted-widget' ).removeClass( 'widget-customizer-highlighted-widget' );
- widget_el.addClass( 'widget-customizer-highlighted-widget' );
- setTimeout( function () {
- widget_el.removeClass( 'widget-customizer-highlighted-widget' );
- }, 500 );
</del><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> } );
</span><span class="lines">@@ -1547,6 +1529,32 @@
</span><span class="cx"> } );
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Highlight a widget control.
+ *
+ * @param {string} widgetId
+ */
+ self.highlightWidgetFormControl = function( widgetId ) {
+ var control = self.getWidgetFormControlForWidget( widgetId );
+
+ if ( control ) {
+ control.highlightSectionAndControl();
+ }
+ },
+
+ /**
+ * Focus a widget control.
+ *
+ * @param {string} widgetId
+ */
+ self.focusWidgetFormControl = function( widgetId ) {
+ var control = self.getWidgetFormControlForWidget( widgetId );
+
+ if ( control ) {
+ control.focus();
+ }
+ },
+
+ /**
</ins><span class="cx"> * Given a widget control, find the sidebar widgets control that contains it.
</span><span class="cx"> * @param {string} widget_id
</span><span class="cx"> * @return {object|null}
</span></span></pre></div>
<a id="trunksrcwpincludesjscustomizepreviewwidgetsjs"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-includes/js/customize-preview-widgets.js (27891 => 27892)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-includes/js/customize-preview-widgets.js 2014-04-01 12:37:43 UTC (rev 27891)
+++ trunk/src/wp-includes/js/customize-preview-widgets.js 2014-04-01 15:25:56 UTC (rev 27892)
</span><span class="lines">@@ -27,6 +27,8 @@
</span><span class="cx"> self.preview.send( 'rendered-sidebars', self.renderedSidebars ); // @todo Only send array of IDs
</span><span class="cx"> self.preview.send( 'rendered-widgets', self.renderedWidgets ); // @todo Only send array of IDs
</span><span class="cx"> } );
</span><ins>+
+ this.preview.bind( 'highlight-widget', self.highlightWidget );
</ins><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -58,31 +60,34 @@
</span><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Obtain a rendered widget element. Assumes standard practice of using
- * the widget ID as the ID for the DOM element. To eliminate this
- * assumption, additional data-* attributes would need to be injected
- * onto the rendered widget root element.
</del><ins>+ * Highlight the widget on widget updates or widget control mouse overs.
</ins><span class="cx"> *
</span><del>- * @param {String} widget_id
- * @return {jQuery}
</del><ins>+ * @param {string} widgetId ID of the widget.
</ins><span class="cx"> */
</span><del>- getWidgetElement: function ( widget_id ) {
- return $( '#' + widget_id );
</del><ins>+ highlightWidget: function( widgetId ) {
+ var $body = $( document.body ),
+ $widget = $( '#' + widgetId );
+
+ $body.find( '.widget-customizer-highlighted-widget' ).removeClass( 'widget-customizer-highlighted-widget' );
+
+ $widget.addClass( 'widget-customizer-highlighted-widget' );
+ setTimeout( function () {
+ $widget.removeClass( 'widget-customizer-highlighted-widget' );
+ }, 500 );
</ins><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- *
</del><ins>+ * Show a title and highlight widgets on hover. On shift+clicking
+ * focus the widget control.
</ins><span class="cx"> */
</span><span class="cx"> highlightControls: function() {
</span><del>- var selector = this.widgetSelectors.join(',');
</del><ins>+ var self = this,
+ selector = this.widgetSelectors.join(',');
</ins><span class="cx">
</span><span class="cx"> $(selector).attr( 'title', this.l10n.widgetTooltip );
</span><span class="cx">
</span><span class="cx"> $(document).on( 'mouseenter', selector, function () {
</span><del>- var control = parent.WidgetCustomizer.getWidgetFormControlForWidget( $(this).prop('id') );
- if ( control ) {
- control.highlightSectionAndControl();
- }
</del><ins>+ self.preview.send( 'highlight-widget-control', $( this ).prop( 'id' ) );
</ins><span class="cx"> });
</span><span class="cx">
</span><span class="cx"> // Open expand the widget control when shift+clicking the widget element
</span><span class="lines">@@ -91,10 +96,8 @@
</span><span class="cx"> return;
</span><span class="cx"> }
</span><span class="cx"> e.preventDefault();
</span><del>- var control = parent.WidgetCustomizer.getWidgetFormControlForWidget( $(this).prop('id') );
- if ( control ) {
- control.focus();
- }
</del><ins>+
+ self.preview.send( 'focus-widget-control', $( this ).prop( 'id' ) );
</ins><span class="cx"> });
</span><span class="cx"> }
</span><span class="cx"> };
</span></span></pre>
</div>
</div>
</body>
</html>