enmi-conf.org: comparison wp/wp-admin/js/customize-nav-menus.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-nav-menus.js

changeset 9	177826044cd9
parent 7	cf61fcea0001
child 16	a86126ab1dd4

equal deleted inserted replaced

-:c7c34916027a
+:177826044cd9
+/**
+* @output wp-admin/js/customize-nav-menus.js
+*/
 /* global _wpCustomizeNavMenusSettings, wpNavMenu, console */
 ( function( api, wp, $ ) {
 	'use strict';
 	/**
 	wpNavMenu.options.targetTolerance       = 10;
 	wpNavMenu.init = function() {
 		this.jQueryExtensions();
 	};
+	/**
+	 * @namespace wp.customize.Menus
+	 */
 	api.Menus = api.Menus || {};
 	// Link settings.
 	api.Menus.data = {
 		itemTypes: [],
 	/**
 	 * Newly-created Nav Menus and Nav Menu Items have negative integer IDs which
 	 * serve as placeholders until Save & Publish happens.
 	 *
+	 * @alias wp.customize.Menus.generatePlaceholderAutoIncrementId
+	 *
 	 * @return {number}
 	 */
 	api.Menus.generatePlaceholderAutoIncrementId = function() {
 		return -Math.ceil( api.Menus.data.phpIntMax * Math.random() );
 	};
 	/**
 	 * wp.customize.Menus.AvailableItemModel
 	 *
 	 * A single available menu item model. See PHP's WP_Customize_Nav_Menu_Item_Setting class.
 	 *
-	 * @constructor
+	 * @class    wp.customize.Menus.AvailableItemModel
 	 * @augments Backbone.Model
 	 */
 	api.Menus.AvailableItemModel = Backbone.Model.extend( $.extend(
 		{
 			id: null // This is only used by Backbone.
 	/**
 	 * wp.customize.Menus.AvailableItemCollection
 	 *
 	 * Collection for available menu item models.
 	 *
-	 * @constructor
+	 * @class    wp.customize.Menus.AvailableItemCollection
-	 * @augments Backbone.Model
+	 * @augments Backbone.Collection
 	 */
-	api.Menus.AvailableItemCollection = Backbone.Collection.extend({
+	api.Menus.AvailableItemCollection = Backbone.Collection.extend(/** @lends wp.customize.Menus.AvailableItemCollection.prototype */{
 		model: api.Menus.AvailableItemModel,
 		sort_key: 'order',
 		comparator: function( item ) {
 	/**
 	 * Insert a new `auto-draft` post.
 	 *
 	 * @since 4.7.0
-	 * @access public
+	 * @alias wp.customize.Menus.insertAutoDraftPost
 	 *
 	 * @param {object} params - Parameters for the draft post to create.
 	 * @param {string} params.post_type - Post type to add.
 	 * @param {string} params.post_title - Post title to use.
 	 * @return {jQuery.promise} Promise resolved with the added post.
 		} );
 		return deferred.promise();
 	};
-	/**
+	api.Menus.AvailableMenuItemsPanelView = wp.Backbone.View.extend(/** @lends wp.customize.Menus.AvailableMenuItemsPanelView.prototype */{
-	 * wp.customize.Menus.AvailableMenuItemsPanelView
-	 *
-	 * View class for the available menu items panel.
-	 *
-	 * @constructor
-	 * @augments wp.Backbone.View
-	 * @augments Backbone.View
-	 */
-	api.Menus.AvailableMenuItemsPanelView = wp.Backbone.View.extend({
 		el: '#available-menu-items',
 		events: {
 			'input #menu-items-search': 'debounceSearch',
-			'keyup #menu-items-search': 'debounceSearch',
 			'focus .menu-item-tpl': 'focus',
 			'click .menu-item-tpl': '_submit',
 			'click #custom-menu-item-submit': '_submitLink',
 			'keypress #custom-menu-item-name': '_submitLink',
 			'click .new-content-item .add-content': '_submitNew',
 		pages: {},
 		sectionContent: '',
 		loading: false,
 		addingNew: false,
+		/**
+		 * wp.customize.Menus.AvailableMenuItemsPanelView
+		 *
+		 * View class for the available menu items panel.
+		 *
+		 * @constructs wp.customize.Menus.AvailableMenuItemsPanelView
+		 * @augments   wp.Backbone.View
+		 */
 		initialize: function() {
 			var self = this;
 			if ( ! api.panel.has( 'nav_menus' ) ) {
 				return;
 		// Adds the custom menu item to the menu.
 		submitLink: function() {
 			var menuItem,
 				itemName = $( '#custom-menu-item-name' ),
 				itemUrl = $( '#custom-menu-item-url' ),
+				url = itemUrl.val().trim(),
 				urlRegex;
 			if ( ! this.currentMenuControl ) {
 				return;
 			}
 			urlRegex = /^((\w+:)?\/\/\w.*|\w+:(?!\/\/$)|\/|\?|#)/;
 			if ( '' === itemName.val() ) {
 				itemName.addClass( 'invalid' );
 				return;
-			} else if ( ! urlRegex.test( itemUrl.val() ) ) {
+			} else if ( ! urlRegex.test( url ) ) {
 				itemUrl.addClass( 'invalid' );
 				return;
 			}
 			menuItem = {
 				'title': itemName.val(),
-				'url': itemUrl.val(),
+				'url': url,
 				'type': 'custom',
 				'type_label': api.Menus.data.l10n.custom_label,
 				'object': 'custom'
 			};
 	 * wp.customize.Menus.MenusPanel
 	 *
 	 * Customizer panel for menus. This is used only for screen options management.
 	 * Note that 'menus' must match the WP_Customize_Menu_Panel::$type.
 	 *
-	 * @constructor
+	 * @class    wp.customize.Menus.MenusPanel
 	 * @augments wp.customize.Panel
 	 */
-	api.Menus.MenusPanel = api.Panel.extend({
+	api.Menus.MenusPanel = api.Panel.extend(/** @lends wp.customize.Menus.MenusPanel.prototype */{
 		attachEvents: function() {
 			api.Panel.prototype.attachEvents.call( this );
 			var panel = this,
 	 * wp.customize.Menus.MenuSection
 	 *
 	 * Customizer section for menus. This is used only for lazy-loading child controls.
 	 * Note that 'nav_menu' must match the WP_Customize_Menu_Section::$type.
 	 *
-	 * @constructor
+	 * @class    wp.customize.Menus.MenuSection
 	 * @augments wp.customize.Section
 	 */
-	api.Menus.MenuSection = api.Section.extend({
+	api.Menus.MenuSection = api.Section.extend(/** @lends wp.customize.Menus.MenuSection.prototype */{
 		/**
 		 * Initialize.
 		 *
 		 * @since 4.3.0
 	/**
 	 * wp.customize.Menus.NewMenuSection
 	 *
 	 * Customizer section for new menus.
 	 *
-	 * @constructor
+	 * @class    wp.customize.Menus.NewMenuSection
 	 * @augments wp.customize.Section
 	 */
-	api.Menus.NewMenuSection = api.Section.extend({
+	api.Menus.NewMenuSection = api.Section.extend(/** @lends wp.customize.Menus.NewMenuSection.prototype */{
 		/**
 		 * Add behaviors for the accordion section.
 		 *
 		 * @since 4.3.0
 	 * wp.customize.Menus.MenuLocationControl
 	 *
 	 * Customizer control for menu locations (rendered as a <select>).
 	 * Note that 'nav_menu_location' must match the WP_Customize_Nav_Menu_Location_Control::$type.
 	 *
-	 * @constructor
+	 * @class    wp.customize.Menus.MenuLocationControl
 	 * @augments wp.customize.Control
 	 */
-	api.Menus.MenuLocationControl = api.Control.extend({
+	api.Menus.MenuLocationControl = api.Control.extend(/** @lends wp.customize.Menus.MenuLocationControl.prototype */{
 		initialize: function( id, options ) {
 			var control = this,
 				matches = id.match( /^nav_menu_locations\[(.+?)]/ );
 			control.themeLocation = matches[1];
 			api.Control.prototype.initialize.call( control, id, options );
 				}
 			});
 		}
 	});
-	/**
+	api.Menus.MenuItemControl = api.Control.extend(/** @lends wp.customize.Menus.MenuItemControl.prototype */{
-	 * wp.customize.Menus.MenuItemControl
-	 *
+		/**
-	 * Customizer control for menu items.
+		 * wp.customize.Menus.MenuItemControl
-	 * Note that 'menu_item' must match the WP_Customize_Menu_Item_Control::$type.
+		 *
-	 *
+		 * Customizer control for menu items.
-	 * @constructor
+		 * Note that 'menu_item' must match the WP_Customize_Menu_Item_Control::$type.
-	 * @augments wp.customize.Control
+		 *
-	 */
+		 * @constructs wp.customize.Menus.MenuItemControl
-	api.Menus.MenuItemControl = api.Control.extend({
+		 * @augments   wp.customize.Control
+		 *
-		/**
+		 * @inheritDoc
-		 * @inheritdoc
 		 */
 		initialize: function( id, options ) {
 			var control = this;
 			control.expanded = new api.Value( false );
 			control.expandedArgumentsQueue = [];
 	/**
 	 * wp.customize.Menus.MenuNameControl
 	 *
 	 * Customizer control for a nav menu's name.
 	 *
-	 * @constructor
+	 * @class    wp.customize.Menus.MenuNameControl
 	 * @augments wp.customize.Control
 	 */
-	api.Menus.MenuNameControl = api.Control.extend({
+	api.Menus.MenuNameControl = api.Control.extend(/** @lends wp.customize.Menus.MenuNameControl.prototype */{
 		ready: function() {
 			var control = this;
 			if ( control.setting ) {
 	 * wp.customize.Menus.MenuLocationsControl
 	 *
 	 * Customizer control for a nav menu's locations.
 	 *
 	 * @since 4.9.0
-	 * @constructor
+	 * @class    wp.customize.Menus.MenuLocationsControl
 	 * @augments wp.customize.Control
 	 */
-	api.Menus.MenuLocationsControl = api.Control.extend({
+	api.Menus.MenuLocationsControl = api.Control.extend(/** @lends wp.customize.Menus.MenuLocationsControl.prototype */{
 		/**
 		 * Set up the control.
 		 *
 		 * @since 4.9.0
 	/**
 	 * wp.customize.Menus.MenuAutoAddControl
 	 *
 	 * Customizer control for a nav menu's auto add.
 	 *
-	 * @constructor
+	 * @class    wp.customize.Menus.MenuAutoAddControl
 	 * @augments wp.customize.Control
 	 */
-	api.Menus.MenuAutoAddControl = api.Control.extend({
+	api.Menus.MenuAutoAddControl = api.Control.extend(/** @lends wp.customize.Menus.MenuAutoAddControl.prototype */{
 		ready: function() {
 			var control = this,
 				settingValue = control.setting();
 	 * wp.customize.Menus.MenuControl
 	 *
 	 * Customizer control for menus.
 	 * Note that 'nav_menu' must match the WP_Menu_Customize_Control::$type
 	 *
-	 * @constructor
+	 * @class    wp.customize.Menus.MenuControl
 	 * @augments wp.customize.Control
 	 */
-	api.Menus.MenuControl = api.Control.extend({
+	api.Menus.MenuControl = api.Control.extend(/** @lends wp.customize.Menus.MenuControl.prototype */{
 		/**
 		 * Set up the control.
 		 */
 		ready: function() {
 			var control = this,
 			this.container.find( '.new-menu-item-invitation' ).toggle( menuItemControls.length === 0 );
 		}
 	} );
-	/**
+	api.Menus.NewMenuControl = api.Control.extend(/** @lends wp.customize.Menus.NewMenuControl.prototype */{
-	 * wp.customize.Menus.NewMenuControl
-	 *
+		/**
-	 * Customizer control for creating new menus and handling deletion of existing menus.
+		 * wp.customize.Menus.NewMenuControl
-	 * Note that 'new_menu' must match the WP_Customize_New_Menu_Control::$type.
+		 *
-	 *
+		 * Customizer control for creating new menus and handling deletion of existing menus.
-	 * @constructor
+		 * Note that 'new_menu' must match the WP_Customize_New_Menu_Control::$type.
-	 * @augments wp.customize.Control
+		 *
-	 * @deprecated 4.9.0 This class is no longer used due to new menu creation UX.
+		 * @constructs wp.customize.Menus.NewMenuControl
-	 */
+		 * @augments   wp.customize.Control
-	api.Menus.NewMenuControl = api.Control.extend({
+		 *
+		 * @deprecated 4.9.0 This class is no longer used due to new menu creation UX.
-		/**
-		 * Initialize.
-		 *
-		 * @deprecated 4.9.0
 		 */
 		initialize: function() {
 			if ( 'undefined' !== typeof console && console.warn ) {
 				console.warn( '[DEPRECATED] wp.customize.NewMenuControl will be removed. Please use wp.customize.Menus.createNavMenu() instead.' );
 			}
 	$.extend( api.controlConstructor, {
 		nav_menu_location: api.Menus.MenuLocationControl,
 		nav_menu_item: api.Menus.MenuItemControl,
 		nav_menu: api.Menus.MenuControl,
 		nav_menu_name: api.Menus.MenuNameControl,
-		new_menu: api.Menus.NewMenuControl, // @todo Remove in 5.0. See #42364.
+		new_menu: api.Menus.NewMenuControl, // @todo Remove in a future release. See #42364.
 		nav_menu_locations: api.Menus.MenuLocationsControl,
 		nav_menu_auto_add: api.Menus.MenuAutoAddControl
 	});
 	/**
 	} );
 	/**
 	 * When customize_save comes back with a success, make sure any inserted
 	 * nav menus and items are properly re-added with their newly-assigned IDs.
+	 *
+	 * @alias wp.customize.Menus.applySavedData
 	 *
 	 * @param {object} data
 	 * @param {array} data.nav_menu_updates
 	 * @param {array} data.nav_menu_item_updates
 	 */
 	};
 	/**
 	 * Focus a menu item control.
 	 *
+	 * @alias wp.customize.Menus.focusMenuItemControl
+	 *
 	 * @param {string} menuItemId
 	 */
 	api.Menus.focusMenuItemControl = function( menuItemId ) {
 		var control = api.Menus.getMenuItemControl( menuItemId );
 		if ( control ) {
 	};
 	/**
 	 * Get the control for a given menu.
 	 *
+	 * @alias wp.customize.Menus.getMenuControl
+	 *
 	 * @param menuId
 	 * @return {wp.customize.controlConstructor.menus[]}
 	 */
 	api.Menus.getMenuControl = function( menuId ) {
 		return api.control( 'nav_menu[' + menuId + ']' );
 	};
 	/**
 	 * Given a menu item ID, get the control associated with it.
 	 *
+	 * @alias wp.customize.Menus.getMenuItemControl
+	 *
 	 * @param {string} menuItemId
 	 * @return {object|null}
 	 */
 	api.Menus.getMenuItemControl = function( menuItemId ) {
 		return api.control( menuItemIdToSettingId( menuItemId ) );
 	};
 	/**
+	 * @alias wp.customize.Menus~menuItemIdToSettingId
+	 *
 	 * @param {String} menuItemId
 	 */
 	function menuItemIdToSettingId( menuItemId ) {
 		return 'nav_menu_item[' + menuItemId + ']';
 	}
 	/**
 	 * Apply sanitize_text_field()-like logic to the supplied name, returning a
 	 * "unnammed" fallback string if the name is then empty.
 	 *
+	 * @alias wp.customize.Menus~displayNavMenuName
+	 *
 	 * @param {string} name
 	 * @returns {string}
 	 */
 	function displayNavMenuName( name ) {
 		name = name || '';
-		name = $( '<div>' ).text( name ).html(); // Emulate esc_html() which is used in wp-admin/nav-menus.php.
+		name = wp.sanitize.stripTagsAndEncodeText( name ); // Remove any potential tags from name.
 		name = $.trim( name );
 		return name || api.Menus.data.l10n.unnamed;
 	}
 })( wp.customize, wp, jQuery );

enmi-conf.org