1 (function( exports, $ ){
2 var api = wp.customize;
6 * - previewer - The Previewer instance to sync with.
7 * - transport - The transport to use for previewing. Supports 'refresh' and 'postMessage'.
9 api.Setting = api.Value.extend({
10 initialize: function( id, value, options ) {
11 api.Value.prototype.initialize.call( this, value, options );
14 this.transport = this.transport || 'refresh';
16 this.bind( this.preview );
19 switch ( this.transport ) {
21 return this.previewer.refresh();
23 return this.previewer.send( 'setting', [ this.id, this() ] );
28 api.Control = api.Class.extend({
29 initialize: function( id, options ) {
31 nodes, radios, settings;
34 $.extend( this, options || {} );
37 this.selector = '#customize-control-' + id.replace( /\]/g, '' ).replace( /\[/g, '-' );
38 this.container = $( this.selector );
40 settings = $.map( this.params.settings, function( value ) {
44 api.apply( api, settings.concat( function() {
47 control.settings = {};
48 for ( key in control.params.settings ) {
49 control.settings[ key ] = api( control.params.settings[ key ] );
52 control.setting = control.settings['default'] || null;
56 control.elements = [];
58 nodes = this.container.find('[data-customize-setting-link]');
61 nodes.each( function() {
65 if ( node.is(':radio') ) {
66 name = node.prop('name');
70 radios[ name ] = true;
71 node = nodes.filter( '[name="' + name + '"]' );
74 api( node.data('customizeSettingLink'), function( setting ) {
75 var element = new api.Element( node );
76 control.elements.push( element );
77 element.sync( setting );
78 element.set( setting() );
85 dropdownInit: function() {
87 statuses = this.container.find('.dropdown-status'),
90 update = function( to ) {
91 if ( typeof to === 'string' && params.statuses && params.statuses[ to ] )
92 statuses.html( params.statuses[ to ] ).show();
97 // Support the .dropdown class to open/close complex elements
98 this.container.on( 'click keydown', '.dropdown', function( event ) {
99 if ( event.type === 'keydown' && 13 !== event.which ) // enter
102 event.preventDefault();
105 control.container.toggleClass('open');
107 if ( control.container.hasClass('open') )
108 control.container.parent().parent().find('li.library-selected').focus();
110 // Don't want to fire focus and click at same time
112 setTimeout(function () {
113 toggleFreeze = false;
117 this.setting.bind( update );
118 update( this.setting() );
122 api.ColorControl = api.Control.extend({
125 picker = this.container.find('.color-picker-hex');
127 picker.val( control.setting() ).wpColorPicker({
129 control.setting.set( picker.wpColorPicker('color') );
132 control.setting.set( false );
138 api.UploadControl = api.Control.extend({
142 this.params.removed = this.params.removed || '';
144 this.success = $.proxy( this.success, this );
146 this.uploader = $.extend({
147 container: this.container,
148 browser: this.container.find('.upload'),
149 dropzone: this.container.find('.upload-dropzone'),
150 success: this.success,
153 }, this.uploader || {} );
155 if ( control.params.extensions ) {
156 control.uploader.plupload.filters = [{
157 title: api.l10n.allowedFiles,
158 extensions: control.params.extensions
162 if ( control.params.context )
163 control.uploader.params['post_data[context]'] = this.params.context;
165 if ( api.settings.theme.stylesheet )
166 control.uploader.params['post_data[theme]'] = api.settings.theme.stylesheet;
168 this.uploader = new wp.Uploader( this.uploader );
170 this.remover = this.container.find('.remove');
171 this.remover.on( 'click keydown', function( event ) {
172 if ( event.type === 'keydown' && 13 !== event.which ) // enter
175 control.setting.set( control.params.removed );
176 event.preventDefault();
179 this.removerVisibility = $.proxy( this.removerVisibility, this );
180 this.setting.bind( this.removerVisibility );
181 this.removerVisibility( this.setting.get() );
183 success: function( attachment ) {
184 this.setting.set( attachment.get('url') );
186 removerVisibility: function( to ) {
187 this.remover.toggle( to != this.params.removed );
191 api.ImageControl = api.UploadControl.extend({
198 var fallback, button;
200 if ( this.supports.dragdrop )
203 // Maintain references while wrapping the fallback button.
204 fallback = control.container.find( '.upload-fallback' );
205 button = fallback.children().detach();
207 this.browser.detach().empty().append( button );
208 fallback.append( this.browser ).show();
212 api.UploadControl.prototype.ready.call( this );
214 this.thumbnail = this.container.find('.preview-thumbnail img');
215 this.thumbnailSrc = $.proxy( this.thumbnailSrc, this );
216 this.setting.bind( this.thumbnailSrc );
218 this.library = this.container.find('.library');
220 // Generate tab objects
222 panels = this.library.find('.library-content');
224 this.library.children('ul').children('li').each( function() {
226 id = link.data('customizeTab'),
227 panel = panels.filter('[data-customize-tab="' + id + '"]');
229 control.tabs[ id ] = {
230 both: link.add( panel ),
236 // Bind tab switch events
237 this.library.children('ul').on( 'click keydown', 'li', function( event ) {
238 if ( event.type === 'keydown' && 13 !== event.which ) // enter
241 var id = $(this).data('customizeTab'),
242 tab = control.tabs[ id ];
244 event.preventDefault();
246 if ( tab.link.hasClass('library-selected') )
249 control.selected.both.removeClass('library-selected');
250 control.selected = tab;
251 control.selected.both.addClass('library-selected');
254 // Bind events to switch image urls.
255 this.library.on( 'click keydown', 'a', function( event ) {
256 if ( event.type === 'keydown' && 13 !== event.which ) // enter
259 var value = $(this).data('customizeImageValue');
262 control.setting.set( value );
263 event.preventDefault();
267 if ( this.tabs.uploaded ) {
268 this.tabs.uploaded.target = this.library.find('.uploaded-target');
269 if ( ! this.tabs.uploaded.panel.find('.thumbnail').length )
270 this.tabs.uploaded.both.addClass('hidden');
274 panels.each( function() {
275 var tab = control.tabs[ $(this).data('customizeTab') ];
277 // Select the first visible tab.
278 if ( ! tab.link.hasClass('hidden') ) {
279 control.selected = tab;
280 tab.both.addClass('library-selected');
287 success: function( attachment ) {
288 api.UploadControl.prototype.success.call( this, attachment );
290 // Add the uploaded image to the uploaded tab.
291 if ( this.tabs.uploaded && this.tabs.uploaded.target.length ) {
292 this.tabs.uploaded.both.removeClass('hidden');
294 // @todo: Do NOT store this on the attachment model. That is bad.
295 attachment.element = $( '<a href="#" class="thumbnail"></a>' )
296 .data( 'customizeImageValue', attachment.get('url') )
297 .append( '<img src="' + attachment.get('url')+ '" />' )
298 .appendTo( this.tabs.uploaded.target );
301 thumbnailSrc: function( to ) {
302 if ( /^(https?:)?\/\//.test( to ) )
303 this.thumbnail.prop( 'src', to ).show();
305 this.thumbnail.hide();
309 // Change objects contained within the main customize object to Settings.
310 api.defaultConstructor = api.Setting;
312 // Create the collection of Control objects.
313 api.control = new api.Values({ defaultConstructor: api.Control });
315 api.PreviewFrame = api.Messenger.extend({
318 initialize: function( params, options ) {
319 var deferred = $.Deferred();
321 // This is the promise object.
322 deferred.promise( this );
324 this.container = params.container;
325 this.signature = params.signature;
327 $.extend( params, { channel: api.PreviewFrame.uuid() });
329 api.Messenger.prototype.initialize.call( this, params, options );
331 this.add( 'previewUrl', params.previewUrl );
333 this.query = $.extend( params.query || {}, { customize_messenger_channel: this.channel() });
335 this.run( deferred );
338 run: function( deferred ) {
344 this.unbind( 'ready', this._ready );
346 this._ready = function() {
350 deferred.resolveWith( self );
353 this.bind( 'ready', this._ready );
355 this.request = $.ajax( this.previewUrl(), {
359 withCredentials: true
363 this.request.fail( function() {
364 deferred.rejectWith( self, [ 'request failure' ] );
367 this.request.done( function( response ) {
368 var location = self.request.getResponseHeader('Location'),
369 signature = self.signature,
372 // Check if the location response header differs from the current URL.
373 // If so, the request was redirected; try loading the requested page.
374 if ( location && location != self.previewUrl() ) {
375 deferred.rejectWith( self, [ 'redirect', location ] );
379 // Check if the user is not logged in.
380 if ( '0' === response ) {
381 self.login( deferred );
385 // Check for cheaters.
386 if ( '-1' === response ) {
387 deferred.rejectWith( self, [ 'cheatin' ] );
391 // Check for a signature in the request.
392 index = response.lastIndexOf( signature );
393 if ( -1 === index || index < response.lastIndexOf('</html>') ) {
394 deferred.rejectWith( self, [ 'unsigned' ] );
398 // Strip the signature from the request.
399 response = response.slice( 0, index ) + response.slice( index + signature.length );
401 // Create the iframe and inject the html content.
402 self.iframe = $('<iframe />').appendTo( self.container );
404 // Bind load event after the iframe has been added to the page;
405 // otherwise it will fire when injected into the DOM.
406 self.iframe.one( 'load', function() {
410 deferred.resolveWith( self );
412 setTimeout( function() {
413 deferred.rejectWith( self, [ 'ready timeout' ] );
414 }, self.sensitivity );
418 self.targetWindow( self.iframe[0].contentWindow );
420 self.targetWindow().document.open();
421 self.targetWindow().document.write( response );
422 self.targetWindow().document.close();
426 login: function( deferred ) {
430 reject = function() {
431 deferred.rejectWith( self, [ 'logged out' ] );
434 if ( this.triedLogin )
437 // Check if we have an admin cookie.
438 $.get( api.settings.url.ajax, {
440 }).fail( reject ).done( function( response ) {
443 if ( '1' !== response )
446 iframe = $('<iframe src="' + self.previewUrl() + '" />').hide();
447 iframe.appendTo( self.container );
448 iframe.load( function() {
449 self.triedLogin = true;
452 self.run( deferred );
457 destroy: function() {
458 api.Messenger.prototype.destroy.call( this );
459 this.request.abort();
462 this.iframe.remove();
466 delete this.targetWindow;
472 api.PreviewFrame.uuid = function() {
473 return 'preview-' + uuid++;
477 api.Previewer = api.Messenger.extend({
482 * - container - a selector or jQuery element
483 * - previewUrl - the URL of preview frame
485 initialize: function( params, options ) {
489 $.extend( this, options || {} );
492 * Wrap this.refresh to prevent it from hammering the servers:
494 * If refresh is called once and no other refresh requests are
495 * loading, trigger the request immediately.
497 * If refresh is called while another refresh request is loading,
498 * debounce the refresh requests:
499 * 1. Stop the loading request (as it is instantly outdated).
500 * 2. Trigger the new request once refresh hasn't been called for
501 * self.refreshBuffer milliseconds.
503 this.refresh = (function( self ) {
504 var refresh = self.refresh,
505 callback = function() {
507 refresh.call( self );
512 if ( typeof timeout !== 'number' ) {
513 if ( self.loading ) {
520 clearTimeout( timeout );
521 timeout = setTimeout( callback, self.refreshBuffer );
525 this.container = api.ensure( params.container );
526 this.allowedUrls = params.allowedUrls;
527 this.signature = params.signature;
529 params.url = window.location.href;
531 api.Messenger.prototype.initialize.call( this, params );
533 this.add( 'scheme', this.origin() ).link( this.origin ).setter( function( to ) {
534 var match = to.match( rscheme );
535 return match ? match[0] : '';
538 // Limit the URL to internal, front-end links.
540 // If the frontend and the admin are served from the same domain, load the
541 // preview over ssl if the customizer is being loaded over ssl. This avoids
542 // insecure content warnings. This is not attempted if the admin and frontend
543 // are on different domains to avoid the case where the frontend doesn't have
546 this.add( 'previewUrl', params.previewUrl ).setter( function( to ) {
549 // Check for URLs that include "/wp-admin/" or end in "/wp-admin".
550 // Strip hashes and query strings before testing.
551 if ( /\/wp-admin(\/|$)/.test( to.replace( /[#?].*$/, '' ) ) )
554 // Attempt to match the URL to the control frame's scheme
555 // and check if it's allowed. If not, try the original URL.
556 $.each([ to.replace( rscheme, self.scheme() ), to ], function( i, url ) {
557 $.each( self.allowedUrls, function( i, allowed ) {
560 allowed = allowed.replace( /\/+$/, '' );
561 path = url.replace( allowed, '' );
563 if ( 0 === url.indexOf( allowed ) && /^([/#?]|$)/.test( path ) ) {
572 // If we found a matching result, return it. If not, bail.
573 return result ? result : null;
576 // Refresh the preview when the URL is changed (but not yet).
577 this.previewUrl.bind( this.refresh );
580 this.bind( 'scroll', function( distance ) {
581 this.scroll = distance;
584 // Update the URL when the iframe sends a URL message.
585 this.bind( 'url', this.previewUrl );
588 query: function() {},
591 if ( this.loading ) {
592 this.loading.destroy();
597 refresh: function() {
602 this.loading = new api.PreviewFrame({
604 previewUrl: this.previewUrl(),
605 query: this.query() || {},
606 container: this.container,
607 signature: this.signature
610 this.loading.done( function() {
611 // 'this' is the loading frame
612 this.bind( 'synced', function() {
614 self.preview.destroy();
618 self.targetWindow( this.targetWindow() );
619 self.channel( this.channel() );
621 self.send( 'active' );
630 this.loading.fail( function( reason, location ) {
631 if ( 'redirect' === reason && location )
632 self.previewUrl( location );
634 if ( 'logged out' === reason ) {
635 if ( self.preview ) {
636 self.preview.destroy();
640 self.login().done( self.refresh );
643 if ( 'cheatin' === reason )
649 var previewer = this,
650 deferred, messenger, iframe;
655 deferred = $.Deferred();
656 this._login = deferred.promise();
658 messenger = new api.Messenger({
660 url: api.settings.url.login
663 iframe = $('<iframe src="' + api.settings.url.login + '" />').appendTo( this.container );
665 messenger.targetWindow( iframe[0].contentWindow );
667 messenger.bind( 'login', function() {
670 delete previewer._login;
677 cheatin: function() {
678 $( document.body ).empty().addClass('cheatin').append( '<p>' + api.l10n.cheatin + '</p>' );
682 /* =====================================================================
684 * ===================================================================== */
686 api.controlConstructor = {
687 color: api.ColorControl,
688 upload: api.UploadControl,
689 image: api.ImageControl
693 api.settings = window._wpCustomizeSettings;
694 api.l10n = window._wpCustomizeControlsL10n;
696 // Check if we can run the customizer.
697 if ( ! api.settings )
700 // Redirect to the fallback preview if any incompatibilities are found.
701 if ( ! $.support.postMessage || ( ! $.support.cors && api.settings.isCrossDomain ) )
702 return window.location = api.settings.url.fallback;
704 var previewer, parent, topFocus,
705 body = $( document.body ),
706 overlay = body.children('.wp-full-overlay');
708 // Prevent the form from saving when enter is pressed.
709 $('#customize-controls').on( 'keydown', function( e ) {
710 if ( $( e.target ).is('textarea') )
713 if ( 13 === e.which ) // Enter
717 // Initialize Previewer
718 previewer = new api.Previewer({
719 container: '#customize-preview',
720 form: '#customize-controls',
721 previewUrl: api.settings.url.preview,
722 allowedUrls: api.settings.url.allowed,
723 signature: 'WP_CUSTOMIZER_SIGNATURE'
726 nonce: api.settings.nonce,
731 theme: api.settings.theme.stylesheet,
732 customized: JSON.stringify( api.get() ),
733 nonce: this.nonce.preview
739 query = $.extend( this.query(), {
740 action: 'customize_save',
741 nonce: this.nonce.save
743 request = $.post( api.settings.url.ajax, query );
745 api.trigger( 'save', request );
747 body.addClass('saving');
749 request.always( function() {
750 body.removeClass('saving');
753 request.done( function( response ) {
754 // Check if the user is logged out.
755 if ( '0' === response ) {
756 self.preview.iframe.hide();
757 self.login().done( function() {
759 self.preview.iframe.show();
764 // Check for cheaters.
765 if ( '-1' === response ) {
770 api.trigger( 'saved' );
775 // Refresh the nonces if the preview sends updated nonces over.
776 previewer.bind( 'nonce', function( nonce ) {
777 $.extend( this.nonce, nonce );
780 $.each( api.settings.settings, function( id, data ) {
781 api.create( id, id, data.value, {
782 transport: data.transport,
787 $.each( api.settings.controls, function( id, data ) {
788 var constructor = api.controlConstructor[ data.type ] || api.Control,
791 control = api.control.add( id, new constructor( id, {
797 // Check if preview url is valid and load the preview frame.
798 if ( previewer.previewUrl() )
801 previewer.previewUrl( api.settings.url.home );
803 // Save and activated states
805 var state = new api.Values(),
806 saved = state.create('saved'),
807 activated = state.create('activated');
809 state.bind( 'change', function() {
810 var save = $('#save'),
813 if ( ! activated() ) {
814 save.val( api.l10n.activate ).prop( 'disabled', false );
815 back.text( api.l10n.cancel );
817 } else if ( saved() ) {
818 save.val( api.l10n.saved ).prop( 'disabled', true );
819 back.text( api.l10n.close );
822 save.val( api.l10n.save ).prop( 'disabled', false );
823 back.text( api.l10n.cancel );
827 // Set default states.
829 activated( api.settings.theme.active );
831 api.bind( 'change', function() {
832 state('saved').set( false );
835 api.bind( 'saved', function() {
836 state('saved').set( true );
837 state('activated').set( true );
840 activated.bind( function( to ) {
842 api.trigger( 'activated' );
845 // Expose states to the API.
850 $('#save').click( function( event ) {
852 event.preventDefault();
853 }).keydown( function( event ) {
854 if ( 9 === event.which ) // tab
856 if ( 13 === event.which ) // enter
858 event.preventDefault();
861 $('.back').keydown( function( event ) {
862 if ( 9 === event.which ) // tab
864 if ( 13 === event.which ) // enter
866 event.preventDefault();
869 $('.upload-dropzone a.upload').keydown( function( event ) {
870 if ( 13 === event.which ) // enter
874 $('.collapse-sidebar').on( 'click keydown', function( event ) {
875 if ( event.type === 'keydown' && 13 !== event.which ) // enter
878 overlay.toggleClass( 'collapsed' ).toggleClass( 'expanded' );
879 event.preventDefault();
882 // Create a potential postMessage connection with the parent frame.
883 parent = new api.Messenger({
884 url: api.settings.url.parent,
888 // If we receive a 'back' event, we're inside an iframe.
889 // Send any clicks to the 'Return' link to the parent page.
890 parent.bind( 'back', function() {
891 $('.back').on( 'click.back', function( event ) {
892 event.preventDefault();
893 parent.send( 'close' );
897 // Pass events through to the parent.
898 api.bind( 'saved', function() {
899 parent.send( 'saved' );
902 // When activated, let the loader handle redirecting the page.
903 // If no loader exists, redirect the page ourselves (if a url exists).
904 api.bind( 'activated', function() {
905 if ( parent.targetWindow() )
906 parent.send( 'activated', api.settings.url.activated );
907 else if ( api.settings.url.activated )
908 window.location = api.settings.url.activated;
911 // Initialize the connection with the parent frame.
912 parent.send( 'ready' );
914 // Control visibility for default controls
916 'background_image': {
917 controls: [ 'background_repeat', 'background_position_x', 'background_attachment' ],
918 callback: function( to ) { return !! to; }
921 controls: [ 'page_on_front', 'page_for_posts' ],
922 callback: function( to ) { return 'page' === to; }
924 'header_textcolor': {
925 controls: [ 'header_textcolor' ],
926 callback: function( to ) { return 'blank' !== to; }
928 }, function( settingId, o ) {
929 api( settingId, function( setting ) {
930 $.each( o.controls, function( i, controlId ) {
931 api.control( controlId, function( control ) {
932 var visibility = function( to ) {
933 control.container.toggle( o.callback( to ) );
936 visibility( setting.get() );
937 setting.bind( visibility );
943 // Juggle the two controls that use header_textcolor
944 api.control( 'display_header_text', function( control ) {
947 control.elements[0].unsync( api( 'header_textcolor' ) );
949 control.element = new api.Element( control.container.find('input') );
950 control.element.set( 'blank' !== control.setting() );
952 control.element.bind( function( to ) {
954 last = api( 'header_textcolor' ).get();
956 control.setting.set( to ? last : 'blank' );
959 control.setting.bind( function( to ) {
960 control.element.set( 'blank' !== to );
964 // Handle header image data
965 api.control( 'header_image', function( control ) {
966 control.setting.bind( function( to ) {
967 if ( to === control.params.removed )
968 control.settings.data.set( false );
971 control.library.on( 'click', 'a', function() {
972 control.settings.data.set( $(this).data('customizeHeaderImageData') );
975 control.uploader.success = function( attachment ) {
978 api.ImageControl.prototype.success.call( control, attachment );
981 attachment_id: attachment.get('id'),
982 url: attachment.get('url'),
983 thumbnail_url: attachment.get('url'),
984 height: attachment.get('height'),
985 width: attachment.get('width')
988 attachment.element.data( 'customizeHeaderImageData', data );
989 control.settings.data.set( data );
993 api.trigger( 'ready' );
995 // Make sure left column gets focus
996 topFocus = $('.back');
998 setTimeout(function () {