: str_replace(): Passing null to parameter #2 ($replace) of type array|string is deprecated in
// noinspection ES6ConvertVarToLetConst
/* global wpf, WPFormsBuilder, WPSplash */
var WPForms = window.WPForms || {}; // eslint-disable-line no-var
WPForms.Admin = WPForms.Admin || {};
WPForms.Admin.Builder = WPForms.Admin.Builder || {};
WPForms.Admin.Builder.ContextMenu = WPForms.Admin.Builder.ContextMenu || ( function( document, window, $ ) {
* Public functions and properties.
contextMenu: '.wpforms-context-menu',
mainContextMenuContainer: '#wpforms-context-menu-container',
mainContextMenu: '#wpforms-context-menu',
fieldContextMenu: '#wpforms-field-context-menu',
contextMenuItem: '.wpforms-context-menu:not(.wpforms-context-menu-dropdown) .wpforms-context-menu-list-item',
contextMenuSelectiveItem: '.wpforms-context-menu-list-item-selective',
contextMenuDivider: '.wpforms-context-menu .wpforms-context-menu-list-divider',
builder: '#wpforms-builder',
sidebarToggle: '.wpforms-panels .wpforms-panel-sidebar-content .wpforms-panel-sidebar-toggle',
* Start the engine. DOM is not ready yet, use only to init something.
* Setup. Prepare some variables.
el.$document = $( document );
el.$contextMenu = $( app.selectors.contextMenu );
el.$mainContextMenuContainer = $( app.selectors.mainContextMenuContainer );
el.$mainContextMenu = $( app.selectors.mainContextMenu );
el.$fieldContextMenu = $( app.selectors.fieldContextMenu );
el.$contextMenuItem = $( app.selectors.contextMenuItem );
el.$contextMenuSelectiveItem = $( app.selectors.contextMenuSelectiveItem );
el.$contextMenuDivider = $( app.selectors.contextMenuDivider );
el.$builder = $( app.selectors.builder );
el.$sidebarToggle = $( app.selectors.sidebarToggle );
// Display a main menu on click on the icon in the toolbar.
el.$mainContextMenuContainer.on( 'click', ( event ) => {
el.$mainContextMenu.fadeToggle( 150, () => {
el.$mainContextMenuContainer.toggleClass( 'wpforms-context-menu-active' );
// Handle clicks on the main menu items.
el.$mainContextMenu.on( 'click', '.wpforms-context-menu-list-item', app.mainMenuItemClickAction );
// Hide the main menu if it's visible when clicking outside it.
el.$builder.on( 'click contextmenu', app.hideMainContextMenu );
// Display a context menu on right-click on the form field in the preview area.
el.$document.on( 'contextmenu', app.rightClickContextMenuHandler );
el.$document.on( 'click', app.hideMenuOnClick );
el.$builder.on( 'wpformsFieldTabToggle', app.hideMenuOnClick );
* Right-click context menu handler.
* @param {KeyboardEvent} e Event object.
rightClickContextMenuHandler( e ) {
const $field = $( e.target ).closest( '.wpforms-field' );
if ( $( e.target ).closest( app.selectors.contextMenu ).length || ! $field.length ) {
app.checkMenuItemsVisibility( $field );
app.checkDividerVisibility();
app.menuPositioning( e );
app.menuItemClickAction( $field );
app.checkSelectiveMenuItemsState( $field );
* Hide the main context menu when clicking outside it.
* @param {Event} event Event object.
hideMainContextMenu( event ) {
if ( el.$mainContextMenu.is( ':hidden' ) || $( event.target ).closest( app.selectors.mainContextMenuContainer ).length > 0 ) {
el.$mainContextMenu.fadeOut( 150, () => {
el.$mainContextMenuContainer.removeClass( 'wpforms-context-menu-active' );
* Main menu item click action.
mainMenuItemClickAction() {
const action = $item.data( 'action' );
const actionUrl = $item.data( 'action-url' ) ?? '';
'duplicate-form': () => app.handleUrlAction( actionUrl, false, true ),
'save-as-template': () => app.handleUrlAction( actionUrl, false, true ),
'duplicate-template': () => app.handleUrlAction( actionUrl, false, true ),
'view-entries': () => app.handleUrlAction( actionUrl, true ),
'view-payments': () => app.handleUrlAction( actionUrl, true ),
'keyboard-shortcuts': WPFormsBuilder.openKeyboardShortcutsModal,
'whats-new': app.handleWhatsNewAction,
const handler = actionHandlers[ action ];
* Menu item click action.
* @param {Object} $field Field object.
menuItemClickAction( $field ) {
const fieldId = $field.data( 'field-id' );
el.$contextMenuItem.off( 'click' ).on( 'click', function() {
if ( $item.hasClass( 'wpforms-context-menu-list-item-has-child' ) ) {
const action = $item.data( 'action' );
edit: () => app.handleEditAction( $field, fieldId ),
duplicate: () => app.handleDuplicateAction( $field ),
delete: () => app.handleDeleteAction( $field ),
required: () => app.handleRequiredAction( $item, fieldId ),
label: () => app.handleLabelAction( $item, fieldId ),
'smart-logic': () => app.handleSmartLogicAction( $field, fieldId ),
'field-size': () => app.handleSizeAction( $item, fieldId ),
const handler = actionHandlers[ action ];
* @param {Object} $field Field object.
* @param {string} fieldId Field ID.
handleEditAction( $field, fieldId ) {
$field.trigger( 'click' );
// This is needed to make sure the sidebar is open when the "Edit" button is clicked.
$( `#wpforms-field-option-basic-${ fieldId } .wpforms-field-option-group-toggle` ).trigger( 'click' );
* Handle duplicate action.
* @param {Object} $field Field object.
handleDuplicateAction( $field ) {
$field.find( '.wpforms-field-duplicate' ).first().trigger( 'click' );
* @param {Object} $field Field object.
handleDeleteAction( $field ) {
$field.find( '.wpforms-field-delete' ).first().trigger( 'click' );
* Handle required action.
* @param {Object} $item Menu item object.
* @param {string} fieldId Field ID.
handleRequiredAction( $item, fieldId ) {
$( `#wpforms-field-option-${ fieldId }-required` ).trigger( 'click' );
const state = app.checkRequiredState( fieldId ) ? 'active' : 'inactive';
app.toggleItemText( $item, state );
* @param {Object} $item Menu item object.
* @param {string} fieldId Field ID.
handleLabelAction( $item, fieldId ) {
$( `#wpforms-field-option-${ fieldId }-label_hide` ).trigger( 'click' );
const state = app.checkLabelState( fieldId ) ? 'active' : 'inactive';
app.toggleItemText( $item, state );
* Handle smart logic action.
* @param {Object} $field Field object.
* @param {string} fieldId Field ID.
handleSmartLogicAction( $field, fieldId ) {
// This is needed to make sure the sidebar is open when the "Edit Conditional Logic" button is clicked.
$field.trigger( 'click' );
$( `#wpforms-field-option-conditionals-${ fieldId } .wpforms-field-option-group-toggle` ).trigger( 'click' );
$( `#wpforms-field-option-${ fieldId } .wpforms-field-option-group-conditionals .education-modal` ).trigger( 'click' );
* @param {Object} $item Menu item object.
* @param {string} fieldId Field ID.
handleSizeAction( $item, fieldId ) {
const value = $item.data( 'value' );
$( `#wpforms-field-option-${ fieldId }-size` ).val( value ).trigger( 'change' );
$item.addClass( 'wpforms-context-menu-list-item-active' ).siblings().removeClass( 'wpforms-context-menu-list-item-active' );
* Handle "What's New" action.
const modal = $( '#tmpl-wpforms-splash-modal-content' );
if ( modal.length && typeof WPSplash !== 'undefined' ) {
* Handle a simple URL action.
* @param {string} actionUrl URL.
* @param {boolean} newTab Whether to open the URL in a new tab.
* @param {boolean} saveForm Whether to save the form before following the action URL.
handleUrlAction( actionUrl, newTab = false, saveForm = false ) {
// The form does not need to be saved, open the URL.
newTab ? window.open( actionUrl ) : window.location.assign( actionUrl ); // eslint-disable-line no-unused-expressions
const isModified = wpf.savedState !== wpf.getFormState( '#wpforms-builder-form' );
// The form was changed and must be saved before following the action URL.
el.$builder.on( 'wpformsSaved', () => {
newTab ? window.open( actionUrl ) : window.location.assign( actionUrl ); // eslint-disable-line no-unused-expressions
WPFormsBuilder.formSave( false );
// The form was not changed, open the URL.
newTab ? window.open( actionUrl ) : window.location.assign( actionUrl ); // eslint-disable-line no-unused-expressions
* @param {Object} $item Menu item object.
* @param {string} state State.
toggleItemText( $item, state ) {
const $text = $item.find( '.wpforms-context-menu-list-item-text' );
const activeText = $text.data( 'active-text' );
const inactiveText = $text.data( 'inactive-text' ) || $text.text();
$text.data( 'inactive-text', inactiveText );
$text.text( state === 'active' ? activeText : inactiveText );
* Check selective menu items state.
* @param {Object} $field Field object.
checkSelectiveMenuItemsState( $field ) {
const fieldId = $field.data( 'field-id' );
el.$contextMenuSelectiveItem.each( function() {
const action = $item.data( 'action' );
const value = $item.data( 'value' );
const shouldChangeStateHandlers = {
required: () => app.checkRequiredState( fieldId ),
label: () => app.checkLabelState( fieldId ),
'field-size': () => app.checkFieldSizeState( fieldId, value ),
const handler = shouldChangeStateHandlers[ action ];
$item.addClass( 'wpforms-context-menu-list-item-active' );
app.toggleItemText( $item, 'active' );
$item.removeClass( 'wpforms-context-menu-list-item-active' );
app.toggleItemText( $item, 'inactive' );
* Check the required state.
* @param {string} fieldId Field ID.
* @return {boolean} True if option checked.
checkRequiredState( fieldId ) {
return $( `#wpforms-field-option-${ fieldId }-required[type="checkbox"]` ).is( ':checked' );
* @param {string} fieldId Field ID.
* @return {boolean} True if option checked.
checkLabelState( fieldId ) {
return $( `#wpforms-field-option-${ fieldId }-label_hide[type="checkbox"]` ).is( ':checked' );
* Check field size state.
* @param {string} fieldId Field ID.
* @param {string} value Value.
* @return {boolean} True if value equals.
checkFieldSizeState( fieldId, value ) {
return $( `#wpforms-field-option-${ fieldId }-size` ).val() === value;
* @param {Object} e Event object.
const menuWidth = el.$fieldContextMenu.width();
const menuHeight = el.$fieldContextMenu.height();
const windowWidth = window.innerWidth;
const windowHeight = window.innerHeight;
el.$fieldContextMenu.removeClass( 'wpforms-context-menu-selective-left' );
let topPosition = e.pageY;
let leftPosition = e.pageX;
if ( e.pageY + menuHeight > windowHeight ) {
topPosition = windowHeight - menuHeight - 15;
if ( e.pageX + menuWidth > windowWidth ) {
leftPosition = windowWidth - menuWidth - 15;
el.$fieldContextMenu.addClass( 'wpforms-context-menu-selective-left' );