X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/0f684a09c03e547d3132bddc970cbeafcd1102f4..0f74cdeda4c069bfbb9c4131ef1352f55b6f8499:/wp-admin/js/customize-controls.js
diff --git a/wp-admin/js/customize-controls.js b/wp-admin/js/customize-controls.js
index 4bfc252a..e6270ee0 100644
--- a/wp-admin/js/customize-controls.js
+++ b/wp-admin/js/customize-controls.js
@@ -1,87 +1,2172 @@
-/* globals _wpCustomizeHeader, _wpMediaViewsL10n */
+/* global _wpCustomizeHeader, _wpCustomizeBackground, _wpMediaViewsL10n, MediaElementPlayer */
(function( exports, $ ){
- var api = wp.customize;
+ var Container, focus, normalizedTransitionendEventName, api = wp.customize;
/**
- * @param options
- * - previewer - The Previewer instance to sync with.
- * - transport - The transport to use for previewing. Supports 'refresh' and 'postMessage'.
+ * A Customizer Setting.
+ *
+ * A setting is WordPress data (theme mod, option, menu, etc.) that the user can
+ * draft changes to in the Customizer.
+ *
+ * @see PHP class WP_Customize_Setting.
+ *
+ * @class
+ * @augments wp.customize.Value
+ * @augments wp.customize.Class
+ *
+ * @param {object} id The Setting ID.
+ * @param {object} value The initial value of the setting.
+ * @param {object} options.previewer The Previewer instance to sync with.
+ * @param {object} options.transport The transport to use for previewing. Supports 'refresh' and 'postMessage'.
+ * @param {object} options.dirty
*/
api.Setting = api.Value.extend({
initialize: function( id, value, options ) {
- api.Value.prototype.initialize.call( this, value, options );
+ var setting = this;
+ api.Value.prototype.initialize.call( setting, value, options );
- this.id = id;
- this.transport = this.transport || 'refresh';
+ setting.id = id;
+ setting.transport = setting.transport || 'refresh';
+ setting._dirty = options.dirty || false;
+ setting.notifications = new api.Values({ defaultConstructor: api.Notification });
- this.bind( this.preview );
+ // Whenever the setting's value changes, refresh the preview.
+ setting.bind( setting.preview );
},
+
+ /**
+ * Refresh the preview, respective of the setting's refresh policy.
+ *
+ * If the preview hasn't sent a keep-alive message and is likely
+ * disconnected by having navigated to a non-allowed URL, then the
+ * refresh transport will be forced when postMessage is the transport.
+ * Note that postMessage does not throw an error when the recipient window
+ * fails to match the origin window, so using try/catch around the
+ * previewer.send() call to then fallback to refresh will not work.
+ *
+ * @since 3.4.0
+ * @access public
+ *
+ * @returns {void}
+ */
preview: function() {
- switch ( this.transport ) {
- case 'refresh':
- return this.previewer.refresh();
- case 'postMessage':
- return this.previewer.send( 'setting', [ this.id, this() ] );
+ var setting = this, transport;
+ transport = setting.transport;
+
+ if ( 'postMessage' === transport && ! api.state( 'previewerAlive' ).get() ) {
+ transport = 'refresh';
+ }
+
+ if ( 'postMessage' === transport ) {
+ setting.previewer.send( 'setting', [ setting.id, setting() ] );
+ } else if ( 'refresh' === transport ) {
+ setting.previewer.refresh();
+ }
+ },
+
+ /**
+ * Find controls associated with this setting.
+ *
+ * @since 4.6.0
+ * @returns {wp.customize.Control[]} Controls associated with setting.
+ */
+ findControls: function() {
+ var setting = this, controls = [];
+ api.control.each( function( control ) {
+ _.each( control.settings, function( controlSetting ) {
+ if ( controlSetting.id === setting.id ) {
+ controls.push( control );
+ }
+ } );
+ } );
+ return controls;
+ }
+ });
+
+ /**
+ * Current change count.
+ *
+ * @since 4.7.0
+ * @type {number}
+ * @protected
+ */
+ api._latestRevision = 0;
+
+ /**
+ * Last revision that was saved.
+ *
+ * @since 4.7.0
+ * @type {number}
+ * @protected
+ */
+ api._lastSavedRevision = 0;
+
+ /**
+ * Latest revisions associated with the updated setting.
+ *
+ * @since 4.7.0
+ * @type {object}
+ * @protected
+ */
+ api._latestSettingRevisions = {};
+
+ /*
+ * Keep track of the revision associated with each updated setting so that
+ * requestChangesetUpdate knows which dirty settings to include. Also, once
+ * ready is triggered and all initial settings have been added, increment
+ * revision for each newly-created initially-dirty setting so that it will
+ * also be included in changeset update requests.
+ */
+ api.bind( 'change', function incrementChangedSettingRevision( setting ) {
+ api._latestRevision += 1;
+ api._latestSettingRevisions[ setting.id ] = api._latestRevision;
+ } );
+ api.bind( 'ready', function() {
+ api.bind( 'add', function incrementCreatedSettingRevision( setting ) {
+ if ( setting._dirty ) {
+ api._latestRevision += 1;
+ api._latestSettingRevisions[ setting.id ] = api._latestRevision;
+ }
+ } );
+ } );
+
+ /**
+ * Get the dirty setting values.
+ *
+ * @since 4.7.0
+ * @access public
+ *
+ * @param {object} [options] Options.
+ * @param {boolean} [options.unsaved=false] Whether only values not saved yet into a changeset will be returned (differential changes).
+ * @returns {object} Dirty setting values.
+ */
+ api.dirtyValues = function dirtyValues( options ) {
+ var values = {};
+ api.each( function( setting ) {
+ var settingRevision;
+
+ if ( ! setting._dirty ) {
+ return;
+ }
+
+ settingRevision = api._latestSettingRevisions[ setting.id ];
+
+ // Skip including settings that have already been included in the changeset, if only requesting unsaved.
+ if ( api.state( 'changesetStatus' ).get() && ( options && options.unsaved ) && ( _.isUndefined( settingRevision ) || settingRevision <= api._lastSavedRevision ) ) {
+ return;
+ }
+
+ values[ setting.id ] = setting.get();
+ } );
+ return values;
+ };
+
+ /**
+ * Request updates to the changeset.
+ *
+ * @since 4.7.0
+ * @access public
+ *
+ * @param {object} [changes] Mapping of setting IDs to setting params each normally including a value property, or mapping to null.
+ * If not provided, then the changes will still be obtained from unsaved dirty settings.
+ * @returns {jQuery.Promise} Promise resolving with the response data.
+ */
+ api.requestChangesetUpdate = function requestChangesetUpdate( changes ) {
+ var deferred, request, submittedChanges = {}, data;
+ deferred = new $.Deferred();
+
+ if ( changes ) {
+ _.extend( submittedChanges, changes );
+ }
+
+ // Ensure all revised settings (changes pending save) are also included, but not if marked for deletion in changes.
+ _.each( api.dirtyValues( { unsaved: true } ), function( dirtyValue, settingId ) {
+ if ( ! changes || null !== changes[ settingId ] ) {
+ submittedChanges[ settingId ] = _.extend(
+ {},
+ submittedChanges[ settingId ] || {},
+ { value: dirtyValue }
+ );
+ }
+ } );
+
+ // Short-circuit when there are no pending changes.
+ if ( _.isEmpty( submittedChanges ) ) {
+ deferred.resolve( {} );
+ return deferred.promise();
+ }
+
+ // Make sure that publishing a changeset waits for all changeset update requests to complete.
+ api.state( 'processing' ).set( api.state( 'processing' ).get() + 1 );
+ deferred.always( function() {
+ api.state( 'processing' ).set( api.state( 'processing' ).get() - 1 );
+ } );
+
+ // Allow plugins to attach additional params to the settings.
+ api.trigger( 'changeset-save', submittedChanges );
+
+ // Ensure that if any plugins add data to save requests by extending query() that they get included here.
+ data = api.previewer.query( { excludeCustomizedSaved: true } );
+ delete data.customized; // Being sent in customize_changeset_data instead.
+ _.extend( data, {
+ nonce: api.settings.nonce.save,
+ customize_theme: api.settings.theme.stylesheet,
+ customize_changeset_data: JSON.stringify( submittedChanges )
+ } );
+
+ request = wp.ajax.post( 'customize_save', data );
+
+ request.done( function requestChangesetUpdateDone( data ) {
+ var savedChangesetValues = {};
+
+ // Ensure that all settings updated subsequently will be included in the next changeset update request.
+ api._lastSavedRevision = Math.max( api._latestRevision, api._lastSavedRevision );
+
+ api.state( 'changesetStatus' ).set( data.changeset_status );
+ deferred.resolve( data );
+ api.trigger( 'changeset-saved', data );
+
+ if ( data.setting_validities ) {
+ _.each( data.setting_validities, function( validity, settingId ) {
+ if ( true === validity && _.isObject( submittedChanges[ settingId ] ) && ! _.isUndefined( submittedChanges[ settingId ].value ) ) {
+ savedChangesetValues[ settingId ] = submittedChanges[ settingId ].value;
+ }
+ } );
+ }
+
+ api.previewer.send( 'changeset-saved', _.extend( {}, data, { saved_changeset_values: savedChangesetValues } ) );
+ } );
+ request.fail( function requestChangesetUpdateFail( data ) {
+ deferred.reject( data );
+ api.trigger( 'changeset-error', data );
+ } );
+ request.always( function( data ) {
+ if ( data.setting_validities ) {
+ api._handleSettingValidities( {
+ settingValidities: data.setting_validities
+ } );
+ }
+ } );
+
+ return deferred.promise();
+ };
+
+ /**
+ * Watch all changes to Value properties, and bubble changes to parent Values instance
+ *
+ * @since 4.1.0
+ *
+ * @param {wp.customize.Class} instance
+ * @param {Array} properties The names of the Value instances to watch.
+ */
+ api.utils.bubbleChildValueChanges = function ( instance, properties ) {
+ $.each( properties, function ( i, key ) {
+ instance[ key ].bind( function ( to, from ) {
+ if ( instance.parent && to !== from ) {
+ instance.parent.trigger( 'change', instance );
+ }
+ } );
+ } );
+ };
+
+ /**
+ * Expand a panel, section, or control and focus on the first focusable element.
+ *
+ * @since 4.1.0
+ *
+ * @param {Object} [params]
+ * @param {Function} [params.completeCallback]
+ */
+ focus = function ( params ) {
+ var construct, completeCallback, focus, focusElement;
+ construct = this;
+ params = params || {};
+ focus = function () {
+ var focusContainer;
+ if ( ( construct.extended( api.Panel ) || construct.extended( api.Section ) ) && construct.expanded && construct.expanded() ) {
+ focusContainer = construct.contentContainer;
+ } else {
+ focusContainer = construct.container;
+ }
+
+ focusElement = focusContainer.find( '.control-focus:first' );
+ if ( 0 === focusElement.length ) {
+ // Note that we can't use :focusable due to a jQuery UI issue. See: https://github.com/jquery/jquery-ui/pull/1583
+ focusElement = focusContainer.find( 'input, select, textarea, button, object, a[href], [tabindex]' ).filter( ':visible' ).first();
+ }
+ focusElement.focus();
+ };
+ if ( params.completeCallback ) {
+ completeCallback = params.completeCallback;
+ params.completeCallback = function () {
+ focus();
+ completeCallback();
+ };
+ } else {
+ params.completeCallback = focus;
+ }
+
+ api.state( 'paneVisible' ).set( true );
+ if ( construct.expand ) {
+ construct.expand( params );
+ } else {
+ params.completeCallback();
+ }
+ };
+
+ /**
+ * Stable sort for Panels, Sections, and Controls.
+ *
+ * If a.priority() === b.priority(), then sort by their respective params.instanceNumber.
+ *
+ * @since 4.1.0
+ *
+ * @param {(wp.customize.Panel|wp.customize.Section|wp.customize.Control)} a
+ * @param {(wp.customize.Panel|wp.customize.Section|wp.customize.Control)} b
+ * @returns {Number}
+ */
+ api.utils.prioritySort = function ( a, b ) {
+ if ( a.priority() === b.priority() && typeof a.params.instanceNumber === 'number' && typeof b.params.instanceNumber === 'number' ) {
+ return a.params.instanceNumber - b.params.instanceNumber;
+ } else {
+ return a.priority() - b.priority();
+ }
+ };
+
+ /**
+ * Return whether the supplied Event object is for a keydown event but not the Enter key.
+ *
+ * @since 4.1.0
+ *
+ * @param {jQuery.Event} event
+ * @returns {boolean}
+ */
+ api.utils.isKeydownButNotEnterEvent = function ( event ) {
+ return ( 'keydown' === event.type && 13 !== event.which );
+ };
+
+ /**
+ * Return whether the two lists of elements are the same and are in the same order.
+ *
+ * @since 4.1.0
+ *
+ * @param {Array|jQuery} listA
+ * @param {Array|jQuery} listB
+ * @returns {boolean}
+ */
+ api.utils.areElementListsEqual = function ( listA, listB ) {
+ var equal = (
+ listA.length === listB.length && // if lists are different lengths, then naturally they are not equal
+ -1 === _.indexOf( _.map( // are there any false values in the list returned by map?
+ _.zip( listA, listB ), // pair up each element between the two lists
+ function ( pair ) {
+ return $( pair[0] ).is( pair[1] ); // compare to see if each pair are equal
+ }
+ ), false ) // check for presence of false in map's return value
+ );
+ return equal;
+ };
+
+ /**
+ * Return browser supported `transitionend` event name.
+ *
+ * @since 4.7.0
+ *
+ * @returns {string|null} Normalized `transitionend` event name or null if CSS transitions are not supported.
+ */
+ normalizedTransitionendEventName = (function () {
+ var el, transitions, prop;
+ el = document.createElement( 'div' );
+ transitions = {
+ 'transition' : 'transitionend',
+ 'OTransition' : 'oTransitionEnd',
+ 'MozTransition' : 'transitionend',
+ 'WebkitTransition': 'webkitTransitionEnd'
+ };
+ prop = _.find( _.keys( transitions ), function( prop ) {
+ return ! _.isUndefined( el.style[ prop ] );
+ } );
+ if ( prop ) {
+ return transitions[ prop ];
+ } else {
+ return null;
+ }
+ })();
+
+ /**
+ * Base class for Panel and Section.
+ *
+ * @since 4.1.0
+ *
+ * @class
+ * @augments wp.customize.Class
+ */
+ Container = api.Class.extend({
+ defaultActiveArguments: { duration: 'fast', completeCallback: $.noop },
+ defaultExpandedArguments: { duration: 'fast', completeCallback: $.noop },
+ containerType: 'container',
+ defaults: {
+ title: '',
+ description: '',
+ priority: 100,
+ type: 'default',
+ content: null,
+ active: true,
+ instanceNumber: null
+ },
+
+ /**
+ * @since 4.1.0
+ *
+ * @param {string} id - The ID for the container.
+ * @param {object} options - Object containing one property: params.
+ * @param {object} options.params - Object containing the following properties.
+ * @param {string} options.params.title - Title shown when panel is collapsed and expanded.
+ * @param {string=} [options.params.description] - Description shown at the top of the panel.
+ * @param {number=100} [options.params.priority] - The sort priority for the panel.
+ * @param {string=default} [options.params.type] - The type of the panel. See wp.customize.panelConstructor.
+ * @param {string=} [options.params.content] - The markup to be used for the panel container. If empty, a JS template is used.
+ * @param {boolean=true} [options.params.active] - Whether the panel is active or not.
+ */
+ initialize: function ( id, options ) {
+ var container = this;
+ container.id = id;
+ options = options || {};
+
+ options.params = _.defaults(
+ options.params || {},
+ container.defaults
+ );
+
+ $.extend( container, options );
+ container.templateSelector = 'customize-' + container.containerType + '-' + container.params.type;
+ container.container = $( container.params.content );
+ if ( 0 === container.container.length ) {
+ container.container = $( container.getContainer() );
+ }
+ container.headContainer = container.container;
+ container.contentContainer = container.getContent();
+ container.container = container.container.add( container.contentContainer );
+
+ container.deferred = {
+ embedded: new $.Deferred()
+ };
+ container.priority = new api.Value();
+ container.active = new api.Value();
+ container.activeArgumentsQueue = [];
+ container.expanded = new api.Value();
+ container.expandedArgumentsQueue = [];
+
+ container.active.bind( function ( active ) {
+ var args = container.activeArgumentsQueue.shift();
+ args = $.extend( {}, container.defaultActiveArguments, args );
+ active = ( active && container.isContextuallyActive() );
+ container.onChangeActive( active, args );
+ });
+ container.expanded.bind( function ( expanded ) {
+ var args = container.expandedArgumentsQueue.shift();
+ args = $.extend( {}, container.defaultExpandedArguments, args );
+ container.onChangeExpanded( expanded, args );
+ });
+
+ container.deferred.embedded.done( function () {
+ container.attachEvents();
+ });
+
+ api.utils.bubbleChildValueChanges( container, [ 'priority', 'active' ] );
+
+ container.priority.set( container.params.priority );
+ container.active.set( container.params.active );
+ container.expanded.set( false );
+ },
+
+ /**
+ * @since 4.1.0
+ *
+ * @abstract
+ */
+ ready: function() {},
+
+ /**
+ * Get the child models associated with this parent, sorting them by their priority Value.
+ *
+ * @since 4.1.0
+ *
+ * @param {String} parentType
+ * @param {String} childType
+ * @returns {Array}
+ */
+ _children: function ( parentType, childType ) {
+ var parent = this,
+ children = [];
+ api[ childType ].each( function ( child ) {
+ if ( child[ parentType ].get() === parent.id ) {
+ children.push( child );
+ }
+ } );
+ children.sort( api.utils.prioritySort );
+ return children;
+ },
+
+ /**
+ * To override by subclass, to return whether the container has active children.
+ *
+ * @since 4.1.0
+ *
+ * @abstract
+ */
+ isContextuallyActive: function () {
+ throw new Error( 'Container.isContextuallyActive() must be overridden in a subclass.' );
+ },
+
+ /**
+ * Active state change handler.
+ *
+ * Shows the container if it is active, hides it if not.
+ *
+ * To override by subclass, update the container's UI to reflect the provided active state.
+ *
+ * @since 4.1.0
+ *
+ * @param {Boolean} active
+ * @param {Object} args
+ * @param {Object} args.duration
+ * @param {Object} args.completeCallback
+ */
+ onChangeActive: function( active, args ) {
+ var construct = this,
+ headContainer = construct.headContainer,
+ duration, expandedOtherPanel;
+
+ if ( args.unchanged ) {
+ if ( args.completeCallback ) {
+ args.completeCallback();
+ }
+ return;
+ }
+
+ duration = ( 'resolved' === api.previewer.deferred.active.state() ? args.duration : 0 );
+
+ if ( construct.extended( api.Panel ) ) {
+ // If this is a panel is not currently expanded but another panel is expanded, do not animate.
+ api.panel.each(function ( panel ) {
+ if ( panel !== construct && panel.expanded() ) {
+ expandedOtherPanel = panel;
+ duration = 0;
+ }
+ });
+
+ // Collapse any expanded sections inside of this panel first before deactivating.
+ if ( ! active ) {
+ _.each( construct.sections(), function( section ) {
+ section.collapse( { duration: 0 } );
+ } );
+ }
+ }
+
+ if ( ! $.contains( document, headContainer ) ) {
+ // jQuery.fn.slideUp is not hiding an element if it is not in the DOM
+ headContainer.toggle( active );
+ if ( args.completeCallback ) {
+ args.completeCallback();
+ }
+ } else if ( active ) {
+ headContainer.stop( true, true ).slideDown( duration, args.completeCallback );
+ } else {
+ if ( construct.expanded() ) {
+ construct.collapse({
+ duration: duration,
+ completeCallback: function() {
+ headContainer.stop( true, true ).slideUp( duration, args.completeCallback );
+ }
+ });
+ } else {
+ headContainer.stop( true, true ).slideUp( duration, args.completeCallback );
+ }
+ }
+ },
+
+ /**
+ * @since 4.1.0
+ *
+ * @params {Boolean} active
+ * @param {Object} [params]
+ * @returns {Boolean} false if state already applied
+ */
+ _toggleActive: function ( active, params ) {
+ var self = this;
+ params = params || {};
+ if ( ( active && this.active.get() ) || ( ! active && ! this.active.get() ) ) {
+ params.unchanged = true;
+ self.onChangeActive( self.active.get(), params );
+ return false;
+ } else {
+ params.unchanged = false;
+ this.activeArgumentsQueue.push( params );
+ this.active.set( active );
+ return true;
+ }
+ },
+
+ /**
+ * @param {Object} [params]
+ * @returns {Boolean} false if already active
+ */
+ activate: function ( params ) {
+ return this._toggleActive( true, params );
+ },
+
+ /**
+ * @param {Object} [params]
+ * @returns {Boolean} false if already inactive
+ */
+ deactivate: function ( params ) {
+ return this._toggleActive( false, params );
+ },
+
+ /**
+ * To override by subclass, update the container's UI to reflect the provided active state.
+ * @abstract
+ */
+ onChangeExpanded: function () {
+ throw new Error( 'Must override with subclass.' );
+ },
+
+ /**
+ * Handle the toggle logic for expand/collapse.
+ *
+ * @param {Boolean} expanded - The new state to apply.
+ * @param {Object} [params] - Object containing options for expand/collapse.
+ * @param {Function} [params.completeCallback] - Function to call when expansion/collapse is complete.
+ * @returns {Boolean} false if state already applied or active state is false
+ */
+ _toggleExpanded: function( expanded, params ) {
+ var instance = this, previousCompleteCallback;
+ params = params || {};
+ previousCompleteCallback = params.completeCallback;
+
+ // Short-circuit expand() if the instance is not active.
+ if ( expanded && ! instance.active() ) {
+ return false;
+ }
+
+ api.state( 'paneVisible' ).set( true );
+ params.completeCallback = function() {
+ if ( previousCompleteCallback ) {
+ previousCompleteCallback.apply( instance, arguments );
+ }
+ if ( expanded ) {
+ instance.container.trigger( 'expanded' );
+ } else {
+ instance.container.trigger( 'collapsed' );
+ }
+ };
+ if ( ( expanded && instance.expanded.get() ) || ( ! expanded && ! instance.expanded.get() ) ) {
+ params.unchanged = true;
+ instance.onChangeExpanded( instance.expanded.get(), params );
+ return false;
+ } else {
+ params.unchanged = false;
+ instance.expandedArgumentsQueue.push( params );
+ instance.expanded.set( expanded );
+ return true;
+ }
+ },
+
+ /**
+ * @param {Object} [params]
+ * @returns {Boolean} false if already expanded or if inactive.
+ */
+ expand: function ( params ) {
+ return this._toggleExpanded( true, params );
+ },
+
+ /**
+ * @param {Object} [params]
+ * @returns {Boolean} false if already collapsed.
+ */
+ collapse: function ( params ) {
+ return this._toggleExpanded( false, params );
+ },
+
+ /**
+ * Animate container state change if transitions are supported by the browser.
+ *
+ * @since 4.7.0
+ * @private
+ *
+ * @param {function} completeCallback Function to be called after transition is completed.
+ * @returns {void}
+ */
+ _animateChangeExpanded: function( completeCallback ) {
+ // Return if CSS transitions are not supported.
+ if ( ! normalizedTransitionendEventName ) {
+ if ( completeCallback ) {
+ completeCallback();
+ }
+ return;
+ }
+
+ var construct = this,
+ content = construct.contentContainer,
+ overlay = content.closest( '.wp-full-overlay' ),
+ elements, transitionEndCallback;
+
+ // Determine set of elements that are affected by the animation.
+ elements = overlay.add( content );
+ if ( _.isUndefined( construct.panel ) || '' === construct.panel() ) {
+ elements = elements.add( '#customize-info, .customize-pane-parent' );
+ }
+
+ // Handle `transitionEnd` event.
+ transitionEndCallback = function( e ) {
+ if ( 2 !== e.eventPhase || ! $( e.target ).is( content ) ) {
+ return;
+ }
+ content.off( normalizedTransitionendEventName, transitionEndCallback );
+ elements.removeClass( 'busy' );
+ if ( completeCallback ) {
+ completeCallback();
+ }
+ };
+ content.on( normalizedTransitionendEventName, transitionEndCallback );
+ elements.addClass( 'busy' );
+
+ // Prevent screen flicker when pane has been scrolled before expanding.
+ _.defer( function() {
+ var container = content.closest( '.wp-full-overlay-sidebar-content' ),
+ currentScrollTop = container.scrollTop(),
+ previousScrollTop = content.data( 'previous-scrollTop' ) || 0,
+ expanded = construct.expanded();
+
+ if ( expanded && 0 < currentScrollTop ) {
+ content.css( 'top', currentScrollTop + 'px' );
+ content.data( 'previous-scrollTop', currentScrollTop );
+ } else if ( ! expanded && 0 < currentScrollTop + previousScrollTop ) {
+ content.css( 'top', previousScrollTop - currentScrollTop + 'px' );
+ container.scrollTop( previousScrollTop );
+ }
+ } );
+ },
+
+ /**
+ * Bring the container into view and then expand this and bring it into view
+ * @param {Object} [params]
+ */
+ focus: focus,
+
+ /**
+ * Return the container html, generated from its JS template, if it exists.
+ *
+ * @since 4.3.0
+ */
+ getContainer: function () {
+ var template,
+ container = this;
+
+ if ( 0 !== $( '#tmpl-' + container.templateSelector ).length ) {
+ template = wp.template( container.templateSelector );
+ } else {
+ template = wp.template( 'customize-' + container.containerType + '-default' );
+ }
+ if ( template && container.container ) {
+ return $.trim( template( container.params ) );
+ }
+
+ return '';
+ },
+
+ /**
+ * Find content element which is displayed when the section is expanded.
+ *
+ * After a construct is initialized, the return value will be available via the `contentContainer` property.
+ * By default the element will be related it to the parent container with `aria-owns` and detached.
+ * Custom panels and sections (such as the `NewMenuSection`) that do not have a sliding pane should
+ * just return the content element without needing to add the `aria-owns` element or detach it from
+ * the container. Such non-sliding pane custom sections also need to override the `onChangeExpanded`
+ * method to handle animating the panel/section into and out of view.
+ *
+ * @since 4.7.0
+ * @access public
+ *
+ * @returns {jQuery} Detached content element.
+ */
+ getContent: function() {
+ var construct = this,
+ container = construct.container,
+ content = container.find( '.accordion-section-content, .control-panel-content' ).first(),
+ contentId = 'sub-' + container.attr( 'id' ),
+ ownedElements = contentId,
+ alreadyOwnedElements = container.attr( 'aria-owns' );
+
+ if ( alreadyOwnedElements ) {
+ ownedElements = ownedElements + ' ' + alreadyOwnedElements;
}
+ container.attr( 'aria-owns', ownedElements );
+
+ return content.detach().attr( {
+ 'id': contentId,
+ 'class': 'customize-pane-child ' + content.attr( 'class' ) + ' ' + container.attr( 'class' )
+ } );
}
});
- api.Control = api.Class.extend({
- initialize: function( id, options ) {
+ /**
+ * @since 4.1.0
+ *
+ * @class
+ * @augments wp.customize.Class
+ */
+ api.Section = Container.extend({
+ containerType: 'section',
+ defaults: {
+ title: '',
+ description: '',
+ priority: 100,
+ type: 'default',
+ content: null,
+ active: true,
+ instanceNumber: null,
+ panel: null,
+ customizeAction: ''
+ },
+
+ /**
+ * @since 4.1.0
+ *
+ * @param {string} id - The ID for the section.
+ * @param {object} options - Object containing one property: params.
+ * @param {object} options.params - Object containing the following properties.
+ * @param {string} options.params.title - Title shown when section is collapsed and expanded.
+ * @param {string=} [options.params.description] - Description shown at the top of the section.
+ * @param {number=100} [options.params.priority] - The sort priority for the section.
+ * @param {string=default} [options.params.type] - The type of the section. See wp.customize.sectionConstructor.
+ * @param {string=} [options.params.content] - The markup to be used for the section container. If empty, a JS template is used.
+ * @param {boolean=true} [options.params.active] - Whether the section is active or not.
+ * @param {string} options.params.panel - The ID for the panel this section is associated with.
+ * @param {string=} [options.params.customizeAction] - Additional context information shown before the section title when expanded.
+ */
+ initialize: function ( id, options ) {
+ var section = this;
+ Container.prototype.initialize.call( section, id, options );
+
+ section.id = id;
+ section.panel = new api.Value();
+ section.panel.bind( function ( id ) {
+ $( section.headContainer ).toggleClass( 'control-subsection', !! id );
+ });
+ section.panel.set( section.params.panel || '' );
+ api.utils.bubbleChildValueChanges( section, [ 'panel' ] );
+
+ section.embed();
+ section.deferred.embedded.done( function () {
+ section.ready();
+ });
+ },
+
+ /**
+ * Embed the container in the DOM when any parent panel is ready.
+ *
+ * @since 4.1.0
+ */
+ embed: function () {
+ var inject,
+ section = this,
+ container = $( '#customize-theme-controls' );
+
+ // Watch for changes to the panel state
+ inject = function ( panelId ) {
+ var parentContainer;
+ if ( panelId ) {
+ // The panel has been supplied, so wait until the panel object is registered
+ api.panel( panelId, function ( panel ) {
+ // The panel has been registered, wait for it to become ready/initialized
+ panel.deferred.embedded.done( function () {
+ parentContainer = panel.contentContainer;
+ if ( ! section.headContainer.parent().is( parentContainer ) ) {
+ parentContainer.append( section.headContainer );
+ }
+ if ( ! section.contentContainer.parent().is( section.headContainer ) ) {
+ container.append( section.contentContainer );
+ }
+ section.deferred.embedded.resolve();
+ });
+ } );
+ } else {
+ // There is no panel, so embed the section in the root of the customizer
+ parentContainer = $( '.customize-pane-parent' ); // @todo This should be defined elsewhere, and to be configurable
+ if ( ! section.headContainer.parent().is( parentContainer ) ) {
+ parentContainer.append( section.headContainer );
+ }
+ if ( ! section.contentContainer.parent().is( section.headContainer ) ) {
+ container.append( section.contentContainer );
+ }
+ section.deferred.embedded.resolve();
+ }
+ };
+ section.panel.bind( inject );
+ inject( section.panel.get() ); // Since a section may never get a panel, assume that it won't ever get one
+ },
+
+ /**
+ * Add behaviors for the accordion section.
+ *
+ * @since 4.1.0
+ */
+ attachEvents: function () {
+ var meta, content, section = this;
+
+ if ( section.container.hasClass( 'cannot-expand' ) ) {
+ return;
+ }
+
+ // Expand/Collapse accordion sections on click.
+ section.container.find( '.accordion-section-title, .customize-section-back' ).on( 'click keydown', function( event ) {
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
+ return;
+ }
+ event.preventDefault(); // Keep this AFTER the key filter above
+
+ if ( section.expanded() ) {
+ section.collapse();
+ } else {
+ section.expand();
+ }
+ });
+
+ // This is very similar to what is found for api.Panel.attachEvents().
+ section.container.find( '.customize-section-title .customize-help-toggle' ).on( 'click', function() {
+
+ meta = section.container.find( '.section-meta' );
+ if ( meta.hasClass( 'cannot-expand' ) ) {
+ return;
+ }
+ content = meta.find( '.customize-section-description:first' );
+ content.toggleClass( 'open' );
+ content.slideToggle();
+ content.attr( 'aria-expanded', function ( i, attr ) {
+ return 'true' === attr ? 'false' : 'true';
+ });
+ });
+ },
+
+ /**
+ * Return whether this section has any active controls.
+ *
+ * @since 4.1.0
+ *
+ * @returns {Boolean}
+ */
+ isContextuallyActive: function () {
+ var section = this,
+ controls = section.controls(),
+ activeCount = 0;
+ _( controls ).each( function ( control ) {
+ if ( control.active() ) {
+ activeCount += 1;
+ }
+ } );
+ return ( activeCount !== 0 );
+ },
+
+ /**
+ * Get the controls that are associated with this section, sorted by their priority Value.
+ *
+ * @since 4.1.0
+ *
+ * @returns {Array}
+ */
+ controls: function () {
+ return this._children( 'section', 'control' );
+ },
+
+ /**
+ * Update UI to reflect expanded state.
+ *
+ * @since 4.1.0
+ *
+ * @param {Boolean} expanded
+ * @param {Object} args
+ */
+ onChangeExpanded: function ( expanded, args ) {
+ var section = this,
+ container = section.headContainer.closest( '.wp-full-overlay-sidebar-content' ),
+ content = section.contentContainer,
+ overlay = section.headContainer.closest( '.wp-full-overlay' ),
+ backBtn = content.find( '.customize-section-back' ),
+ sectionTitle = section.headContainer.find( '.accordion-section-title' ).first(),
+ expand;
+
+ if ( expanded && ! content.hasClass( 'open' ) ) {
+
+ if ( args.unchanged ) {
+ expand = args.completeCallback;
+ } else {
+ expand = $.proxy( function() {
+ section._animateChangeExpanded( function() {
+ sectionTitle.attr( 'tabindex', '-1' );
+ backBtn.attr( 'tabindex', '0' );
+
+ backBtn.focus();
+ content.css( 'top', '' );
+ container.scrollTop( 0 );
+
+ if ( args.completeCallback ) {
+ args.completeCallback();
+ }
+ } );
+
+ content.addClass( 'open' );
+ overlay.addClass( 'section-open' );
+ api.state( 'expandedSection' ).set( section );
+ }, this );
+ }
+
+ if ( ! args.allowMultiple ) {
+ api.section.each( function ( otherSection ) {
+ if ( otherSection !== section ) {
+ otherSection.collapse( { duration: args.duration } );
+ }
+ });
+ }
+
+ if ( section.panel() ) {
+ api.panel( section.panel() ).expand({
+ duration: args.duration,
+ completeCallback: expand
+ });
+ } else {
+ api.panel.each( function( panel ) {
+ panel.collapse();
+ });
+ expand();
+ }
+
+ } else if ( ! expanded && content.hasClass( 'open' ) ) {
+ section._animateChangeExpanded( function() {
+ backBtn.attr( 'tabindex', '-1' );
+ sectionTitle.attr( 'tabindex', '0' );
+
+ sectionTitle.focus();
+ content.css( 'top', '' );
+
+ if ( args.completeCallback ) {
+ args.completeCallback();
+ }
+ } );
+
+ content.removeClass( 'open' );
+ overlay.removeClass( 'section-open' );
+ if ( section === api.state( 'expandedSection' ).get() ) {
+ api.state( 'expandedSection' ).set( false );
+ }
+
+ } else {
+ if ( args.completeCallback ) {
+ args.completeCallback();
+ }
+ }
+ }
+ });
+
+ /**
+ * wp.customize.ThemesSection
+ *
+ * Custom section for themes that functions similarly to a backwards panel,
+ * and also handles the theme-details view rendering and navigation.
+ *
+ * @constructor
+ * @augments wp.customize.Section
+ * @augments wp.customize.Container
+ */
+ api.ThemesSection = api.Section.extend({
+ currentTheme: '',
+ overlay: '',
+ template: '',
+ screenshotQueue: null,
+ $window: $( window ),
+
+ /**
+ * @since 4.2.0
+ */
+ initialize: function () {
+ this.$customizeSidebar = $( '.wp-full-overlay-sidebar-content:first' );
+ return api.Section.prototype.initialize.apply( this, arguments );
+ },
+
+ /**
+ * @since 4.2.0
+ */
+ ready: function () {
+ var section = this;
+ section.overlay = section.container.find( '.theme-overlay' );
+ section.template = wp.template( 'customize-themes-details-view' );
+
+ // Bind global keyboard events.
+ section.container.on( 'keydown', function( event ) {
+ if ( ! section.overlay.find( '.theme-wrap' ).is( ':visible' ) ) {
+ return;
+ }
+
+ // Pressing the right arrow key fires a theme:next event
+ if ( 39 === event.keyCode ) {
+ section.nextTheme();
+ }
+
+ // Pressing the left arrow key fires a theme:previous event
+ if ( 37 === event.keyCode ) {
+ section.previousTheme();
+ }
+
+ // Pressing the escape key fires a theme:collapse event
+ if ( 27 === event.keyCode ) {
+ section.closeDetails();
+ event.stopPropagation(); // Prevent section from being collapsed.
+ }
+ });
+
+ _.bindAll( this, 'renderScreenshots' );
+ },
+
+ /**
+ * Override Section.isContextuallyActive method.
+ *
+ * Ignore the active states' of the contained theme controls, and just
+ * use the section's own active state instead. This ensures empty search
+ * results for themes to cause the section to become inactive.
+ *
+ * @since 4.2.0
+ *
+ * @returns {Boolean}
+ */
+ isContextuallyActive: function () {
+ return this.active();
+ },
+
+ /**
+ * @since 4.2.0
+ */
+ attachEvents: function () {
+ var section = this;
+
+ // Expand/Collapse section/panel.
+ section.container.find( '.change-theme, .customize-theme' ).on( 'click keydown', function( event ) {
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
+ return;
+ }
+ event.preventDefault(); // Keep this AFTER the key filter above
+
+ if ( section.expanded() ) {
+ section.collapse();
+ } else {
+ section.expand();
+ }
+ });
+
+ // Theme navigation in details view.
+ section.container.on( 'click keydown', '.left', function( event ) {
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
+ return;
+ }
+
+ event.preventDefault(); // Keep this AFTER the key filter above
+
+ section.previousTheme();
+ });
+
+ section.container.on( 'click keydown', '.right', function( event ) {
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
+ return;
+ }
+
+ event.preventDefault(); // Keep this AFTER the key filter above
+
+ section.nextTheme();
+ });
+
+ section.container.on( 'click keydown', '.theme-backdrop, .close', function( event ) {
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
+ return;
+ }
+
+ event.preventDefault(); // Keep this AFTER the key filter above
+
+ section.closeDetails();
+ });
+
+ var renderScreenshots = _.throttle( _.bind( section.renderScreenshots, this ), 100 );
+ section.container.on( 'input', '#themes-filter', function( event ) {
+ var count,
+ term = event.currentTarget.value.toLowerCase().trim().replace( '-', ' ' ),
+ controls = section.controls();
+
+ _.each( controls, function( control ) {
+ control.filter( term );
+ });
+
+ renderScreenshots();
+
+ // Update theme count.
+ count = section.container.find( 'li.customize-control:visible' ).length;
+ section.container.find( '.theme-count' ).text( count );
+ });
+
+ // Pre-load the first 3 theme screenshots.
+ api.bind( 'ready', function () {
+ _.each( section.controls().slice( 0, 3 ), function ( control ) {
+ var img, src = control.params.theme.screenshot[0];
+ if ( src ) {
+ img = new Image();
+ img.src = src;
+ }
+ });
+ });
+ },
+
+ /**
+ * Update UI to reflect expanded state
+ *
+ * @since 4.2.0
+ *
+ * @param {Boolean} expanded
+ * @param {Object} args
+ * @param {Boolean} args.unchanged
+ * @param {Callback} args.completeCallback
+ */
+ onChangeExpanded: function ( expanded, args ) {
+
+ // Immediately call the complete callback if there were no changes
+ if ( args.unchanged ) {
+ if ( args.completeCallback ) {
+ args.completeCallback();
+ }
+ return;
+ }
+
+ // Note: there is a second argument 'args' passed
+ var panel = this,
+ section = panel.contentContainer,
+ overlay = section.closest( '.wp-full-overlay' ),
+ container = section.closest( '.wp-full-overlay-sidebar-content' ),
+ customizeBtn = section.find( '.customize-theme' ),
+ changeBtn = panel.headContainer.find( '.change-theme' );
+
+ if ( expanded && ! section.hasClass( 'current-panel' ) ) {
+ // Collapse any sibling sections/panels
+ api.section.each( function ( otherSection ) {
+ if ( otherSection !== panel ) {
+ otherSection.collapse( { duration: args.duration } );
+ }
+ });
+ api.panel.each( function ( otherPanel ) {
+ otherPanel.collapse( { duration: 0 } );
+ });
+
+ panel._animateChangeExpanded( function() {
+ changeBtn.attr( 'tabindex', '-1' );
+ customizeBtn.attr( 'tabindex', '0' );
+
+ customizeBtn.focus();
+ section.css( 'top', '' );
+ container.scrollTop( 0 );
+
+ if ( args.completeCallback ) {
+ args.completeCallback();
+ }
+ } );
+
+ overlay.addClass( 'in-themes-panel' );
+ section.addClass( 'current-panel' );
+ _.delay( panel.renderScreenshots, 10 ); // Wait for the controls
+ panel.$customizeSidebar.on( 'scroll.customize-themes-section', _.throttle( panel.renderScreenshots, 300 ) );
+
+ } else if ( ! expanded && section.hasClass( 'current-panel' ) ) {
+ panel._animateChangeExpanded( function() {
+ changeBtn.attr( 'tabindex', '0' );
+ customizeBtn.attr( 'tabindex', '-1' );
+
+ changeBtn.focus();
+ section.css( 'top', '' );
+
+ if ( args.completeCallback ) {
+ args.completeCallback();
+ }
+ } );
+
+ overlay.removeClass( 'in-themes-panel' );
+ section.removeClass( 'current-panel' );
+ panel.$customizeSidebar.off( 'scroll.customize-themes-section' );
+ }
+ },
+
+ /**
+ * Render control's screenshot if the control comes into view.
+ *
+ * @since 4.2.0
+ */
+ renderScreenshots: function( ) {
+ var section = this;
+
+ // Fill queue initially.
+ if ( section.screenshotQueue === null ) {
+ section.screenshotQueue = section.controls();
+ }
+
+ // Are all screenshots rendered?
+ if ( ! section.screenshotQueue.length ) {
+ return;
+ }
+
+ section.screenshotQueue = _.filter( section.screenshotQueue, function( control ) {
+ var $imageWrapper = control.container.find( '.theme-screenshot' ),
+ $image = $imageWrapper.find( 'img' );
+
+ if ( ! $image.length ) {
+ return false;
+ }
+
+ if ( $image.is( ':hidden' ) ) {
+ return true;
+ }
+
+ // Based on unveil.js.
+ var wt = section.$window.scrollTop(),
+ wb = wt + section.$window.height(),
+ et = $image.offset().top,
+ ih = $imageWrapper.height(),
+ eb = et + ih,
+ threshold = ih * 3,
+ inView = eb >= wt - threshold && et <= wb + threshold;
+
+ if ( inView ) {
+ control.container.trigger( 'render-screenshot' );
+ }
+
+ // If the image is in view return false so it's cleared from the queue.
+ return ! inView;
+ } );
+ },
+
+ /**
+ * Advance the modal to the next theme.
+ *
+ * @since 4.2.0
+ */
+ nextTheme: function () {
+ var section = this;
+ if ( section.getNextTheme() ) {
+ section.showDetails( section.getNextTheme(), function() {
+ section.overlay.find( '.right' ).focus();
+ } );
+ }
+ },
+
+ /**
+ * Get the next theme model.
+ *
+ * @since 4.2.0
+ */
+ getNextTheme: function () {
+ var control, next;
+ control = api.control( 'theme_' + this.currentTheme );
+ next = control.container.next( 'li.customize-control-theme' );
+ if ( ! next.length ) {
+ return false;
+ }
+ next = next[0].id.replace( 'customize-control-', '' );
+ control = api.control( next );
+
+ return control.params.theme;
+ },
+
+ /**
+ * Advance the modal to the previous theme.
+ *
+ * @since 4.2.0
+ */
+ previousTheme: function () {
+ var section = this;
+ if ( section.getPreviousTheme() ) {
+ section.showDetails( section.getPreviousTheme(), function() {
+ section.overlay.find( '.left' ).focus();
+ } );
+ }
+ },
+
+ /**
+ * Get the previous theme model.
+ *
+ * @since 4.2.0
+ */
+ getPreviousTheme: function () {
+ var control, previous;
+ control = api.control( 'theme_' + this.currentTheme );
+ previous = control.container.prev( 'li.customize-control-theme' );
+ if ( ! previous.length ) {
+ return false;
+ }
+ previous = previous[0].id.replace( 'customize-control-', '' );
+ control = api.control( previous );
+
+ return control.params.theme;
+ },
+
+ /**
+ * Disable buttons when we're viewing the first or last theme.
+ *
+ * @since 4.2.0
+ */
+ updateLimits: function () {
+ if ( ! this.getNextTheme() ) {
+ this.overlay.find( '.right' ).addClass( 'disabled' );
+ }
+ if ( ! this.getPreviousTheme() ) {
+ this.overlay.find( '.left' ).addClass( 'disabled' );
+ }
+ },
+
+ /**
+ * Load theme preview.
+ *
+ * @since 4.7.0
+ * @access public
+ *
+ * @param {string} themeId Theme ID.
+ * @returns {jQuery.promise} Promise.
+ */
+ loadThemePreview: function( themeId ) {
+ var deferred = $.Deferred(), onceProcessingComplete, overlay, urlParser;
+
+ urlParser = document.createElement( 'a' );
+ urlParser.href = location.href;
+ urlParser.search = $.param( _.extend(
+ api.utils.parseQueryString( urlParser.search.substr( 1 ) ),
+ {
+ theme: themeId,
+ changeset_uuid: api.settings.changeset.uuid
+ }
+ ) );
+
+ overlay = $( '.wp-full-overlay' );
+ overlay.addClass( 'customize-loading' );
+
+ onceProcessingComplete = function() {
+ var request;
+ if ( api.state( 'processing' ).get() > 0 ) {
+ return;
+ }
+
+ api.state( 'processing' ).unbind( onceProcessingComplete );
+
+ request = api.requestChangesetUpdate();
+ request.done( function() {
+ $( window ).off( 'beforeunload.customize-confirm' );
+ top.location.href = urlParser.href;
+ deferred.resolve();
+ } );
+ request.fail( function() {
+ overlay.removeClass( 'customize-loading' );
+ deferred.reject();
+ } );
+ };
+
+ if ( 0 === api.state( 'processing' ).get() ) {
+ onceProcessingComplete();
+ } else {
+ api.state( 'processing' ).bind( onceProcessingComplete );
+ }
+
+ return deferred.promise();
+ },
+
+ /**
+ * Render & show the theme details for a given theme model.
+ *
+ * @since 4.2.0
+ *
+ * @param {Object} theme
+ */
+ showDetails: function ( theme, callback ) {
+ var section = this, link;
+ callback = callback || function(){};
+ section.currentTheme = theme.id;
+ section.overlay.html( section.template( theme ) )
+ .fadeIn( 'fast' )
+ .focus();
+ $( 'body' ).addClass( 'modal-open' );
+ section.containFocus( section.overlay );
+ section.updateLimits();
+
+ link = section.overlay.find( '.inactive-theme > a' );
+
+ link.on( 'click', function( event ) {
+ event.preventDefault();
+
+ // Short-circuit if request is currently being made.
+ if ( link.hasClass( 'disabled' ) ) {
+ return;
+ }
+ link.addClass( 'disabled' );
+
+ section.loadThemePreview( theme.id ).fail( function() {
+ link.removeClass( 'disabled' );
+ } );
+ } );
+ callback();
+ },
+
+ /**
+ * Close the theme details modal.
+ *
+ * @since 4.2.0
+ */
+ closeDetails: function () {
+ $( 'body' ).removeClass( 'modal-open' );
+ this.overlay.fadeOut( 'fast' );
+ api.control( 'theme_' + this.currentTheme ).focus();
+ },
+
+ /**
+ * Keep tab focus within the theme details modal.
+ *
+ * @since 4.2.0
+ */
+ containFocus: function( el ) {
+ var tabbables;
+
+ el.on( 'keydown', function( event ) {
+
+ // Return if it's not the tab key
+ // When navigating with prev/next focus is already handled
+ if ( 9 !== event.keyCode ) {
+ return;
+ }
+
+ // uses jQuery UI to get the tabbable elements
+ tabbables = $( ':tabbable', el );
+
+ // Keep focus within the overlay
+ if ( tabbables.last()[0] === event.target && ! event.shiftKey ) {
+ tabbables.first().focus();
+ return false;
+ } else if ( tabbables.first()[0] === event.target && event.shiftKey ) {
+ tabbables.last().focus();
+ return false;
+ }
+ });
+ }
+ });
+
+ /**
+ * @since 4.1.0
+ *
+ * @class
+ * @augments wp.customize.Class
+ */
+ api.Panel = Container.extend({
+ containerType: 'panel',
+
+ /**
+ * @since 4.1.0
+ *
+ * @param {string} id - The ID for the panel.
+ * @param {object} options - Object containing one property: params.
+ * @param {object} options.params - Object containing the following properties.
+ * @param {string} options.params.title - Title shown when panel is collapsed and expanded.
+ * @param {string=} [options.params.description] - Description shown at the top of the panel.
+ * @param {number=100} [options.params.priority] - The sort priority for the panel.
+ * @param {string=default} [options.params.type] - The type of the panel. See wp.customize.panelConstructor.
+ * @param {string=} [options.params.content] - The markup to be used for the panel container. If empty, a JS template is used.
+ * @param {boolean=true} [options.params.active] - Whether the panel is active or not.
+ */
+ initialize: function ( id, options ) {
+ var panel = this;
+ Container.prototype.initialize.call( panel, id, options );
+ panel.embed();
+ panel.deferred.embedded.done( function () {
+ panel.ready();
+ });
+ },
+
+ /**
+ * Embed the container in the DOM when any parent panel is ready.
+ *
+ * @since 4.1.0
+ */
+ embed: function () {
+ var panel = this,
+ container = $( '#customize-theme-controls' ),
+ parentContainer = $( '.customize-pane-parent' ); // @todo This should be defined elsewhere, and to be configurable
+
+ if ( ! panel.headContainer.parent().is( parentContainer ) ) {
+ parentContainer.append( panel.headContainer );
+ }
+ if ( ! panel.contentContainer.parent().is( panel.headContainer ) ) {
+ container.append( panel.contentContainer );
+ panel.renderContent();
+ }
+
+ panel.deferred.embedded.resolve();
+ },
+
+ /**
+ * @since 4.1.0
+ */
+ attachEvents: function () {
+ var meta, panel = this;
+
+ // Expand/Collapse accordion sections on click.
+ panel.headContainer.find( '.accordion-section-title' ).on( 'click keydown', function( event ) {
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
+ return;
+ }
+ event.preventDefault(); // Keep this AFTER the key filter above
+
+ if ( ! panel.expanded() ) {
+ panel.expand();
+ }
+ });
+
+ // Close panel.
+ panel.container.find( '.customize-panel-back' ).on( 'click keydown', function( event ) {
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
+ return;
+ }
+ event.preventDefault(); // Keep this AFTER the key filter above
+
+ if ( panel.expanded() ) {
+ panel.collapse();
+ }
+ });
+
+ meta = panel.container.find( '.panel-meta:first' );
+
+ meta.find( '> .accordion-section-title .customize-help-toggle' ).on( 'click keydown', function( event ) {
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
+ return;
+ }
+ event.preventDefault(); // Keep this AFTER the key filter above
+
+ if ( meta.hasClass( 'cannot-expand' ) ) {
+ return;
+ }
+
+ var content = meta.find( '.customize-panel-description:first' );
+ if ( meta.hasClass( 'open' ) ) {
+ meta.toggleClass( 'open' );
+ content.slideUp( panel.defaultExpandedArguments.duration );
+ $( this ).attr( 'aria-expanded', false );
+ } else {
+ content.slideDown( panel.defaultExpandedArguments.duration );
+ meta.toggleClass( 'open' );
+ $( this ).attr( 'aria-expanded', true );
+ }
+ });
+
+ },
+
+ /**
+ * Get the sections that are associated with this panel, sorted by their priority Value.
+ *
+ * @since 4.1.0
+ *
+ * @returns {Array}
+ */
+ sections: function () {
+ return this._children( 'panel', 'section' );
+ },
+
+ /**
+ * Return whether this panel has any active sections.
+ *
+ * @since 4.1.0
+ *
+ * @returns {boolean}
+ */
+ isContextuallyActive: function () {
+ var panel = this,
+ sections = panel.sections(),
+ activeCount = 0;
+ _( sections ).each( function ( section ) {
+ if ( section.active() && section.isContextuallyActive() ) {
+ activeCount += 1;
+ }
+ } );
+ return ( activeCount !== 0 );
+ },
+
+ /**
+ * Update UI to reflect expanded state
+ *
+ * @since 4.1.0
+ *
+ * @param {Boolean} expanded
+ * @param {Object} args
+ * @param {Boolean} args.unchanged
+ * @param {Function} args.completeCallback
+ */
+ onChangeExpanded: function ( expanded, args ) {
+
+ // Immediately call the complete callback if there were no changes
+ if ( args.unchanged ) {
+ if ( args.completeCallback ) {
+ args.completeCallback();
+ }
+ return;
+ }
+
+ // Note: there is a second argument 'args' passed
+ var panel = this,
+ accordionSection = panel.contentContainer,
+ overlay = accordionSection.closest( '.wp-full-overlay' ),
+ container = accordionSection.closest( '.wp-full-overlay-sidebar-content' ),
+ topPanel = panel.headContainer.find( '.accordion-section-title' ),
+ backBtn = accordionSection.find( '.customize-panel-back' );
+
+ if ( expanded && ! accordionSection.hasClass( 'current-panel' ) ) {
+ // Collapse any sibling sections/panels
+ api.section.each( function ( section ) {
+ if ( panel.id !== section.panel() ) {
+ section.collapse( { duration: 0 } );
+ }
+ });
+ api.panel.each( function ( otherPanel ) {
+ if ( panel !== otherPanel ) {
+ otherPanel.collapse( { duration: 0 } );
+ }
+ });
+
+ panel._animateChangeExpanded( function() {
+ topPanel.attr( 'tabindex', '-1' );
+ backBtn.attr( 'tabindex', '0' );
+
+ backBtn.focus();
+ accordionSection.css( 'top', '' );
+ container.scrollTop( 0 );
+
+ if ( args.completeCallback ) {
+ args.completeCallback();
+ }
+ } );
+
+ overlay.addClass( 'in-sub-panel' );
+ accordionSection.addClass( 'current-panel' );
+ api.state( 'expandedPanel' ).set( panel );
+
+ } else if ( ! expanded && accordionSection.hasClass( 'current-panel' ) ) {
+ panel._animateChangeExpanded( function() {
+ topPanel.attr( 'tabindex', '0' );
+ backBtn.attr( 'tabindex', '-1' );
+
+ topPanel.focus();
+ accordionSection.css( 'top', '' );
+
+ if ( args.completeCallback ) {
+ args.completeCallback();
+ }
+ } );
+
+ overlay.removeClass( 'in-sub-panel' );
+ accordionSection.removeClass( 'current-panel' );
+ if ( panel === api.state( 'expandedPanel' ).get() ) {
+ api.state( 'expandedPanel' ).set( false );
+ }
+ }
+ },
+
+ /**
+ * Render the panel from its JS template, if it exists.
+ *
+ * The panel's container must already exist in the DOM.
+ *
+ * @since 4.3.0
+ */
+ renderContent: function () {
+ var template,
+ panel = this;
+
+ // Add the content to the container.
+ if ( 0 !== $( '#tmpl-' + panel.templateSelector + '-content' ).length ) {
+ template = wp.template( panel.templateSelector + '-content' );
+ } else {
+ template = wp.template( 'customize-panel-default-content' );
+ }
+ if ( template && panel.headContainer ) {
+ panel.contentContainer.html( template( panel.params ) );
+ }
+ }
+ });
+
+ /**
+ * A Customizer Control.
+ *
+ * A control provides a UI element that allows a user to modify a Customizer Setting.
+ *
+ * @see PHP class WP_Customize_Control.
+ *
+ * @class
+ * @augments wp.customize.Class
+ *
+ * @param {string} id Unique identifier for the control instance.
+ * @param {object} options Options hash for the control instance.
+ * @param {object} options.params
+ * @param {object} options.params.type Type of control (e.g. text, radio, dropdown-pages, etc.)
+ * @param {string} options.params.content The HTML content for the control.
+ * @param {string} options.params.priority Order of priority to show the control within the section.
+ * @param {string} options.params.active
+ * @param {string} options.params.section The ID of the section the control belongs to.
+ * @param {string} options.params.settings.default The ID of the setting the control relates to.
+ * @param {string} options.params.settings.data
+ * @param {string} options.params.label
+ * @param {string} options.params.description
+ * @param {string} options.params.instanceNumber Order in which this instance was created in relation to other instances.
+ */
+ api.Control = api.Class.extend({
+ defaultActiveArguments: { duration: 'fast', completeCallback: $.noop },
+
+ initialize: function( id, options ) {
+ var control = this,
+ nodes, radios, settings;
+
+ control.params = {};
+ $.extend( control, options || {} );
+ control.id = id;
+ control.selector = '#customize-control-' + id.replace( /\]/g, '' ).replace( /\[/g, '-' );
+ control.templateSelector = 'customize-control-' + control.params.type + '-content';
+ control.container = control.params.content ? $( control.params.content ) : $( control.selector );
+
+ control.deferred = {
+ embedded: new $.Deferred()
+ };
+ control.section = new api.Value();
+ control.priority = new api.Value();
+ control.active = new api.Value();
+ control.activeArgumentsQueue = [];
+ control.notifications = new api.Values({ defaultConstructor: api.Notification });
+
+ control.elements = [];
+
+ nodes = control.container.find('[data-customize-setting-link]');
+ radios = {};
+
+ nodes.each( function() {
+ var node = $( this ),
+ name;
+
+ if ( node.is( ':radio' ) ) {
+ name = node.prop( 'name' );
+ if ( radios[ name ] ) {
+ return;
+ }
+
+ radios[ name ] = true;
+ node = nodes.filter( '[name="' + name + '"]' );
+ }
+
+ api( node.data( 'customizeSettingLink' ), function( setting ) {
+ var element = new api.Element( node );
+ control.elements.push( element );
+ element.sync( setting );
+ element.set( setting() );
+ });
+ });
+
+ control.active.bind( function ( active ) {
+ var args = control.activeArgumentsQueue.shift();
+ args = $.extend( {}, control.defaultActiveArguments, args );
+ control.onChangeActive( active, args );
+ } );
+
+ control.section.set( control.params.section );
+ control.priority.set( isNaN( control.params.priority ) ? 10 : control.params.priority );
+ control.active.set( control.params.active );
+
+ api.utils.bubbleChildValueChanges( control, [ 'section', 'priority', 'active' ] );
+
+ /*
+ * After all settings related to the control are available,
+ * make them available on the control and embed the control into the page.
+ */
+ settings = $.map( control.params.settings, function( value ) {
+ return value;
+ });
+
+ if ( 0 === settings.length ) {
+ control.setting = null;
+ control.settings = {};
+ control.embed();
+ } else {
+ api.apply( api, settings.concat( function() {
+ var key;
+
+ control.settings = {};
+ for ( key in control.params.settings ) {
+ control.settings[ key ] = api( control.params.settings[ key ] );
+ }
+
+ control.setting = control.settings['default'] || null;
+
+ // Add setting notifications to the control notification.
+ _.each( control.settings, function( setting ) {
+ setting.notifications.bind( 'add', function( settingNotification ) {
+ var controlNotification, code, params;
+ code = setting.id + ':' + settingNotification.code;
+ params = _.extend(
+ {},
+ settingNotification,
+ {
+ setting: setting.id
+ }
+ );
+ controlNotification = new api.Notification( code, params );
+ control.notifications.add( controlNotification.code, controlNotification );
+ } );
+ setting.notifications.bind( 'remove', function( settingNotification ) {
+ control.notifications.remove( setting.id + ':' + settingNotification.code );
+ } );
+ } );
+
+ control.embed();
+ }) );
+ }
+
+ // After the control is embedded on the page, invoke the "ready" method.
+ control.deferred.embedded.done( function () {
+ /*
+ * Note that this debounced/deferred rendering is needed for two reasons:
+ * 1) The 'remove' event is triggered just _before_ the notification is actually removed.
+ * 2) Improve performance when adding/removing multiple notifications at a time.
+ */
+ var debouncedRenderNotifications = _.debounce( function renderNotifications() {
+ control.renderNotifications();
+ } );
+ control.notifications.bind( 'add', function( notification ) {
+ wp.a11y.speak( notification.message, 'assertive' );
+ debouncedRenderNotifications();
+ } );
+ control.notifications.bind( 'remove', debouncedRenderNotifications );
+ control.renderNotifications();
+
+ control.ready();
+ });
+ },
+
+ /**
+ * Embed the control into the page.
+ */
+ embed: function () {
var control = this,
- nodes, radios, settings;
+ inject;
- this.params = {};
- $.extend( this, options || {} );
+ // Watch for changes to the section state
+ inject = function ( sectionId ) {
+ var parentContainer;
+ if ( ! sectionId ) { // @todo allow a control to be embedded without a section, for instance a control embedded in the front end.
+ return;
+ }
+ // Wait for the section to be registered
+ api.section( sectionId, function ( section ) {
+ // Wait for the section to be ready/initialized
+ section.deferred.embedded.done( function () {
+ parentContainer = ( section.contentContainer.is( 'ul' ) ) ? section.contentContainer : section.contentContainer.find( 'ul:first' );
+ if ( ! control.container.parent().is( parentContainer ) ) {
+ parentContainer.append( control.container );
+ control.renderContent();
+ }
+ control.deferred.embedded.resolve();
+ });
+ });
+ };
+ control.section.bind( inject );
+ inject( control.section.get() );
+ },
- this.id = id;
- this.selector = '#customize-control-' + id.replace( /\]/g, '' ).replace( /\[/g, '-' );
- this.container = $( this.selector );
+ /**
+ * Triggered when the control's markup has been injected into the DOM.
+ *
+ * @returns {void}
+ */
+ ready: function() {
+ var control = this, newItem;
+ if ( 'dropdown-pages' === control.params.type && control.params.allow_addition ) {
+ newItem = control.container.find( '.new-content-item' );
+ newItem.hide(); // Hide in JS to preserve flex display when showing.
+ control.container.on( 'click', '.add-new-toggle', function( e ) {
+ $( e.currentTarget ).slideUp( 180 );
+ newItem.slideDown( 180 );
+ newItem.find( '.create-item-input' ).focus();
+ });
+ control.container.on( 'click', '.add-content', function() {
+ control.addNewPage();
+ });
+ control.container.on( 'keyup', '.create-item-input', function( e ) {
+ if ( 13 === e.which ) { // Enter
+ control.addNewPage();
+ }
+ });
+ }
+ },
- settings = $.map( this.params.settings, function( value ) {
- return value;
- });
+ /**
+ * Get the element inside of a control's container that contains the validation error message.
+ *
+ * Control subclasses may override this to return the proper container to render notifications into.
+ * Injects the notification container for existing controls that lack the necessary container,
+ * including special handling for nav menu items and widgets.
+ *
+ * @since 4.6.0
+ * @returns {jQuery} Setting validation message element.
+ * @this {wp.customize.Control}
+ */
+ getNotificationsContainerElement: function() {
+ var control = this, controlTitle, notificationsContainer;
- api.apply( api, settings.concat( function() {
- var key;
+ notificationsContainer = control.container.find( '.customize-control-notifications-container:first' );
+ if ( notificationsContainer.length ) {
+ return notificationsContainer;
+ }
- control.settings = {};
- for ( key in control.params.settings ) {
- control.settings[ key ] = api( control.params.settings[ key ] );
+ notificationsContainer = $( '' );
+
+ if ( control.container.hasClass( 'customize-control-nav_menu_item' ) ) {
+ control.container.find( '.menu-item-settings:first' ).prepend( notificationsContainer );
+ } else if ( control.container.hasClass( 'customize-control-widget_form' ) ) {
+ control.container.find( '.widget-inside:first' ).prepend( notificationsContainer );
+ } else {
+ controlTitle = control.container.find( '.customize-control-title' );
+ if ( controlTitle.length ) {
+ controlTitle.after( notificationsContainer );
+ } else {
+ control.container.prepend( notificationsContainer );
}
+ }
+ return notificationsContainer;
+ },
- control.setting = control.settings['default'] || null;
- control.ready();
- }) );
+ /**
+ * Render notifications.
+ *
+ * Renders the `control.notifications` into the control's container.
+ * Control subclasses may override this method to do their own handling
+ * of rendering notifications.
+ *
+ * @since 4.6.0
+ * @this {wp.customize.Control}
+ */
+ renderNotifications: function() {
+ var control = this, container, notifications, hasError = false;
+ container = control.getNotificationsContainerElement();
+ if ( ! container || ! container.length ) {
+ return;
+ }
+ notifications = [];
+ control.notifications.each( function( notification ) {
+ notifications.push( notification );
+ if ( 'error' === notification.type ) {
+ hasError = true;
+ }
+ } );
- control.elements = [];
+ if ( 0 === notifications.length ) {
+ container.stop().slideUp( 'fast' );
+ } else {
+ container.stop().slideDown( 'fast', null, function() {
+ $( this ).css( 'height', 'auto' );
+ } );
+ }
- nodes = this.container.find('[data-customize-setting-link]');
- radios = {};
+ if ( ! control.notificationsTemplate ) {
+ control.notificationsTemplate = wp.template( 'customize-control-notifications' );
+ }
- nodes.each( function() {
- var node = $(this),
- name;
+ control.container.toggleClass( 'has-notifications', 0 !== notifications.length );
+ control.container.toggleClass( 'has-error', hasError );
+ container.empty().append( $.trim(
+ control.notificationsTemplate( { notifications: notifications, altNotice: Boolean( control.altNotice ) } )
+ ) );
+ },
- if ( node.is(':radio') ) {
- name = node.prop('name');
- if ( radios[ name ] )
- return;
+ /**
+ * Normal controls do not expand, so just expand its parent
+ *
+ * @param {Object} [params]
+ */
+ expand: function ( params ) {
+ api.section( this.section() ).expand( params );
+ },
- radios[ name ] = true;
- node = nodes.filter( '[name="' + name + '"]' );
+ /**
+ * Bring the containing section and panel into view and then
+ * this control into view, focusing on the first input.
+ */
+ focus: focus,
+
+ /**
+ * Update UI in response to a change in the control's active state.
+ * This does not change the active state, it merely handles the behavior
+ * for when it does change.
+ *
+ * @since 4.1.0
+ *
+ * @param {Boolean} active
+ * @param {Object} args
+ * @param {Number} args.duration
+ * @param {Callback} args.completeCallback
+ */
+ onChangeActive: function ( active, args ) {
+ if ( args.unchanged ) {
+ if ( args.completeCallback ) {
+ args.completeCallback();
}
+ return;
+ }
- api( node.data('customizeSettingLink'), function( setting ) {
- var element = new api.Element( node );
- control.elements.push( element );
- element.sync( setting );
- element.set( setting() );
- });
- });
+ if ( ! $.contains( document, this.container[0] ) ) {
+ // jQuery.fn.slideUp is not hiding an element if it is not in the DOM
+ this.container.toggle( active );
+ if ( args.completeCallback ) {
+ args.completeCallback();
+ }
+ } else if ( active ) {
+ this.container.slideDown( args.duration, args.completeCallback );
+ } else {
+ this.container.slideUp( args.duration, args.completeCallback );
+ }
},
- ready: function() {},
+ /**
+ * @deprecated 4.1.0 Use this.onChangeActive() instead.
+ */
+ toggle: function ( active ) {
+ return this.onChangeActive( active, this.defaultActiveArguments );
+ },
+
+ /**
+ * Shorthand way to enable the active state.
+ *
+ * @since 4.1.0
+ *
+ * @param {Object} [params]
+ * @returns {Boolean} false if already active
+ */
+ activate: Container.prototype.activate,
+
+ /**
+ * Shorthand way to disable the active state.
+ *
+ * @since 4.1.0
+ *
+ * @param {Object} [params]
+ * @returns {Boolean} false if already inactive
+ */
+ deactivate: Container.prototype.deactivate,
+
+ /**
+ * Re-use _toggleActive from Container class.
+ *
+ * @access private
+ */
+ _toggleActive: Container.prototype._toggleActive,
dropdownInit: function() {
var control = this,
@@ -97,247 +2182,901 @@
// Support the .dropdown class to open/close complex elements
this.container.on( 'click keydown', '.dropdown', function( event ) {
- if ( event.type === 'keydown' && 13 !== event.which ) // enter
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
return;
+ }
event.preventDefault();
if (!toggleFreeze)
control.container.toggleClass('open');
- if ( control.container.hasClass('open') )
- control.container.parent().parent().find('li.library-selected').focus();
+ if ( control.container.hasClass('open') )
+ control.container.parent().parent().find('li.library-selected').focus();
+
+ // Don't want to fire focus and click at same time
+ toggleFreeze = true;
+ setTimeout(function () {
+ toggleFreeze = false;
+ }, 400);
+ });
+
+ this.setting.bind( update );
+ update( this.setting() );
+ },
+
+ /**
+ * Render the control from its JS template, if it exists.
+ *
+ * The control's container must already exist in the DOM.
+ *
+ * @since 4.1.0
+ */
+ renderContent: function () {
+ var template,
+ control = this;
+
+ // Replace the container element's content with the control.
+ if ( 0 !== $( '#tmpl-' + control.templateSelector ).length ) {
+ template = wp.template( control.templateSelector );
+ if ( template && control.container ) {
+ control.container.html( template( control.params ) );
+ }
+ }
+ },
+
+ /**
+ * Add a new page to a dropdown-pages control reusing menus code for this.
+ *
+ * @since 4.7.0
+ * @access private
+ * @returns {void}
+ */
+ addNewPage: function () {
+ var control = this, promise, toggle, container, input, title, select;
+
+ if ( 'dropdown-pages' !== control.params.type || ! control.params.allow_addition || ! api.Menus ) {
+ return;
+ }
+
+ toggle = control.container.find( '.add-new-toggle' );
+ container = control.container.find( '.new-content-item' );
+ input = control.container.find( '.create-item-input' );
+ title = input.val();
+ select = control.container.find( 'select' );
+
+ if ( ! title ) {
+ input.addClass( 'invalid' );
+ return;
+ }
+
+ input.removeClass( 'invalid' );
+ input.attr( 'disabled', 'disabled' );
+
+ // The menus functions add the page, publish when appropriate, and also add the new page to the dropdown-pages controls.
+ promise = api.Menus.insertAutoDraftPost( {
+ post_title: title,
+ post_type: 'page'
+ } );
+ promise.done( function( data ) {
+ var availableItem, $content, itemTemplate;
+
+ // Prepare the new page as an available menu item.
+ // See api.Menus.submitNew().
+ availableItem = new api.Menus.AvailableItemModel( {
+ 'id': 'post-' + data.post_id, // Used for available menu item Backbone models.
+ 'title': title,
+ 'type': 'page',
+ 'type_label': api.Menus.data.l10n.page_label,
+ 'object': 'post_type',
+ 'object_id': data.post_id,
+ 'url': data.url
+ } );
+
+ // Add the new item to the list of available menu items.
+ api.Menus.availableMenuItemsPanel.collection.add( availableItem );
+ $content = $( '#available-menu-items-post_type-page' ).find( '.available-menu-items-list' );
+ itemTemplate = wp.template( 'available-menu-item' );
+ $content.prepend( itemTemplate( availableItem.attributes ) );
+
+ // Focus the select control.
+ select.focus();
+ control.setting.set( String( data.post_id ) ); // Triggers a preview refresh and updates the setting.
+
+ // Reset the create page form.
+ container.slideUp( 180 );
+ toggle.slideDown( 180 );
+ } );
+ promise.always( function() {
+ input.val( '' ).removeAttr( 'disabled' );
+ } );
+ }
+ });
+
+ /**
+ * A colorpicker control.
+ *
+ * @class
+ * @augments wp.customize.Control
+ * @augments wp.customize.Class
+ */
+ api.ColorControl = api.Control.extend({
+ ready: function() {
+ var control = this,
+ isHueSlider = this.params.mode === 'hue',
+ updating = false,
+ picker;
+
+ if ( isHueSlider ) {
+ picker = this.container.find( '.color-picker-hue' );
+ picker.val( control.setting() ).wpColorPicker({
+ change: function( event, ui ) {
+ updating = true;
+ control.setting( ui.color.h() );
+ updating = false;
+ }
+ });
+ } else {
+ picker = this.container.find( '.color-picker-hex' );
+ picker.val( control.setting() ).wpColorPicker({
+ change: function() {
+ updating = true;
+ control.setting.set( picker.wpColorPicker( 'color' ) );
+ updating = false;
+ },
+ clear: function() {
+ updating = true;
+ control.setting.set( '' );
+ updating = false;
+ }
+ });
+ }
+
+ control.setting.bind( function ( value ) {
+ // Bail if the update came from the control itself.
+ if ( updating ) {
+ return;
+ }
+ picker.val( value );
+ picker.wpColorPicker( 'color', value );
+ } );
+
+ // Collapse color picker when hitting Esc instead of collapsing the current section.
+ control.container.on( 'keydown', function( event ) {
+ var pickerContainer;
+ if ( 27 !== event.which ) { // Esc.
+ return;
+ }
+ pickerContainer = control.container.find( '.wp-picker-container' );
+ if ( pickerContainer.hasClass( 'wp-picker-active' ) ) {
+ picker.wpColorPicker( 'close' );
+ control.container.find( '.wp-color-result' ).focus();
+ event.stopPropagation(); // Prevent section from being collapsed.
+ }
+ } );
+ }
+ });
+
+ /**
+ * A control that implements the media modal.
+ *
+ * @class
+ * @augments wp.customize.Control
+ * @augments wp.customize.Class
+ */
+ api.MediaControl = api.Control.extend({
+
+ /**
+ * When the control's DOM structure is ready,
+ * set up internal event bindings.
+ */
+ ready: function() {
+ var control = this;
+ // Shortcut so that we don't have to use _.bind every time we add a callback.
+ _.bindAll( control, 'restoreDefault', 'removeFile', 'openFrame', 'select', 'pausePlayer' );
+
+ // Bind events, with delegation to facilitate re-rendering.
+ control.container.on( 'click keydown', '.upload-button', control.openFrame );
+ control.container.on( 'click keydown', '.upload-button', control.pausePlayer );
+ control.container.on( 'click keydown', '.thumbnail-image img', control.openFrame );
+ control.container.on( 'click keydown', '.default-button', control.restoreDefault );
+ control.container.on( 'click keydown', '.remove-button', control.pausePlayer );
+ control.container.on( 'click keydown', '.remove-button', control.removeFile );
+ control.container.on( 'click keydown', '.remove-button', control.cleanupPlayer );
+
+ // Resize the player controls when it becomes visible (ie when section is expanded)
+ api.section( control.section() ).container
+ .on( 'expanded', function() {
+ if ( control.player ) {
+ control.player.setControlsSize();
+ }
+ })
+ .on( 'collapsed', function() {
+ control.pausePlayer();
+ });
+
+ /**
+ * Set attachment data and render content.
+ *
+ * Note that BackgroundImage.prototype.ready applies this ready method
+ * to itself. Since BackgroundImage is an UploadControl, the value
+ * is the attachment URL instead of the attachment ID. In this case
+ * we skip fetching the attachment data because we have no ID available,
+ * and it is the responsibility of the UploadControl to set the control's
+ * attachmentData before calling the renderContent method.
+ *
+ * @param {number|string} value Attachment
+ */
+ function setAttachmentDataAndRenderContent( value ) {
+ var hasAttachmentData = $.Deferred();
+
+ if ( control.extended( api.UploadControl ) ) {
+ hasAttachmentData.resolve();
+ } else {
+ value = parseInt( value, 10 );
+ if ( _.isNaN( value ) || value <= 0 ) {
+ delete control.params.attachment;
+ hasAttachmentData.resolve();
+ } else if ( control.params.attachment && control.params.attachment.id === value ) {
+ hasAttachmentData.resolve();
+ }
+ }
+
+ // Fetch the attachment data.
+ if ( 'pending' === hasAttachmentData.state() ) {
+ wp.media.attachment( value ).fetch().done( function() {
+ control.params.attachment = this.attributes;
+ hasAttachmentData.resolve();
+
+ // Send attachment information to the preview for possible use in `postMessage` transport.
+ wp.customize.previewer.send( control.setting.id + '-attachment-data', this.attributes );
+ } );
+ }
+
+ hasAttachmentData.done( function() {
+ control.renderContent();
+ } );
+ }
+
+ // Ensure attachment data is initially set (for dynamically-instantiated controls).
+ setAttachmentDataAndRenderContent( control.setting() );
+
+ // Update the attachment data and re-render the control when the setting changes.
+ control.setting.bind( setAttachmentDataAndRenderContent );
+ },
+
+ pausePlayer: function () {
+ this.player && this.player.pause();
+ },
+
+ cleanupPlayer: function () {
+ this.player && wp.media.mixin.removePlayer( this.player );
+ },
+
+ /**
+ * Open the media modal.
+ */
+ openFrame: function( event ) {
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
+ return;
+ }
+
+ event.preventDefault();
+
+ if ( ! this.frame ) {
+ this.initFrame();
+ }
+
+ this.frame.open();
+ },
+
+ /**
+ * Create a media modal select frame, and store it so the instance can be reused when needed.
+ */
+ initFrame: function() {
+ this.frame = wp.media({
+ button: {
+ text: this.params.button_labels.frame_button
+ },
+ states: [
+ new wp.media.controller.Library({
+ title: this.params.button_labels.frame_title,
+ library: wp.media.query({ type: this.params.mime_type }),
+ multiple: false,
+ date: false
+ })
+ ]
+ });
+
+ // When a file is selected, run a callback.
+ this.frame.on( 'select', this.select );
+ },
+
+ /**
+ * Callback handler for when an attachment is selected in the media modal.
+ * Gets the selected image information, and sets it within the control.
+ */
+ select: function() {
+ // Get the attachment from the modal frame.
+ var node,
+ attachment = this.frame.state().get( 'selection' ).first().toJSON(),
+ mejsSettings = window._wpmejsSettings || {};
+
+ this.params.attachment = attachment;
+
+ // Set the Customizer setting; the callback takes care of rendering.
+ this.setting( attachment.id );
+ node = this.container.find( 'audio, video' ).get(0);
+
+ // Initialize audio/video previews.
+ if ( node ) {
+ this.player = new MediaElementPlayer( node, mejsSettings );
+ } else {
+ this.cleanupPlayer();
+ }
+ },
+
+ /**
+ * Reset the setting to the default value.
+ */
+ restoreDefault: function( event ) {
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
+ return;
+ }
+ event.preventDefault();
+
+ this.params.attachment = this.params.defaultAttachment;
+ this.setting( this.params.defaultAttachment.url );
+ },
+
+ /**
+ * Called when the "Remove" link is clicked. Empties the setting.
+ *
+ * @param {object} event jQuery Event object
+ */
+ removeFile: function( event ) {
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
+ return;
+ }
+ event.preventDefault();
+
+ this.params.attachment = {};
+ this.setting( '' );
+ this.renderContent(); // Not bound to setting change when emptying.
+ }
+ });
+
+ /**
+ * An upload control, which utilizes the media modal.
+ *
+ * @class
+ * @augments wp.customize.MediaControl
+ * @augments wp.customize.Control
+ * @augments wp.customize.Class
+ */
+ api.UploadControl = api.MediaControl.extend({
+
+ /**
+ * Callback handler for when an attachment is selected in the media modal.
+ * Gets the selected image information, and sets it within the control.
+ */
+ select: function() {
+ // Get the attachment from the modal frame.
+ var node,
+ attachment = this.frame.state().get( 'selection' ).first().toJSON(),
+ mejsSettings = window._wpmejsSettings || {};
+
+ this.params.attachment = attachment;
+
+ // Set the Customizer setting; the callback takes care of rendering.
+ this.setting( attachment.url );
+ node = this.container.find( 'audio, video' ).get(0);
+
+ // Initialize audio/video previews.
+ if ( node ) {
+ this.player = new MediaElementPlayer( node, mejsSettings );
+ } else {
+ this.cleanupPlayer();
+ }
+ },
- // Don't want to fire focus and click at same time
- toggleFreeze = true;
- setTimeout(function () {
- toggleFreeze = false;
- }, 400);
- });
+ // @deprecated
+ success: function() {},
- this.setting.bind( update );
- update( this.setting() );
- }
+ // @deprecated
+ removerVisibility: function() {}
});
- api.ColorControl = api.Control.extend({
+ /**
+ * A control for uploading images.
+ *
+ * This control no longer needs to do anything more
+ * than what the upload control does in JS.
+ *
+ * @class
+ * @augments wp.customize.UploadControl
+ * @augments wp.customize.MediaControl
+ * @augments wp.customize.Control
+ * @augments wp.customize.Class
+ */
+ api.ImageControl = api.UploadControl.extend({
+ // @deprecated
+ thumbnailSrc: function() {}
+ });
+
+ /**
+ * A control for uploading background images.
+ *
+ * @class
+ * @augments wp.customize.UploadControl
+ * @augments wp.customize.MediaControl
+ * @augments wp.customize.Control
+ * @augments wp.customize.Class
+ */
+ api.BackgroundControl = api.UploadControl.extend({
+
+ /**
+ * When the control's DOM structure is ready,
+ * set up internal event bindings.
+ */
ready: function() {
- var control = this,
- picker = this.container.find('.color-picker-hex');
+ api.UploadControl.prototype.ready.apply( this, arguments );
+ },
- picker.val( control.setting() ).wpColorPicker({
- change: function() {
- control.setting.set( picker.wpColorPicker('color') );
- },
- clear: function() {
- control.setting.set( false );
- }
- });
+ /**
+ * Callback handler for when an attachment is selected in the media modal.
+ * Does an additional AJAX request for setting the background context.
+ */
+ select: function() {
+ api.UploadControl.prototype.select.apply( this, arguments );
+
+ wp.ajax.post( 'custom-background-add', {
+ nonce: _wpCustomizeBackground.nonces.add,
+ wp_customize: 'on',
+ customize_theme: api.settings.theme.stylesheet,
+ attachment_id: this.params.attachment.id
+ } );
}
});
- api.UploadControl = api.Control.extend({
+ /**
+ * A control for positioning a background image.
+ *
+ * @since 4.7.0
+ *
+ * @class
+ * @augments wp.customize.Control
+ * @augments wp.customize.Class
+ */
+ api.BackgroundPositionControl = api.Control.extend( {
+
+ /**
+ * Set up control UI once embedded in DOM and settings are created.
+ *
+ * @since 4.7.0
+ * @access public
+ */
ready: function() {
- var control = this;
+ var control = this, updateRadios;
- this.params.removed = this.params.removed || '';
+ control.container.on( 'change', 'input[name="background-position"]', function() {
+ var position = $( this ).val().split( ' ' );
+ control.settings.x( position[0] );
+ control.settings.y( position[1] );
+ } );
+
+ updateRadios = _.debounce( function() {
+ var x, y, radioInput, inputValue;
+ x = control.settings.x.get();
+ y = control.settings.y.get();
+ inputValue = String( x ) + ' ' + String( y );
+ radioInput = control.container.find( 'input[name="background-position"][value="' + inputValue + '"]' );
+ radioInput.click();
+ } );
+ control.settings.x.bind( updateRadios );
+ control.settings.y.bind( updateRadios );
- this.success = $.proxy( this.success, this );
+ updateRadios(); // Set initial UI.
+ }
+ } );
- this.uploader = $.extend({
- container: this.container,
- browser: this.container.find('.upload'),
- dropzone: this.container.find('.upload-dropzone'),
- success: this.success,
- plupload: {},
- params: {}
- }, this.uploader || {} );
+ /**
+ * A control for selecting and cropping an image.
+ *
+ * @class
+ * @augments wp.customize.MediaControl
+ * @augments wp.customize.Control
+ * @augments wp.customize.Class
+ */
+ api.CroppedImageControl = api.MediaControl.extend({
- if ( control.params.extensions ) {
- control.uploader.plupload.filters = [{
- title: api.l10n.allowedFiles,
- extensions: control.params.extensions
- }];
+ /**
+ * Open the media modal to the library state.
+ */
+ openFrame: function( event ) {
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
+ return;
}
- if ( control.params.context )
- control.uploader.params['post_data[context]'] = this.params.context;
+ this.initFrame();
+ this.frame.setState( 'library' ).open();
+ },
- if ( api.settings.theme.stylesheet )
- control.uploader.params['post_data[theme]'] = api.settings.theme.stylesheet;
+ /**
+ * Create a media modal select frame, and store it so the instance can be reused when needed.
+ */
+ initFrame: function() {
+ var l10n = _wpMediaViewsL10n;
- this.uploader = new wp.Uploader( this.uploader );
+ this.frame = wp.media({
+ button: {
+ text: l10n.select,
+ close: false
+ },
+ states: [
+ new wp.media.controller.Library({
+ title: this.params.button_labels.frame_title,
+ library: wp.media.query({ type: 'image' }),
+ multiple: false,
+ date: false,
+ priority: 20,
+ suggestedWidth: this.params.width,
+ suggestedHeight: this.params.height
+ }),
+ new wp.media.controller.CustomizeImageCropper({
+ imgSelectOptions: this.calculateImageSelectOptions,
+ control: this
+ })
+ ]
+ });
- this.remover = this.container.find('.remove');
- this.remover.on( 'click keydown', function( event ) {
- if ( event.type === 'keydown' && 13 !== event.which ) // enter
- return;
+ this.frame.on( 'select', this.onSelect, this );
+ this.frame.on( 'cropped', this.onCropped, this );
+ this.frame.on( 'skippedcrop', this.onSkippedCrop, this );
+ },
- control.setting.set( control.params.removed );
- event.preventDefault();
- });
+ /**
+ * After an image is selected in the media modal, switch to the cropper
+ * state if the image isn't the right size.
+ */
+ onSelect: function() {
+ var attachment = this.frame.state().get( 'selection' ).first().toJSON();
- this.removerVisibility = $.proxy( this.removerVisibility, this );
- this.setting.bind( this.removerVisibility );
- this.removerVisibility( this.setting.get() );
+ if ( this.params.width === attachment.width && this.params.height === attachment.height && ! this.params.flex_width && ! this.params.flex_height ) {
+ this.setImageFromAttachment( attachment );
+ this.frame.close();
+ } else {
+ this.frame.setState( 'cropper' );
+ }
},
- success: function( attachment ) {
- this.setting.set( attachment.get('url') );
+
+ /**
+ * After the image has been cropped, apply the cropped image data to the setting.
+ *
+ * @param {object} croppedImage Cropped attachment data.
+ */
+ onCropped: function( croppedImage ) {
+ this.setImageFromAttachment( croppedImage );
},
- removerVisibility: function( to ) {
- this.remover.toggle( to != this.params.removed );
- }
- });
- api.ImageControl = api.UploadControl.extend({
- ready: function() {
- var control = this,
- panels;
+ /**
+ * Returns a set of options, computed from the attached image data and
+ * control-specific data, to be fed to the imgAreaSelect plugin in
+ * wp.media.view.Cropper.
+ *
+ * @param {wp.media.model.Attachment} attachment
+ * @param {wp.media.controller.Cropper} controller
+ * @returns {Object} Options
+ */
+ calculateImageSelectOptions: function( attachment, controller ) {
+ var control = controller.get( 'control' ),
+ flexWidth = !! parseInt( control.params.flex_width, 10 ),
+ flexHeight = !! parseInt( control.params.flex_height, 10 ),
+ realWidth = attachment.get( 'width' ),
+ realHeight = attachment.get( 'height' ),
+ xInit = parseInt( control.params.width, 10 ),
+ yInit = parseInt( control.params.height, 10 ),
+ ratio = xInit / yInit,
+ xImg = xInit,
+ yImg = yInit,
+ x1, y1, imgSelectOptions;
+
+ controller.set( 'canSkipCrop', ! control.mustBeCropped( flexWidth, flexHeight, xInit, yInit, realWidth, realHeight ) );
+
+ if ( realWidth / realHeight > ratio ) {
+ yInit = realHeight;
+ xInit = yInit * ratio;
+ } else {
+ xInit = realWidth;
+ yInit = xInit / ratio;
+ }
- this.uploader = {
- init: function() {
- var fallback, button;
+ x1 = ( realWidth - xInit ) / 2;
+ y1 = ( realHeight - yInit ) / 2;
- if ( this.supports.dragdrop )
- return;
+ imgSelectOptions = {
+ handles: true,
+ keys: true,
+ instance: true,
+ persistent: true,
+ imageWidth: realWidth,
+ imageHeight: realHeight,
+ minWidth: xImg > xInit ? xInit : xImg,
+ minHeight: yImg > yInit ? yInit : yImg,
+ x1: x1,
+ y1: y1,
+ x2: xInit + x1,
+ y2: yInit + y1
+ };
- // Maintain references while wrapping the fallback button.
- fallback = control.container.find( '.upload-fallback' );
- button = fallback.children().detach();
+ if ( flexHeight === false && flexWidth === false ) {
+ imgSelectOptions.aspectRatio = xInit + ':' + yInit;
+ }
- this.browser.detach().empty().append( button );
- fallback.append( this.browser ).show();
- }
- };
+ if ( true === flexHeight ) {
+ delete imgSelectOptions.minHeight;
+ imgSelectOptions.maxWidth = realWidth;
+ }
- api.UploadControl.prototype.ready.call( this );
+ if ( true === flexWidth ) {
+ delete imgSelectOptions.minWidth;
+ imgSelectOptions.maxHeight = realHeight;
+ }
- this.thumbnail = this.container.find('.preview-thumbnail img');
- this.thumbnailSrc = $.proxy( this.thumbnailSrc, this );
- this.setting.bind( this.thumbnailSrc );
+ return imgSelectOptions;
+ },
- this.library = this.container.find('.library');
+ /**
+ * Return whether the image must be cropped, based on required dimensions.
+ *
+ * @param {bool} flexW
+ * @param {bool} flexH
+ * @param {int} dstW
+ * @param {int} dstH
+ * @param {int} imgW
+ * @param {int} imgH
+ * @return {bool}
+ */
+ mustBeCropped: function( flexW, flexH, dstW, dstH, imgW, imgH ) {
+ if ( true === flexW && true === flexH ) {
+ return false;
+ }
- // Generate tab objects
- this.tabs = {};
- panels = this.library.find('.library-content');
+ if ( true === flexW && dstH === imgH ) {
+ return false;
+ }
- this.library.children('ul').children('li').each( function() {
- var link = $(this),
- id = link.data('customizeTab'),
- panel = panels.filter('[data-customize-tab="' + id + '"]');
+ if ( true === flexH && dstW === imgW ) {
+ return false;
+ }
- control.tabs[ id ] = {
- both: link.add( panel ),
- link: link,
- panel: panel
- };
- });
+ if ( dstW === imgW && dstH === imgH ) {
+ return false;
+ }
- // Bind tab switch events
- this.library.children('ul').on( 'click keydown', 'li', function( event ) {
- if ( event.type === 'keydown' && 13 !== event.which ) // enter
- return;
+ if ( imgW <= dstW ) {
+ return false;
+ }
- var id = $(this).data('customizeTab'),
- tab = control.tabs[ id ];
+ return true;
+ },
- event.preventDefault();
+ /**
+ * If cropping was skipped, apply the image data directly to the setting.
+ */
+ onSkippedCrop: function() {
+ var attachment = this.frame.state().get( 'selection' ).first().toJSON();
+ this.setImageFromAttachment( attachment );
+ },
- if ( tab.link.hasClass('library-selected') )
- return;
+ /**
+ * Updates the setting and re-renders the control UI.
+ *
+ * @param {object} attachment
+ */
+ setImageFromAttachment: function( attachment ) {
+ this.params.attachment = attachment;
- control.selected.both.removeClass('library-selected');
- control.selected = tab;
- control.selected.both.addClass('library-selected');
- });
+ // Set the Customizer setting; the callback takes care of rendering.
+ this.setting( attachment.id );
+ }
+ });
- // Bind events to switch image urls.
- this.library.on( 'click keydown', 'a', function( event ) {
- if ( event.type === 'keydown' && 13 !== event.which ) // enter
- return;
+ /**
+ * A control for selecting and cropping Site Icons.
+ *
+ * @class
+ * @augments wp.customize.CroppedImageControl
+ * @augments wp.customize.MediaControl
+ * @augments wp.customize.Control
+ * @augments wp.customize.Class
+ */
+ api.SiteIconControl = api.CroppedImageControl.extend({
- var value = $(this).data('customizeImageValue');
+ /**
+ * Create a media modal select frame, and store it so the instance can be reused when needed.
+ */
+ initFrame: function() {
+ var l10n = _wpMediaViewsL10n;
- if ( value ) {
- control.setting.set( value );
- event.preventDefault();
- }
+ this.frame = wp.media({
+ button: {
+ text: l10n.select,
+ close: false
+ },
+ states: [
+ new wp.media.controller.Library({
+ title: this.params.button_labels.frame_title,
+ library: wp.media.query({ type: 'image' }),
+ multiple: false,
+ date: false,
+ priority: 20,
+ suggestedWidth: this.params.width,
+ suggestedHeight: this.params.height
+ }),
+ new wp.media.controller.SiteIconCropper({
+ imgSelectOptions: this.calculateImageSelectOptions,
+ control: this
+ })
+ ]
});
- if ( this.tabs.uploaded ) {
- this.tabs.uploaded.target = this.library.find('.uploaded-target');
- if ( ! this.tabs.uploaded.panel.find('.thumbnail').length )
- this.tabs.uploaded.both.addClass('hidden');
+ this.frame.on( 'select', this.onSelect, this );
+ this.frame.on( 'cropped', this.onCropped, this );
+ this.frame.on( 'skippedcrop', this.onSkippedCrop, this );
+ },
+
+ /**
+ * After an image is selected in the media modal, switch to the cropper
+ * state if the image isn't the right size.
+ */
+ onSelect: function() {
+ var attachment = this.frame.state().get( 'selection' ).first().toJSON(),
+ controller = this;
+
+ if ( this.params.width === attachment.width && this.params.height === attachment.height && ! this.params.flex_width && ! this.params.flex_height ) {
+ wp.ajax.post( 'crop-image', {
+ nonce: attachment.nonces.edit,
+ id: attachment.id,
+ context: 'site-icon',
+ cropDetails: {
+ x1: 0,
+ y1: 0,
+ width: this.params.width,
+ height: this.params.height,
+ dst_width: this.params.width,
+ dst_height: this.params.height
+ }
+ } ).done( function( croppedImage ) {
+ controller.setImageFromAttachment( croppedImage );
+ controller.frame.close();
+ } ).fail( function() {
+ controller.frame.trigger('content:error:crop');
+ } );
+ } else {
+ this.frame.setState( 'cropper' );
}
+ },
- // Select a tab
- panels.each( function() {
- var tab = control.tabs[ $(this).data('customizeTab') ];
+ /**
+ * Updates the setting and re-renders the control UI.
+ *
+ * @param {object} attachment
+ */
+ setImageFromAttachment: function( attachment ) {
+ var sizes = [ 'site_icon-32', 'thumbnail', 'full' ], link,
+ icon;
- // Select the first visible tab.
- if ( ! tab.link.hasClass('hidden') ) {
- control.selected = tab;
- tab.both.addClass('library-selected');
- return false;
+ _.each( sizes, function( size ) {
+ if ( ! icon && ! _.isUndefined ( attachment.sizes[ size ] ) ) {
+ icon = attachment.sizes[ size ];
}
- });
+ } );
- this.dropdownInit();
- },
- success: function( attachment ) {
- api.UploadControl.prototype.success.call( this, attachment );
+ this.params.attachment = attachment;
- // Add the uploaded image to the uploaded tab.
- if ( this.tabs.uploaded && this.tabs.uploaded.target.length ) {
- this.tabs.uploaded.both.removeClass('hidden');
+ // Set the Customizer setting; the callback takes care of rendering.
+ this.setting( attachment.id );
- // @todo: Do NOT store this on the attachment model. That is bad.
- attachment.element = $( '' )
- .data( 'customizeImageValue', attachment.get('url') )
- .append( '+ ')
' )
- .appendTo( this.tabs.uploaded.target );
+ if ( ! icon ) {
+ return;
}
+
+ // Update the icon in-browser.
+ link = $( 'link[rel="icon"][sizes="32x32"]' );
+ link.attr( 'href', icon.url );
},
- thumbnailSrc: function( to ) {
- if ( /^(https?:)?\/\//.test( to ) )
- this.thumbnail.prop( 'src', to ).show();
- else
- this.thumbnail.hide();
+
+ /**
+ * Called when the "Remove" link is clicked. Empties the setting.
+ *
+ * @param {object} event jQuery Event object
+ */
+ removeFile: function( event ) {
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
+ return;
+ }
+ event.preventDefault();
+
+ this.params.attachment = {};
+ this.setting( '' );
+ this.renderContent(); // Not bound to setting change when emptying.
+ $( 'link[rel="icon"][sizes="32x32"]' ).attr( 'href', '/favicon.ico' ); // Set to default.
}
});
+ /**
+ * @class
+ * @augments wp.customize.Control
+ * @augments wp.customize.Class
+ */
api.HeaderControl = api.Control.extend({
ready: function() {
- this.btnRemove = $('#customize-control-header_image .actions .remove');
- this.btnNew = $('#customize-control-header_image .actions .new');
+ this.btnRemove = $('#customize-control-header_image .actions .remove');
+ this.btnNew = $('#customize-control-header_image .actions .new');
_.bindAll(this, 'openMedia', 'removeImage');
this.btnNew.on( 'click', this.openMedia );
this.btnRemove.on( 'click', this.removeImage );
- api.HeaderTool.currentHeader = new api.HeaderTool.ImageModel();
+ api.HeaderTool.currentHeader = this.getInitialHeaderImage();
new api.HeaderTool.CurrentView({
model: api.HeaderTool.currentHeader,
- el: '.current .container'
+ el: '#customize-control-header_image .current .container'
});
new api.HeaderTool.ChoiceListView({
collection: api.HeaderTool.UploadsList = new api.HeaderTool.ChoiceList(),
- el: '.choices .uploaded .list'
+ el: '#customize-control-header_image .choices .uploaded .list'
});
new api.HeaderTool.ChoiceListView({
collection: api.HeaderTool.DefaultsList = new api.HeaderTool.DefaultsList(),
- el: '.choices .default .list'
+ el: '#customize-control-header_image .choices .default .list'
});
api.HeaderTool.combinedList = api.HeaderTool.CombinedList = new api.HeaderTool.CombinedList([
api.HeaderTool.UploadsList,
api.HeaderTool.DefaultsList
]);
+
+ // Ensure custom-header-crop Ajax requests bootstrap the Customizer to activate the previewed theme.
+ wp.media.controller.Cropper.prototype.defaults.doCropArgs.wp_customize = 'on';
+ wp.media.controller.Cropper.prototype.defaults.doCropArgs.customize_theme = api.settings.theme.stylesheet;
+ },
+
+ /**
+ * Returns a new instance of api.HeaderTool.ImageModel based on the currently
+ * saved header image (if any).
+ *
+ * @since 4.2.0
+ *
+ * @returns {Object} Options
+ */
+ getInitialHeaderImage: function() {
+ if ( ! api.get().header_image || ! api.get().header_image_data || _.contains( [ 'remove-header', 'random-default-image', 'random-uploaded-image' ], api.get().header_image ) ) {
+ return new api.HeaderTool.ImageModel();
+ }
+
+ // Get the matching uploaded image object.
+ var currentHeaderObject = _.find( _wpCustomizeHeader.uploads, function( imageObj ) {
+ return ( imageObj.attachment_id === api.get().header_image_data.attachment_id );
+ } );
+ // Fall back to raw current header image.
+ if ( ! currentHeaderObject ) {
+ currentHeaderObject = {
+ url: api.get().header_image,
+ thumbnail_url: api.get().header_image,
+ attachment_id: api.get().header_image_data.attachment_id
+ };
+ }
+
+ return new api.HeaderTool.ImageModel({
+ header: currentHeaderObject,
+ choice: currentHeaderObject.url.split( '/' ).pop()
+ });
},
/**
@@ -433,6 +3172,7 @@
title: l10n.chooseImage,
library: wp.media.query({ type: 'image' }),
multiple: false,
+ date: false,
priority: 20,
suggestedWidth: _wpCustomizeHeader.data.width,
suggestedHeight: _wpCustomizeHeader.data.height
@@ -450,16 +3190,32 @@
this.frame.open();
},
+ /**
+ * After an image is selected in the media modal,
+ * switch to the cropper state.
+ */
onSelect: function() {
this.frame.setState('cropper');
},
+
+ /**
+ * After the image has been cropped, apply the cropped image data to the setting.
+ *
+ * @param {object} croppedImage Cropped attachment data.
+ */
onCropped: function(croppedImage) {
- var url = croppedImage.post_content,
+ var url = croppedImage.url,
attachmentId = croppedImage.attachment_id,
w = croppedImage.width,
h = croppedImage.height;
this.setImageFromURL(url, attachmentId, w, h);
},
+
+ /**
+ * If cropping was skipped, apply the image data directly to the setting.
+ *
+ * @param {object} selection
+ */
onSkippedCrop: function(selection) {
var url = selection.get('url'),
w = selection.get('width'),
@@ -507,33 +3263,159 @@
},
/**
- * Triggers the necessary events to deselect an image which was set as
- * the currently selected one.
+ * Triggers the necessary events to deselect an image which was set as
+ * the currently selected one.
+ */
+ removeImage: function() {
+ api.HeaderTool.currentHeader.trigger('hide');
+ api.HeaderTool.CombinedList.trigger('control:removeImage');
+ }
+
+ });
+
+ /**
+ * wp.customize.ThemeControl
+ *
+ * @constructor
+ * @augments wp.customize.Control
+ * @augments wp.customize.Class
+ */
+ api.ThemeControl = api.Control.extend({
+
+ touchDrag: false,
+ isRendered: false,
+
+ /**
+ * Defer rendering the theme control until the section is displayed.
+ *
+ * @since 4.2.0
+ */
+ renderContent: function () {
+ var control = this,
+ renderContentArgs = arguments;
+
+ api.section( control.section(), function( section ) {
+ if ( section.expanded() ) {
+ api.Control.prototype.renderContent.apply( control, renderContentArgs );
+ control.isRendered = true;
+ } else {
+ section.expanded.bind( function( expanded ) {
+ if ( expanded && ! control.isRendered ) {
+ api.Control.prototype.renderContent.apply( control, renderContentArgs );
+ control.isRendered = true;
+ }
+ } );
+ }
+ } );
+ },
+
+ /**
+ * @since 4.2.0
+ */
+ ready: function() {
+ var control = this;
+
+ control.container.on( 'touchmove', '.theme', function() {
+ control.touchDrag = true;
+ });
+
+ // Bind details view trigger.
+ control.container.on( 'click keydown touchend', '.theme', function( event ) {
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
+ return;
+ }
+
+ // Bail if the user scrolled on a touch device.
+ if ( control.touchDrag === true ) {
+ return control.touchDrag = false;
+ }
+
+ // Prevent the modal from showing when the user clicks the action button.
+ if ( $( event.target ).is( '.theme-actions .button' ) ) {
+ return;
+ }
+
+ api.section( control.section() ).loadThemePreview( control.params.theme.id );
+ });
+
+ control.container.on( 'click keydown', '.theme-actions .theme-details', function( event ) {
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
+ return;
+ }
+
+ event.preventDefault(); // Keep this AFTER the key filter above
+
+ api.section( control.section() ).showDetails( control.params.theme );
+ });
+
+ control.container.on( 'render-screenshot', function() {
+ var $screenshot = $( this ).find( 'img' ),
+ source = $screenshot.data( 'src' );
+
+ if ( source ) {
+ $screenshot.attr( 'src', source );
+ }
+ });
+ },
+
+ /**
+ * Show or hide the theme based on the presence of the term in the title, description, and author.
+ *
+ * @since 4.2.0
*/
- removeImage: function() {
- api.HeaderTool.currentHeader.trigger('hide');
- api.HeaderTool.CombinedList.trigger('control:removeImage');
+ filter: function( term ) {
+ var control = this,
+ haystack = control.params.theme.name + ' ' +
+ control.params.theme.description + ' ' +
+ control.params.theme.tags + ' ' +
+ control.params.theme.author;
+ haystack = haystack.toLowerCase().replace( '-', ' ' );
+ if ( -1 !== haystack.search( term ) ) {
+ control.activate();
+ } else {
+ control.deactivate();
+ }
}
-
});
// Change objects contained within the main customize object to Settings.
api.defaultConstructor = api.Setting;
- // Create the collection of Control objects.
+ // Create the collections for Controls, Sections and Panels.
api.control = new api.Values({ defaultConstructor: api.Control });
+ api.section = new api.Values({ defaultConstructor: api.Section });
+ api.panel = new api.Values({ defaultConstructor: api.Panel });
+ /**
+ * An object that fetches a preview in the background of the document, which
+ * allows for seamless replacement of an existing preview.
+ *
+ * @class
+ * @augments wp.customize.Messenger
+ * @augments wp.customize.Class
+ * @mixes wp.customize.Events
+ */
api.PreviewFrame = api.Messenger.extend({
- sensitivity: 2000,
+ sensitivity: null, // Will get set to api.settings.timeouts.previewFrameSensitivity.
+ /**
+ * Initialize the PreviewFrame.
+ *
+ * @param {object} params.container
+ * @param {object} params.previewUrl
+ * @param {object} params.query
+ * @param {object} options
+ */
initialize: function( params, options ) {
var deferred = $.Deferred();
- // This is the promise object.
+ /*
+ * Make the instance of the PreviewFrame the promise object
+ * so other objects can easily interact with it.
+ */
deferred.promise( this );
this.container = params.container;
- this.signature = params.signature;
$.extend( params, { channel: api.PreviewFrame.uuid() });
@@ -546,91 +3428,125 @@
this.run( deferred );
},
+ /**
+ * Run the preview request.
+ *
+ * @param {object} deferred jQuery Deferred object to be resolved with
+ * the request.
+ */
run: function( deferred ) {
- var self = this,
+ var previewFrame = this,
loaded = false,
- ready = false;
-
- if ( this._ready )
- this.unbind( 'ready', this._ready );
+ ready = false,
+ readyData = null,
+ hasPendingChangesetUpdate = '{}' !== previewFrame.query.customized,
+ urlParser,
+ params,
+ form;
+
+ if ( previewFrame._ready ) {
+ previewFrame.unbind( 'ready', previewFrame._ready );
+ }
- this._ready = function() {
+ previewFrame._ready = function( data ) {
ready = true;
+ readyData = data;
+ previewFrame.container.addClass( 'iframe-ready' );
+ if ( ! data ) {
+ return;
+ }
- if ( loaded )
- deferred.resolveWith( self );
+ if ( loaded ) {
+ deferred.resolveWith( previewFrame, [ data ] );
+ }
};
- this.bind( 'ready', this._ready );
+ previewFrame.bind( 'ready', previewFrame._ready );
- this.request = $.ajax( this.previewUrl(), {
- type: 'POST',
- data: this.query,
- xhrFields: {
- withCredentials: true
+ urlParser = document.createElement( 'a' );
+ urlParser.href = previewFrame.previewUrl();
+
+ params = _.extend(
+ api.utils.parseQueryString( urlParser.search.substr( 1 ) ),
+ {
+ customize_changeset_uuid: previewFrame.query.customize_changeset_uuid,
+ customize_theme: previewFrame.query.customize_theme,
+ customize_messenger_channel: previewFrame.query.customize_messenger_channel
}
+ );
+
+ urlParser.search = $.param( params );
+ previewFrame.iframe = $( '', {
+ title: api.l10n.previewIframeTitle,
+ name: 'customize-' + previewFrame.channel()
} );
+ previewFrame.iframe.attr( 'onmousewheel', '' ); // Workaround for Safari bug. See WP Trac #38149.
- this.request.fail( function() {
- deferred.rejectWith( self, [ 'request failure' ] );
- });
+ if ( ! hasPendingChangesetUpdate ) {
+ previewFrame.iframe.attr( 'src', urlParser.href );
+ } else {
+ previewFrame.iframe.attr( 'data-src', urlParser.href ); // For debugging purposes.
+ }
- this.request.done( function( response ) {
- var location = self.request.getResponseHeader('Location'),
- signature = self.signature,
- index;
+ previewFrame.iframe.appendTo( previewFrame.container );
+ previewFrame.targetWindow( previewFrame.iframe[0].contentWindow );
- // Check if the location response header differs from the current URL.
- // If so, the request was redirected; try loading the requested page.
- if ( location && location != self.previewUrl() ) {
- deferred.rejectWith( self, [ 'redirect', location ] );
- return;
- }
+ /*
+ * Submit customized data in POST request to preview frame window since
+ * there are setting value changes not yet written to changeset.
+ */
+ if ( hasPendingChangesetUpdate ) {
+ form = $( '