[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/js/dist/ -> customize-widgets.js (summary)

(no description)

File Size: 4339 lines (142 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

error_boundary_ErrorBoundary:: (42 methods):
  BlockInspectorButton()
  blockInserterPanel()
  selectors_isInserterOpened()
  __experimentalGetInsertionPoint()
  actions_setIsInserterOpened()
  Inserter()
  KeyCombination()
  Shortcut()
  DynamicShortcut()
  KeyboardShortcutHelpModal()
  MoreMenu()
  Header()
  useInserter()
  settingIdToWidgetId()
  blockToWidget()
  widgetToBlock()
  widgetsToBlocks()
  useSidebarBlockEditor()
  FocusControl()
  handleFocus()
  handleReady()
  useBlocksFocusControl()
  SidebarEditorProvider()
  WelcomeGuide()
  KeyboardShortcuts()
  KeyboardShortcutsRegister()
  BlockAppender()
  SidebarBlockEditor()
  SidebarControls()
  useSidebarControls()
  useActiveSidebarControl()
  useClearSelectedBlock()
  handleClearSelectedBlock()
  handleMouseDown()
  handleBlur()
  CustomizeWidgets()
  getInspectorSection()
  getSidebarSection()
  parseWidgetId()
  widgetIdToSettingId()
  debounce()
  debounced()

sidebar_adapter_SidebarAdapter:: (36 methods):
  getInserterOuterSection()
  getSidebarControl()
  moveToSidebar()
  initialize()
  classNames()
  singleEnableItems()
  multipleEnableItems()
  setSingleEnableItem()
  actions_enableComplementaryArea()
  actions_disableComplementaryArea()
  setMultipleEnableItem()
  actions_pinItem()
  actions_unpinItem()
  actions_toggleFeature()
  setFeatureValue()
  setFeatureDefaults()
  getSingleEnableItem()
  selectors_getActiveComplementaryArea()
  isMultipleEnabledItemEnabled()
  selectors_isItemPinned()
  isFeatureActive()
  ComplementaryAreaToggle()
  ActionItemSlot()
  ActionItem()
  ComplementaryAreaMoreMenuItem()
  PinnedItems()
  PinnedItemsSlot()
  ComplementaryAreaSlot()
  ComplementaryAreaFill()
  useAdjustComplementaryListener()
  ComplementaryArea()
  useHTMLClass()
  InterfaceSkeleton()
  MoreMenuDropdown()
  MoreMenuFeatureToggle()
  _extends()

Defines 36 functions

  __webpack_require__()
  getDefault()
  getModuleExports()
  CopyButton()

Class: error_boundary_ErrorBoundary  - X-Ref

BlockInspectorButton(_ref)   X-Ref
No description

blockInserterPanel()   X-Ref
Reducer tracking whether the inserter is open.

param: {boolean|Object} state
param: {Object}         action

selectors_isInserterOpened(state)   X-Ref
Returns true if the inserter is opened.

param: {Object} state Global application state.
return: {boolean} Whether the inserter is opened.

__experimentalGetInsertionPoint(state)   X-Ref
Get the insertion point for the inserter.

param: {Object} state Global application state.
return: {Object} The root client ID and index to insert at.

actions_setIsInserterOpened(value)   X-Ref
Returns an action object used to open/close the inserter.

param: {boolean|Object} value                Whether the inserter should be
param: {string}         value.rootClientId   The root client ID to insert at.
param: {number}         value.insertionIndex The index to insert at.
return: {Object} Action object.

Inserter(_ref)   X-Ref
No description

KeyCombination(_ref)   X-Ref
No description

Shortcut(_ref2)   X-Ref
No description

DynamicShortcut(_ref)   X-Ref
No description

KeyboardShortcutHelpModal(_ref4)   X-Ref
No description

MoreMenu()   X-Ref
No description

Header(_ref)   X-Ref
No description

useInserter(inserter)   X-Ref
Internal dependencies


settingIdToWidgetId(settingId)   X-Ref
Convert settingId to widgetId.

param: {string} settingId The setting id.
return: {string} The widget id.

blockToWidget(block)   X-Ref
Transform a block to a customizable widget.

param: {WPBlock} block          The block to be transformed from.
param: {Object}  existingWidget The widget to be extended from.
return: {Object} The transformed widget.

widgetToBlock(_ref)   X-Ref
Transform a widget to a block.

param: {Object} widget          The widget to be transformed from.
param: {string} widget.id       The widget id.
param: {string} widget.idBase   The id base of the widget.
param: {number} widget.number   The number/index of the widget.
param: {Object} widget.instance The instance of the widget.
return: {WPBlock} The transformed block.

widgetsToBlocks(widgets)   X-Ref
No description

useSidebarBlockEditor(sidebar)   X-Ref
No description

FocusControl(_ref)   X-Ref
No description

handleFocus(settingId)   X-Ref
No description

handleReady()   X-Ref
No description

useBlocksFocusControl(blocks)   X-Ref
Internal dependencies


SidebarEditorProvider(_ref)   X-Ref
No description

WelcomeGuide(_ref)   X-Ref
No description

KeyboardShortcuts(_ref)   X-Ref
No description

KeyboardShortcutsRegister()   X-Ref
No description

BlockAppender(props)   X-Ref
No description

SidebarBlockEditor(_ref)   X-Ref
No description

SidebarControls(_ref)   X-Ref
WordPress dependencies


useSidebarControls()   X-Ref
No description

useActiveSidebarControl()   X-Ref
No description

useClearSelectedBlock(sidebarControl, popoverRef)   X-Ref
We can't just use <BlockSelectionClearer> because the customizer has
many root nodes rather than just one in the post editor.
We need to listen to the focus events in all those roots, and also in
the preview iframe.
This hook will clear the selected block when focusing outside the editor,
with a few exceptions:
1. Focusing on popovers.
2. Focusing on the inspector.
3. Focusing on any modals/dialogs.
These cases are normally triggered by user interactions from the editor,
not by explicitly focusing outside the editor, hence no need for clearing.

param: {Object} sidebarControl The sidebar control instance.
param: {Object} popoverRef     The ref object of the popover node container.

handleClearSelectedBlock(element)   X-Ref
No description

handleMouseDown(event)   X-Ref
No description

handleBlur()   X-Ref
No description

CustomizeWidgets(_ref)   X-Ref
No description

getInspectorSection()   X-Ref
No description

getSidebarSection()   X-Ref
No description

parseWidgetId(widgetId)   X-Ref
No description

widgetIdToSettingId(widgetId)   X-Ref
No description

debounce(leading, callback, timeout)   X-Ref
This is a custom debounce function to call different callbacks depending on
whether it's the _leading_ call or not.

param: {Function} leading  The callback that gets called first.
param: {Function} callback The callback that gets called after the first time.
param: {number}   timeout  The debounced time in milliseconds.
return: {Function} The debounced function.

debounced()   X-Ref
No description

Class: sidebar_adapter_SidebarAdapter  - X-Ref

getInserterOuterSection()   X-Ref
Internal dependencies


getSidebarControl()   X-Ref
No description

moveToSidebar(sidebarControlId)   X-Ref
No description

initialize(editorName, blockEditorSettings)   X-Ref
Initializes the widgets block editor in the customizer.

param: {string} editorName          The editor name.
param: {Object} blockEditorSettings Block editor settings.

classNames()   X-Ref
No description

singleEnableItems()   X-Ref
Reducer to keep tract of the active area per scope.

param: {boolean} state           Previous state.
param: {Object}  action          Action object.
param: {string}  action.type     Action type.
param: {string}  action.itemType Type of item.
param: {string}  action.scope    Item scope.
param: {string}  action.item     Item name.
return: {Object} Updated state.

multipleEnableItems()   X-Ref
Reducer keeping track of the "pinned" items per scope.

param: {boolean} state           Previous state.
param: {Object}  action          Action object.
param: {string}  action.type     Action type.
param: {string}  action.itemType Type of item.
param: {string}  action.scope    Item scope.
param: {string}  action.item     Item name.
param: {boolean} action.isEnable Whether the item is pinned.
return: {Object} Updated state.

setSingleEnableItem(itemType, scope, item)   X-Ref
Returns an action object used in signalling that an active area should be changed.

param: {string} itemType Type of item.
param: {string} scope    Item scope.
param: {string} item     Item identifier.
return: {Object} Action object.

actions_enableComplementaryArea(scope, area)   X-Ref
Returns an action object used in signalling that a complementary item should be enabled.

param: {string} scope Complementary area scope.
param: {string} area  Area identifier.
return: {Object} Action object.

actions_disableComplementaryArea(scope)   X-Ref
Returns an action object used in signalling that the complementary area of a given scope should be disabled.

param: {string} scope Complementary area scope.
return: {Object} Action object.

setMultipleEnableItem(itemType, scope, item, isEnable)   X-Ref
Returns an action object to make an area enabled/disabled.

param: {string}  itemType Type of item.
param: {string}  scope    Item scope.
param: {string}  item     Item identifier.
param: {boolean} isEnable Boolean indicating if an area should be pinned or not.
return: {Object} Action object.

actions_pinItem(scope, itemId)   X-Ref
Returns an action object used in signalling that an item should be pinned.

param: {string} scope  Item scope.
param: {string} itemId Item identifier.
return: {Object} Action object.

actions_unpinItem(scope, itemId)   X-Ref
Returns an action object used in signalling that an item should be unpinned.

param: {string} scope  Item scope.
param: {string} itemId Item identifier.
return: {Object} Action object.

actions_toggleFeature(scope, featureName)   X-Ref
Returns an action object used in signalling that a feature should be toggled.

param: {string} scope       The feature scope (e.g. core/edit-post).
param: {string} featureName The feature name.

setFeatureValue(scope, featureName, value)   X-Ref
Returns an action object used in signalling that a feature should be set to
a true or false value

param: {string}  scope       The feature scope (e.g. core/edit-post).
param: {string}  featureName The feature name.
param: {boolean} value       The value to set.
return: {Object} Action object.

setFeatureDefaults(scope, defaults)   X-Ref
Returns an action object used in signalling that defaults should be set for features.

param: {string}                  scope    The feature scope (e.g. core/edit-post).
param: {Object<string, boolean>} defaults A key/value map of feature names to values.
return: {Object} Action object.

getSingleEnableItem(state, itemType, scope)   X-Ref
Returns the item that is enabled in a given scope.

param: {Object} state    Global application state.
param: {string} itemType Type of item.
param: {string} scope    Item scope.
return: {?string|null} The item that is enabled in the passed scope and type.

selectors_getActiveComplementaryArea(state, scope)   X-Ref
Returns the complementary area that is active in a given scope.

param: {Object} state Global application state.
param: {string} scope Item scope.
return: {string} The complementary area that is active in the given scope.

isMultipleEnabledItemEnabled(state, itemType, scope, item)   X-Ref
Returns a boolean indicating if an item is enabled or not in a given scope.

param: {Object} state    Global application state.
param: {string} itemType Type of item.
param: {string} scope    Scope.
param: {string} item     Item to check.
return: {boolean|undefined} True if the item is enabled, false otherwise if the item is explicitly disabled, and undefined if there is no information for that item.

selectors_isItemPinned(state, scope, item)   X-Ref
Returns a boolean indicating if an item is pinned or not.

param: {Object} state Global application state.
param: {string} scope Scope.
param: {string} item  Item to check.
return: {boolean} True if the item is pinned and false otherwise.

isFeatureActive(state, scope, featureName)   X-Ref
Returns a boolean indicating whether a feature is active for a particular
scope.

param: {Object} state       The store state.
param: {string} scope       The scope of the feature (e.g. core/edit-post).
param: {string} featureName The name of the feature.
return: {boolean} Is the feature enabled?

ComplementaryAreaToggle(_ref)   X-Ref
No description

ActionItemSlot(_ref)   X-Ref
No description

ActionItem(_ref3)   X-Ref
No description

ComplementaryAreaMoreMenuItem(_ref)   X-Ref
No description

PinnedItems(_ref)   X-Ref
No description

PinnedItemsSlot(_ref2)   X-Ref
No description

ComplementaryAreaSlot(_ref)   X-Ref
No description

ComplementaryAreaFill(_ref2)   X-Ref
No description

useAdjustComplementaryListener(scope, identifier, activeArea, isActive, isSmall)   X-Ref
No description

ComplementaryArea(_ref3)   X-Ref
No description

useHTMLClass(className)   X-Ref
No description

InterfaceSkeleton(_ref, ref)   X-Ref
No description

MoreMenuDropdown(_ref)   X-Ref
No description

MoreMenuFeatureToggle(_ref)   X-Ref
Internal dependencies


_extends()   X-Ref
No description

Functions
Functions that are not part of a class:

__webpack_require__(moduleId)   X-Ref
No description

getDefault()   X-Ref
No description

getModuleExports()   X-Ref
No description

CopyButton(_ref)   X-Ref
No description



Generated: Sun Jan 16 01:00:03 2022 Cross-referenced by PHPXref 0.7.1