| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 3225 lines (112 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
ErrorBoundary:: (51 methods):
BlockInspectorButton()
blockInserterPanel()
isInserterOpened()
__experimentalGetInsertionPoint()
setIsInserterOpened()
Inserter()
MoreMenuDropdown()
toggleFeature()
setFeatureValue()
setFeatureDefaults()
openModal()
closeModal()
isModalActive()
complementaryAreas()
activeModal()
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()
SidebarAdapter:: (4 methods):
getInserterOuterSection()
getSidebarControl()
moveToSidebar()
initialize()
Class: ErrorBoundary - X-Ref
| BlockInspectorButton({inspector,closeMenu,...props}) X-Ref |
| No description |
| blockInserterPanel(state = false, action) X-Ref |
| Reducer tracking whether the inserter is open. param: {boolean|Object} state param: {Object} action |
| 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. |
| 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. |
| Inserter({setIsOpened}) X-Ref |
| Internal dependencies |
| MoreMenuDropdown({as: DropdownComponent = external_wp_components_namespaceObject.DropdownMenu,className,label = (0,external_wp_i18n_namespaceObject.__) 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 |
| KeyCombination({keyCombination,forceAriaLabel}) X-Ref |
| WordPress dependencies |
| 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 |
| Internal dependencies |
| Header({sidebar,inserter,isInserterOpened,setIsInserterOpened,isFixedToolbarActive}) X-Ref |
| Internal dependencies |
| useInserter(inserter) X-Ref |
| Internal 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 |
| Internal dependencies |
| useSidebarBlockEditor(sidebar) X-Ref |
| No description |
| FocusControl({api,sidebarControls,children}) X-Ref |
| Internal dependencies |
| 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 |
| No description |
| 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 |
| Internal dependencies |
| 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 |
Class: SidebarAdapter - X-Ref
| getInserterOuterSection() X-Ref |
| Internal 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 |
| __webpack_require__(moduleId) X-Ref |
| No description |
| CopyButton({text,children}) X-Ref |
| No description |
| Generated : Wed Apr 24 08:20:01 2024 | Cross-referenced by PHPXref |