enmi-conf.org: comparison wp/wp-admin/js/customize-widgets.js

Mercurial Mercurial > enmi-conf.org / comparison

summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help

wp/wp-admin/js/customize-widgets.js

changeset 9	177826044cd9
parent 7	cf61fcea0001
child 16	a86126ab1dd4

equal deleted inserted replaced

-:c7c34916027a
+:177826044cd9
+/**
+* @output wp-admin/js/customize-widgets.js
+*/
 /* global _wpCustomizeWidgetsSettings */
 (function( wp, $ ){
 	if ( ! wp || ! wp.customize ) { return; }
 	// Set up our namespace...
 	var api = wp.customize,
 		l10n;
+	/**
+	 * @namespace wp.customize.Widgets
+	 */
 	api.Widgets = api.Widgets || {};
 	api.Widgets.savedWidgetIds = {};
 	// Link settings
 	api.Widgets.data = _wpCustomizeWidgetsSettings || {};
 	/**
 	 * wp.customize.Widgets.WidgetModel
 	 *
 	 * A single widget model.
 	 *
-	 * @constructor
+	 * @class    wp.customize.Widgets.WidgetModel
 	 * @augments Backbone.Model
 	 */
-	api.Widgets.WidgetModel = Backbone.Model.extend({
+	api.Widgets.WidgetModel = Backbone.Model.extend(/** @lends wp.customize.Widgets.WidgetModel.prototype */{
 		id: null,
 		temp_id: null,
 		classname: null,
 		control_tpl: null,
 		description: null,
 	/**
 	 * wp.customize.Widgets.WidgetCollection
 	 *
 	 * Collection for widget models.
 	 *
-	 * @constructor
+	 * @class    wp.customize.Widgets.WidgetCollection
-	 * @augments Backbone.Model
+	 * @augments Backbone.Collection
 	 */
-	api.Widgets.WidgetCollection = Backbone.Collection.extend({
+	api.Widgets.WidgetCollection = Backbone.Collection.extend(/** @lends wp.customize.Widgets.WidgetCollection.prototype */{
 		model: api.Widgets.WidgetModel,
 		// Controls searching on the current widget collection
 		// and triggers an update event
 		doSearch: function( value ) {
 	/**
 	 * wp.customize.Widgets.SidebarModel
 	 *
 	 * A single sidebar model.
 	 *
-	 * @constructor
+	 * @class    wp.customize.Widgets.SidebarModel
 	 * @augments Backbone.Model
 	 */
-	api.Widgets.SidebarModel = Backbone.Model.extend({
+	api.Widgets.SidebarModel = Backbone.Model.extend(/** @lends wp.customize.Widgets.SidebarModel.prototype */{
 		after_title: null,
 		after_widget: null,
 		before_title: null,
 		before_widget: null,
 		'class': null,
 	/**
 	 * wp.customize.Widgets.SidebarCollection
 	 *
 	 * Collection for sidebar models.
 	 *
-	 * @constructor
+	 * @class    wp.customize.Widgets.SidebarCollection
 	 * @augments Backbone.Collection
 	 */
-	api.Widgets.SidebarCollection = Backbone.Collection.extend({
+	api.Widgets.SidebarCollection = Backbone.Collection.extend(/** @lends wp.customize.Widgets.SidebarCollection.prototype */{
 		model: api.Widgets.SidebarModel
 	});
 	api.Widgets.registeredSidebars = new api.Widgets.SidebarCollection( api.Widgets.data.registeredSidebars );
-	/**
+	api.Widgets.AvailableWidgetsPanelView = wp.Backbone.View.extend(/** @lends wp.customize.Widgets.AvailableWidgetsPanelView.prototype */{
-	 * wp.customize.Widgets.AvailableWidgetsPanelView
-	 *
-	 * View class for the available widgets panel.
-	 *
-	 * @constructor
-	 * @augments wp.Backbone.View
-	 * @augments Backbone.View
-	 */
-	api.Widgets.AvailableWidgetsPanelView = wp.Backbone.View.extend({
 		el: '#available-widgets',
 		events: {
 			'input #widgets-search': 'search',
-			'keyup #widgets-search': 'search',
 			'focus .widget-tpl' : 'focus',
 			'click .widget-tpl' : '_submit',
 			'keypress .widget-tpl' : '_submit',
 			'keydown' : 'keyboardAccessible'
 		},
 		currentSidebarControl: null,
 		$search: null,
 		$clearResults: null,
 		searchMatchesCount: null,
+		/**
+		 * View class for the available widgets panel.
+		 *
+		 * @constructs wp.customize.Widgets.AvailableWidgetsPanelView
+		 * @augments   wp.Backbone.View
+		 */
 		initialize: function() {
 			var self = this;
 			this.$search = $( '#widgets-search' );
 			// Close the panel if the URL in the preview changes
 			api.previewer.bind( 'url', this.close );
 		},
-		// Performs a search and handles selected widget
+		/**
-		search: function( event ) {
+		 * Performs a search and handles selected widget.
+		 */
+		search: _.debounce( function( event ) {
 			var firstVisible;
 			this.collection.doSearch( event.target.value );
 			// Update the search matches count.
 			this.updateSearchMatchesCount();
 			if ( ! this.searchMatchesCount ) {
 				this.$el.addClass( 'no-widgets-found' );
 			} else {
 				this.$el.removeClass( 'no-widgets-found' );
 			}
-		},
+		}, 500 ),
-		// Update the count of the available widgets that have the `search_matched` attribute.
+		/**
+		 * Updates the count of the available widgets that have the `search_matched` attribute.
+		 */
 		updateSearchMatchesCount: function() {
 			this.searchMatchesCount = this.collection.where({ search_matched: true }).length;
 		},
-		// Send a message to the aria-live region to announce how many search results.
+		/**
-		announceSearchMatches: _.debounce( function() {
+		 * Sends a message to the aria-live region to announce how many search results.
+		 */
+		announceSearchMatches: function() {
 			var message = l10n.widgetsFound.replace( '%d', this.searchMatchesCount ) ;
 			if ( ! this.searchMatchesCount ) {
 				message = l10n.noWidgetsFound;
 			}
 			wp.a11y.speak( message );
-		}, 500 ),
+		},
-		// Changes visibility of available widgets
+		/**
+		 * Changes visibility of available widgets.
+		 */
 		updateList: function() {
 			this.collection.each( function( widget ) {
 				var widgetTpl = $( '#widget-tpl-' + widget.id );
 				widgetTpl.toggle( widget.get( 'search_matched' ) && ! widget.get( 'is_disabled' ) );
 				if ( widget.get( 'is_disabled' ) && widgetTpl.is( this.selected ) ) {
 					this.selected = null;
 				}
 			} );
 		},
-		// Highlights a widget
+		/**
+		 * Highlights a widget.
+		 */
 		select: function( widgetTpl ) {
 			this.selected = $( widgetTpl );
 			this.selected.siblings( '.widget-tpl' ).removeClass( 'selected' );
 			this.selected.addClass( 'selected' );
 		},
-		// Highlights a widget on focus
+		/**
+		 * Highlights a widget on focus.
+		 */
 		focus: function( event ) {
 			this.select( $( event.currentTarget ) );
 		},
-		// Submit handler for keypress and click on widget
+		/**
+		 * Handles submit for keypress and click on widget.
+		 */
 		_submit: function( event ) {
 			// Only proceed with keypress if it is Enter or Spacebar
 			if ( event.type === 'keypress' && ( event.which !== 13 && event.which !== 32 ) ) {
 				return;
 			}
 			this.submit( $( event.currentTarget ) );
 		},
-		// Adds a selected widget to the sidebar
+		/**
+		 * Adds a selected widget to the sidebar.
+		 */
 		submit: function( widgetTpl ) {
 			var widgetId, widget, widgetFormControl;
 			if ( ! widgetTpl ) {
 				widgetTpl = this.selected;
 			}
 			this.close();
 		},
-		// Opens the panel
+		/**
+		 * Opens the panel.
+		 */
 		open: function( sidebarControl ) {
 			this.currentSidebarControl = sidebarControl;
 			// Wide widget controls appear over the preview, and so they need to be collapsed when the panel opens
 			_( this.currentSidebarControl.getWidgetFormControls() ).each( function( control ) {
 			if ( ! api.settings.browser.mobile ) {
 				this.$search.focus();
 			}
 		},
-		// Closes the panel
+		/**
+		 * Closes the panel.
+		 */
 		close: function( options ) {
 			options = options || {};
 			if ( options.returnFocus && this.currentSidebarControl ) {
 				this.currentSidebarControl.container.find( '.add-new-widget' ).focus();
 			$( 'body' ).removeClass( 'adding-widget' );
 			this.$search.val( '' );
 		},
-		// Add keyboard accessiblity to the panel
+		/**
+		 * Adds keyboard accessiblity to the panel.
+		 */
 		keyboardAccessible: function( event ) {
 			var isEnter = ( event.which === 13 ),
 				isEsc = ( event.which === 27 ),
 				isDown = ( event.which === 40 ),
 				isUp = ( event.which === 38 ),
 	/**
 	 * Handlers for the widget-synced event, organized by widget ID base.
 	 * Other widgets may provide their own update handlers by adding
 	 * listeners for the widget-synced event.
+	 *
+	 * @alias    wp.customize.Widgets.formSyncHandlers
 	 */
 	api.Widgets.formSyncHandlers = {
 		/**
 		 * @param {jQuery.Event} e
 				widget.find( '.widget-content:first' ).prepend( newWidgetError );
 			}
 		}
 	};
-	/**
+	api.Widgets.WidgetControl = api.Control.extend(/** @lends wp.customize.Widgets.WidgetControl.prototype */{
-	 * wp.customize.Widgets.WidgetControl
-	 *
-	 * Customizer control for widgets.
-	 * Note that 'widget_form' must match the WP_Widget_Form_Customize_Control::$type
-	 *
-	 * @constructor
-	 * @augments wp.customize.Control
-	 */
-	api.Widgets.WidgetControl = api.Control.extend({
 		defaultExpandedArguments: {
 			duration: 'fast',
 			completeCallback: $.noop
 		},
 		/**
+		 * wp.customize.Widgets.WidgetControl
+		 *
+		 * Customizer control for widgets.
+		 * Note that 'widget_form' must match the WP_Widget_Form_Customize_Control::$type
+		 *
 		 * @since 4.1.0
+		 *
+		 * @constructs wp.customize.Widgets.WidgetControl
+		 * @augments   wp.customize.Control
 		 */
 		initialize: function( id, options ) {
 			var control = this;
 			control.widgetControlEmbedded = false;
 				}
 				self.expanded( ! self.expanded() );
 			} );
 			$closeBtn = this.container.find( '.widget-control-close' );
-			$closeBtn.on( 'click', function( e ) {
+			$closeBtn.on( 'click', function() {
-				e.preventDefault();
 				self.collapse();
 				self.container.find( '.widget-top .widget-action:first' ).focus(); // keyboard accessibility
 			} );
 		},
 		 *
 		 * @since 4.1.0
 		 *
 		 * @param {Boolean}   active
 		 * @param {Object}    args
-		 * @param {Callback}  args.completeCallback
+		 * @param {function}  args.completeCallback
 		 */
 		onChangeActive: function ( active, args ) {
 			// Note: there is a second 'args' parameter being passed, merged on top of this.defaultActiveArguments
 			this.container.toggleClass( 'widget-rendered', active );
 			if ( args.completeCallback ) {
 		_setupRemoveUI: function() {
 			var self = this, $removeBtn, replaceDeleteWithRemove;
 			// Configure remove button
 			$removeBtn = this.container.find( '.widget-control-remove' );
-			$removeBtn.on( 'click', function( e ) {
+			$removeBtn.on( 'click', function() {
-				e.preventDefault();
 				// Find an adjacent element to add focus to when this widget goes away
 				var $adjacentFocusTarget;
 				if ( self.container.next().is( '.customize-control-widget_form' ) ) {
 					$adjacentFocusTarget = self.container.next().find( '.widget-action:first' );
 				} else if ( self.container.prev().is( '.customize-control-widget_form' ) ) {
 	 * wp.customize.Widgets.WidgetsPanel
 	 *
 	 * Customizer panel containing the widget area sections.
 	 *
 	 * @since 4.4.0
+	 *
+	 * @class    wp.customize.Widgets.WidgetsPanel
+	 * @augments wp.customize.Panel
 	 */
-	api.Widgets.WidgetsPanel = api.Panel.extend({
+	api.Widgets.WidgetsPanel = api.Panel.extend(/** @lends wp.customize.Widgets.WigetsPanel.prototype */{
 		/**
 		 * Add and manage the display of the no-rendered-areas notice.
 		 *
 		 * @since 4.4.0
 				 *
 				 * @return {number} Number of active sidebar sections.
 				 */
 				getActiveSectionCount = function() {
 					return _.filter( panel.sections(), function( section ) {
-						return section.active();
+						return 'sidebar' === section.params.type && section.active();
 					} ).length;
 				};
 				/**
 				 * Determine whether or not the notice should be displayed.
 	 * wp.customize.Widgets.SidebarSection
 	 *
 	 * Customizer section representing a widget area widget
 	 *
 	 * @since 4.1.0
+	 *
+	 * @class    wp.customize.Widgets.SidebarSection
+	 * @augments wp.customize.Section
 	 */
-	api.Widgets.SidebarSection = api.Section.extend({
+	api.Widgets.SidebarSection = api.Section.extend(/** @lends wp.customize.Widgets.SidebarSection.prototype */{
 		/**
 		 * Sync the section's active state back to the Backbone model's is_rendered attribute
 		 *
 		 * @since 4.1.0
 	 * Customizer control for widgets.
 	 * Note that 'sidebar_widgets' must match the WP_Widget_Area_Customize_Control::$type
 	 *
 	 * @since 3.9.0
 	 *
-	 * @constructor
+	 * @class    wp.customize.Widgets.SidebarControl
 	 * @augments wp.customize.Control
 	 */
-	api.Widgets.SidebarControl = api.Control.extend({
+	api.Widgets.SidebarControl = api.Control.extend(/** @lends wp.customize.Widgets.SidebarControl.prototype */{
 		/**
 		 * Set up the control
 		 */
 		ready: function() {

enmi-conf.org