Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-06-25 06:14:58 +02:00
Code Issues Projects Releases Wiki Activity

Customize: Support instantiation of partials with flat/unwrapped params for parity with controls, sections, and panels in [41726].

Browse Source 
* Passing `options.params` when constructing `Partial` is now deprecated in favor of just passing `options`.
* Improve usage of jsdoc in JS `Partial` class.
* Also add `defaults` property to `wp.customize.selectiveRefresh.Partial` class for parity with `Control`.

See #42083.

Built from https://develop.svn.wordpress.org/trunk@42037


git-svn-id: http://core.svn.wordpress.org/trunk@41871 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Weston Ruter 2017-10-29 00:15:53 +00:00
parent cb7483b595
commit 35172737ef
4 changed files with 36 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
wp-admin/js/customize-controls.js
View File

@ -3401,6 +3401,12 @@
api.Control = api.Class.extend({
defaultActiveArguments: { duration: 'fast', completeCallback: $.noop },
/**
* Default params.
*
* @since 4.9.0
* @var {object}
*/
defaults: {
label: '',
description: '',

47
wp-includes/js/customize-selective-refresh.js
View File

@ -32,28 +32,37 @@ wp.customize.selectiveRefresh = ( function( $, api ) {
* @class
* @augments wp.customize.Class
* @since 4.5.0
*
* @param {string} id Unique identifier for the control instance.
* @param {object} options Options hash for the control instance.
* @param {object} options.params
* @param {string} options.params.type Type of partial (e.g. nav_menu, widget, etc)
* @param {string} options.params.selector jQuery selector to find the container element in the page.
* @param {array} options.params.settings The IDs for the settings the partial relates to.
* @param {string} options.params.primarySetting The ID for the primary setting the partial renders.
* @param {bool} options.params.fallbackRefresh Whether to refresh the entire preview in case of a partial refresh failure.
*/
Partial = self.Partial = api.Class.extend(/** @lends wp.customize.SelectiveRefresh.Partial.prototype */{
id: null,
/**
* Default params.
*
* @since 4.9.0
* @var {object}
*/
defaults: {
selector: null,
primarySetting: null,
containerInclusive: false,
fallbackRefresh: true // Note this needs to be false in a front-end editing context.
},
/**
* Constructor.
*
* @since 4.5.0
*
* @param {string} id - Partial ID.
* @param {Object} options
* @param {Object} options.params
* @param {string} id - Unique identifier for the partial instance.
* @param {object} options - Options hash for the partial instance.
* @param {string} options.type - Type of partial (e.g. nav_menu, widget, etc)
* @param {string} options.selector - jQuery selector to find the container element in the page.
* @param {array} options.settings - The IDs for the settings the partial relates to.
* @param {string} options.primarySetting - The ID for the primary setting the partial renders.
* @param {bool} options.fallbackRefresh - Whether to refresh the entire preview in case of a partial refresh failure.
* @param {object} [options.params] - Deprecated wrapper for the above properties.
*/
initialize: function( id, options ) {
var partial = this;
@ -62,13 +71,10 @@ wp.customize.selectiveRefresh = ( function( $, api ) {
partial.params = _.extend(
{
selector: null,
settings: [],
primarySetting: null,
containerInclusive: false,
fallbackRefresh: true // Note this needs to be false in a front-end editing context.
settings: []
},
options.params || {}
partial.defaults,
options.params || options
);
partial.deferred = {};
@ -917,7 +923,10 @@ wp.customize.selectiveRefresh = ( function( $, api ) {
var Constructor, partial = self.partial( id );
if ( ! partial ) {
Constructor = self.partialConstructor[ data.type ] || self.Partial;
partial = new Constructor( id, { params: data } );
partial = new Constructor(
id,
_.extend( { params: data }, data ) // Inclusion of params alias is for back-compat for custom partials that expect to augment this property.
);
self.partial.add( partial );
} else {
_.extend( partial.params, data );

2
wp-includes/js/customize-selective-refresh.min.js vendored
View File

File diff suppressed because one or more lines are too long

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.9-beta4-42036';
$wp_version = '4.9-beta4-42037';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.