PHPXRef 0.7.1 : WordPress Trunk (Updated Daily) : Detail view of edit-widgets.js

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.

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

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.

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

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.

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

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

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.

openModal(name) X-Ref

Returns an action object used in signalling that the user opened a modal.

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

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.

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

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.

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

roleSupportsCheckedState(role) X-Ref

Whether the role supports checked state.

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

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.

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

transformBlockToWidget(block, relatedWidget = {}) 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.

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.

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.

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.

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.

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.

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