<!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>[20128] trunk/wp-includes: Theme Customizer: Add a Control object to better encapsulate different UI elements and make it easy to switch between hard refreshes and postMessage.</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, #logmsg > ol { margin-left: 0; 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/20128">20128</a></dd>
<dt>Author</dt> <dd>koopersmith</dd>
<dt>Date</dt> <dd>2012-03-06 22:48:07 +0000 (Tue, 06 Mar 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Theme Customizer: Add a Control object to better encapsulate different UI elements and make it easy to switch between hard refreshes and postMessage. see <a href="http://core.trac.wordpress.org/ticket/19910">#19910</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesclasswpcustomizesectionphp">trunk/wp-includes/class-wp-customize-section.php</a></li>
<li><a href="#trunkwpincludesclasswpcustomizesettingphp">trunk/wp-includes/class-wp-customize-setting.php</a></li>
<li><a href="#trunkwpincludescustomizecontrolsphp">trunk/wp-includes/customize-controls.php</a></li>
<li><a href="#trunkwpincludesjscustomizebasedevjs">trunk/wp-includes/js/customize-base.dev.js</a></li>
<li><a href="#trunkwpincludesjscustomizecontrolsdevjs">trunk/wp-includes/js/customize-controls.dev.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesclasswpcustomizesectionphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/class-wp-customize-section.php (20127 => 20128)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/class-wp-customize-section.php 2012-03-06 22:44:44 UTC (rev 20127)
+++ trunk/wp-includes/class-wp-customize-section.php 2012-03-06 22:48:07 UTC (rev 20128)
</span><span class="lines">@@ -72,7 +72,7 @@
</span><span class="cx"> <?php endif; ?>
</span><span class="cx">
</span><span class="cx"> <?php foreach ( $this->settings as $setting ) : ?>
</span><del>- <li>
</del><ins>+ <li id="customize-control-<?php echo esc_attr( $setting->id ); ?>" class="customize-control">
</ins><span class="cx"> <?php $setting->_render(); ?>
</span><span class="cx"> </li>
</span><span class="cx"> <?php endforeach; ?>
</span></span></pre></div>
<a id="trunkwpincludesclasswpcustomizesettingphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/class-wp-customize-setting.php (20127 => 20128)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/class-wp-customize-setting.php 2012-03-06 22:44:44 UTC (rev 20127)
+++ trunk/wp-includes/class-wp-customize-setting.php 2012-03-06 22:48:07 UTC (rev 20128)
</span><span class="lines">@@ -343,7 +343,7 @@
</span><span class="cx"> <label>
</span><span class="cx"> <span><?php echo esc_html( $this->label ); ?></span>
</span><span class="cx"> <div class="color-picker">
</span><del>- <input class="color-picker-value" type="hidden" value="<?php echo esc_attr( $this->value() ); ?>" <?php $this->name(); ?> />
</del><ins>+ <input type="hidden" value="<?php echo esc_attr( $this->value() ); ?>" <?php $this->name(); ?> />
</ins><span class="cx"> <a href="#"></a>
</span><span class="cx"> <div class="color-picker-controls">
</span><span class="cx"> <div class="farbtastic-placeholder"></div>
</span></span></pre></div>
<a id="trunkwpincludescustomizecontrolsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/customize-controls.php (20127 => 20128)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/customize-controls.php 2012-03-06 22:44:44 UTC (rev 20127)
+++ trunk/wp-includes/customize-controls.php 2012-03-06 22:48:07 UTC (rev 20128)
</span><span class="lines">@@ -49,7 +49,7 @@
</span><span class="cx"> <input type="hidden" name="customize" value="on" />
</span><span class="cx"> <input type="hidden" id="customize-template" name="template" value="<?php echo esc_attr( $theme['Template'] ); ?>" />
</span><span class="cx"> <input type="hidden" id="customize-stylesheet" name="stylesheet" value="<?php echo esc_attr( $theme['Stylesheet'] ); ?>" />
</span><del>-
</del><ins>+
</ins><span class="cx"> <div id="customize-header-actions" class="customize-section">&nbsp;</div>
</span><span class="cx">
</span><span class="cx"> <div id="customize-info" class="customize-section">
</span><span class="lines">@@ -94,13 +94,16 @@
</span><span class="cx"> // Check current scheme and load the preview with the same scheme
</span><span class="cx"> $scheme = is_ssl() ? 'https' : 'http';
</span><span class="cx"> $settings = array(
</span><del>- 'preview' => esc_url( home_url( '/', $scheme ) ),
- 'values' => array(),
- 'prefix' => WP_Customize_Setting::name_prefix,
</del><ins>+ 'preview' => esc_url( home_url( '/', $scheme ) ),
+ 'controls' => array(),
+ 'prefix' => WP_Customize_Setting::name_prefix,
</ins><span class="cx"> );
</span><span class="cx">
</span><span class="cx"> foreach ( $this->settings as $id => $setting ) {
</span><del>- $settings['values'][ $id ] = $setting->value();
</del><ins>+ $settings['controls'][ $id ] = array(
+ 'value' => $setting->value(),
+ 'control' => $setting->control,
+ );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> ?>
</span></span></pre></div>
<a id="trunkwpincludesjscustomizebasedevjs"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/js/customize-base.dev.js (20127 => 20128)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/js/customize-base.dev.js 2012-03-06 22:44:44 UTC (rev 20127)
+++ trunk/wp-includes/js/customize-base.dev.js 2012-03-06 22:48:07 UTC (rev 20128)
</span><span class="lines">@@ -152,7 +152,7 @@
</span><span class="cx">
</span><span class="cx"> api.Value = api.Class.extend({
</span><span class="cx"> initialize: function( initial, options ) {
</span><del>- this._value = initial;
</del><ins>+ this._value = initial; // @todo: potentially change this to a this.set() call.
</ins><span class="cx"> this.callbacks = $.Callbacks();
</span><span class="cx">
</span><span class="cx"> $.extend( this, options || {} );
</span></span></pre></div>
<a id="trunkwpincludesjscustomizecontrolsdevjs"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/js/customize-controls.dev.js (20127 => 20128)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/js/customize-controls.dev.js 2012-03-06 22:44:44 UTC (rev 20127)
+++ trunk/wp-includes/js/customize-controls.dev.js 2012-03-06 22:48:07 UTC (rev 20128)
</span><span class="lines">@@ -1,6 +1,78 @@
</span><span class="cx"> (function( exports, $ ){
</span><span class="cx"> var api = wp.customize;
</span><span class="cx">
</span><ins>+ /*
+ * @param options
+ * - previewer - The Previewer instance to sync with.
+ * - method - The method to use for syncing. Supports 'refresh' and 'postMessage'.
+ */
+ api.Control = api.Value.extend({
+ initialize: function( id, value, options ) {
+ var name = '[name="' + api.settings.prefix + id + '"]';
+
+ api.Value.prototype.initialize.call( this, value, options );
+
+ this.id = id;
+ this.container = $( '#customize-control-' + id );
+ this.element = this.element || new api.Element( this.container.find( name ) );
+
+ this.method = this.method || 'refresh';
+
+ this.element.link( this );
+ this.link( this.element );
+
+ this.bind( this.sync );
+ },
+ sync: function() {
+ switch ( this.method ) {
+ case 'refresh':
+ return this.previewer.refresh();
+ case 'postMessage':
+ return this.previewer.send( 'setting', [ this.id, this() ] );
+ }
+ }
+ });
+
+ api.ColorControl = api.Control.extend({
+ initialize: function( id, value, options ) {
+ var self = this,
+ picker, ui, text, toggle, update;
+
+ api.Control.prototype.initialize.call( this, id, value, options );
+
+ picker = this.container.find( '.color-picker' );
+ ui = picker.find( '.color-picker-controls' );
+ toggle = picker.find( 'a' );
+ update = function( color ) {
+ color = '#' + color;
+ toggle.css( 'background', color );
+ self.farbtastic.setColor( color );
+ };
+
+ this.input = new api.Element( ui.find( 'input' ) ); // Find text input.
+
+ this.link( this.input );
+ this.input.link( this );
+
+ picker.on( 'click', 'a', function() {
+ ui.toggle();
+ });
+
+ this.farbtastic = $.farbtastic( picker.find('.farbtastic-placeholder'), function( color ) {
+ self.set( color.replace( '#', '' ) );
+ });
+
+ this.bind( update );
+ update( this() );
+ },
+ validate: function( to ) {
+ return /^[a-fA-F0-9]{3}([a-fA-F0-9]{3})?$/.test( to ) ? to : null;
+ }
+ });
+
+ // Change objects contained within the main customize object to Settings.
+ api.defaultConstructor = api.Setting;
+
</ins><span class="cx"> api.Previewer = api.Messenger.extend({
</span><span class="cx"> refreshBuffer: 250,
</span><span class="cx">
</span><span class="lines">@@ -121,32 +193,26 @@
</span><span class="cx"> * Ready.
</span><span class="cx"> * ===================================================================== */
</span><span class="cx">
</span><ins>+ api.controls = {
+ color: api.ColorControl
+ };
+
</ins><span class="cx"> $( function() {
</span><span class="cx"> if ( ! api.settings )
</span><span class="cx"> return;
</span><span class="cx">
</span><del>- var controls = $('[name^="' + api.settings.prefix + '"]'),
- previewer, pickers, validateColor, sendSetting;
-
</del><span class="cx"> // Initialize Previewer
</span><del>- previewer = new api.Previewer({
</del><ins>+ var previewer = new api.Previewer({
</ins><span class="cx"> iframe: '#customize-preview iframe',
</span><span class="cx"> form: '#customize-controls',
</span><span class="cx"> url: api.settings.preview
</span><span class="cx"> });
</span><span class="cx">
</span><del>- $.each( api.settings.values, function( id, value ) {
- var elements = controls.filter( '[name="' + api.settings.prefix + id + '"]' ),
- setting = api.set( id, value );
-
- setting.control = new wp.customize.Element( elements );
-
- setting.control.link( setting );
- setting.link( setting.control );
-
- setting.bind( previewer.refresh );
-
-
</del><ins>+ $.each( api.settings.controls, function( id, data ) {
+ var constructor = api.controls[ data.control ] || api.Control;
+ api.add( id, new constructor( id, data.value, {
+ previewer: previewer
+ } ) );
</ins><span class="cx"> });
</span><span class="cx">
</span><span class="cx"> // Temporary accordion code.
</span><span class="lines">@@ -161,46 +227,8 @@
</span><span class="cx"> return false;
</span><span class="cx"> });
</span><span class="cx">
</span><del>- // Set up color pickers
- pickers = $('.color-picker');
- validateColor = function( to ) {
- return /^[a-fA-F0-9]{3}([a-fA-F0-9]{3})?$/.test( to ) ? to : null;
- };
-
- $( '.farbtastic-placeholder', pickers ).each( function() {
- var picker = $(this),
- text = new api.Element( picker.siblings('input') ),
- parent = picker.parent(),
- toggle = parent.siblings('a'),
- value = api( parent.siblings('input').prop('name').replace( api.settings.prefix, '' ) ),
- farb, update;
-
- value.validate = validateColor;
- text.link( value );
- value.link( text );
-
- farb = $.farbtastic( this, function( color ) {
- value.set( color.replace( '#', '' ) );
- });
-
- update = function( color ) {
- color = '#' + color;
- toggle.css( 'background', color );
- farb.setColor( color );
- };
-
- value.bind( update );
- update( value() );
- });
-
- $('.color-picker a').click( function(e) {
- $(this).siblings('div').toggle();
- });
-
</del><span class="cx"> // Background color uses postMessage by default
</span><del>- api('background_color').unbind( previewer.refresh ).bind( function() {
- previewer.send( 'setting', [ 'background_color', this() ] );
- });
</del><ins>+ api('background_color').method = 'postMessage';
</ins><span class="cx"> });
</span><span class="cx">
</span><span class="cx"> })( wp, jQuery );
</span><span class="cx">\ No newline at end of file
</span></span></pre>
</div>
</div>
</body>
</html>