[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

(no description)

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

Defines 1 class

sidebar_adapter_SidebarAdapter:: (6 methods):
  getInserterOuterSection()
  getSidebarControl()
  moveToSidebar()
  initialize()
  classNames()
  _extends()

Defines 6 functions

  __webpack_require__()
  getDefault()
  getModuleExports()
  BlockInspectorButton()
  Inserter()
  __unstableIsFeatureActive()
  __unstableToggleFeature()
  FeatureToggle()
  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()

Class: sidebar_adapter_SidebarAdapter  - X-Ref

getInserterOuterSection()   X-Ref
WordPress 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

_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

BlockInspectorButton({inspector,closeMenu,...props})   X-Ref
No description

Inserter({setIsOpened})   X-Ref
No description

__unstableIsFeatureActive(state, feature)   X-Ref
Returns whether the given feature is enabled or not.

This function is unstable, as it is mostly copied from the edit-post
package. Editor features and preferences have a lot of scope for
being generalized and refactored.

return: {boolean} Is active.
param: {Object} state   Global application state.
param: {string} feature Feature slug.

__unstableToggleFeature(feature)   X-Ref
Returns an action object used to toggle a feature flag.

This function is unstable, as it is mostly copied from the edit-post
package. Editor features and preferences have a lot of scope for
being generalized and refactored.

return: {Object} Action object.
param: {string} feature Feature name.

FeatureToggle({label,info,messageActivated,messageDeactivated,shortcut,feature})   X-Ref
Internal dependencies


KeyCombination({keyCombination,forceAriaLabel})   X-Ref
No description

Shortcut({description,keyCombination,aliases = [],ariaLabel})   X-Ref
No description

DynamicShortcut({name})   X-Ref
No description

KeyboardShortcutHelpModal({isModalActive,toggleModal})   X-Ref
No description

MoreMenu()   X-Ref
No description

Header({sidebar,inserter,isInserterOpened,setIsInserterOpened,isFixedToolbarActive})   X-Ref
No description

useInserter(inserter)   X-Ref
WordPress dependencies


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

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

blockToWidget(block, existingWidget = null)   X-Ref
Transform a block to a customizable widget.

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

widgetToBlock({id,idBase,number,instance})   X-Ref
Transform a widget to a block.

return: {WPBlock} The transformed 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.

widgetsToBlocks(widgets)   X-Ref
No description

useSidebarBlockEditor(sidebar)   X-Ref
No description

FocusControl({api,sidebarControls,children})   X-Ref
No description

handleFocus(settingId)   X-Ref
No description

handleReady()   X-Ref
No description

useBlocksFocusControl(blocks)   X-Ref
Internal dependencies


SidebarEditorProvider({sidebar,settings,children})   X-Ref
No description

WelcomeGuide({sidebar})   X-Ref
Internal dependencies


KeyboardShortcuts({undo,redo,save})   X-Ref
No description

KeyboardShortcutsRegister()   X-Ref
No description

BlockAppender(props)   X-Ref
No description

SidebarBlockEditor({blockEditorSettings,sidebar,inserter,inspector})   X-Ref
No description

SidebarControls({sidebarControls,activeSidebarControl,children})   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({api,sidebarControls,blockEditorSettings})   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.

return: {Function} The debounced function.
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.

debounced(...args)   X-Ref
No description



Generated: Sun Aug 1 01:00:05 2021 Cross-referenced by PHPXref 0.7.1