/** * 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. * * @class wp.customize.Menus.AvailableItemModel * @augments Backbone.Model */ api.Menus.AvailableItemModel = Backbone.Model.extend( $.extend( { id: null // This is only used by Backbone. }, api.Menus.data.defaultSettingValues.nav_menu_item ) );
/** * wp.customize.Menus.AvailableItemCollection * * Collection for available menu item models. * * @class wp.customize.Menus.AvailableItemCollection * @augments Backbone.Collection */ api.Menus.AvailableItemCollection = Backbone.Collection.extend(/** @lends wp.customize.Menus.AvailableItemCollection.prototype */{ model: api.Menus.AvailableItemModel,
/** * Insert a new `auto-draft` post. * * @since 4.7.0 * @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. */ api.Menus.insertAutoDraftPost = function insertAutoDraftPost( params ) { var request, deferred = $.Deferred();
// Activate static front page controls as this could be the first page created. if ( api.section.has( 'static_front_page' ) ) { api.section( 'static_front_page' ).activate(); }
// Add new page to dropdown-pages controls. api.control.each( function( control ) { var select; if ( 'dropdown-pages' === control.params.type ) { select = control.container.find( 'select[name^="_customize-dropdown-pages-"]' ); select.append( new Option( params.post_title, response.post_id ) ); } } ); } deferred.resolve( response ); } } );
// Cache current selected menu item. selected: null,
// Cache menu control that opened the panel. currentMenuControl: null, debounceSearch: null, $search: null, $clearResults: null, searchTerm: '', rendered: false, 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 the available menu items panel is open and the customize controls * are interacted with (other than an item being deleted), then close * the available menu items panel. Also close on back button click. */ $( '#customize-controls, .customize-section-back' ).on( 'click keydown', function( e ) { var isDeleteBtn = $( e.target ).is( '.item-delete, .item-delete *' ), isAddNewBtn = $( e.target ).is( '.add-new-menu-item, .add-new-menu-item *' ); if ( $( 'body' ).hasClass( 'adding-menu-items' ) && ! isDeleteBtn && ! isAddNewBtn ) { self.close(); } } );
// Clear the search results and trigger an `input` event to fire a new search. this.$clearResults.on( 'click', function() { self.$search.val( '' ).trigger( 'focus' ).trigger( 'input' ); } );
this.$el.on( 'input', '#custom-menu-item-name.invalid, #custom-menu-item-url.invalid', function() { $( this ).removeClass( 'invalid' ); var errorMessageId = $( this ).attr( 'aria-describedby' ); $( '#' + errorMessageId ).hide(); $( this ).removeAttr( 'aria-invalid' ).removeAttr( 'aria-describedby' ); });
// Load available items if it looks like we'll need them. api.panel( 'nav_menus' ).container.on( 'expanded', function() { if ( ! self.rendered ) { self.initList(); self.rendered = true; } });
self.currentRequest.done(function( data ) { var items; if ( 1 === page ) { // Clear previous results as it's a new search. $content.empty(); } $section.removeClass( 'loading loading-more' ); $content.attr( 'aria-busy', 'false' ); $section.addClass( 'open' ); self.loading = false; items = new api.Menus.AvailableItemCollection( data.items ); self.collection.add( items.models ); items.each( function( menuItem ) { $content.append( itemTemplate( menuItem.attributes ) ); } ); if ( 20 > items.length ) { self.pages.search = -1; // Up to 20 posts and 20 terms in results, if <20, no more results for either. } else { self.pages.search = self.pages.search + 1; } if ( items && page > 1 ) { wp.a11y.speak( api.Menus.data.l10n.itemsFoundMore.replace( '%d', items.length ) ); } else if ( items && page === 1 ) { wp.a11y.speak( api.Menus.data.l10n.itemsFound.replace( '%d', items.length ) ); } });
self.currentRequest.fail(function( data ) { // data.message may be undefined, for example when typing slow and the request is aborted. if ( data.message ) { $content.empty().append( $( '<li class="nothing-found"></li>' ).text( data.message ) ); wp.a11y.speak( data.message ); } self.pages.search = -1; });
// Render the individual items. initList: function() { var self = this;
// Render the template for each item by type. _.each( api.Menus.data.itemTypes, function( itemType ) { self.pages[ itemType.type + ':' + itemType.object ] = 0; } ); self.loadItems( api.Menus.data.itemTypes ); },
/** * Load available nav menu items. * * @since 4.3.0 * @since 4.7.0 Changed function signature to take list of item types instead of single type/object. * @access private * * @param {Array.<Object>} itemTypes List of objects containing type and key. * @param {string} deprecated Formerly the object parameter. * @return {void} */ loadItems: function( itemTypes, deprecated ) { var self = this, _itemTypes, requestItemTypes = [], params, request, itemTemplate, availableMenuItemContainers = {}; itemTemplate = wp.template( 'available-menu-item' );
// Highlights a menu item on focus. focus: function( event ) { this.select( $( event.currentTarget ) ); },
// Submit handler for keypress and click on menu item. _submit: function( event ) { // Only proceed with keypress if it is Enter or Spacebar. if ( 'keypress' === event.type && ( 13 !== event.which && 32 !== event.which ) ) { return; }
this.submit( $( event.currentTarget ) ); },
// Adds a selected menu item to the menu. submit: function( menuitemTpl ) { var menuitemId, menu_item;
if ( ! menuitemTpl ) { menuitemTpl = this.selected; }
// Submit handler for keypress and click on custom menu item. _submitLink: function( event ) { // Only proceed with keypress if it is Enter. if ( 'keypress' === event.type && 13 !== event.which ) { return; }
this.submitLink(); },
// Adds the custom menu item to the menu. submitLink: function() { var menuItem, itemName = $( '#custom-menu-item-name' ), itemUrl = $( '#custom-menu-item-url' ), urlErrorMessage = $( '#custom-url-error' ), nameErrorMessage = $( '#custom-name-error' ), url = itemUrl.val().trim(), urlRegex, errorText;
if ( ! this.currentMenuControl ) { return; }
/* * Allow URLs including: * - http://example.com/ * - //example.com * - /directory/ * - ?query-param * - #target * - mailto:foo@example.com * * Any further validation will be handled on the server when the setting is attempted to be saved, * so this pattern does not need to be complete. */ urlRegex = /^((\w+:)?\/\/\w.*|\w+:(?!\/\/$)|\/|\?|#)/; if ( ! urlRegex.test( url ) || '' === itemName.val() ) { if ( ! urlRegex.test( url ) ) { itemUrl.addClass( 'invalid' ) .attr( 'aria-invalid', 'true' ) .attr( 'aria-describedby', 'custom-url-error' ); urlErrorMessage.show(); errorText = urlErrorMessage.text(); // Announce error message via screen reader wp.a11y.speak( errorText, 'assertive' ); } if ( '' === itemName.val() ) { itemName.addClass( 'invalid' ) .attr( 'aria-invalid', 'true' ) .attr( 'aria-describedby', 'custom-name-error' ); nameErrorMessage.show(); errorText = ( '' === errorText ) ? nameErrorMessage.text() : errorText + nameErrorMessage.text(); // Announce error message via screen reader wp.a11y.speak( errorText, 'assertive' ); } return; }
/** * 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. * * @class wp.customize.Menus.MenusPanel * @augments wp.customize.Panel */ api.Menus.MenusPanel = api.Panel.extend(/** @lends wp.customize.Menus.MenusPanel.prototype */{
attachEvents: function() { api.Panel.prototype.attachEvents.call( this );
/** * Update field visibility when clicking on the field toggles. */ ready: function() { var panel = this; panel.container.find( '.hide-column-tog' ).on( 'click', function() { panel.saveManageColumnsState(); });
// Inject additional heading into the menu locations section's head container. api.section( 'menu_locations', function( section ) { section.headContainer.prepend( wp.template( 'nav-menu-locations-header' )( api.Menus.data ) ); } ); },
/** * Save hidden column states. * * @since 4.3.0 * @private * * @return {void} */ saveManageColumnsState: _.debounce( function() { var panel = this; if ( panel._updateHiddenColumnsRequest ) { panel._updateHiddenColumnsRequest.abort(); }
/** * @deprecated Since 4.7.0 now that the nav_menu sections are responsible for toggling the classes on their own containers. */ checked: function() {},
/** * @deprecated Since 4.7.0 now that the nav_menu sections are responsible for toggling the classes on their own containers. */ unchecked: function() {},
/** * Get hidden fields. * * @since 4.3.0 * @private * * @return {Array} Fields (columns) that are hidden. */ hidden: function() { return $( '.hide-column-tog' ).not( ':checked' ).map( function() { var id = this.id; return id.substring( 0, id.length - 5 ); }).get().join( ',' ); } } );
/** * 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. * * @class wp.customize.Menus.MenuSection * @augments wp.customize.Section */ api.Menus.MenuSection = api.Section.extend(/** @lends wp.customize.Menus.MenuSection.prototype */{
if ( 'undefined' === typeof section.params.menu_id ) { throw new Error( 'params.menu_id was not defined' ); }
/* * Since newly created sections won't be registered in PHP, we need to prevent the * preview's sending of the activeSections to result in this control * being deactivated when the preview refreshes. So we can hook onto * the setting that has the same ID and its presence can dictate * whether the section is active. */ section.active.validate = function() { if ( ! api.has( section.id ) ) { return false; } return !! api( section.id ).get(); };
section.populateControls();
section.navMenuLocationSettings = {}; section.assignedLocations = new api.Value( [] );
api.each(function( setting, id ) { var matches = id.match( /^nav_menu_locations\[(.+?)]/ ); if ( matches ) { section.navMenuLocationSettings[ matches[1] ] = setting; setting.bind( function() { section.refreshAssignedLocations(); }); } });
section.assignedLocations.bind(function( to ) { section.updateAssignedLocationsInSectionTitle( to ); });
_.each( api.section( section.id ).controls(), function( control ) { if ( 'nav_menu_item' === control.params.type ) { control.actuallyEmbed(); } } );
// Make sure Sortables is initialized after the section has been expanded to prevent `offset` issues. if ( args.completeCallback ) { completeCallback = args.completeCallback; } args.completeCallback = function() { if ( 'resolved' !== section.deferred.initSortables.state() ) { wpNavMenu.initSortables(); // Depends on menu-to-edit ID being set above. section.deferred.initSortables.resolve( wpNavMenu.menuList ); // Now MenuControl can extend the sortable.
// @todo Note that wp.customize.reflowPaneContents() is debounced, // so this immediate change will show a slight flicker while priorities get updated. api.control( 'nav_menu[' + String( section.params.menu_id ) + ']' ).reflowMenuItems(); } if ( _.isFunction( completeCallback ) ) { completeCallback(); } }; } api.Section.prototype.onChangeExpanded.call( section, expanded, args ); },
/** * Highlight how a user may create new menu items. * * This method reminds the user to create new menu items and how. * It's exposed this way because this class knows best which UI needs * highlighted but those expanding this section know more about why and * when the affordance should be highlighted. * * @since 4.9.0 * * @return {void} */ highlightNewItemButton: function() { api.utils.highlightButton( this.contentContainer.find( '.add-new-menu-item' ), { delay: 2000 } ); } });
/** * Create a nav menu setting and section. * * @since 4.9.0 * * @param {string} [name=''] Nav menu name. * @return {wp.customize.Menus.MenuSection} Added nav menu. */ api.Menus.createNavMenu = function createNavMenu( name ) { var customizeId, placeholderId, setting; placeholderId = api.Menus.generatePlaceholderAutoIncrementId();
// Register the menu control setting. setting = api.create( customizeId, customizeId, {}, { type: 'nav_menu', transport: api.Menus.data.settingTransport, previewer: api.previewer } ); setting.set( $.extend( {}, api.Menus.data.defaultSettingValues.nav_menu, { name: name || '' } ) );
/* * Add the menu section (and its controls). * Note that this will automatically create the required controls * inside via the Section's ready method. */ return api.section.add( new api.Menus.MenuSection( customizeId, { panel: 'nav_menus', title: displayNavMenuName( name ), customizeAction: api.Menus.data.l10n.customizingMenus, priority: 10, menu_id: placeholderId } ) ); };
/* * We have to manually handle section expanded because we do not * apply the `accordion-section-title` class to this button-driven section. */ container.on( 'click', '.customize-add-menu-button', function() { section.expand(); });
/** * Create the new menu with name and location supplied by the user. * * @since 4.9.0 */ submit: function() { var section = this, contentContainer = section.contentContainer, nameInput = contentContainer.find( '.menu-name-field' ).first(), name = nameInput.val(), menuSection;
if ( ! name ) { nameInput.addClass( 'invalid' ); nameInput.focus(); return; }
menuSection = api.Menus.createNavMenu( name );
// Clear name field. nameInput.val( '' ); nameInput.removeClass( 'invalid' );
contentContainer.find( '.assigned-menu-location input[type=checkbox]' ).each( function() { var checkbox = $( this ), navMenuLocationSetting;
// Reset state for next new menu. checkbox.prop( 'checked', false ); } } );
wp.a11y.speak( api.Menus.data.l10n.menuAdded );
// Focus on the new menu section. menuSection.focus( { completeCallback: function() { menuSection.highlightNewItemButton(); } } ); },
/** * Select a default location. * * This method selects a single location by default so we can support * creating a menu for a specific menu location. * * @since 4.9.0 * * @param {string|null} locationId - The ID of the location to select. `null` clears all selections. * @return {void} */ selectDefaultLocation: function( locationId ) { var locationControl = api.control( this.id + '[locations]' ), locationSelections = {};
/** * 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. * * @class wp.customize.Menus.MenuLocationControl * @augments wp.customize.Control */ 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 ); },
ready: function() { var control = this, navMenuIdRegex = /^nav_menu\[(-?\d+)]/;
// @todo It would be better if this was added directly on the setting itself, as opposed to the control. control.setting.validate = function( value ) { if ( '' === value ) { return 0; } else { return parseInt( value, 10 ); } };
/** * wp.customize.Menus.MenuItemControl * * Customizer control for menu items. * Note that 'menu_item' must match the WP_Customize_Menu_Item_Control::$type. * * @constructs wp.customize.Menus.MenuItemControl * @augments wp.customize.Control * * @inheritDoc */ initialize: function( id, options ) { var control = this; control.expanded = new api.Value( false ); control.expandedArgumentsQueue = []; control.expanded.bind( function( expanded ) { var args = control.expandedArgumentsQueue.shift(); args = $.extend( {}, control.defaultExpandedArguments, args ); control.onChangeExpanded( expanded, args ); }); api.Control.prototype.initialize.call( control, id, options ); control.active.validate = function() { var value, section = api.section( control.section() ); if ( section ) { value = section.active(); } else { value = false; } return value; }; },
/** * Set up the initial state of the screen reader accessibility information for menu items. * * @since 6.6.0 */ initAccessibility: function() { var control = this, menu = $( '#menu-to-edit' );
// Refresh the accessibility when the user comes close to the item in any way. menu.on( 'mouseenter.refreshAccessibility focus.refreshAccessibility touchstart.refreshAccessibility', '.menu-item', function(){ control.refreshAdvancedAccessibilityOfItem( $( this ).find( 'button.item-edit' ) ); } );
// We have to update on click as well because we might hover first, change the item, and then click. menu.on( 'click', 'button.item-edit', function() { control.refreshAdvancedAccessibilityOfItem( $( this ) ); } ); },
/** * refreshAdvancedAccessibilityOfItem( [itemToRefresh] ) * * Refreshes advanced accessibility buttons for one menu item. * Shows or hides buttons based on the location of the menu item. * * @param {Object} itemToRefresh The menu item that might need its advanced accessibility buttons refreshed * * @since 6.6.0 */ refreshAdvancedAccessibilityOfItem: function( itemToRefresh ) { // Only refresh accessibility when necessary. if ( true !== $( itemToRefresh ).data( 'needs_accessibility_refresh' ) ) { return; }
// String together help text for sub menu items. if ( depth < 2 ) { title = menus.subMenuFocus.replace( '%1$s', itemName ).replace( '%2$s', menuItemType ).replace( '%3$d', itemPosition ).replace( '%4$d', totalSubItems ).replace( '%5$s', parentItemName ); } else { title = menus.subMenuMoreDepthFocus.replace( '%1$s', itemName ).replace( '%2$s', menuItemType ).replace( '%3$d', itemPosition ).replace( '%4$d', totalSubItems ).replace( '%5$s', parentItemName ).replace( '%6$d', depth ); } }
$this.find( '.screen-reader-text' ).text( title );
// Mark this item's accessibility as refreshed. $this.data( 'needs_accessibility_refresh', false ); },
/** * Override the embed() method to do nothing, * so that the control isn't embedded on load, * unless the containing section is already expanded. * * @since 4.3.0 */ embed: function() { var control = this, sectionId = control.section(), section; if ( ! sectionId ) { return; } section = api.section( sectionId ); if ( ( section && section.expanded() ) || api.settings.autofocus.control === control.id ) { control.actuallyEmbed(); } },
/** * This function is called in Section.onChangeExpanded() so the control * will only get embedded when the Section is first expanded. * * @since 4.3.0 */ actuallyEmbed: function() { var control = this; if ( 'resolved' === control.deferred.embedded.state() ) { return; } control.renderContent(); control.deferred.embedded.resolve(); // This triggers control.ready().
// Mark all menu items as unprocessed. $( 'button.item-edit' ).data( 'needs_accessibility_refresh', true ); },
/** * Set up the control. */ ready: function() { if ( 'undefined' === typeof this.params.menu_item_id ) { throw new Error( 'params.menu_item_id was not defined' ); }
if ( isMoveUp ) { control.moveUp(); } else if ( isMoveDown ) { control.moveDown(); } else if ( isMoveLeft ) { control.moveLeft(); } else if ( isMoveRight ) { control.moveRight(); control.params.depth += 1; }
moveBtn.focus(); // Re-focus after the container was moved.
// Mark all menu items as unprocessed. $( 'button.item-edit' ).data( 'needs_accessibility_refresh', true ); } ); },
/** * Set up event handlers for menu item updating. */ _setupUpdateUI: function() { var control = this, settingValue = control.setting(), updateNotifications;
control.elements = {}; control.elements.url = new api.Element( control.container.find( '.edit-menu-item-url' ) ); control.elements.title = new api.Element( control.container.find( '.edit-menu-item-title' ) ); control.elements.attr_title = new api.Element( control.container.find( '.edit-menu-item-attr-title' ) ); control.elements.target = new api.Element( control.container.find( '.edit-menu-item-target' ) ); control.elements.classes = new api.Element( control.container.find( '.edit-menu-item-classes' ) ); control.elements.xfn = new api.Element( control.container.find( '.edit-menu-item-xfn' ) ); control.elements.description = new api.Element( control.container.find( '.edit-menu-item-description' ) ); // @todo Allow other elements, added by plugins, to be automatically picked up here; // allow additional values to be added to setting array.
_.each( control.elements, function( element, property ) { element.bind(function( value ) { if ( element.element.is( 'input[type=checkbox]' ) ) { value = ( value ) ? element.element.val() : ''; }
// Shift all following siblings by the number of children this item has. _.each( followingSiblingItemControls, function( followingSiblingItemControl ) { var value = _.clone( followingSiblingItemControl.setting() ); value.position += childrenItemControls.length; followingSiblingItemControl.setting.set( value ); });
// Now move the children up to be the new subsequent siblings. _.each( childrenItemControls, function( childrenItemControl, i ) { var value = _.clone( childrenItemControl.setting() ); value.position = from.position + i; value.menu_item_parent = from.menu_item_parent; childrenItemControl.setting.set( value ); });
menuControl.debouncedReflowMenuItems(); } else { // Update the elements' values to match the new setting properties. _.each( to, function( value, key ) { if ( control.elements[ key] ) { control.elements[ key ].set( to[ key ] ); } } ); control.container.find( '.menu-item-data-parent-id' ).val( to.menu_item_parent );
// Handle UI updates when the position or depth (parent) change. if ( to.position !== from.position || to.menu_item_parent !== from.menu_item_parent ) { control.getMenuControl().debouncedReflowMenuItems(); } } });
// Style the URL field as invalid when there is an invalid_url notification. updateNotifications = function() { control.elements.url.element.toggleClass( 'invalid', control.setting.notifications.has( 'invalid_url' ) ); }; control.setting.notifications.bind( 'add', updateNotifications ); control.setting.notifications.bind( 'removed', updateNotifications ); },
/** * Set up event handlers for menu item deletion. */ _setupRemoveUI: function() { var control = this, $removeBtn;
$removeBtn.on( 'click', function() { // Find an adjacent element to add focus to when this menu item goes away. var addingItems = true, $adjacentFocusTarget, $next, $prev, instanceCounter = 0, // Instance count of the menu item deleted. deleteItemOriginalItemId = control.params.original_item_id, addedItems = control.getMenuControl().$sectionContent.find( '.menu-item' ), availableMenuItem;
/* * If the menu item deleted is the only of its instance left, * remove the check icon of this menu item in the right panel. */ _.each( addedItems, function( addedItem ) { var menuItemId, menuItemControl, matches;
// This is because menu item that's deleted is just hidden. if ( ! $( addedItem ).is( ':visible' ) ) { return; }
/** * Update item handle title when changed. */ _setupTitleUI: function() { var control = this, titleEl;
// Ensure that whitespace is trimmed on blur so placeholder can be shown. control.container.find( '.edit-menu-item-title' ).on( 'blur', function() { $( this ).val( $( this ).val().trim() ); } );
/** * * @return {number} */ getDepth: function() { var control = this, setting = control.setting(), depth = 0; if ( ! setting ) { return 0; } while ( setting && setting.menu_item_parent ) { depth += 1; control = api.control( 'nav_menu_item[' + setting.menu_item_parent + ']' ); if ( ! control ) { break; } setting = control.setting(); } return depth; },
/** * Amend the control's params with the data necessary for the JS template just in time. */ renderContent: function() { var control = this, settingValue = control.setting(), containerClasses;
api.Control.prototype.renderContent.call( control ); },
/*********************************************************************** * Begin public API methods **********************************************************************/
/** * Collapse the menu item form control. * * @since 4.5.0 Added params.completeCallback. * * @param {Object} [params] - Optional params. * @param {Function} [params.completeCallback] - Function to call when the form toggle has finished animating. */ collapseForm: function( params ) { this.collapse( params ); },
/** * Expand or collapse the menu item control. * * @deprecated this is poor naming, and it is better to directly set control.expanded( showOrHide ) * @since 4.5.0 Added params.completeCallback. * * @param {boolean} [showOrHide] - If not supplied, will be inverse of current visibility * @param {Object} [params] - Optional params. * @param {Function} [params.completeCallback] - Function to call when the form toggle has finished animating. */ toggleForm: function( showOrHide, params ) { if ( typeof showOrHide === 'undefined' ) { showOrHide = ! this.expanded(); } if ( showOrHide ) { this.expand( params ); } else { this.collapse( params ); } },
/** * Expand or collapse the menu item control. * * @since 4.6.0 * @param {boolean} [showOrHide] - If not supplied, will be inverse of current visibility * @param {Object} [params] - Optional params. * @param {Function} [params.completeCallback] - Function to call when the form toggle has finished animating. */ onChangeExpanded: function( showOrHide, params ) { var self = this, $menuitem, $inside, complete;
// Already expanded or collapsed. if ( $inside.is( ':visible' ) === showOrHide ) { if ( params && params.completeCallback ) { params.completeCallback(); } return; }
if ( showOrHide ) { // Close all other menu item controls before expanding this one. api.control.each( function( otherControl ) { if ( self.params.type === otherControl.params.type && self !== otherControl ) { otherControl.collapseForm(); } } );
/** * Expand the containing menu section, expand the form, and focus on * the first input in the control. * * @since 4.5.0 Added params.completeCallback. * * @param {Object} [params] - Params object. * @param {Function} [params.completeCallback] - Optional callback function when focus has completed. */ focus: function( params ) { params = params || {}; var control = this, originalCompleteCallback = params.completeCallback, focusControl;
/** * Move menu item up one in the menu. */ moveUp: function() { this._changePosition( -1 ); wp.a11y.speak( api.Menus.data.l10n.movedUp ); },
/** * Move menu item up one in the menu. */ moveDown: function() { this._changePosition( 1 ); wp.a11y.speak( api.Menus.data.l10n.movedDown ); }, /** * Move menu item and all children up one level of depth. */ moveLeft: function() { this._changeDepth( -1 ); wp.a11y.speak( api.Menus.data.l10n.movedLeft ); },
/** * Move menu item and children one level deeper, as a submenu of the previous item. */ moveRight: function() { this._changeDepth( 1 ); wp.a11y.speak( api.Menus.data.l10n.movedRight ); },
/** * Note that this will trigger a UI update, causing child items to * move as well and cardinal order class names to be updated. * * @private * * @param {number} offset 1|-1 */ _changePosition: function( offset ) { var control = this, adjacentSetting, settingValue = _.clone( control.setting() ), siblingSettings = [], realPosition;
if ( 1 !== offset && -1 !== offset ) { throw new Error( 'Offset changes by 1 are only supported.' ); }
// Locate the other items under the same parent (siblings). _( control.getMenuControl().getMenuItemControls() ).each(function( otherControl ) { if ( otherControl.setting().menu_item_parent === settingValue.menu_item_parent ) { siblingSettings.push( otherControl.setting ); } }); siblingSettings.sort(function( a, b ) { return a().position - b().position; });
realPosition = _.indexOf( siblingSettings, control.setting ); if ( -1 === realPosition ) { throw new Error( 'Expected setting to be among siblings.' ); }
// Skip doing anything if the item is already at the edge in the desired direction. if ( ( realPosition === 0 && offset < 0 ) || ( realPosition === siblingSettings.length - 1 && offset > 0 ) ) { // @todo Should we allow a menu item to be moved up to break it out of a parent? Adopt with previous or following parent? return; }
// Update any adjacent menu item setting to take on this item's position. adjacentSetting = siblingSettings[ realPosition + offset ]; if ( adjacentSetting ) { adjacentSetting.set( $.extend( _.clone( adjacentSetting() ), { position: settingValue.position } ) ); }
/** * Note that this will trigger a UI update, causing child items to * move as well and cardinal order class names to be updated. * * @private * * @param {number} offset 1|-1 */ _changeDepth: function( offset ) { if ( 1 !== offset && -1 !== offset ) { throw new Error( 'Offset changes by 1 are only supported.' ); } var control = this, settingValue = _.clone( control.setting() ), siblingControls = [], realPosition, siblingControl, parentControl;
// Locate the other items under the same parent (siblings). _( control.getMenuControl().getMenuItemControls() ).each(function( otherControl ) { if ( otherControl.setting().menu_item_parent === settingValue.menu_item_parent ) { siblingControls.push( otherControl ); } }); siblingControls.sort(function( a, b ) { return a.setting().position - b.setting().position; });
realPosition = _.indexOf( siblingControls, control ); if ( -1 === realPosition ) { throw new Error( 'Expected control to be among siblings.' ); }
if ( -1 === offset ) { // Skip moving left an item that is already at the top level. if ( ! settingValue.menu_item_parent ) { return; }
// Make this control the parent of all the following siblings. _( siblingControls ).chain().slice( realPosition ).each(function( siblingControl, i ) { siblingControl.setting.set( $.extend( {}, siblingControl.setting(), { menu_item_parent: control.params.menu_item_id, position: i } ) ); });
// Increase the positions of the parent item's subsequent children to make room for this one. _( control.getMenuControl().getMenuItemControls() ).each(function( otherControl ) { var otherControlSettingValue, isControlToBeShifted; isControlToBeShifted = ( otherControl.setting().menu_item_parent === parentControl.setting().menu_item_parent && otherControl.setting().position > parentControl.setting().position ); if ( isControlToBeShifted ) { otherControlSettingValue = _.clone( otherControl.setting() ); otherControl.setting.set( $.extend( otherControlSettingValue, { position: otherControlSettingValue.position + 1 } ) ); } });
// Make this control the following sibling of its parent item. settingValue.position = parentControl.setting().position + 1; settingValue.menu_item_parent = parentControl.setting().menu_item_parent; control.setting.set( settingValue );
} else if ( 1 === offset ) { // Skip moving right an item that doesn't have a previous sibling. if ( realPosition === 0 ) { return; }
// Make the control the last child of the previous sibling. siblingControl = siblingControls[ realPosition - 1 ]; settingValue.menu_item_parent = siblingControl.params.menu_item_id; settingValue.position = 0; _( control.getMenuControl().getMenuItemControls() ).each(function( otherControl ) { if ( otherControl.setting().menu_item_parent === settingValue.menu_item_parent ) { settingValue.position = Math.max( settingValue.position, otherControl.setting().position ); } }); settingValue.position += 1; control.setting.set( settingValue ); } } } );
/** * wp.customize.Menus.MenuNameControl * * Customizer control for a nav menu's name. * * @class wp.customize.Menus.MenuNameControl * @augments wp.customize.Control */ api.Menus.MenuNameControl = api.Control.extend(/** @lends wp.customize.Menus.MenuNameControl.prototype */{
ready: function() { var control = this;
if ( control.setting ) { var settingValue = control.setting();
control.nameElement = new api.Element( control.container.find( '.menu-name-field' ) );
control.nameElement.bind(function( value ) { var settingValue = control.setting(); if ( settingValue && settingValue.name !== value ) { settingValue = _.clone( settingValue ); settingValue.name = value; control.setting.set( settingValue ); } }); if ( settingValue ) { control.nameElement.set( settingValue.name ); }
checkbox.on( 'change', function() { // Note: We can't use element.bind( function( checked ){ ... } ) here because it will trigger a change as well. updateSetting( this.checked ); } );
/** * Set the selected locations. * * This method sets the selected locations and allows us to do things like * set the default location for a new menu. * * @since 4.9.0 * * @param {Object.<string,boolean>} selections - A map of location selections. * @return {void} */ setSelections: function( selections ) { this.container.find( '.menu-location' ).each( function( i, checkboxNode ) { var locationId = checkboxNode.dataset.locationId; checkboxNode.checked = locationId in selections ? selections[ locationId ] : false; } ); } });
/** * wp.customize.Menus.MenuAutoAddControl * * Customizer control for a nav menu's auto add. * * @class wp.customize.Menus.MenuAutoAddControl * @augments wp.customize.Control */ api.Menus.MenuAutoAddControl = api.Control.extend(/** @lends wp.customize.Menus.MenuAutoAddControl.prototype */{
ready: function() { var control = this, settingValue = control.setting();
/* * Since the control is not registered in PHP, we need to prevent the * preview's sending of the activeControls to result in this control * being deactivated. */ control.active.validate = function() { var value, section = api.section( control.section() ); if ( section ) { value = section.active(); } else { value = false; } return value; };
control.autoAddElement = new api.Element( control.container.find( 'input[type=checkbox].auto_add' ) );
control.autoAddElement.bind(function( value ) { var settingValue = control.setting(); if ( settingValue && settingValue.name !== value ) { settingValue = _.clone( settingValue ); settingValue.auto_add = value; control.setting.set( settingValue ); } }); if ( settingValue ) { control.autoAddElement.set( settingValue.auto_add ); }
/** * wp.customize.Menus.MenuControl * * Customizer control for menus. * Note that 'nav_menu' must match the WP_Menu_Customize_Control::$type * * @class wp.customize.Menus.MenuControl * @augments wp.customize.Control */ api.Menus.MenuControl = api.Control.extend(/** @lends wp.customize.Menus.MenuControl.prototype */{ /** * Set up the control. */ ready: function() { var control = this, section = api.section( control.section() ), menuId = control.params.menu_id, menu = control.setting(), name, widgetTemplate, select;
if ( 'undefined' === typeof this.params.menu_id ) { throw new Error( 'params.menu_id was not defined' ); }
/* * Since the control is not registered in PHP, we need to prevent the * preview's sending of the activeControls to result in this control * being deactivated. */ control.active.validate = function() { var value; if ( section ) { value = section.active(); } else { value = false; } return value; };
// Add the menu to the widget template. widgetTemplate = $( '#available-widgets-list .widget-tpl:has( input.id_base[ value=nav_menu ] )' ); widgetTemplate.find( '.nav-menu-widget-form-controls:first' ).show(); widgetTemplate.find( '.nav-menu-widget-no-menus-message:first' ).hide(); select = widgetTemplate.find( '.widget-inside select:first' ); if ( 0 === select.find( 'option[value=' + String( menuId ) + ']' ).length ) { select.append( new Option( name, menuId ) ); } }
/* * Wait for menu items to be added. * Ideally, we'd bind to an event indicating construction is complete, * but deferring appears to be the best option today. */ _.defer( function () { control.updateInvitationVisibility(); } ); },
/** * Update ordering of menu item controls when the setting is updated. */ _setupModel: function() { var control = this, menuId = control.params.menu_id;
control.setting.bind( function( to ) { var name; if ( false === to ) { control._handleDeletion(); } else { // Update names in the Navigation Menu widgets. name = displayNavMenuName( to.name ); api.control.each( function( widgetControl ) { if ( ! widgetControl.extended( api.controlConstructor.widget_form ) || 'nav_menu' !== widgetControl.params.widget_id_base ) { return; } var select = widgetControl.container.find( 'select' ); select.find( 'option[value=' + String( menuId ) + ']' ).text( name ); }); } } ); },
/** * Allow items in each menu to be re-ordered, and for the order to be previewed. * * Notice that the UI aspects here are handled by wpNavMenu.initSortables() * which is called in MenuSection.onChangeExpanded() * * @param {Object} menuList - The element that has sortable(). */ _setupSortable: function( menuList ) { var control = this;
if ( ! menuList.is( control.$sectionContent ) ) { throw new Error( 'Unexpected menuList.' ); }
// Update the control title. controlTitle.text( name ); if ( location.length ) { location.appendTo( controlTitle ); }
// Update the section title. sectionTitle.text( name ); if ( action.length ) { action.prependTo( sectionTitle ); }
// Update the nav menu name in location selects. api.control.each( function( control ) { if ( /^nav_menu_locations\[/.test( control.id ) ) { control.container.find( 'option[value=' + menuId + ']' ).text( name ); } } );
// Update the nav menu name in all location checkboxes. section.contentContainer.find( '.customize-control-checkbox input' ).each( function() { if ( $( this ).prop( 'checked' ) ) { $( '.current-menu-location-name-' + $( this ).data( 'location-id' ) ).text( name ); } } ); } ); },
/*********************************************************************** * Begin public API methods **********************************************************************/
api.control.each(function( control ) { if ( 'nav_menu_item' === control.params.type && control.setting() && menuTermId === control.setting().nav_menu_term_id ) { menuItemControls.push( control ); } });
return menuItemControls; },
/** * Make sure that each menu item control has the proper depth. */ reflowMenuItems: function() { var menuControl = this, menuItemControls = menuControl.getMenuItemControls(), reflowRecursively;
reflowRecursively = function( context ) { var currentMenuItemControls = [], thisParent = context.currentParent; _.each( context.menuItemControls, function( menuItemControl ) { if ( thisParent === menuItemControl.setting().menu_item_parent ) { currentMenuItemControls.push( menuItemControl ); // @todo We could remove this item from menuItemControls now, for efficiency. } }); currentMenuItemControls.sort( function( a, b ) { return a.setting().position - b.setting().position; });
_.each( currentMenuItemControls, function( menuItemControl ) { // Update position. context.currentAbsolutePosition += 1; menuItemControl.priority.set( context.currentAbsolutePosition ); // This will change the sort order.
/** * Note that this function gets debounced so that when a lot of setting * changes are made at once, for instance when moving a menu item that * has child items, this function will only be called once all of the * settings have been updated. */ debouncedReflowMenuItems: _.debounce( function() { this.reflowMenuItems.apply( this, arguments ); }, 0 ),
/** * Add a new item to this menu. * * @param {Object} item - Value for the nav_menu_item setting to be created. * @return {wp.customize.Menus.controlConstructor.nav_menu_item} The newly-created nav_menu_item control instance. */ addItemToMenu: function( item ) { var menuControl = this, customizeId, settingArgs, setting, menuItemControl, placeholderId, position = 0, priority = 10, originalItemId = item.id || '';
_.each( menuControl.getMenuItemControls(), function( control ) { if ( false === control.setting() ) { return; } priority = Math.max( priority, control.priority() ); if ( 0 === control.setting().menu_item_parent ) { position = Math.max( position, control.setting().position ); } }); position += 1; priority += 1;
item = $.extend( {}, api.Menus.data.defaultSettingValues.nav_menu_item, item, { nav_menu_term_id: menuControl.params.menu_id, original_title: item.title, position: position } ); delete item.id; // Only used by Backbone.
placeholderId = api.Menus.generatePlaceholderAutoIncrementId(); customizeId = 'nav_menu_item[' + String( placeholderId ) + ']'; settingArgs = { type: 'nav_menu_item', transport: api.Menus.data.settingTransport, previewer: api.previewer }; setting = api.create( customizeId, customizeId, {}, settingArgs ); setting.set( item ); // Change from initial empty object to actual item to mark as dirty.
// Add the menu item control. menuItemControl = new api.controlConstructor.nav_menu_item( customizeId, { type: 'nav_menu_item', section: menuControl.id, priority: priority, settings: { 'default': customizeId }, menu_item_id: placeholderId, original_item_id: originalItemId } );
/** * Show an invitation to add new menu items when there are no menu items. * * @since 4.9.0 * * @param {wp.customize.controlConstructor.nav_menu_item[]} optionalMenuItemControls */ updateInvitationVisibility: function ( optionalMenuItemControls ) { var menuItemControls = optionalMenuItemControls || this.getMenuItemControls();
// Set up the menu items panel. api.Menus.availableMenuItemsPanel = new api.Menus.AvailableMenuItemsPanelView({ collection: api.Menus.availableMenuItems });
api.bind( 'saved', function( data ) { if ( data.nav_menu_updates || data.nav_menu_item_updates ) { api.Menus.applySavedData( data ); } } );
/* * Reset the list of posts created in the customizer once published. * The setting is updated quietly (bypassing events being triggered) * so that the customized state doesn't become immediately dirty. */ api.state( 'changesetStatus' ).bind( function( status ) { if ( 'publish' === status ) { api( 'nav_menus_created_posts' )._value = []; } } );
// Open and focus menu control. api.previewer.bind( 'focus-nav-menu-item-control', api.Menus.focusMenuItemControl ); } );
/** * 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 */ api.Menus.applySavedData = function( data ) {
var insertedMenuIdMapping = {}, insertedMenuItemIdMapping = {};
_( data.nav_menu_updates ).each(function( update ) { var oldCustomizeId, newCustomizeId, customizeId, oldSetting, newSetting, setting, settingValue, oldSection, newSection, wasSaved, widgetTemplate, navMenuCount, shouldExpandNewSection; if ( 'inserted' === update.status ) { if ( ! update.previous_term_id ) { throw new Error( 'Expected previous_term_id' ); } if ( ! update.term_id ) { throw new Error( 'Expected term_id' ); } oldCustomizeId = 'nav_menu[' + String( update.previous_term_id ) + ']'; if ( ! api.has( oldCustomizeId ) ) { throw new Error( 'Expected setting to exist: ' + oldCustomizeId ); } oldSetting = api( oldCustomizeId ); if ( ! api.section.has( oldCustomizeId ) ) { throw new Error( 'Expected control to exist: ' + oldCustomizeId ); } oldSection = api.section( oldCustomizeId );
settingValue = oldSetting.get(); if ( ! settingValue ) { throw new Error( 'Did not expect setting to be empty (deleted).' ); } settingValue = $.extend( _.clone( settingValue ), update.saved_value );
// Update the nav_menu_locations[...] controls to remove the placeholder menus from the dropdown options. wp.customize.control.each(function( control ){ if ( /^nav_menu_locations\[/.test( control.id ) ) { control.container.find( 'option[value=' + String( update.previous_term_id ) + ']' ).remove(); } });
// Update nav_menu_locations to reference the new ID. api.each( function( setting ) { var wasSaved = api.state( 'saved' ).get(); if ( /^nav_menu_locations\[/.test( setting.id ) && setting.get() === update.previous_term_id ) { setting.set( update.term_id ); setting._dirty = false; // Not dirty because this is has also just been done on server in WP_Customize_Nav_Menu_Setting::update(). api.state( 'saved' ).set( wasSaved ); setting.preview(); } } );
if ( shouldExpandNewSection ) { newSection.expand(); } } else if ( 'updated' === update.status ) { customizeId = 'nav_menu[' + String( update.term_id ) + ']'; if ( ! api.has( customizeId ) ) { throw new Error( 'Expected setting to exist: ' + customizeId ); }
// Make sure the setting gets updated with its sanitized server value (specifically the conflict-resolved name). setting = api( customizeId ); if ( ! _.isEqual( update.saved_value, setting.get() ) ) { wasSaved = api.state( 'saved' ).get(); setting.set( update.saved_value ); setting._dirty = false; api.state( 'saved' ).set( wasSaved ); } } } );
// Build up mapping of nav_menu_item placeholder IDs to inserted IDs. _( data.nav_menu_item_updates ).each(function( update ) { if ( update.previous_post_id ) { insertedMenuItemIdMapping[ update.previous_post_id ] = update.post_id; } });
_( data.nav_menu_item_updates ).each(function( update ) { var oldCustomizeId, newCustomizeId, oldSetting, newSetting, settingValue, oldControl, newControl; if ( 'inserted' === update.status ) { if ( ! update.previous_post_id ) { throw new Error( 'Expected previous_post_id' ); } if ( ! update.post_id ) { throw new Error( 'Expected post_id' ); } oldCustomizeId = 'nav_menu_item[' + String( update.previous_post_id ) + ']'; if ( ! api.has( oldCustomizeId ) ) { throw new Error( 'Expected setting to exist: ' + oldCustomizeId ); } oldSetting = api( oldCustomizeId ); if ( ! api.control.has( oldCustomizeId ) ) { throw new Error( 'Expected control to exist: ' + oldCustomizeId ); } oldControl = api.control( oldCustomizeId );
settingValue = oldSetting.get(); if ( ! settingValue ) { throw new Error( 'Did not expect setting to be empty (deleted).' ); } settingValue = _.clone( settingValue );
// If the parent menu item was also inserted, update the menu_item_parent to the new ID. if ( settingValue.menu_item_parent < 0 ) { if ( ! insertedMenuItemIdMapping[ settingValue.menu_item_parent ] ) { throw new Error( 'inserted ID for menu_item_parent not available' ); } settingValue.menu_item_parent = insertedMenuItemIdMapping[ settingValue.menu_item_parent ]; }
// If the menu was also inserted, then make sure it uses the new menu ID for nav_menu_term_id. if ( insertedMenuIdMapping[ settingValue.nav_menu_term_id ] ) { settingValue.nav_menu_term_id = insertedMenuIdMapping[ settingValue.nav_menu_term_id ]; }
// Remove old control. oldControl.container.remove(); api.control.remove( oldCustomizeId );
// Add new control to take its place. api.control.add( newControl );
// Delete the placeholder and preview the new setting. oldSetting.callbacks.disable(); // Prevent setting triggering Customizer dirty state when set. oldSetting.set( false ); oldSetting.preview(); newSetting.preview(); oldSetting._dirty = false;
/* * Update the settings for any nav_menu widgets that had selected a placeholder ID. */ _.each( data.widget_nav_menu_updates, function( widgetSettingValue, widgetSettingId ) { var setting = api( widgetSettingId ); if ( setting ) { setting._value = widgetSettingValue; setting.preview(); // Send to the preview now so that menu refresh will use the inserted menu. } }); };
/** * 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 ) { control.focus(); } };
/** * 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 ) ); };
/** * 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 * @return {string} */ function displayNavMenuName( name ) { name = name || ''; name = wp.sanitize.stripTagsAndEncodeText( name ); // Remove any potential tags from name. name = name.toString().trim(); return name || api.Menus.data.l10n.unnamed; }