-/* globals _wpCustomizeHeader, _wpCustomizeBackground, _wpMediaViewsL10n, MediaElementPlayer */
+/* global _wpCustomizeHeader, _wpCustomizeBackground, _wpMediaViewsL10n, MediaElementPlayer */
(function( exports, $ ){
var Container, focus, api = wp.customize;
/**
+ * 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 options
- * - previewer - The Previewer instance to sync with.
- * - transport - The transport to use for previewing. Supports 'refresh' and 'postMessage'.
+ * @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 ) {
this.transport = this.transport || 'refresh';
this._dirty = options.dirty || false;
+ // Whenever the setting's value changes, refresh the preview.
this.bind( this.preview );
},
+
+ /**
+ * Refresh the preview, respective of the setting's refresh policy.
+ */
preview: function() {
switch ( this.transport ) {
case 'refresh':
params = params || {};
focus = function () {
var focusContainer;
- if ( construct.extended( api.Panel ) && construct.expanded() ) {
- focusContainer = construct.container.find( '.control-panel-content:first' );
+ if ( construct.extended( api.Panel ) && construct.expanded && construct.expanded() ) {
+ focusContainer = construct.container.find( 'ul.control-panel-content' );
+ } else if ( construct.extended( api.Section ) && construct.expanded && construct.expanded() ) {
+ focusContainer = construct.container.find( 'ul.accordion-section-content' );
} else {
focusContainer = construct.container;
}
- focusContainer.find( ':focusable:first' ).focus();
- focusContainer[0].scrollIntoView( true );
+
+ // Note that we can't use :focusable due to a jQuery UI issue. See: https://github.com/jquery/jquery-ui/pull/1583
+ focusContainer.find( 'input, select, textarea, button, object, a[href], [tabindex]' ).filter( ':visible' ).first().focus();
};
if ( params.completeCallback ) {
completeCallback = params.completeCallback;
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
- * @param {Object} options
+ * @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;
- container.params = {};
- $.extend( container, options || {} );
+ 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.deferred = {
embedded: new $.Deferred()
container.onChangeExpanded( expanded, args );
});
- container.attachEvents();
+ container.deferred.embedded.done( function () {
+ container.attachEvents();
+ });
api.utils.bubbleChildValueChanges( container, [ 'priority', 'active' ] );
- container.priority.set( isNaN( container.params.priority ) ? 100 : container.params.priority );
+ container.priority.set( container.params.priority );
container.active.set( container.params.active );
container.expanded.set( false );
},
},
/**
- * Handle changes to the active state.
+ * Active state change handler.
*
- * This does not change the active state, it merely handles the behavior
- * for when it does change.
+ * 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.
*
* @param {Object} args.duration
* @param {Object} args.completeCallback
*/
- onChangeActive: function ( active, args ) {
- var duration = ( 'resolved' === api.previewer.deferred.active.state() ? args.duration : 0 );
- if ( ! $.contains( document, this.container ) ) {
+ onChangeActive: function( active, args ) {
+ var duration, construct = this, 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, construct.container[0] ) ) {
// jQuery.fn.slideUp is not hiding an element if it is not in the DOM
- this.container.toggle( active );
+ construct.container.toggle( active );
if ( args.completeCallback ) {
args.completeCallback();
}
} else if ( active ) {
- this.container.stop( true, true ).slideDown( duration, args.completeCallback );
+ construct.container.stop( true, true ).slideDown( duration, args.completeCallback );
} else {
- this.container.stop( true, true ).slideUp( duration, args.completeCallback );
+ if ( construct.expanded() ) {
+ construct.collapse({
+ duration: duration,
+ completeCallback: function() {
+ construct.container.stop( true, true ).slideUp( duration, args.completeCallback );
+ }
+ });
+ } else {
+ construct.container.stop( true, true ).slideUp( duration, args.completeCallback );
+ }
+ }
+
+ // Recalculate the margin-top immediately, not waiting for debounced reflow, to prevent momentary (100ms) vertical jiggle.
+ if ( expandedOtherPanel ) {
+ expandedOtherPanel._recalculateTopMargin();
}
},
},
/**
- * @param {Boolean} expanded
- * @param {Object} [params]
- * @returns {Boolean} false if state already applied
+ * 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 self = this;
+ _toggleExpanded: function( expanded, params ) {
+ var instance = this, previousCompleteCallback;
params = params || {};
- var section = this, previousCompleteCallback = params.completeCallback;
- params.completeCallback = function () {
+ previousCompleteCallback = params.completeCallback;
+
+ // Short-circuit expand() if the instance is not active.
+ if ( expanded && ! instance.active() ) {
+ return false;
+ }
+
+ params.completeCallback = function() {
if ( previousCompleteCallback ) {
- previousCompleteCallback.apply( section, arguments );
+ previousCompleteCallback.apply( instance, arguments );
}
if ( expanded ) {
- section.container.trigger( 'expanded' );
+ instance.container.trigger( 'expanded' );
} else {
- section.container.trigger( 'collapsed' );
+ instance.container.trigger( 'collapsed' );
}
};
- if ( ( expanded && this.expanded.get() ) || ( ! expanded && ! this.expanded.get() ) ) {
+ if ( ( expanded && instance.expanded.get() ) || ( ! expanded && ! instance.expanded.get() ) ) {
params.unchanged = true;
- self.onChangeExpanded( self.expanded.get(), params );
+ instance.onChangeExpanded( instance.expanded.get(), params );
return false;
} else {
params.unchanged = false;
- this.expandedArgumentsQueue.push( params );
- this.expanded.set( expanded );
+ instance.expandedArgumentsQueue.push( params );
+ instance.expanded.set( expanded );
return true;
}
},
/**
* @param {Object} [params]
- * @returns {Boolean} false if already expanded
+ * @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
+ * @returns {Boolean} false if already collapsed.
*/
collapse: function ( params ) {
return this._toggleExpanded( false, params );
* Bring the container into view and then expand this and bring it into view
* @param {Object} [params]
*/
- focus: focus
+ 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 '<li></li>';
+ }
});
/**
* @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
- * @param {Array} options
+ * @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;
};
section.panel.bind( inject );
inject( section.panel.get() ); // Since a section may never get a panel, assume that it won't ever get one
+
+ section.deferred.embedded.done(function() {
+ // Fix the top margin after reflow.
+ api.bind( 'pane-contents-reflowed', _.debounce( function() {
+ section._recalculateTopMargin();
+ }, 100 ) );
+ });
},
/**
var section = this;
// Expand/Collapse accordion sections on click.
- section.container.find( '.accordion-section-title' ).on( 'click keydown', function( event ) {
+ section.container.find( '.accordion-section-title, .customize-section-back' ).on( 'click keydown', function( event ) {
if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
return;
}
*/
onChangeExpanded: function ( expanded, args ) {
var section = this,
+ container = section.container.closest( '.wp-full-overlay-sidebar-content' ),
content = section.container.find( '.accordion-section-content' ),
- expand;
+ overlay = section.container.closest( '.wp-full-overlay' ),
+ backBtn = section.container.find( '.customize-section-back' ),
+ sectionTitle = section.container.find( '.accordion-section-title' ).first(),
+ headerActionsHeight = $( '#customize-header-actions' ).height(),
+ resizeContentHeight, expand, position, scroll;
- if ( expanded ) {
+ if ( expanded && ! section.container.hasClass( 'open' ) ) {
if ( args.unchanged ) {
expand = args.completeCallback;
} else {
- expand = function () {
- content.stop().slideDown( args.duration, args.completeCallback );
+ container.scrollTop( 0 );
+ resizeContentHeight = function() {
+ var matchMedia, offset;
+ matchMedia = window.matchMedia || window.msMatchMedia;
+ offset = 90; // 45px for customize header actions + 45px for footer actions.
+
+ // No footer on small screens.
+ if ( matchMedia && matchMedia( '(max-width: 640px)' ).matches ) {
+ offset = 45;
+ }
+ content.css( 'height', ( window.innerHeight - offset ) );
+ };
+ expand = function() {
section.container.addClass( 'open' );
+ overlay.addClass( 'section-open' );
+ position = content.offset().top;
+ scroll = container.scrollTop();
+ content.css( 'margin-top', ( headerActionsHeight - position - scroll ) );
+ resizeContentHeight();
+ sectionTitle.attr( 'tabindex', '-1' );
+ backBtn.attr( 'tabindex', '0' );
+ backBtn.focus();
+ if ( args.completeCallback ) {
+ args.completeCallback();
+ }
+
+ // Fix the height after browser resize.
+ $( window ).on( 'resize.customizer-section', _.debounce( resizeContentHeight, 100 ) );
+
+ section._recalculateTopMargin();
};
}
completeCallback: expand
});
} else {
+ api.panel.each( function( panel ) {
+ panel.collapse();
+ });
expand();
}
- } else {
+ } else if ( ! expanded && section.container.hasClass( 'open' ) ) {
section.container.removeClass( 'open' );
- content.slideUp( args.duration, args.completeCallback );
+ overlay.removeClass( 'section-open' );
+ content.css( 'margin-top', '' );
+ container.scrollTop( 0 );
+ backBtn.attr( 'tabindex', '-1' );
+ sectionTitle.attr( 'tabindex', '0' );
+ sectionTitle.focus();
+ if ( args.completeCallback ) {
+ args.completeCallback();
+ }
+ $( window ).off( 'resize.customizer-section' );
+ } else {
+ if ( args.completeCallback ) {
+ args.completeCallback();
+ }
+ }
+ },
+
+ /**
+ * Recalculate the top margin.
+ *
+ * @since 4.4.0
+ * @private
+ */
+ _recalculateTopMargin: function() {
+ var section = this, content, offset, headerActionsHeight;
+ content = section.container.find( '.accordion-section-content' );
+ if ( 0 === content.length ) {
+ return;
+ }
+ headerActionsHeight = $( '#customize-header-actions' ).height();
+ offset = ( content.offset().top - headerActionsHeight );
+ if ( 0 < offset ) {
+ content.css( 'margin-top', ( parseInt( content.css( 'margin-top' ), 10 ) - offset ) );
}
}
});
overlay = section.closest( '.wp-full-overlay' ),
container = section.closest( '.wp-full-overlay-sidebar-content' ),
siblings = container.find( '.open' ),
- topPanel = overlay.find( '#customize-theme-controls > ul > .accordion-section > .accordion-section-title' ).add( '#customize-info > .accordion-section-title' ),
customizeBtn = section.find( '.customize-theme' ),
changeBtn = section.find( '.change-theme' ),
content = section.find( '.control-panel-content' );
args.completeCallback();
}
} );
- topPanel.attr( 'tabindex', '-1' );
- changeBtn.attr( 'tabindex', '-1' );
customizeBtn.focus();
} else {
siblings.removeClass( 'open' );
args.completeCallback();
}
} );
- topPanel.attr( 'tabindex', '0' );
customizeBtn.attr( 'tabindex', '0' );
changeBtn.focus();
container.scrollTop( 0 );
}
},
+ /**
+ * Recalculate the top margin.
+ *
+ * @since 4.4.0
+ * @private
+ */
+ _recalculateTopMargin: function() {
+ api.Panel.prototype._recalculateTopMargin.call( this );
+ },
+
/**
* Render control's screenshot if the control comes into view.
*
* @augments wp.customize.Class
*/
api.Panel = Container.extend({
+ containerType: 'panel',
+
/**
* @since 4.1.0
*
- * @param {String} id
- * @param {Object} options
+ * @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;
if ( ! panel.container.parent().is( parentContainer ) ) {
parentContainer.append( panel.container );
+ panel.renderContent();
}
+
+ api.bind( 'pane-contents-reflowed', _.debounce( function() {
+ panel._recalculateTopMargin();
+ }, 100 ) );
+
panel.deferred.embedded.resolve();
},
}
});
+ // 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' ).on( 'click keydown', function( event ) {
+ 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
+ meta = panel.container.find( '.panel-meta' );
if ( meta.hasClass( 'cannot-expand' ) ) {
return;
}
- var content = meta.find( '.accordion-section-content:first' );
+ 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 );
}
});
* @param {Boolean} expanded
* @param {Object} args
* @param {Boolean} args.unchanged
- * @param {Callback} args.completeCallback
+ * @param {Function} args.completeCallback
*/
onChangeExpanded: function ( expanded, args ) {
// Note: there is a second argument 'args' passed
var position, scroll,
panel = this,
- section = panel.container.closest( '.accordion-section' ),
- overlay = section.closest( '.wp-full-overlay' ),
- container = section.closest( '.wp-full-overlay-sidebar-content' ),
+ accordionSection = panel.container.closest( '.accordion-section' ),
+ overlay = accordionSection.closest( '.wp-full-overlay' ),
+ container = accordionSection.closest( '.wp-full-overlay-sidebar-content' ),
siblings = container.find( '.open' ),
- topPanel = overlay.find( '#customize-theme-controls > ul > .accordion-section > .accordion-section-title' ).add( '#customize-info > .accordion-section-title' ),
- backBtn = overlay.find( '.control-panel-back' ),
- panelTitle = section.find( '.accordion-section-title' ).first(),
- content = section.find( '.control-panel-content' );
+ topPanel = overlay.find( '#customize-theme-controls > ul > .accordion-section > .accordion-section-title' ),
+ backBtn = accordionSection.find( '.customize-panel-back' ),
+ panelTitle = accordionSection.find( '.accordion-section-title' ).first(),
+ content = accordionSection.find( '.control-panel-content' ),
+ headerActionsHeight = $( '#customize-header-actions' ).height();
if ( expanded ) {
// Collapse any sibling sections/panels
api.section.each( function ( section ) {
- if ( ! section.panel() ) {
+ if ( panel.id !== section.panel() ) {
section.collapse( { duration: 0 } );
}
});
content.parent().show();
position = content.offset().top;
scroll = container.scrollTop();
- content.css( 'margin-top', ( $( '#customize-header-actions' ).height() - position - scroll ) );
- section.addClass( 'current-panel' );
+ content.css( 'margin-top', ( headerActionsHeight - position - scroll ) );
+ accordionSection.addClass( 'current-panel' );
overlay.addClass( 'in-sub-panel' );
container.scrollTop( 0 );
if ( args.completeCallback ) {
topPanel.attr( 'tabindex', '-1' );
backBtn.attr( 'tabindex', '0' );
backBtn.focus();
+ panel._recalculateTopMargin();
} else {
siblings.removeClass( 'open' );
- section.removeClass( 'current-panel' );
+ accordionSection.removeClass( 'current-panel' );
overlay.removeClass( 'in-sub-panel' );
content.delay( 180 ).hide( 0, function() {
content.css( 'margin-top', 'inherit' ); // Reset
panelTitle.focus();
container.scrollTop( 0 );
}
+ },
+
+ /**
+ * Recalculate the top margin.
+ *
+ * @since 4.4.0
+ * @private
+ */
+ _recalculateTopMargin: function() {
+ var panel = this, headerActionsHeight, content, accordionSection;
+ headerActionsHeight = $( '#customize-header-actions' ).height();
+ accordionSection = panel.container.closest( '.accordion-section' );
+ content = accordionSection.find( '.control-panel-content' );
+ content.css( 'margin-top', ( parseInt( content.css( 'margin-top' ), 10 ) - ( content.offset().top - headerActionsHeight ) ) );
+ },
+
+ /**
+ * 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.container ) {
+ panel.container.find( '.accordion-sub-container' ).html( template( panel.params ) );
+ }
}
});
* @class
* @augments wp.customize.Class
*
- * @param {string} id Unique identifier for the control instance.
- * @param {object} options Options hash for the control instance.
+ * @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 {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
+ * @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.utils.bubbleChildValueChanges( control, [ 'section', 'priority', 'active' ] );
- // Associate this control with its settings when they are created
+ /*
+ * 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;
});
control.embed();
}) );
+ // After the control is embedded on the page, invoke the "ready" method.
control.deferred.embedded.done( function () {
control.ready();
});
* @param {Callback} args.completeCallback
*/
onChangeActive: function ( active, args ) {
- if ( ! $.contains( document, this.container ) ) {
+ if ( args.unchanged ) {
+ if ( args.completeCallback ) {
+ args.completeCallback();
+ }
+ return;
+ }
+
+ 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 ) {
control.setting.set( picker.wpColorPicker('color') );
},
clear: function() {
- control.setting.set( false );
+ control.setting.set( '' );
}
});
}
});
+ /**
+ * 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({
+
+ /**
+ * Open the media modal to the library state.
+ */
+ openFrame: function( event ) {
+ if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
+ return;
+ }
+
+ this.initFrame();
+ this.frame.setState( 'library' ).open();
+ },
+
+ /**
+ * Create a media modal select frame, and store it so the instance can be reused when needed.
+ */
+ initFrame: function() {
+ var l10n = _wpMediaViewsL10n;
+
+ 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.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();
+
+ 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' );
+ }
+ },
+
+ /**
+ * 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 );
+ },
+
+ /**
+ * 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 = realWidth,
+ yImg = realHeight,
+ x1, y1, imgSelectOptions;
+
+ controller.set( 'canSkipCrop', ! control.mustBeCropped( flexWidth, flexHeight, xInit, yInit, realWidth, realHeight ) );
+
+ if ( xImg / yImg > ratio ) {
+ yInit = yImg;
+ xInit = yInit * ratio;
+ } else {
+ xInit = xImg;
+ yInit = xInit / ratio;
+ }
+
+ x1 = ( xImg - xInit ) / 2;
+ y1 = ( yImg - yInit ) / 2;
+
+ imgSelectOptions = {
+ handles: true,
+ keys: true,
+ instance: true,
+ persistent: true,
+ imageWidth: realWidth,
+ imageHeight: realHeight,
+ x1: x1,
+ y1: y1,
+ x2: xInit + x1,
+ y2: yInit + y1
+ };
+
+ if ( flexHeight === false && flexWidth === false ) {
+ imgSelectOptions.aspectRatio = xInit + ':' + yInit;
+ }
+ if ( flexHeight === false ) {
+ imgSelectOptions.maxHeight = yInit;
+ }
+ if ( flexWidth === false ) {
+ imgSelectOptions.maxWidth = xInit;
+ }
+
+ return imgSelectOptions;
+ },
+
+ /**
+ * 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;
+ }
+
+ if ( true === flexW && dstH === imgH ) {
+ return false;
+ }
+
+ if ( true === flexH && dstW === imgW ) {
+ return false;
+ }
+
+ if ( dstW === imgW && dstH === imgH ) {
+ return false;
+ }
+
+ if ( imgW <= dstW ) {
+ return false;
+ }
+
+ return true;
+ },
+
+ /**
+ * 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 );
+ },
+
+ /**
+ * Updates the setting and re-renders the control UI.
+ *
+ * @param {object} attachment
+ */
+ setImageFromAttachment: function( attachment ) {
+ this.params.attachment = attachment;
+
+ // Set the Customizer setting; the callback takes care of rendering.
+ this.setting( attachment.id );
+ }
+ });
+
+ /**
+ * 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({
+
+ /**
+ * Create a media modal select frame, and store it so the instance can be reused when needed.
+ */
+ initFrame: function() {
+ var l10n = _wpMediaViewsL10n;
+
+ 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
+ })
+ ]
+ });
+
+ 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.trigger('content:error:crop');
+ } );
+ } else {
+ this.frame.setState( 'cropper' );
+ }
+ },
+
+ /**
+ * Updates the setting and re-renders the control UI.
+ *
+ * @param {object} attachment
+ */
+ setImageFromAttachment: function( attachment ) {
+ var sizes = [ 'site_icon-32', 'thumbnail', 'full' ],
+ icon;
+
+ _.each( sizes, function( size ) {
+ if ( ! icon && ! _.isUndefined ( attachment.sizes[ size ] ) ) {
+ icon = attachment.sizes[ size ];
+ }
+ } );
+
+ this.params.attachment = attachment;
+
+ // Set the Customizer setting; the callback takes care of rendering.
+ this.setting( attachment.id );
+
+ // Update the icon in-browser.
+ $( 'link[sizes="32x32"]' ).attr( 'href', icon.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.
+ $( 'link[rel="icon"]' ).attr( 'href', '' );
+ }
+ });
+
/**
* @class
* @augments wp.customize.Control
* @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;
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
api.PreviewFrame = api.Messenger.extend({
sensitivity: 2000,
+ /**
+ * Initialize the PreviewFrame.
+ *
+ * @param {object} params.container
+ * @param {object} params.signature
+ * @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.run( deferred );
},
+ /**
+ * Run the preview request.
+ *
+ * @param {object} deferred jQuery Deferred object to be resolved with
+ * the request.
+ */
run: function( deferred ) {
var self = this,
loaded = false,
_( constructs ).each( function ( activeConstructs, type ) {
api[ type ].each( function ( construct, id ) {
var active = !! ( activeConstructs && activeConstructs[ id ] );
- construct.active( active );
+ if ( active ) {
+ construct.activate();
+ } else {
+ construct.deactivate();
+ }
} );
} );
} );
refreshBuffer: 250,
/**
- * Requires params:
- * - container - a selector or jQuery element
- * - previewUrl - the URL of preview frame
+ * @param {array} params.allowedUrls
+ * @param {string} params.container A selector or jQuery element for the preview
+ * frame to be placed.
+ * @param {string} params.form
+ * @param {string} params.previewUrl The URL to preview.
+ * @param {string} params.signature
+ * @param {object} options
*/
initialize: function( params, options ) {
var self = this,
} );
},
+ /**
+ * Query string data sent with each preview request.
+ *
+ * @abstract
+ */
query: function() {},
abort: function() {
}
},
+ /**
+ * Refresh the preview.
+ */
refresh: function() {
var self = this;
},
cheatin: function() {
- $( document.body ).empty().addClass('cheatin').append( '<p>' + api.l10n.cheatin + '</p>' );
+ $( document.body ).empty().addClass( 'cheatin' ).append(
+ '<h1>' + api.l10n.cheatin + '</h1>' +
+ '<p>' + api.l10n.notAllowed + '</p>'
+ );
},
refreshNonces: function() {
});
api.controlConstructor = {
- color: api.ColorControl,
- media: api.MediaControl,
- upload: api.UploadControl,
- image: api.ImageControl,
- header: api.HeaderControl,
- background: api.BackgroundControl,
- theme: api.ThemeControl
+ color: api.ColorControl,
+ media: api.MediaControl,
+ upload: api.UploadControl,
+ image: api.ImageControl,
+ cropped_image: api.CroppedImageControl,
+ site_icon: api.SiteIconControl,
+ header: api.HeaderControl,
+ background: api.BackgroundControl,
+ theme: api.ThemeControl
};
api.panelConstructor = {};
api.sectionConstructor = {
return;
}
- // Redirect to the fallback preview if any incompatibilities are found.
- if ( ! $.support.postMessage || ( ! $.support.cors && api.settings.isCrossDomain ) )
- return window.location = api.settings.url.fallback;
+ // Bail if any incompatibilities are found.
+ if ( ! $.support.postMessage || ( ! $.support.cors && api.settings.isCrossDomain ) ) {
+ return;
+ }
var parent, topFocus,
body = $( document.body ),
overlay = body.children( '.wp-full-overlay' ),
- title = $( '#customize-info .theme-name.site-title' ),
+ title = $( '#customize-info .panel-title.site-title' ),
closeBtn = $( '.customize-controls-close' ),
saveBtn = $( '#save' );
});
// Expand/Collapse the main customizer customize info.
- $( '#customize-info' ).find( '> .accordion-section-title' ).on( 'click keydown', function( event ) {
+ $( '.customize-info' ).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
- var section = $( this ).parent(),
- content = section.find( '.accordion-section-content:first' );
+ var section = $( this ).closest( '.accordion-section' ),
+ content = section.find( '.customize-panel-description:first' );
if ( section.hasClass( 'cannot-expand' ) ) {
return;
if ( section.hasClass( 'open' ) ) {
section.toggleClass( 'open' );
content.slideUp( api.Panel.prototype.defaultExpandedArguments.duration );
+ $( this ).attr( 'aria-expanded', false );
} else {
content.slideDown( api.Panel.prototype.defaultExpandedArguments.duration );
section.toggleClass( 'open' );
+ $( this ).attr( 'aria-expanded', true );
}
});
nonce: api.settings.nonce,
+ /**
+ * Build the query to send along with the Preview request.
+ *
+ * @return {object}
+ */
query: function() {
var dirtyCustomized = {};
api.each( function ( value, key ) {
if ( wasReflowed && activeElement ) {
activeElement.focus();
}
+ api.trigger( 'pane-contents-reflowed' );
}, api );
api.bind( 'ready', api.reflowPaneContents );
api.reflowPaneContents = _.debounce( api.reflowPaneContents, 100 );
event.preventDefault();
});
- // Go back to the top-level Customizer accordion.
- $( '#customize-header-actions' ).on( 'click keydown', '.control-panel-back', function( event ) {
- if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
- return;
- }
-
- event.preventDefault(); // Keep this AFTER the key filter above
- api.panel.each( function ( panel ) {
- panel.collapse();
- });
- });
-
closeBtn.keydown( function( event ) {
if ( 9 === event.which ) // tab
return;
event.preventDefault();
});
- $('.collapse-sidebar').on( 'click keydown', function( event ) {
- if ( api.utils.isKeydownButNotEnterEvent( event ) ) {
- return;
+ $( '.collapse-sidebar' ).on( 'click', function() {
+ if ( 'true' === $( this ).attr( 'aria-expanded' ) ) {
+ $( this ).attr({ 'aria-expanded': 'false', 'aria-label': api.l10n.expandSidebar });
+ } else {
+ $( this ).attr({ 'aria-expanded': 'true', 'aria-label': api.l10n.collapseSidebar });
}
overlay.toggleClass( 'collapsed' ).toggleClass( 'expanded' );
- event.preventDefault();
});
$( '.customize-controls-preview-toggle' ).on( 'click keydown', function( event ) {
} );
}
- // Create a potential postMessage connection with the parent frame.
+ /*
+ * Create a postMessage connection with a parent frame,
+ * in case the Customizer frame was opened with the Customize loader.
+ *
+ * @see wp.customize.Loader
+ */
parent = new api.Messenger({
url: api.settings.url.parent,
channel: 'loader'
});
- // If we receive a 'back' event, we're inside an iframe.
- // Send any clicks to the 'Return' link to the parent page.
+ /*
+ * If we receive a 'back' event, we're inside an iframe.
+ * Send any clicks to the 'Return' link to the parent page.
+ */
parent.bind( 'back', function() {
closeBtn.on( 'click.customize-controls-close', function( event ) {
event.preventDefault();
});
} );
- // When activated, let the loader handle redirecting the page.
- // If no loader exists, redirect the page ourselves (if a url exists).
+ /*
+ * When activated, let the loader handle redirecting the page.
+ * If no loader exists, redirect the page ourselves (if a url exists).
+ */
api.bind( 'activated', function() {
if ( parent.targetWindow() )
parent.send( 'activated', api.settings.url.activated );
});
});
+ // Change previewed URL to the homepage when changing the page_on_front.
+ api( 'show_on_front', 'page_on_front', function( showOnFront, pageOnFront ) {
+ var updatePreviewUrl = function() {
+ if ( showOnFront() === 'page' && parseInt( pageOnFront(), 10 ) > 0 ) {
+ api.previewer.previewUrl.set( api.settings.url.home );
+ }
+ };
+ showOnFront.bind( updatePreviewUrl );
+ pageOnFront.bind( updatePreviewUrl );
+ });
+
+ // Change the previewed URL to the selected page when changing the page_for_posts.
+ api( 'page_for_posts', function( setting ) {
+ setting.bind(function( pageId ) {
+ pageId = parseInt( pageId, 10 );
+ if ( pageId > 0 ) {
+ api.previewer.previewUrl.set( api.settings.url.home + '?page_id=' + pageId );
+ }
+ });
+ });
+
api.trigger( 'ready' );
// Make sure left column gets focus