[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

(no description)

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

Defines 2 classes

error_boundary_ErrorBoundary:: (48 methods):
  KeyboardShortcuts()
  KeyboardShortcutsRegister()
  WidgetAreasBlockEditorProvider()
  WidgetAreas()
  ComplementaryAreaTab()
  Sidebar()
  SaveButton()
  UndoButton()
  RedoButton()
  FeatureToggle()
  KeyCombination()
  Shortcut()
  DynamicShortcut()
  KeyboardShortcutHelpModal()
  MoreMenu()
  Header()
  Notices()
  WidgetAreasBlockEditorContent()
  Interface()
  UnsavedChangesWarning()
  WelcomeGuide()
  WelcomeGuideImage()
  Layout()
  reinitializeEditor()
  initialize()
  classNames()
  singleEnableItems()
  multipleEnableItems()
  setSingleEnableItem()
  actions_enableComplementaryArea()
  actions_disableComplementaryArea()
  setMultipleEnableItem()
  actions_pinItem()
  actions_unpinItem()
  getSingleEnableItem()
  selectors_getActiveComplementaryArea()
  isMultipleEnabledItemEnabled()
  selectors_isItemPinned()
  ComplementaryAreaToggle()
  ActionItemSlot()
  ActionItem()
  ComplementaryAreaMoreMenuItem()
  PinnedItems()
  PinnedItemsSlot()
  ComplementaryAreaSlot()
  ComplementaryAreaFill()
  useAdjustComplementaryListener()
  ComplementaryArea()

fullscreen_mode_FullscreenMode:: (3 methods):
  useHTMLClass()
  InterfaceSkeleton()
  _extends()

Defines 3 functions

  __webpack_require__()
  getDefault()
  getModuleExports()
  reducer_widgetAreasOpenState()
  blockInserterPanel()
  buildWidgetAreasQuery()
  buildWidgetsQuery()
  apiFetch()
  getPendingActions()
  isProcessingPost()
  getNavigationPostForMenu()
  resolveWidgetAreas()
  resolveWidgets()
  controls_select()
  dispatch()
  transformWidgetToBlock()
  transformBlockToWidget()
  setWidgetIdForClientId()
  setWidgetAreasOpenState()
  actions_setIsWidgetAreaOpen()
  actions_setIsInserterOpened()
  __unstableToggleFeature()
  selectors_isInserterOpened()
  __experimentalGetInsertionPoint()
  __unstableIsFeatureActive()
  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({blockEditorSettings,children,...props})   X-Ref
No description

WidgetAreas({selectedWidgetAreaId})   X-Ref
Internal dependencies


ComplementaryAreaTab({identifier,label,isActive})   X-Ref
No description

Sidebar()   X-Ref
No description

SaveButton()   X-Ref
No description

UndoButton()   X-Ref
No description

RedoButton()   X-Ref
No description

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()   X-Ref
No description

Notices()   X-Ref
No description

WidgetAreasBlockEditorContent({blockEditorSettings})   X-Ref
No description

Interface({blockEditorSettings})   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({nonAnimatedSrc,animatedSrc})   X-Ref
No description

Layout({blockEditorSettings,onError})   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(state = {}, {type,itemType,scope,item})   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(state = {}, {type,itemType,scope,item,isEnable})   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.

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.

ComplementaryAreaToggle({as = external_wp_components_["Button"],scope,identifier,icon,selectedIcon,...props})   X-Ref
No description

ActionItemSlot({name,as: Component = external_wp_components_["ButtonGroup"],fillProps = {},bubblesVirtually,...props})   X-Ref
No description

ActionItem({name,as: Component = external_wp_components_["Button"],onClick,...props})   X-Ref
No description

ComplementaryAreaMoreMenuItem({scope,target,__unstableExplicitMenuItem,...props})   X-Ref
No description

PinnedItems({scope,...props})   X-Ref
No description

PinnedItemsSlot({scope,className,...props})   X-Ref
No description

ComplementaryAreaSlot({scope,...props})   X-Ref
No description

ComplementaryAreaFill({scope,children,className})   X-Ref
No description

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

ComplementaryArea({children,className,closeLabel = Object(external_wp_i18n_["__"])   X-Ref
No description

Class: fullscreen_mode_FullscreenMode  - X-Ref

WordPress dependencies

useHTMLClass(className)   X-Ref
No description

InterfaceSkeleton({footer,header,sidebar,secondarySidebar,notices,content,drawer,actions,labels,className,shortcuts}, ref)   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

reducer_widgetAreasOpenState(state = {}, action)   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(state = false, action)   X-Ref
Reducer tracking whether the inserter is open.

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

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

return: {Object} Query.

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

return: {Object} Query.

apiFetch(request)   X-Ref
Trigger an API Fetch request.

param: {Object} request API Fetch Request Object.
return: {Object} control descriptor.

getPendingActions(postId)   X-Ref
Returns a list of pending actions for given post id.

param: {number} postId Post ID.
return: {Array} List of pending actions.

isProcessingPost(postId)   X-Ref
Returns boolean indicating whether or not an action processing specified
post is currently running.

param: {number} postId Post ID.
return: {Object} Action.

getNavigationPostForMenu(menuId)   X-Ref
Resolves navigation post for given menuId.

param: {number} menuId Menu ID.
return: {Object} Action.

resolveWidgetAreas(query = buildWidgetAreasQuery()   X-Ref
Resolves widget areas.

param: {Object} query Query.
return: {Object} Action.

resolveWidgets(query = buildWidgetsQuery()   X-Ref
Resolves widgets.

param: {Object} query Query.
return: {Object} Action.

controls_select(registryName, selectorName, ...args)   X-Ref
Calls a selector using chosen registry.

param: {string} registryName Registry name.
param: {string} selectorName Selector name.
param: {Array} args          Selector arguments.
return: {Object} control descriptor.

dispatch(registryName, actionName, ...args)   X-Ref
Dispatches an action using chosen registry.

param: {string} registryName Registry name.
param: {string} actionName   Action name.
param: {Array} args          Selector arguments.
return: {Object} control descriptor.

transformWidgetToBlock(widget)   X-Ref
WordPress dependencies


transformBlockToWidget(block, relatedWidget = {})   X-Ref
No description

setWidgetIdForClientId(clientId, widgetId)   X-Ref
No description

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.

__unstableToggleFeature(feature)   X-Ref
No description

selectors_isInserterOpened(state)   X-Ref
No description

__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.

__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.

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

handleDragStart(event)   X-Ref
No description

handleDragEnd()   X-Ref
No description

handleDragEnter(event)   X-Ref
No description

WidgetAreaInnerBlocks({id})   X-Ref
Internal dependencies


WidgetAreaEdit({clientId,className,attributes: {id,name}})   X-Ref
No description

handleDragStart()   X-Ref
No description

handleDragEnd()   X-Ref
No description

CopyButton({text,children})   X-Ref
No description



Generated: Sun Oct 17 01:00:03 2021 Cross-referenced by PHPXref 0.7.1