[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

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

WordPress dependencies

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

Defines 1 class

ErrorBoundary:: (30 methods):
  KeyboardShortcuts()
  KeyboardShortcutsRegister()
  WidgetAreasBlockEditorProvider()
  WidgetAreas()
  SidebarHeader()
  SidebarContent()
  Sidebar()
  UndoButton()
  RedoButton()
  DocumentTools()
  SaveButton()
  KeyCombination()
  Shortcut()
  DynamicShortcut()
  KeyboardShortcutHelpModal()
  MoreMenu()
  Header()
  Notices()
  WidgetAreasBlockEditorContent()
  InserterSidebar()
  ListViewSidebar()
  SecondarySidebar()
  Interface()
  UnsavedChangesWarning()
  WelcomeGuide()
  WelcomeGuideImage()
  Layout()
  onPluginAreaError()
  initializeEditor()
  reinitializeEditor()

Defines 30 functions

  widgetAreasOpenState()
  blockInserterPanel()
  listViewPanel()
  listViewToggleRef()
  inserterSidebarToggleRef()
  r()
  normalizeComplementaryAreaScope()
  normalizeComplementaryAreaName()
  toggleFeature()
  setFeatureValue()
  setFeatureDefaults()
  openModal()
  closeModal()
  isModalActive()
  complementaryAreas()
  activeModal()
  roleSupportsCheckedState()
  ComplementaryAreaToggle()
  ActionItemSlot()
  ActionItem()
  ComplementaryAreaMoreMenuItem()
  PinnedItems()
  PinnedItemsSlot()
  ComplementaryAreaSlot()
  ComplementaryAreaFill()
  useAdjustComplementaryListener()
  ComplementaryArea()
  useHTMLClass()
  InterfaceSkeleton()
  transformWidgetToBlock()
  transformBlockToWidget()
  buildWidgetAreasQuery()
  buildWidgetsQuery()
  setWidgetIdForClientId()
  setWidgetAreasOpenState()
  setIsWidgetAreaOpen()
  setIsInserterOpened()
  setIsListViewOpened()
  isInserterOpened()
  __experimentalGetInsertionPoint()
  isListViewOpened()
  getListViewToggleRef()
  getInserterSidebarToggleRef()
  handleDragStart()
  handleDragEnd()
  handleDragEnter()
  WidgetAreaInnerBlocks()
  WidgetAreaEdit()
  handleDragStart()
  handleDragEnd()
  CopyButton()
  ErrorBoundaryWarning()

Class: ErrorBoundary  - X-Ref

KeyboardShortcuts()   X-Ref
Internal dependencies


KeyboardShortcutsRegister()   X-Ref
No description

WidgetAreasBlockEditorProvider({blockEditorSettings,children,...props})   X-Ref
No description

WidgetAreas({selectedWidgetAreaId})   X-Ref
No description

SidebarHeader({selectedWidgetAreaBlock})   X-Ref
No description

SidebarContent({hasSelectedNonAreaBlock,currentArea,isGeneralSidebarOpen,selectedWidgetAreaBlock})   X-Ref
No description

Sidebar()   X-Ref
No description

UndoButton(props, ref)   X-Ref
No description

RedoButton(props, ref)   X-Ref
No description

DocumentTools()   X-Ref
No description

SaveButton()   X-Ref
Internal dependencies


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

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

DynamicShortcut({name})   X-Ref
Internal dependencies


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

InserterSidebar()   X-Ref
No description

ListViewSidebar()   X-Ref
No description

SecondarySidebar()   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: {Component} The component.

WelcomeGuide()   X-Ref
No description

WelcomeGuideImage({nonAnimatedSrc,animatedSrc})   X-Ref
No description

Layout({blockEditorSettings})   X-Ref
No description

onPluginAreaError(name)   X-Ref
No description

initializeEditor(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.

reinitializeEditor()   X-Ref
Compatibility export under the old `initialize` name.


Functions
Functions that are not part of a class:

widgetAreasOpenState(state = {}, action)   X-Ref
Controls the open state of the widget areas.

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

blockInserterPanel(state = false, action)   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(state = false, action)   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.

listViewToggleRef(state = {current: null})   X-Ref
This reducer does nothing aside initializing a ref to the list view toggle.
We will have a unique ref per "editor" instance.

return: {Object} Reference to the list view toggle button.
param: {Object} state

inserterSidebarToggleRef(state = {current: null})   X-Ref
This reducer does nothing aside initializing a ref to the inserter sidebar toggle.
We will have a unique ref per "editor" instance.

return: {Object} Reference to the inserter sidebar toggle button.
param: {Object} state

r(e)   X-Ref
No description

normalizeComplementaryAreaScope(scope)   X-Ref
WordPress dependencies


normalizeComplementaryAreaName(scope, name)   X-Ref
No description

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

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

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

return: {Object} Action object.
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.

openModal(name)   X-Ref
Returns an action object used in signalling that the user opened a modal.

return: {Object} Action object.
param: {string} name A string that uniquely identifies the modal.

closeModal()   X-Ref
Returns an action object signalling that the user closed a modal.

return: {Object} Action object.

isModalActive(state, modalName)   X-Ref
Returns true if a modal is active, or false otherwise.

return: {boolean} Whether the modal is active.
param: {Object} state     Global application state.
param: {string} modalName A string that uniquely identifies the modal.

complementaryAreas(state = {}, action)   X-Ref
WordPress dependencies


activeModal(state = null, action)   X-Ref
Reducer for storing the name of the open modal, or null if no modal is open.

return: {Object} Updated state
param: {Object} state  Previous state.
param: {Object} action Action object containing the `name` of the modal

roleSupportsCheckedState(role)   X-Ref
Whether the role supports checked state.

return: {boolean} Whether the role supports checked state.
param: {import('react').AriaRole} role Role.

ComplementaryAreaToggle({as = external_wp_components_namespaceObject.Button,scope,identifier,icon,selectedIcon,name,shortcut,...props})   X-Ref
No description

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

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

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

PinnedItems({scope,...props})   X-Ref
WordPress dependencies


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

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

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

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

ComplementaryArea({children,className,closeLabel = (0,external_wp_i18n_namespaceObject.__)   X-Ref
No description

useHTMLClass(className)   X-Ref
No description

InterfaceSkeleton({isDistractionFree,footer,header,editorNotices,sidebar,secondarySidebar,content,actions,labels,className}, ref)   X-Ref
No description

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

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

transformBlockToWidget(block, relatedWidget = {})   X-Ref
Converts a block to a widget entity record.

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

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.

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

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

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

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

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

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

return: {Object} Action object.
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.

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

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

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

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

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

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

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

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

getListViewToggleRef(state)   X-Ref
No description

getInserterSidebarToggleRef(state)   X-Ref
No description

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

ErrorBoundaryWarning({message,error})   X-Ref
No description



Generated : Sat Nov 23 08:20:01 2024 Cross-referenced by PHPXref