[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

(no description)

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

Defines 1 class

error_boundary_ErrorBoundary:: (60 methods):
  KeyboardShortcuts()
  KeyboardShortcutsRegister()
  WidgetAreasBlockEditorProvider()
  WidgetAreas()
  ComplementaryAreaTab()
  Sidebar()
  SaveButton()
  UndoButton()
  RedoButton()
  KeyCombination()
  Shortcut()
  DynamicShortcut()
  KeyboardShortcutHelpModal()
  MoreMenu()
  Header()
  Notices()
  WidgetAreasBlockEditorContent()
  InserterSidebar()
  ListViewSidebar()
  closeOnEscape()
  SecondarySidebar()
  Interface()
  UnsavedChangesWarning()
  WelcomeGuide()
  WelcomeGuideImage()
  Layout()
  reinitializeEditor()
  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 60 functions

  __webpack_require__()
  getDefault()
  getModuleExports()
  reducer_widgetAreasOpenState()
  blockInserterPanel()
  listViewPanel()
  transformWidgetToBlock()
  transformBlockToWidget()
  buildWidgetAreasQuery()
  buildWidgetsQuery()
  setWidgetIdForClientId()
  setWidgetAreasOpenState()
  actions_setIsWidgetAreaOpen()
  actions_setIsInserterOpened()
  actions_setIsListViewOpened()
  selectors_isInserterOpened()
  __experimentalGetInsertionPoint()
  selectors_isListViewOpened()
  handleDragStart()
  handleDragEnd()
  handleDragEnter()
  WidgetAreaInnerBlocks()
  WidgetAreaEdit()
  handleDragStart()
  handleDragEnd()
  CopyButton()

Class: error_boundary_ErrorBoundary  - X-Ref

KeyboardShortcuts()   X-Ref
No description

KeyboardShortcutsRegister()   X-Ref
No description

WidgetAreasBlockEditorProvider(_ref)   X-Ref
No description

WidgetAreas(_ref)   X-Ref
Internal dependencies


ComplementaryAreaTab(_ref)   X-Ref
No description

Sidebar()   X-Ref
No description

SaveButton()   X-Ref
No description

UndoButton()   X-Ref
No description

RedoButton()   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
Internal dependencies


Header()   X-Ref
No description

Notices()   X-Ref
No description

WidgetAreasBlockEditorContent(_ref)   X-Ref
No description

InserterSidebar()   X-Ref
No description

ListViewSidebar()   X-Ref
Internal dependencies


closeOnEscape(event)   X-Ref
No description

SecondarySidebar()   X-Ref
No description

Interface(_ref)   X-Ref
No description

UnsavedChangesWarning()   X-Ref
Warns the user if there are unsaved changes before leaving the editor.

This is a duplicate of the component implemented in the editor package.
Duplicated here as edit-widgets doesn't depend on editor.

return: {WPComponent} The component.

WelcomeGuide()   X-Ref
Internal dependencies


WelcomeGuideImage(_ref)   X-Ref
No description

Layout(_ref)   X-Ref
No description

reinitializeEditor(target, settings)   X-Ref
Reinitializes the editor after the user chooses to reboot the editor after
an unhandled error occurs, replacing previously mounted editor element using
an initial state from prior to the crash.

param: {Element} target   DOM node in which editor is rendered.
param: {?Object} settings Editor settings object.

initialize(id, settings)   X-Ref
Initializes the block editor in the widgets screen.

param: {string} id       ID of the root element to render the screen in.
param: {Object} settings 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

reducer_widgetAreasOpenState()   X-Ref
Controls the open state of the widget areas.

param: {Object} state  Redux state.
param: {Object} action Redux action.
return: {Array} Updated state.

blockInserterPanel()   X-Ref
Reducer to set the block inserter panel open or closed.

Note: this reducer interacts with the list view panel reducer
to make sure that only one of the two panels is open at the same time.

param: {Object} state  Current state.
param: {Object} action Dispatched action.

listViewPanel()   X-Ref
Reducer to set the list view panel open or closed.

Note: this reducer interacts with the inserter panel reducer
to make sure that only one of the two panels is open at the same time.

param: {Object} state  Current state.
param: {Object} action Dispatched action.

transformWidgetToBlock(widget)   X-Ref
Converts a widget entity record into a block.

param: {Object} widget The widget entity record.
return: {Object} a block (converted from the entity record).

transformBlockToWidget(block)   X-Ref
Converts a block to a widget entity record.

param: {Object}  block         The block.
param: {Object?} relatedWidget A related widget entity record from the API (optional).
return: {Object} the widget object (converted from block).

buildWidgetAreasQuery()   X-Ref
Builds a query to resolve sidebars.

return: {Object} Query.

buildWidgetsQuery()   X-Ref
Builds a query to resolve widgets.

return: {Object} Query.

setWidgetIdForClientId(clientId, widgetId)   X-Ref
Sets the clientId stored for a particular widgetId.

param: {number} clientId Client id.
param: {number} widgetId Widget id.
return: {Object} Action.

setWidgetAreasOpenState(widgetAreasOpenState)   X-Ref
Sets the open state of all the widget areas.

param: {Object} widgetAreasOpenState The open states of all the widget areas.
return: {Object} Action.

actions_setIsWidgetAreaOpen(clientId, isOpen)   X-Ref
Sets the open state of the widget area.

param: {string}  clientId The clientId of the widget area.
param: {boolean} isOpen   Whether the widget area should be opened.
return: {Object} Action.

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.

actions_setIsListViewOpened(isOpen)   X-Ref
Returns an action object used to open/close the list view.

param: {boolean} isOpen A boolean representing whether the list view should be opened or closed.
return: {Object} Action object.

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.

selectors_isListViewOpened(state)   X-Ref
Returns true if the list view is opened.

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

handleDragStart(event)   X-Ref
No description

handleDragEnd()   X-Ref
No description

handleDragEnter(event)   X-Ref
No description

WidgetAreaInnerBlocks(_ref)   X-Ref
Internal dependencies


WidgetAreaEdit(_ref)   X-Ref
No description

handleDragStart()   X-Ref
No description

handleDragEnd()   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