PHPXRef 0.7.1 : WordPress : Detail view of block-editor.js

Animated works by building a directed acyclic graph of dependencies
transparently when you render your Animated components.

new Animated.Value(0)
.interpolate()        .interpolate()    new Animated.Value(1)
opacity               translateY      scale
style                         transform
View#234                         style
View#123

A) Top Down phase
When an AnimatedValue is updated, we recursively go down through this
graph in order to find leaf nodes: the views that we flag as needing
an update.

B) Bottom Up phase
When a view is flagged as needing an update, we recursively go back up
in order to build the new value that it needs. The reason why we need
this two-phases process is to deal with composite props such as
transform which can receive values from multiple parents.

AnimatedValue(_value) X-Ref

No description

AnimatedValueArray(values) X-Ref

No description

Controller() X-Ref

No description

useTransition(input, keyTransform, config) X-Ref

No description

cleanUp(state, filterKey) X-Ref

No description

diffItems(_ref9, props) X-Ref

No description

AnimatedStyle(style) X-Ref

No description

call() X-Ref

No description

normalizeColor(color) X-Ref

No description

hue2rgb(p, q, t) X-Ref

No description

hslToRgb(h, s, l) X-Ref

No description

parse255(str) X-Ref

No description

parse360(str) X-Ref

No description

parse1(str) X-Ref

No description

parsePercentage(str) X-Ref

No description

colorToRgba(input) X-Ref

No description

dangerousStyleValue(name, value, isCustomProperty) X-Ref

No description

classNames() X-Ref

No description

_assertThisInitialized(self) X-Ref

No description

_iterableToArrayLimit(arr, i) X-Ref

No description

_slicedToArray(arr, i) X-Ref

No description

ownKeys(object, enumerableOnly) X-Ref

No description

_objectSpread(target) X-Ref

No description

Icon(_ref) X-Ref

Return an SVG icon.

param: {IconProps} props icon is the SVG component to render
return: {JSX.Element} Icon component

emptyFunction() X-Ref

No description

emptyFunctionWithReset() X-Ref

No description

shim(props, propName, componentName, location, propFullName, secret) X-Ref

No description

getShim() X-Ref

No description

_inheritsLoose(subClass, superClass) X-Ref

No description

_objectWithoutProperties(source, excluded) X-Ref

No description

_toArray(arr) X-Ref

No description

_getPrototypeOf(o) X-Ref

No description

_extends() X-Ref

No description

_objectWithoutPropertiesLoose(source, excluded) X-Ref

No description

_assertThisInitialized(self) X-Ref

No description

__() X-Ref

No description

TextareaAutosize() X-Ref

A light replacement for built-in textarea component
which automaticaly adjusts its height to match the content

assign(ta) X-Ref

No description

init() X-Ref

No description

changeOverflow(value) X-Ref

No description

getParentOverflows(el) X-Ref

No description

resize() X-Ref

No description

update() X-Ref

No description

destroy(ta) X-Ref

No description

update(ta) X-Ref

No description

lineHeight(node) X-Ref

Calculate the `line-height` of a given node

param: {HTMLElement} node Element to calculate line height of. Must be in the DOM.
returns: {Number} `line-height` of the element in pixels

_arrayWithoutHoles(arr) X-Ref

No description

_nonIterableSpread() X-Ref

No description

_toConsumableArray(arr) X-Ref

No description

scrollIntoView(elem, container, config) X-Ref

No description

getClientPosition(elem) X-Ref

No description

getScroll(w, top) X-Ref

No description

getScrollLeft(w) X-Ref

No description

getScrollTop(w) X-Ref

No description

getOffset(el) X-Ref

No description

_getComputedStyle(elem, name, computedStyle_) X-Ref

No description

_getComputedStyleIE(elem, name) X-Ref

No description

each(arr, fn) X-Ref

No description

isBorderBoxFn(elem) X-Ref

No description

swap(elem, options, callback) X-Ref

No description

getPBMWidth(elem, props, which) X-Ref

No description

isWindow(obj) X-Ref

A crude way of determining if an object is a window

getWH(elem, name, extra) X-Ref

No description

getWHIgnoreDisplay(elem) X-Ref

No description

css(el, name, v) X-Ref

No description

setOffset(elem, offset) X-Ref

No description

_defineProperties(target, props) X-Ref

No description

_createClass(Constructor, protoProps, staticProps) X-Ref

No description

_classCallCheck(instance, Constructor) X-Ref

No description

_setPrototypeOf(o, p) X-Ref

No description

_inherits(subClass, superClass) X-Ref

No description

_possibleConstructorReturn(self, call) X-Ref

No description

multi(_ref) X-Ref

Redux dispatch multiple actions

_interopRequireDefault(obj) X-Ref

No description

diffChars(oldStr, newStr, options) X-Ref

No description

matchQuery(mediaQuery, values) X-Ref

No description

parseQuery(mediaQuery) X-Ref

No description

toDecimal(ratio) X-Ref

No description

toDpi(resolution) X-Ref

No description

toPx(length) X-Ref

No description

_arrayLikeToArray(arr, len) X-Ref

No description

Traverse(obj) X-Ref

No description

walk(root, cb, immutable) X-Ref

No description

updateState() X-Ref

No description

copy(src) X-Ref

No description

toS(obj) X-Ref

No description

isDate(obj) X-Ref

No description

isRegExp(obj) X-Ref

No description

isError(obj) X-Ref

No description

isBoolean(obj) X-Ref

No description

isNumber(obj) X-Ref

No description

isString(obj) X-Ref

No description

_unsupportedIterableToArray(o, minLen) X-Ref

No description

Diff() X-Ref

No description

done(value) X-Ref

No description

execEditLength() X-Ref

No description

buildValues(diff, components, newString, oldString, useLongestToken) X-Ref

No description

clonePath(path) X-Ref

No description

_iterableToArray(iter) X-Ref

No description

_arrayWithHoles(arr) X-Ref

No description

_nonIterableRest() X-Ref

No description

_typeof(obj) X-Ref

No description

_objectWithoutPropertiesLoose(source, excluded) X-Ref

No description

arrayOf( value ) X-Ref

Returns the first argument as the sole entry in an array.

param: {*} value Value to return.
return: {Array} Value returned as entry in array.

isObjectLike( value ) X-Ref

Returns true if the value passed is object-like, or false otherwise. A value
is object-like if it can support property assignment, e.g. object or array.

param: {*} value Value to test.
return: {boolean} Whether value is object-like.

createCache() X-Ref

Creates and returns a new cache object.

return: {Object} Cache object.

isShallowEqual( a, b, fromIndex ) X-Ref

Returns true if entries within the two arrays are strictly equal by
reference from a starting index.

param: {Array} a First array.
param: {Array} b Second array.
param: {number} fromIndex Index from which to start comparison.
return: {boolean} Whether arrays are shallowly equal.

getRootCache() X-Ref

Returns the root cache. If WeakMap is supported, this is assigned to the
root WeakMap cache set, otherwise it is a shared instance of the default
cache object.

return: {(WeakMap|Object)} Root cache object.

getWeakMapCache( dependants ) X-Ref

Returns the cache for a given dependants array. When possible, a WeakMap
will be used to create a unique cache for each set of dependants. This
is feasible due to the nature of WeakMap in allowing garbage collection
to occur on entries where the key object is no longer referenced. Since
WeakMap requires the key to be an object, this is only possible when the
dependant is object-like. The root cache is created as a hierarchy where
each top-level key is the first entry in a dependants set, the value a
WeakMap where each key is the next dependant, and so on. This continues
so long as the dependants are object-like. If no dependants are object-
like, then the cache is shared across all invocations.

param: {Array} dependants Selector dependants.
return: {Object} Cache object.

clear() X-Ref

Resets root memoization cache.

callSelector( ) X-Ref

The augmented selector call, considering first whether dependants have
changed before passing it to underlying memoize function.

param: {Object} source Source object for derivation.
param: {...*} extraArgs Additional arguments to pass to selector.
return: {*} Selector result.

useBlockEditContext() X-Ref

A hook that returns the block edit context.

return: {Object} Block edit context

useDisplayBlockControls() X-Ref

Internal dependencies

BlockControlsSlot(props) X-Ref

No description

BlockControlsFill(_ref) X-Ref

No description

ownKeys(object, enumerableOnly) X-Ref

No description

_objectSpread(target) X-Ref

No description

BlockAlignmentToolbar(_ref) X-Ref

No description

applyOrUnset(align) X-Ref

No description

align_ownKeys(object, enumerableOnly) X-Ref

No description

align_objectSpread(target) X-Ref

No description

getValidAlignments(blockAlign) X-Ref

Returns the valid alignments.
Takes into consideration the aligns supported by a block, if the block supports wide controls or not and if theme supports wide controls or not.
Exported just for testing purposes, not exported outside the module.

param: {?boolean|string[]} blockAlign          Aligns supported by the block.
param: {?boolean}          hasWideBlockSupport True if block supports wide alignments. And False otherwise.
param: {?boolean}          hasWideEnabled      True if theme supports wide alignments. And False otherwise.
return: {string[]} Valid alignments.

addAttribute(settings) X-Ref

Filters registered block settings, extending attributes to include `align`.

param: {Object} settings Original block settings
return: {Object} Filtered block settings

addAssignedAlign(props, blockType, attributes) X-Ref

Override props assigned to save component to inject alignment class name if
block supports it.

param: {Object} props      Additional props applied to save element
param: {Object} blockType  Block type
param: {Object} attributes Block attributes
return: {Object}            Filtered props applied to save element

InspectorAdvancedControls(_ref) X-Ref

No description

anchor_ownKeys(object, enumerableOnly) X-Ref

No description

anchor_objectSpread(target) X-Ref

No description

anchor_addAttribute(settings) X-Ref

Filters registered block settings, extending attributes with anchor using ID
of the first node.

param: {Object} settings Original block settings.
return: {Object} Filtered block settings.

addSaveProps(extraProps, blockType, attributes) X-Ref

Override props assigned to save component to inject anchor ID, if block
supports anchor. This is only applied if the block's save result is an
element and not a markup string.

param: {Object} extraProps Additional props applied to save element.
param: {Object} blockType Block type.
param: {Object} attributes Current block attributes.
return: {Object} Filtered props applied to save element.

custom_class_name_ownKeys(object, enumerableOnly) X-Ref

No description

custom_class_name_objectSpread(target) X-Ref

No description

custom_class_name_addAttribute(settings) X-Ref

Filters registered block settings, extending attributes with anchor using ID
of the first node.

param: {Object} settings Original block settings.
return: {Object} Filtered block settings.

custom_class_name_addSaveProps(extraProps, blockType, attributes) X-Ref

getHTMLRootElementClasses(innerHTML) X-Ref

Given an HTML string, returns an array of class names assigned to the root
element in the markup.

param: {string} innerHTML Markup string from which to extract classes.
return: {string[]} Array of class names assigned to the root element.

addParsedDifference(blockAttributes, blockType, innerHTML) X-Ref

Given a parsed set of block attributes, if the block supports custom class
names and an unknown class (per the block's serialization behavior) is
found, the unknown classes are treated as custom classes. This prevents the
block from being considered as invalid.

param: {Object} blockAttributes Original block attributes.
param: {Object} blockType Block type settings.
param: {string} innerHTML Original block markup.
return: {Object} Filtered block attributes.

addGeneratedClassName(extraProps, blockType) X-Ref

Override props assigned to save component to inject generated className if
block supports it. This is only applied if the block's save result is an
element and not a markup string.

param: {Object} extraProps Additional props applied to save element.
param: {Object} blockType Block type.
return: {Object} Filtered props applied to save element.

getColorClassName(colorContextName, colorSlug) X-Ref

Returns a class based on the context a color is being used and its slug.

param: {string} colorContextName Context/place where color is being used e.g: background, text etc...
param: {string} colorSlug Slug of the color.
return: {?string} String with the class corresponding to the color in the provided context.

utils_getMostReadableColor(colors, colorValue) X-Ref

Given an array of color objects and a color value returns the color value of the most readable color in the array.

param: {Array} colors Array of color objects as set by the theme or by the editor defaults.
param: {?string} colorValue A string containing the color value.
return: {string} String with the color value of the most readable color.

__experimentalGetGradientClass(gradientSlug) X-Ref

Internal dependencies

getGradientValueBySlug(gradients, slug) X-Ref

Retrieves the gradient value per slug.

param: {Array} gradients Gradient Palette
param: {string} slug Gradient slug
return: {string} Gradient value.

__experimentalGetGradientObjectByGradientValue(gradients, value) X-Ref

No description

getGradientSlugByValue(gradients, value) X-Ref

Retrieves the gradient slug per slug.

param: {Array} gradients Gradient Palette
param: {string} value Gradient value
return: {string} Gradient slug.

__experimentalUseGradient() X-Ref

No description

control_ownKeys(object, enumerableOnly) X-Ref

No description

control_objectSpread(target) X-Ref

No description

VisualLabel(_ref) X-Ref

No description

ColorGradientControlInner(_ref2) X-Ref

No description

ColorGradientControlSelect(props) X-Ref

No description

ColorGradientControl(props) X-Ref

No description

panel_color_gradient_settings_ownKeys(object, enumerableOnly) X-Ref

No description

panel_color_gradient_settings_objectSpread(target) X-Ref

No description

ContrastCheckerMessage(_ref) X-Ref

No description

ContrastChecker(_ref2) X-Ref

No description

InspectorControls(_ref) X-Ref

No description

getBlockDOMNode(clientId) X-Ref

Given a block client ID, returns the corresponding DOM node for the block,
if exists. As much as possible, this helper should be avoided, and used only
in cases where isolated behaviors need remote access to a block node.

param: {string} clientId Block client ID.
return: {Element?} Block DOM node.

getBlockPreviewContainerDOMNode(clientId) X-Ref

Returns the preview container DOM node for a given block client ID, or
undefined if the container cannot be determined.

param: {string} clientId Block client ID.
return: {Node|undefined} Preview container DOM node.

isBlockFocusStop(element) X-Ref

Returns true if the given element is a block focus stop. Blocks without their
own text fields rely on the focus stop to be keyboard navigable.

param: {Element} element Element to test.
return: {boolean} Whether element is a block focus stop.

isInSameBlock(a, b) X-Ref

Returns true if two elements are contained within the same block.

param: {Element} a First element.
param: {Element} b Second element.
return: {boolean} Whether elements are in the same block.

isInsideRootBlock(blockElement, element) X-Ref

Returns true if an element is considered part of the block and not its
children.

param: {Element} blockElement Block container element.
param: {Element} element Element.
return: {boolean} Whether element is in the block Element but not its

hasInnerBlocksContext(element) X-Ref

Returns true if the given element contains inner blocks (an InnerBlocks
element).

param: {Element} element Element to test.
return: {boolean} Whether element contains inner blocks.

getBlockClientId(node) X-Ref

Finds the block client ID given any DOM node inside the block.

param: {Node?} node DOM node.
return: {string|undefined} Client ID or undefined if the node is not part of

ColorPanel(_ref) X-Ref

No description

color_ownKeys(object, enumerableOnly) X-Ref

No description

color_objectSpread(target) X-Ref

No description

addAttributes(settings) X-Ref

Filters registered block settings, extending attributes to include
`backgroundColor` and `textColor` attribute.

param: {Object} settings Original block settings
return: {Object} Filtered block settings

color_addSaveProps(props, blockType, attributes) X-Ref

Override props assigned to save component to inject colors classnames.

param: {Object} props      Additional props applied to save element
param: {Object} blockType  Block type
param: {Object} attributes Block attributes
return: {Object}            Filtered props applied to save element

addEditProps(settings) X-Ref

Filters registered block settings to extand the block edit wrapper
to apply the desired styles and classnames properly.

param: {Object} settings Original block settings
return: {Object} Filtered block settings

ColorEdit(props) X-Ref

Inspector control panel containing the color related configuration

param: {Object} props
return: {WPElement} Color edit element.

isLineHeightDefined(lineHeight) X-Ref

Determines if the lineHeight attribute has been properly defined.

param: {any} lineHeight The value to check.
return: {boolean} Whether the lineHeight attribute is valid.

LineHeightControl(_ref) X-Ref

Internal dependencies

line_height_ownKeys(object, enumerableOnly) X-Ref

No description

line_height_objectSpread(target) X-Ref

No description

LineHeightEdit(props) X-Ref

Inspector control panel containing the line height related configuration

param: {Object} props
return: {WPElement} Line height edit element.

useIsLineHeightDisabled() X-Ref

Custom hook that checks if line-height settings have been disabled.

param: {string} name The name of the block.
return: {boolean} Whether setting is disabled.

getFontSizeObjectByValue(fontSizes, value) X-Ref

Returns the corresponding font size object for a given value.

param: {Array} fontSizes Array of font size objects.
param: {number} value Font size value.
return: {Object} Font size object.

getFontSizeClass(fontSizeSlug) X-Ref

Returns a class based on fontSizeName.

param: {string} fontSizeSlug Slug of the fontSize.
return: {string} String with the class corresponding to the fontSize passed.

font_size_ownKeys(object, enumerableOnly) X-Ref

No description

font_size_objectSpread(target) X-Ref

No description

font_size_addAttributes(settings) X-Ref

Filters registered block settings, extending attributes to include
`fontSize` and `fontWeight` attributes.

param: {Object} settings Original block settings
return: {Object} Filtered block settings

font_size_addSaveProps(props, blockType, attributes) X-Ref

Override props assigned to save component to inject font size.

param: {Object} props      Additional props applied to save element
param: {Object} blockType  Block type
param: {Object} attributes Block attributes
return: {Object}            Filtered props applied to save element

font_size_addEditProps(settings) X-Ref

Filters registered block settings to expand the block edit wrapper
by applying the desired styles and classnames.

param: {Object} settings Original block settings
return: {Object} Filtered block settings

useFontSizes() X-Ref

No description

FontSizeEdit(props) X-Ref

Inspector control panel containing the font size related configuration

param: {Object} props
return: {WPElement} Font size edit element.

useIsFontSizeDisabled() X-Ref

Custom hook that checks if font-size settings have been disabled.

param: {string} name The name of the block.
return: {boolean} Whether setting is disabled.

TypographyPanel(props) X-Ref

No description

useIsTypographyDisabled() X-Ref

No description

useEditorFeature(featurePath) X-Ref

Hook that retrieves the setting for the given editor feature.
It works with nested objects using by finding the value at path.

param: {string} featurePath The path to the feature.
return: {any} Returns the value defined for the setting.

UnitControl(_ref) X-Ref

Internal dependencies

filterUnitsWithSettings() X-Ref

Filters available units based on values defined by settings.

param: {Array} settings Collection of preferred units.
param: {Array} units Collection of available units.
return: {Array} Filtered units based on settings.

useCustomUnits(unitsProp) X-Ref

Custom hook to retrieve and consolidate units setting from add_theme_support().

param: {Array} unitsProp Collection of available units.
return: {Array} Filtered units based on settings.

padding_ownKeys(object, enumerableOnly) X-Ref

No description

padding_objectSpread(target) X-Ref

No description

PaddingEdit(props) X-Ref

Inspector control panel containing the line height related configuration

param: {Object} props
return: {WPElement} Line height edit element.

SpacingPanelControl(_ref) X-Ref

Internal dependencies

style_ownKeys(object, enumerableOnly) X-Ref

No description

style_objectSpread(target) X-Ref

No description

compileStyleValue(uncompiledValue) X-Ref

No description

getInlineStyles() X-Ref

Returns the inline styles to add depending on the style object

param: {Object} styles Styles configuration
return: {Object} Flattened CSS variables declaration

style_addAttribute(settings) X-Ref

Filters registered block settings, extending attributes to include `style` attribute.

param: {Object} settings Original block settings
return: {Object} Filtered block settings

style_addSaveProps(props, blockType, attributes) X-Ref

Override props assigned to save component to inject the CSS variables definition.

param: {Object} props      Additional props applied to save element
param: {Object} blockType  Block type
param: {Object} attributes Block attributes
return: {Object}            Filtered props applied to save element

style_addEditProps(settings) X-Ref

_createSuper(Derived) X-Ref

No description

_isNativeReflectConstruct() X-Ref

No description

with_colors_ownKeys(object, enumerableOnly) X-Ref

No description

with_colors_objectSpread(target) X-Ref

No description

createColorHOC(colorTypes, withColorPalette) X-Ref

Helper function used with `createHigherOrderComponent` to create
higher order components for managing color logic.

param: {Array} colorTypes An array of color types (e.g. 'backgroundColor, borderColor).
param: {Function} withColorPalette A HOC for injecting the 'colors' prop into the WrappedComponent.
return: {WPComponent} The component that can be used as a HOC.

_class(props) X-Ref

No description

createCustomColorsHOC(colorsArray) X-Ref

A higher-order component factory for creating a 'withCustomColors' HOC, which handles color logic
for class generation color value, retrieval and color attribute setting.

Use this higher-order component to work with a custom set of colors.

param: {Array} colorsArray The array of color objects (name, slug, color, etc... ).
return: {Function} Higher-order component.

withColors() X-Ref

A higher-order component, which handles color logic for class generation color value, retrieval and color attribute setting.

For use with the default editor/theme color palette.

param: {...(Object|string)} colorTypes The arguments can be strings or objects. If the argument is an object,
return: {Function} Higher-order component.

panel_color_settings_ownKeys(object, enumerableOnly) X-Ref

No description

panel_color_settings_objectSpread(target) X-Ref

No description

color_panel_ColorPanel(_ref) X-Ref

No description

_createForOfIteratorHelper(o) X-Ref

No description

_unsupportedIterableToArray(o, minLen) X-Ref

No description

_arrayLikeToArray(arr, len) X-Ref

No description

use_colors_ownKeys(object, enumerableOnly) X-Ref

No description

use_colors_objectSpread(target) X-Ref

No description

__experimentalUseColors(colorConfigs) X-Ref

No description

with_font_sizes_ownKeys(object, enumerableOnly) X-Ref

No description

with_font_sizes_objectSpread(target) X-Ref

No description

with_font_sizes_createSuper(Derived) X-Ref

No description

with_font_sizes_isNativeReflectConstruct() X-Ref

No description

_class(props) X-Ref

No description

alignment_toolbar_ownKeys(object, enumerableOnly) X-Ref

No description

alignment_toolbar_objectSpread(target) X-Ref

No description

AlignmentToolbar(props) X-Ref

No description

applyOrUnset(align) X-Ref

No description

setIcon() X-Ref

No description

search_items_ownKeys(object, enumerableOnly) X-Ref

No description

search_items_objectSpread(target) X-Ref

No description

utils_ownKeys(object, enumerableOnly) X-Ref

No description

utils_objectSpread(target) X-Ref

No description

includeVariationsInInserterItems(items) X-Ref

Normalizes an inserter block types list and includes variations as separate items.

param: {Array} items Denormalized inserter items
return: {Array} Normalized inserter items.

BlockIcon(_ref) X-Ref

No description

createBlockCompleter() X-Ref

Creates a blocks repeater for replacing the current block with a selected block type.

param: {Object} props                                   Component props.
param: {string} [props.getBlockInsertionParentClientId] Client ID of the parent.
param: {string} [props.getInserterItems]                Inserter items for parent.
param: {string} [props.getSelectedBlockName]            Name of selected block or null.
return: {WPCompleter} A blocks completer.

BlockEditorAutocomplete(props) X-Ref

Wrap the default Autocomplete component with one that supports a filter hook
for customizing its list of autocompleters.

BlockAlignmentMatrixToolbar(props) X-Ref

No description

BlockTitle(_ref) X-Ref

Renders the block's configured title as a string, or empty if the title
cannot be determined.

param: {Object} props
param: {string} props.clientId Client ID of block.
return: {?string} Block title.

BlockBreadcrumb() X-Ref

Block breadcrumb component, displaying the hierarchy of the current block selection as a breadcrumb.

return: {WPElement} Block Breadcrumb.

block_context_ownKeys(object, enumerableOnly) X-Ref

No description

block_context_objectSpread(target) X-Ref

No description

BlockContextProvider(_ref) X-Ref

Component which merges passed value with current consumed block context.

param: {BlockContextProviderProps} props

block_edit_BlockEdit(props) X-Ref

No description

BlockFormatControlsSlot(props) X-Ref

No description

BlockFormatControlsFill(props) X-Ref

No description

useMovingAnimation(ref, isSelected, adjustScrolling, enableAnimation, triggerAnimationOnChange) X-Ref

Hook used to compute the styles required to move a div into a new position.

The way this animation works is the following:
- It first renders the element as if there was no animation.
- It takes a snapshot of the position of the block to use it
as a destination point for the animation.
- It restores the element to the previous position using a CSS transform
- It uses the "resetAnimation" flag to reset the animation
from the beginning in order to animate to the new destination point.

param: {Object}  ref                      Reference to the element to animate.
param: {boolean} isSelected               Whether it's the current block or not.
param: {boolean} adjustScrolling          Adjust the scroll position to the current block.
param: {boolean} enableAnimation          Enable/Disable animation.
param: {*}       triggerAnimationOnChange Variable used to trigger the animation if it changes.

onFrameChange(_ref) X-Ref

No description

onFrame(_ref2) X-Ref

No description

BlockNavigationLeaf(_ref) X-Ref

No description

getBlockMoverDescription(selectedCount, type, firstIndex, isFirst, isLast, dir, orientation, isRTL) X-Ref

Return a label for the block movement controls depending on block position.

param: {number}  selectedCount Number of blocks selected.
param: {string}  type          Block type - in the case of a single block, should
param: {number}  firstIndex    The index (position - 1) of the first block selected.
param: {boolean} isFirst       This is the first block.
param: {boolean} isLast        This is the last block.
param: {number}  dir           Direction of movement (> 0 is considered to be going
param: {string}  orientation   The orientation of the block movers, vertical or
param: {boolean} isRTL         True if current writing system is right to left.
return: {string} Label for the block movement controls.

getMultiBlockMoverDescription(selectedCount, firstIndex, isFirst, isLast, dir) X-Ref

Return a label for the block movement controls depending on block position.

param: {number}  selectedCount Number of blocks selected.
param: {number}  firstIndex    The index (position - 1) of the first block selected.
param: {boolean} isFirst       This is the first block.
param: {boolean} isLast        This is the last block.
param: {number}  dir           Direction of movement (> 0 is considered to be going
return: {string} Label for the block movement controls.

DescenderLines(_ref) X-Ref

No description

Warning(_ref) X-Ref

No description

BlockCompare(_ref) X-Ref

No description

getDifference(originalContent, newContent) X-Ref

No description

getConvertedContent(convertedBlock) X-Ref

No description

block_invalid_warning_createSuper(Derived) X-Ref

No description

block_invalid_warning_isNativeReflectConstruct() X-Ref

No description

BlockInvalidWarning(props) X-Ref

No description

block_crash_boundary_createSuper(Derived) X-Ref

No description

block_crash_boundary_isNativeReflectConstruct() X-Ref

No description

BlockCrashBoundary() X-Ref

No description

BlockHTML(_ref) X-Ref

No description

getDeepestNode(node, type) X-Ref

Returns for the deepest node at the start or end of a container node. Ignores
any text nodes that only contain HTML formatting whitespace.

param: {Element} node Container to search.
param: {string} type 'start' or 'end'.

use_multi_selection_selector(select) X-Ref

No description

toggleRichText(container, toggle) X-Ref

No description

useMultiSelection(ref) X-Ref

No description

Tips() X-Ref

No description

InserterSearchForm(_ref) X-Ref

No description

BlockCard(_ref) X-Ref

Internal dependencies

insertAt(array, elements, index) X-Ref

Insert one or multiple elements into a given position of an array.

param: {Array}  array    Source array.
param: {*}      elements Elements to insert.
param: {number} index    Insert Position.
return: {Array}          Result.

moveTo(array, from, to) X-Ref

Moves an element in an array.

param: {Array}  array Source array.
param: {number} from  Source index.
param: {number} to    Destination index.
param: {number} count Number of elements to move.
return: {Array}       Result.

reducer_ownKeys(object, enumerableOnly) X-Ref

No description

reducer_objectSpread(target) X-Ref

No description

mapBlockOrder(blocks) X-Ref

Given an array of blocks, returns an object where each key is a nesting
context, the value of which is an array of block client IDs existing within
that nesting context.

param: {Array} blocks Blocks to map.
param: {?string} rootClientId Assumed root client ID.
return: {Object} Block order map object.

mapBlockParents(blocks) X-Ref

Given an array of blocks, returns an object where each key contains
the clientId of the block and the value is the parent of the block.

param: {Array} blocks Blocks to map.
param: {?string} rootClientId Assumed root client ID.
return: {Object} Block order map object.

flattenBlocks(blocks) X-Ref

Helper method to iterate through all blocks, recursing into inner blocks,
applying a transformation function to each one.
Returns a flattened object with the transformed blocks.

param: {Array} blocks Blocks to flatten.
param: {Function} transform Transforming function to be applied to each block.
return: {Object} Flattened object.

getFlattenedBlocksWithoutAttributes(blocks) X-Ref

Given an array of blocks, returns an object containing all blocks, without
attributes, recursing into inner blocks. Keys correspond to the block client
ID, the value of which is the attributes object.

param: {Array} blocks Blocks to flatten.
return: {Object} Flattened block attributes object.

getFlattenedBlockAttributes(blocks) X-Ref

Given an array of blocks, returns an object containing all block attributes,
recursing into inner blocks. Keys correspond to the block client ID, the
value of which is the attributes object.

param: {Array} blocks Blocks to flatten.
return: {Object} Flattened block attributes object.

getNestedBlockClientIds(blocksOrder) X-Ref

Given a block order map object, returns *all* of the block client IDs that are
a descendant of the given root client ID.

Calling this with `rootClientId` set to `''` results in a list of client IDs
that are in the post. That is, it excludes blocks like fetched reusable
blocks which are stored into state but not visible. It also excludes
InnerBlocks controllers, like template parts.

It is important to exclude the full inner block controller and not just the
inner blocks because in many cases, we need to persist the previous value of
an inner block controller. To do so, it must be excluded from the list of
client IDs which are considered to be part of the top-level entity.

param: {Object} blocksOrder Object that maps block client IDs to a list of
param: {?string} rootClientId The root client ID to search. Defaults to ''.
param: {?Object} controlledInnerBlocks The InnerBlocks controller state.
return: {Array} List of descendant client IDs.

getMutateSafeObject(original, working) X-Ref

Returns an object against which it is safe to perform mutating operations,
given the original object and its current working copy.

param: {Object} original Original object.
param: {Object} working Working object.
return: {Object} Mutation-safe object.

hasSameKeys(a, b) X-Ref

Returns true if the two object arguments have the same keys, or false
otherwise.

param: {Object} a First object.
param: {Object} b Second object.
return: {boolean} Whether the two objects have the same keys.

isUpdatingSameBlockAttribute(action, lastAction) X-Ref

Returns true if, given the currently dispatching action and the previously
dispatched action, the two actions are updating the same block attribute, or
false otherwise.

param: {Object} action Currently dispatching action.
param: {Object} lastAction Previously dispatched action.
return: {boolean} Whether actions are updating the same block attribute.

withPersistentBlockChange(reducer) X-Ref

Higher-order reducer intended to augment the blocks reducer, assigning an
`isPersistentChange` property value corresponding to whether a change in
state can be considered as persistent. All changes are considered persistent
except when updating the same block attribute as in the previous action.

param: {Function} reducer Original reducer function.
return: {Function} Enhanced reducer function.

withIgnoredBlockChange(reducer) X-Ref

Higher-order reducer intended to augment the blocks reducer, assigning an
`isIgnoredChange` property value corresponding to whether a change in state
can be considered as ignored. A change is considered ignored when the result
of an action not incurred by direct user interaction.

param: {Function} reducer Original reducer function.
return: {Function} Enhanced reducer function.

reducer_isTyping() X-Ref

No description

isDraggingBlocks() X-Ref

Reducer returning dragging state.

param: {boolean} state Current state.
param: {Object} action Dispatched action.
return: {boolean} Updated state.

reducer_isCaretWithinFormattedText() X-Ref

Reducer returning whether the caret is within formatted text.

param: {boolean} state Current state.
param: {Object} action Dispatched action.
return: {boolean} Updated state.

reducer_selection() X-Ref

Internal helper reducer for selectionStart and selectionEnd. Can hold a block
selection, represented by an object with property clientId.

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

reducer_selectionStart() X-Ref

Reducer returning the block selection's start.

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

reducer_selectionEnd() X-Ref

Reducer returning the block selection's end.

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

reducer_isMultiSelecting() X-Ref

Reducer returning whether the user is multi-selecting.

param: {boolean} state Current state.
param: {Object} action Dispatched action.
return: {boolean} Updated state.

reducer_isSelectionEnabled() X-Ref

Reducer returning whether selection is enabled.

param: {boolean} state Current state.
param: {Object} action Dispatched action.
return: {boolean} Updated state.

reducer_initialPosition(state, action) X-Ref

Reducer returning the intial block selection.

Currently this in only used to restore the selection after block deletion and
pasting new content.This reducer should eventually be removed in favour of setting
selection directly.

param: {boolean} state Current state.
param: {Object} action Dispatched action.
return: {?number} Initial position: -1 or undefined.

blocksMode() X-Ref

No description

insertionPoint() X-Ref

Reducer returning the block insertion point visibility, either null if there
is not an explicit insertion point assigned, or an object of its `index` and
`rootClientId`.

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

reducer_template() X-Ref

Reducer returning whether the post blocks match the defined template or not.

param: {Object} state Current state.
param: {Object} action Dispatched action.
return: {boolean} Updated state.

reducer_settings() X-Ref

Reducer returning the editor setting.

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

preferences() X-Ref

Reducer returning the user preferences.

param: {Object} state Current state.
param: {Object} action Dispatched action.
return: {string} Updated state.

reducer_isNavigationMode() X-Ref

Reducer returning whether the navigation mode is enabled or not.

param: {string} state Current state.
param: {Object} action Dispatched action.
return: {string} Updated state.

reducer_hasBlockMovingClientId() X-Ref

Reducer returning whether the block moving mode is enabled or not.

param: {string|null} state Current state.
param: {Object} action Dispatched action.
return: {string|null} Updated state.

lastBlockAttributesChange(state, action) X-Ref

Reducer return an updated state representing the most recent block attribute
update. The state is structured as an object where the keys represent the
client IDs of blocks, the values a subset of attributes from the most recent
block update. The state is always reset to null if the last action is
anything other than an attributes update.

param: {Object<string,Object>} state Current state.
param: {Object} action Action object.
return: {[string,Object]} Updated state.

automaticChangeStatus(state, action) X-Ref

Reducer returning automatic change state.

param: {boolean} state Current state.
param: {Object} action Dispatched action.
return: {string} Updated state.

highlightedBlock(state, action) X-Ref

Reducer returning current highlighted block.

param: {boolean} state Current highlighted block.
param: {Object} action Dispatched action.
return: {string} Updated state.

controls_select(storeName, selectorName) X-Ref

Calls a selector using the current state.

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

actions_createForOfIteratorHelper(o) X-Ref

No description

actions_unsupportedIterableToArray(o, minLen) X-Ref

No description

actions_arrayLikeToArray(arr, len) X-Ref

No description

actions_ownKeys(object, enumerableOnly) X-Ref

No description

actions_objectSpread(target) X-Ref

No description

ensureDefaultBlock() X-Ref

Generator which will yield a default block insert action if there
are no other blocks at the root of the editor. This generator should be used
in actions which may result in no blocks remaining in the editor (removal,
replacement, etc).

actions_resetBlocks(blocks) X-Ref

Returns an action object used in signalling that blocks state should be
reset to the specified array of blocks, taking precedence over any other
content reflected as an edit in state.

param: {Array} blocks Array of blocks.
return: {Object} Action object.

actions_resetSelection(selectionStart, selectionEnd) X-Ref

Returns an action object used in signalling that selection state should be
reset to the specified selection.

param: {WPBlockSelection} selectionStart The selection start.
param: {WPBlockSelection} selectionEnd The selection end.
return: {Object} Action object.

receiveBlocks(blocks) X-Ref

Returns an action object used in signalling that blocks have been received.
Unlike resetBlocks, these should be appended to the existing known set, not
replacing.

param: {Object[]} blocks Array of block objects.
return: {Object} Action object.

actions_updateBlockAttributes(clientIds, attributes) X-Ref

Returns an action object used in signalling that the multiple blocks'
attributes with the specified client IDs have been updated.

param: {string|string[]} clientIds Block client IDs.
param: {Object} attributes Block attributes to be merged.
return: {Object} Action object.

actions_updateBlock(clientId, updates) X-Ref

Returns an action object used in signalling that the block with the
specified client ID has been updated.

param: {string} clientId Block client ID.
param: {Object} updates Block attributes to be merged.
return: {Object} Action object.

actions_selectBlock(clientId) X-Ref

Returns an action object used in signalling that the block with the
specified client ID has been selected, optionally accepting a position
value reflecting its selection directionality. An initialPosition of -1
reflects a reverse selection.

param: {string} clientId Block client ID.
param: {?number} initialPosition Optional initial position. Pass as -1 to
return: {Object} Action object.

selectPreviousBlock(clientId) X-Ref

Yields action objects used in signalling that the block preceding the given
clientId should be selected.

param: {string} clientId Block client ID.

selectNextBlock(clientId) X-Ref

Yields action objects used in signalling that the block following the given
clientId should be selected.

param: {string} clientId Block client ID.

actions_startMultiSelect() X-Ref

Returns an action object used in signalling that a block multi-selection has started.

return: {Object} Action object.

actions_stopMultiSelect() X-Ref

Returns an action object used in signalling that block multi-selection stopped.

return: {Object} Action object.

actions_multiSelect(start, end) X-Ref

Returns an action object used in signalling that block multi-selection changed.

param: {string} start First block of the multi selection.
param: {string} end Last block of the multiselection.
return: {Object} Action object.

actions_clearSelectedBlock() X-Ref

Returns an action object used in signalling that the block selection is cleared.

return: {Object} Action object.

actions_toggleSelection() X-Ref

Returns an action object that enables or disables block selection.

param: {boolean} [isSelectionEnabled=true] Whether block selection should
return: {Object} Action object.

getBlocksWithDefaultStylesApplied(blocks, blockEditorSettings) X-Ref

No description

actions_replaceBlocks(clientIds, blocks, indexToSelect, initialPosition) X-Ref

Returns an action object signalling that a blocks should be replaced with
one or more replacement blocks.

param: {(string|string[])} clientIds     Block client ID(s) to replace.
param: {(Object|Object[])} blocks        Replacement block(s).
param: {number}            indexToSelect Index of replacement block to select.
param: {number}            initialPosition Index of caret after in the selected block after the operation.

replaceBlock(clientId, block) X-Ref

Returns an action object signalling that a single block should be replaced
with one or more replacement blocks.

param: {(string|string[])} clientId Block client ID to replace.
param: {(Object|Object[])} block Replacement block(s).
return: {Object} Action object.

createOnMove(type) X-Ref

Higher-order action creator which, given the action type to dispatch creates
an action creator for managing block movement.

param: {string} type Action type to dispatch.
return: {Function} Action creator.

actions_moveBlocksToPosition(clientIds) X-Ref

Returns an action object signalling that the given blocks should be moved to
a new position.

param: {?string} clientIds        The client IDs of the blocks.
param: {?string} fromRootClientId Root client ID source.
param: {?string} toRootClientId   Root client ID destination.
param: {number}  index            The index to move the blocks to.

actions_moveBlockToPosition(clientId) X-Ref

Returns an action object signalling that the given block should be moved to a
new position.

param: {?string} clientId         The client ID of the block.
param: {?string} fromRootClientId Root client ID source.
param: {?string} toRootClientId   Root client ID destination.
param: {number}  index            The index to move the block to.

actions_insertBlock(block, index, rootClientId) X-Ref

Returns an action object used in signalling that a single block should be
inserted, optionally at a specific index respective a root block list.

param: {Object}  block            Block object to insert.
param: {?number} index            Index at which block should be inserted.
param: {?string} rootClientId     Optional root client ID of block list on which to insert.
param: {?boolean} updateSelection If true block selection will be updated. If false, block selection will not change. Defaults to true.
return: {Object} Action object.

actions_insertBlocks(blocks, index, rootClientId) X-Ref

Returns an action object used in signalling that an array of blocks should
be inserted, optionally at a specific index respective a root block list.

param: {Object[]} blocks          Block objects to insert.
param: {?number}  index           Index at which block should be inserted.
param: {?string}  rootClientId    Optional root client ID of block list on which to insert.
param: {?boolean} updateSelection If true block selection will be updated.  If false, block selection will not change. Defaults to true.
return: {Object} Action object.

actions_showInsertionPoint(rootClientId, index) X-Ref

Returns an action object used in signalling that the insertion point should
be shown.

param: {?string} rootClientId Optional root client ID of block list on
param: {?number} index Index at which block should be inserted.
return: {Object} Action object.

actions_hideInsertionPoint() X-Ref

Returns an action object hiding the insertion point.

return: {Object} Action object.

setTemplateValidity(isValid) X-Ref

Returns an action object resetting the template validity.

param: {boolean} isValid template validity flag.
return: {Object} Action object.

synchronizeTemplate() X-Ref

Returns an action object synchronize the template with the list of blocks

return: {Object} Action object.

actions_mergeBlocks(firstBlockClientId, secondBlockClientId) X-Ref

Returns an action object used in signalling that two blocks should be merged

param: {string} firstBlockClientId Client ID of the first block to merge.
param: {string} secondBlockClientId Client ID of the second block to merge.
return: {Object} Action object.

actions_removeBlocks(clientIds) X-Ref

Yields action objects used in signalling that the blocks corresponding to
the set of specified client IDs are to be removed.

param: {string|string[]} clientIds Client IDs of blocks to remove.
param: {boolean} selectPrevious True if the previous block should be

actions_removeBlock(clientId, selectPrevious) X-Ref

Returns an action object used in signalling that the block with the
specified client ID is to be removed.

param: {string} clientId Client ID of block to remove.
param: {boolean} selectPrevious True if the previous block should be
return: {Object} Action object.

actions_replaceInnerBlocks(rootClientId, blocks) X-Ref

Returns an action object used in signalling that the inner blocks with the
specified client ID should be replaced.

param: {string} rootClientId Client ID of the block whose InnerBlocks will re replaced.
param: {Object[]} blocks Block objects to insert as new InnerBlocks
param: {?boolean} updateSelection If true block selection will be updated. If false, block selection will not change. Defaults to true.
return: {Object} Action object.

toggleBlockMode(clientId) X-Ref

Returns an action object used to toggle the block editing mode between
visual and HTML modes.

param: {string} clientId Block client ID.
return: {Object} Action object.

actions_startTyping() X-Ref

Returns an action object used in signalling that the user has begun to type.

return: {Object} Action object.

actions_stopTyping() X-Ref

Returns an action object used in signalling that the user has stopped typing.

return: {Object} Action object.

actions_startDraggingBlocks() X-Ref

Returns an action object used in signalling that the user has begun to drag blocks.

return: {Object} Action object.

actions_stopDraggingBlocks() X-Ref

Returns an action object used in signalling that the user has stopped dragging blocks.

return: {Object} Action object.

actions_enterFormattedText() X-Ref

Returns an action object used in signalling that the caret has entered formatted text.

return: {Object} Action object.

actions_exitFormattedText() X-Ref

Returns an action object used in signalling that the user caret has exited formatted text.

return: {Object} Action object.

actions_selectionChange(clientId, attributeKey, startOffset, endOffset) X-Ref

Returns an action object used in signalling that the user caret has changed
position.

param: {string} clientId     The selected block client ID.
param: {string} attributeKey The selected block attribute key.
param: {number} startOffset  The start offset.
param: {number} endOffset    The end offset.
return: {Object} Action object.

actions_insertDefaultBlock(attributes, rootClientId, index) X-Ref

Returns an action object used in signalling that a new block of the default
type should be added to the block list.

param: {?Object} attributes Optional attributes of the block to assign.
param: {?string} rootClientId Optional root client ID of block list on which
param: {?number} index Optional index where to insert the default block
return: {Object} Action object

actions_updateBlockListSettings(clientId, settings) X-Ref

Returns an action object that changes the nested settings of a given block.

param: {string} clientId Client ID of the block whose nested setting are
param: {Object} settings Object with the new settings for the nested block.
return: {Object} Action object

actions_updateSettings(settings) X-Ref

Returns an action object used in signalling that the block editor settings have been updated.

param: {Object} settings Updated settings
return: {Object} Action object

__unstableSaveReusableBlock(id, updatedId) X-Ref

Returns an action object used in signalling that a temporary reusable blocks have been saved
in order to switch its temporary id with the real id.

param: {string} id Reusable block's id.
param: {string} updatedId Updated block's id.
return: {Object} Action object.

actions_unstableMarkLastChangeAsPersistent() X-Ref

Returns an action object used in signalling that the last block change should be marked explicitely as persistent.

return: {Object} Action object.

actions_unstableMarkNextChangeAsNotPersistent() X-Ref

Returns an action object used in signalling that the next block change should be marked explicitly as not persistent.

return: {Object} Action object.

actions_unstableMarkAutomaticChange() X-Ref

Returns an action object used in signalling that the last block change is
an automatic change, meaning it was not performed by the user, and can be
undone using the `Escape` and `Backspace` keys. This action must be called
after the change was made, and any actions that are a consequence of it, so
it is recommended to be called at the next idle period to ensure all
selection changes have been recorded.

return: {Object} Action object.

actions_setNavigationMode() X-Ref

Generators that triggers an action used to enable or disable the navigation mode.

param: {string} isNavigationMode Enable/Disable navigation mode.

actions_setBlockMovingClientId() X-Ref

Generator that triggers an action used to enable or disable the block moving mode.

param: {string|null} hasBlockMovingClientId Enable/Disable block moving mode.

actions_duplicateBlocks(clientIds) X-Ref

Generator that triggers an action used to duplicate a list of blocks.

param: {string[]} clientIds
param: {boolean} updateSelection

actions_insertBeforeBlock(clientId) X-Ref

Generator used to insert an empty block after a given block.

param: {string} clientId

actions_insertAfterBlock(clientId) X-Ref

Generator used to insert an empty block before a given block.

param: {string} clientId

actions_toggleBlockHighlight(clientId, isHighlighted) X-Ref

Returns an action object that toggles the highlighted block state.

param: {string} clientId The block's clientId.
param: {boolean} isHighlighted The highlight state.

actions_flashBlock(clientId) X-Ref

Yields action objects used in signalling that the block corresponding to the
given clientId should appear to "flash" by rhythmically highlighting it.

param: {string} clientId Target block client ID.

actions_setHasControlledInnerBlocks(clientId, hasControlledInnerBlocks) X-Ref

Returns an action object that sets whether the block has controlled innerblocks.

param: {string} clientId The block's clientId.
param: {boolean} hasControlledInnerBlocks True if the block's inner blocks are controlled.

selectors_ownKeys(object, enumerableOnly) X-Ref

No description

selectors_objectSpread(target) X-Ref

No description

selectors_getBlockName(state, clientId) X-Ref

Returns a block's name given its client ID, or null if no block exists with
the client ID.

param: {Object} state Editor state.
param: {string} clientId Block client ID.
return: {string} Block name.

selectors_isBlockValid(state, clientId) X-Ref

Returns whether a block is valid or not.

param: {Object} state Editor state.
param: {string} clientId Block client ID.
return: {boolean} Is Valid.

getBlockAttributes(state, clientId) X-Ref

Returns a block's attributes given its client ID, or null if no block exists with
the client ID.

param: {Object} state Editor state.
param: {string} clientId Block client ID.
return: {Object?} Block attributes.

selectors_getBlockCount(state, rootClientId) X-Ref

Returns the number of blocks currently present in the post.

param: {Object} state Editor state.
param: {?string} rootClientId Optional root client ID of block list.
return: {number} Number of blocks in the post.

selectors_getSelectionStart(state) X-Ref

Returns the current selection start block client ID, attribute key and text
offset.

param: {Object} state Block editor state.
return: {WPBlockSelection} Selection start information.

selectors_getSelectionEnd(state) X-Ref

Returns the current selection end block client ID, attribute key and text
offset.

param: {Object} state Block editor state.
return: {WPBlockSelection} Selection end information.

getBlockSelectionStart(state) X-Ref

Returns the current block selection start. This value may be null, and it
may represent either a singular block selection or multi-selection start.
A selection is singular if its start and end match.

param: {Object} state Global application state.
return: {?string} Client ID of block selection start.

selectors_getBlockSelectionEnd(state) X-Ref

Returns the current block selection end. This value may be null, and it
may represent either a singular block selection or multi-selection end.
A selection is singular if its start and end match.

param: {Object} state Global application state.
return: {?string} Client ID of block selection end.

selectors_getSelectedBlockCount(state) X-Ref

Returns the number of blocks currently selected in the post.

param: {Object} state Global application state.
return: {number} Number of blocks selected in the post.

hasSelectedBlock(state) X-Ref

Returns true if there is a single selected block, or false otherwise.

param: {Object} state Editor state.
return: {boolean} Whether a single block is selected.

selectors_getSelectedBlockClientId(state) X-Ref

Returns the currently selected block client ID, or null if there is no
selected block.

param: {Object} state Editor state.
return: {?string} Selected block client ID.

selectors_getSelectedBlock(state) X-Ref

Returns the currently selected block, or null if there is no selected block.

param: {Object} state Global application state.
return: {?Object} Selected block.

selectors_getBlockRootClientId(state, clientId) X-Ref

Given a block client ID, returns the root block from which the block is
nested, an empty string for top-level blocks, or null if the block does not
exist.

param: {Object} state Editor state.
param: {string} clientId Block from which to find root client ID.
return: {?string} Root client ID, if exists

getBlockHierarchyRootClientId(state, clientId) X-Ref

Given a block client ID, returns the root of the hierarchy from which the block is nested, return the block itself for root level blocks.

param: {Object} state Editor state.
param: {string} clientId Block from which to find root client ID.
return: {string} Root client ID

getLowestCommonAncestorWithSelectedBlock(state, clientId) X-Ref

Given a block client ID, returns the lowest common ancestor with selected client ID.

param: {Object} state Editor state.
param: {string} clientId Block from which to find common ancestor client ID.
return: {string} Common ancestor client ID or undefined

getAdjacentBlockClientId(state, startClientId) X-Ref

Returns the client ID of the block adjacent one at the given reference
startClientId and modifier directionality. Defaults start startClientId to
the selected block, and direction as next block. Returns null if there is no
adjacent block.

param: {Object} state Editor state.
param: {?string} startClientId Optional client ID of block from which to
param: {?number} modifier Directionality multiplier (1 next, -1
return: {?string} Return the client ID of the block, or null if none exists.

getPreviousBlockClientId(state, startClientId) X-Ref

Returns the previous block's client ID from the given reference start ID.
Defaults start to the selected block. Returns null if there is no previous
block.

param: {Object} state Editor state.
param: {?string} startClientId Optional client ID of block from which to
return: {?string} Adjacent block's client ID, or null if none exists.

getNextBlockClientId(state, startClientId) X-Ref

Returns the next block's client ID from the given reference start ID.
Defaults start to the selected block. Returns null if there is no next
block.

param: {Object} state Editor state.
param: {?string} startClientId Optional client ID of block from which to
return: {?string} Adjacent block's client ID, or null if none exists.

getSelectedBlocksInitialCaretPosition(state) X-Ref

Returns the initial caret position for the selected block.
This position is to used to position the caret properly when the selected block changes.

param: {Object} state Global application state.
return: {?Object} Selected block.

getMultiSelectedBlockClientIds(state) X-Ref

Returns the current multi-selection set of block client IDs, or an empty
array if there is no multi-selection.

param: {Object} state Editor state.
return: {Array} Multi-selected block client IDs.

selectors_getFirstMultiSelectedBlockClientId(state) X-Ref

Returns the client ID of the first block in the multi-selection set, or null
if there is no multi-selection.

param: {Object} state Editor state.
return: {?string} First block client ID in the multi-selection set.

getLastMultiSelectedBlockClientId(state) X-Ref

Returns the client ID of the last block in the multi-selection set, or null
if there is no multi-selection.

param: {Object} state Editor state.
return: {?string} Last block client ID in the multi-selection set.

isFirstMultiSelectedBlock(state, clientId) X-Ref

Returns true if a multi-selection exists, and the block corresponding to the
specified client ID is the first block of the multi-selection set, or false
otherwise.

param: {Object} state Editor state.
param: {string} clientId Block client ID.
return: {boolean} Whether block is first in multi-selection.

isBlockMultiSelected(state, clientId) X-Ref

Returns true if the client ID occurs within the block multi-selection, or
false otherwise.

param: {Object} state Editor state.
param: {string} clientId Block client ID.
return: {boolean} Whether block is in multi-selection set.

getMultiSelectedBlocksStartClientId(state) X-Ref

Returns the client ID of the block which begins the multi-selection set, or
null if there is no multi-selection.

This is not necessarily the first client ID in the selection.

param: {Object} state Editor state.
return: {?string} Client ID of block beginning multi-selection.

getMultiSelectedBlocksEndClientId(state) X-Ref

Returns the client ID of the block which ends the multi-selection set, or
null if there is no multi-selection.

This is not necessarily the last client ID in the selection.

param: {Object} state Editor state.
return: {?string} Client ID of block ending multi-selection.

selectors_getBlockOrder(state, rootClientId) X-Ref

Returns an array containing all block client IDs in the editor in the order
they appear. Optionally accepts a root client ID of the block list for which
the order should be returned, defaulting to the top-level block order.

param: {Object} state Editor state.
param: {?string} rootClientId Optional root client ID of block list.
return: {Array} Ordered client IDs of editor blocks.

selectors_getBlockIndex(state, clientId, rootClientId) X-Ref

Returns the index at which the block corresponding to the specified client
ID occurs within the block order, or `-1` if the block does not exist.

param: {Object} state Editor state.
param: {string} clientId Block client ID.
param: {?string} rootClientId Optional root client ID of block list.
return: {number} Index at which block exists in order.

isBlockSelected(state, clientId) X-Ref

Returns true if the block corresponding to the specified client ID is
currently selected and no multi-selection exists, or false otherwise.

param: {Object} state Editor state.
param: {string} clientId Block client ID.
return: {boolean} Whether block is selected and multi-selection exists.

hasSelectedInnerBlock(state, clientId) X-Ref

Returns true if one of the block's inner blocks is selected.

param: {Object}  state    Editor state.
param: {string}  clientId Block client ID.
param: {boolean} deep     Perform a deep check.
return: {boolean} Whether the block as an inner block selected

isBlockWithinSelection(state, clientId) X-Ref

Returns true if the block corresponding to the specified client ID is
currently selected but isn't the last of the selected blocks. Here "last"
refers to the block sequence in the document, _not_ the sequence of
multi-selection, which is why `state.selectionEnd` isn't used.

param: {Object} state Editor state.
param: {string} clientId Block client ID.
return: {boolean} Whether block is selected and not the last in the

selectors_hasMultiSelection(state) X-Ref

Returns true if a multi-selection has been made, or false otherwise.

param: {Object} state Editor state.
return: {boolean} Whether multi-selection has been made.

selectors_isMultiSelecting(state) X-Ref

Whether in the process of multi-selecting or not. This flag is only true
while the multi-selection is being selected (by mouse move), and is false
once the multi-selection has been settled.

param: {Object} state Global application state.
return: {boolean} True if multi-selecting, false if not.

selectors_isSelectionEnabled(state) X-Ref

Selector that returns if multi-selection is enabled or not.

param: {Object} state Global application state.
return: {boolean} True if it should be possible to multi-select blocks, false if multi-selection is disabled.

selectors_getBlockMode(state, clientId) X-Ref

Returns the block's editing mode, defaulting to "visual" if not explicitly
assigned.

param: {Object} state Editor state.
param: {string} clientId Block client ID.
return: {Object} Block editing mode.

selectors_isTyping(state) X-Ref

Returns true if the user is typing, or false otherwise.

param: {Object} state Global application state.
return: {boolean} Whether user is typing.

selectors_isDraggingBlocks(state) X-Ref

Returns true if the user is dragging blocks, or false otherwise.

param: {Object} state Global application state.
return: {boolean} Whether user is dragging blocks.

selectors_isCaretWithinFormattedText(state) X-Ref

Returns true if the caret is within formatted text, or false otherwise.

param: {Object} state Global application state.
return: {boolean} Whether the caret is within formatted text.

getBlockInsertionPoint(state) X-Ref

Returns the insertion point, the index at which the new inserted block would
be placed. Defaults to the last index.

param: {Object} state Editor state.
return: {Object} Insertion point object with `rootClientId`, `index`.

isBlockInsertionPointVisible(state) X-Ref

Returns true if we should show the block insertion point.

param: {Object} state Global application state.
return: {?boolean} Whether the insertion point is visible or not.

isValidTemplate(state) X-Ref

Returns whether the blocks matches the template or not.

param: {boolean} state
return: {?boolean} Whether the template is valid or not.

getTemplate(state) X-Ref

Returns the defined block template

param: {boolean} state
return: {?Array} Block Template

selectors_getTemplateLock(state, rootClientId) X-Ref

Returns the defined block template lock. Optionally accepts a root block
client ID as context, otherwise defaulting to the global context.

param: {Object} state Editor state.
param: {?string} rootClientId Optional block root client ID.
return: {?string} Block Template Lock

selectors_canInsertBlocks(state, clientIds) X-Ref

Determines if the given blocks are allowed to be inserted into the block
list.

param: {Object} state Editor state.
param: {string} clientIds The block client IDs to be inserted.
param: {?string} rootClientId Optional root client ID of block list.
return: {boolean} Whether the given blocks are allowed to be inserted.

getInsertUsage(state, id) X-Ref

Returns information about how recently and frequently a block has been inserted.

param: {Object} state Global application state.
param: {string} id A string which identifies the insert, e.g. 'core/block/12'
return: {?{ time: number, count: number }} An object containing `time` which is when the last

selectors_getBlockListSettings(state, clientId) X-Ref

Returns the Block List settings of a block, if any exist.

param: {Object} state Editor state.
param: {?string} clientId Block client ID.
return: {?Object} Block settings of the block if set.

selectors_getSettings(state) X-Ref

Returns the editor settings.

param: {Object} state Editor state.
return: {Object} The editor settings object.

isLastBlockChangePersistent(state) X-Ref

Returns true if the most recent block change is be considered persistent, or
false otherwise. A persistent change is one committed by BlockEditorProvider
via its `onChange` callback, in addition to `onInput`.

param: {Object} state Block editor state.
return: {boolean} Whether the most recent block change was persistent.

__unstableIsLastBlockChangeIgnored(state) X-Ref

Returns true if the most recent block change is be considered ignored, or
false otherwise. An ignored change is one not to be committed by
BlockEditorProvider, neither via `onChange` nor `onInput`.

param: {Object} state Block editor state.
return: {boolean} Whether the most recent block change was ignored.

__experimentalGetLastBlockAttributeChanges(state) X-Ref

Returns the block attributes changed as a result of the last dispatched
action.

param: {Object} state Block editor state.
return: {Object<string,Object>} Subsets of block attributes changed, keyed

getReusableBlocks(state) X-Ref

Returns the available reusable blocks

param: {Object} state Global application state.
return: {Array} Reusable blocks

selectors_isNavigationMode(state) X-Ref

Returns whether the navigation mode is enabled.

param: {Object} state Editor state.
return: {boolean} Is navigation mode enabled.

selectors_hasBlockMovingClientId(state) X-Ref

Returns whether block moving mode is enabled.

param: {Object} state Editor state.
return: {string} Client Id of moving block.

selectors_didAutomaticChange(state) X-Ref

Returns true if the last change was an automatic change, false otherwise.

param: {Object} state Global application state.
return: {boolean} Whether the last change was automatic.

isBlockHighlighted(state, clientId) X-Ref

Returns true if the current highlighted block matches the block clientId.

param: {Object} state Global application state.
param: {string} clientId The block to check.
return: {boolean} Whether the block is currently highlighted.

areInnerBlocksControlled(state, clientId) X-Ref

Checks if a given block has controlled inner blocks.

param: {Object} state Global application state.
param: {string} clientId The block to check.
return: {boolean} True if the block has controlled inner blocks.

effects_ownKeys(object, enumerableOnly) X-Ref

No description

effects_objectSpread(target) X-Ref

No description

validateBlocksToTemplate(action, store) X-Ref

Block validity is a function of blocks state (at the point of a
reset) and the template setting. As a compromise to its placement
across distinct parts of state, it is implemented here as a side-
effect of the block reset action.

param: {Object} action RESET_BLOCKS action.
param: {Object} store Store instance.
return: {?Object} New validity set action if validity has changed.

applyMiddlewares(store) X-Ref

Applies the custom middlewares used specifically in the editor module.

param: {Object} store Store Object.
return: {Object} Update Store Object.

store_ownKeys(object, enumerableOnly) X-Ref

No description

store_objectSpread(target) X-Ref

No description

useBlockSync(_ref) X-Ref

useBlockSync is a side effect which handles bidirectional sync between the
block-editor store and a controlling data source which provides blocks. This
is most commonly used by the BlockEditorProvider to synchronize the contents
of the block-editor store with the root entity, like a post.

Another example would be the template part block, which provides blocks from
a separate entity data source than a root entity. This hook syncs edits to
the template part in the block editor back to the entity and vice-versa.

Here are some of its basic functions:
- Initalizes the block-editor store for the given clientID to the blocks
given via props.
- Adds incoming changes (like undo) to the block-editor store.
- Adds outgoing changes (like editing content) to the controlling entity,
determining if a change should be considered persistent or not.
- Handles edge cases and race conditions which occur in those operations.
- Ignores changes which happen to other entities (like nested inner block
controllers.
- Passes selection state from the block-editor store to the controlling entity.

param: {Object} props Props for the block sync hook
param: {string} props.clientId The client ID of the inner block controller.
param: {Object[]} props.value The control value for the blocks. This value
param: {Object} props.selectionStart The selection start vlaue from the
param: {Object} props.selectionEnd The selection end vlaue from the
param: {onBlockUpdate} props.onChange Function to call when a persistent
param: {onBlockUpdate} props.onInput Function to call when a non-persistent

BlockEditorProvider(props) X-Ref

No description

default_block_appender_DefaultBlockAppender(_ref) X-Ref

Internal dependencies

button_block_appender_ButtonBlockAppender(_ref, ref) X-Ref

No description

block_list_appender_stopPropagation(event) X-Ref

No description

BlockListAppender(_ref) X-Ref

No description

getNearestBlockIndex(elements, position, orientation) X-Ref

Given a list of block DOM elements finds the index that a block should be dropped
at.

This function works for both horizontal and vertical block lists and uses the following
terms for its variables:

- Lateral, meaning the axis running horizontally when a block list is vertical and vertically when a block list is horizontal.
- Forward, meaning the axis running vertically when a block list is vertical and horizontally
when a block list is horizontal.

param: {Element[]} elements Array of DOM elements that represent each block in a block list.
param: {WPBlockDragPosition} position The position of the item being dragged.
param: {WPBlockListOrientation} orientation The orientation of a block list.
return: {number|undefined} The block index that's closest to the drag position.

parseDropEvent(event) X-Ref

Retrieve the data for a block drop event.

param: {WPSyntheticEvent} event The drop event.
return: {Object} An object with block drag and drop data.

useBlockDropZone(_ref) X-Ref

A React hook that can be used to make a block list handle drag and drop.

param: {WPBlockDropZoneConfig} dropZoneConfig configuration data for the drop zone.
return: {number|undefined} The block index that's closest to the drag position.

BlockList(_ref, ref) X-Ref

No description

selector(select) X-Ref

No description

LiveBlockPreview(_ref) X-Ref

Internal dependencies

AutoBlockPreview(_ref) X-Ref

No description

BlockPreview(_ref) X-Ref

No description

preview_panel_ownKeys(object, enumerableOnly) X-Ref

No description

preview_panel_objectSpread(target) X-Ref

No description

InserterPreviewPanel(_ref) X-Ref

No description

InserterListItem(_ref) X-Ref

No description

BlockTypesList(_ref) X-Ref

No description

ChildBlocks(_ref) X-Ref

Internal dependencies

InserterPanel(_ref) X-Ref

WordPress dependencies

InserterNoResults() X-Ref

No description

block_types_tab_ownKeys(object, enumerableOnly) X-Ref

No description

block_types_tab_objectSpread(target) X-Ref

No description

BlockTypesTab(_ref) X-Ref

No description

BlockPattern(_ref) X-Ref

No description

BlockPatternPlaceholder() X-Ref

No description

BlockPatternList(_ref2) X-Ref

No description

BlockPatternsSearchResults(_ref) X-Ref

No description

BlockPatternsPerCategories(_ref2) X-Ref

No description

BlockPatternsTabs(_ref4) X-Ref

No description

ReusableBlocksList(_ref) X-Ref

No description

ReusableBlocksTab(_ref3) X-Ref

List of reusable blocks shown in the "Reusable" tab of the inserter.

param: {Object}   props                Component props.
param: {?string}  props.rootClientId   Client id of block to insert into.
param: {Function} props.onInsert       Callback to run when item is inserted.
param: {Function} props.onHover        Callback to run when item is hovered.
param: {?string}  props.filterValue    Search term.
param: {Function} props.debouncedSpeak Debounced speak function.
return: {WPComponent} The component.

use_insertion_point_ownKeys(object, enumerableOnly) X-Ref

No description

use_insertion_point_objectSpread(target) X-Ref

No description

useInsertionPoint(_ref) X-Ref

Returns the insertion point state given the inserter config.

param: {WPInserterConfig} config Inserter Config.
return: {Array} Insertion Point State (rootClientID, onInsertBlocks and onToggle).

getInsertionIndex() X-Ref

No description

InserterTabs(_ref) X-Ref

No description

InserterMenu(_ref) X-Ref

No description

QuickInserterList(_ref) X-Ref

No description

QuickInserter(_ref2) X-Ref

No description

inserter_createSuper(Derived) X-Ref

No description

inserter_isNativeReflectConstruct() X-Ref

No description

Inserter() X-Ref

No description

getInsertionIndex() X-Ref

No description

onFocus() X-Ref

No description

isNavigationCandidate(element, keyCode, hasModifier) X-Ref

Returns true if the element should consider edge navigation upon a keyboard
event of the given directional key code, or false otherwise.

param: {Element} element HTML element to test.
param: {number} keyCode KeyboardEvent keyCode to test.
param: {boolean} hasModifier Whether a modifier is pressed.
return: {boolean} Whether element should consider edge navigation.

getClosestTabbable(target, isReverse, containerElement, onlyVertical) X-Ref

Returns the optimal tab target from the given focused element in the
desired direction. A preference is made toward text fields, falling back
to the block focus stop if no other candidates exist for the block.

param: {Element} target           Currently focused text field.
param: {boolean} isReverse        True if considering as the first field.
param: {Element} containerElement Element containing all blocks.
param: {boolean} onlyVertical     Wether to only consider tabbable elements
return: {?Element} Optimal tab target, if one exists.

isTabCandidate(node, i, array) X-Ref

No description

writing_flow_selector(select) X-Ref

No description

WritingFlow(_ref) X-Ref

Handles selection and navigation across blocks. This component should be
wrapped around BlockList.

param: {Object} props Component properties.
param: {WPElement} props.children Children to be rendered.

onMouseDown(event) X-Ref

No description

expandSelection(isReverse) X-Ref

No description

moveSelection(isReverse) X-Ref

No description

isTabbableEdge(target, isReverse) X-Ref

Returns true if the given target field is the last in its block which
can be considered for tab transition. For example, in a block with two
text fields, this would return true when reversing from the first of the
two fields, but false when reversing from the second.

param: {Element} target Currently focused text field.
param: {boolean} isReverse True if considering as the first field.
return: {boolean} Whether field is at edge for tab transition.

onKeyDown(event) X-Ref

No description

focusLastTextField() X-Ref

No description

Indicator(_ref) X-Ref

No description

InsertionPoint(_ref2) X-Ref

No description

onMouseMove(event) X-Ref

No description

focusClosestTabbable(event) X-Ref

No description

BlockSelectionButton(_ref) X-Ref

Block selection button component, displaying the label of the block. If the block
descends from a root block, a button is displayed enabling the user to select
the root block.

param: {string} props Component props.
param: {string} props.clientId Client ID of block.
return: {WPComponent} The component to be rendered.

onKeyDown(event) X-Ref

No description

useUpdateLayoutEffect(effect, deps) X-Ref

No description

hasOnlyToolbarItem(elements) X-Ref

No description

focusFirstTabbableIn(container) X-Ref

No description

useIsAccessibleToolbar(ref) X-Ref

No description

useToolbarFocus(ref, focusOnMount, isAccessibleToolbar) X-Ref

No description

NavigableToolbar(_ref) X-Ref

No description

block_mover_createSuper(Derived) X-Ref

No description

block_mover_isNativeReflectConstruct() X-Ref

No description

BlockMover() X-Ref

No description

BlockParentSelector() X-Ref

Block parent selector component, displaying the hierarchy of the
current block selection as a single icon to "go up" a level.

return: {WPComponent} Parent block selector.

block_styles_ownKeys(object, enumerableOnly) X-Ref

No description

block_styles_objectSpread(target) X-Ref

No description

block_styles_createForOfIteratorHelper(o) X-Ref

No description

block_styles_unsupportedIterableToArray(o, minLen) X-Ref

No description

block_styles_arrayLikeToArray(arr, len) X-Ref

No description

getActiveStyle(styles, className) X-Ref

Returns the active style from the given className.

param: {Array} styles Block style variations.
param: {string} className Class name
return: {Object?} The active style.

replaceActiveStyle(className, activeStyle, newStyle) X-Ref

Replaces the active style in the block's className.

param: {string} className Class name.
param: {Object?} activeStyle The replaced style.
param: {Object} newStyle The replacing style.
return: {string} The updated className.

BlockStyles(_ref) X-Ref

No description

BlockStyleItem(_ref2) X-Ref

No description

block_switcher_createSuper(Derived) X-Ref

No description

block_switcher_isNativeReflectConstruct() X-Ref

No description

block_switcher_ownKeys(object, enumerableOnly) X-Ref

No description

block_switcher_objectSpread(target) X-Ref

No description

PreviewBlockPopover(_ref) X-Ref

No description

BlockSwitcher() X-Ref

No description

getPasteEventData(_ref) X-Ref

WordPress dependencies

useNotifyCopy() X-Ref

Internal dependencies

CopyHandler(_ref) X-Ref

No description

BlockActions(_ref) X-Ref

Internal dependencies

BlockModeToggle(_ref) X-Ref

No description

BlockConvertButton(_ref) X-Ref

WordPress dependencies

block_settings_menu_controls_ownKeys(object, enumerableOnly) X-Ref

No description

block_settings_menu_controls_objectSpread(target) X-Ref

No description

BlockSettingsDropdown(_ref) X-Ref

No description

BlockSettingsMenu(_ref) X-Ref

Internal dependencies

BlockDraggableChip(_ref) X-Ref

Internal dependencies

useScrollWhenDragging() X-Ref

React hook that scrolls the scroll container when a block is being dragged.

return: {Function[]} `startScrolling`, `scrollOnDragOver`, `stopScrolling`

useDebouncedShowMovers(_ref) X-Ref

Hook that creates a showMover state, as well as debounced show/hide callbacks.

param: {Object}   props                       Component props.
param: {Object}   props.ref                   Element reference.
param: {boolean}  props.isFocused             Whether the component has current focus.
param: {number}   [props.debounceTimeout=250] Debounce timeout in milliseconds.
param: {Function} [props.onChange=noop]       Callback function.

useShowMoversGestures(_ref2) X-Ref

Hook that provides a showMovers state and gesture events for DOM elements
that interact with the showMovers state.

param: {Object}   props                       Component props.
param: {Object}   props.ref                   Element reference.
param: {number}   [props.debounceTimeout=250] Debounce timeout in milliseconds.
param: {Function} [props.onChange=noop]       Callback function.

useToggleBlockHighlight(clientId) X-Ref

Hook that toggles the highlight (outline) state of a block

param: {string} clientId The block's clientId
return: {Function} Callback function to toggle highlight state.

BlockToolbar(_ref) X-Ref

No description

BlockContextualToolbar(_ref) X-Ref

No description

block_popover_selector(select) X-Ref

No description

BlockPopover(_ref) X-Ref

No description

onFocus() X-Ref

No description

onBlur() X-Ref

No description

wrapperSelector(select) X-Ref

No description

WrappedBlockPopover() X-Ref

No description

root_container_selector(select) X-Ref

No description

onDragStart(event) X-Ref

Prevents default dragging behavior within a block.
To do: we must handle this in the future and clean up the drag target.
Previously dragging was prevented for multi-selected, but this is no longer
needed.

param: {WPSyntheticEvent} event Synthetic drag event.

RootContainer(_ref, ref) X-Ref

No description

onFocus(event) X-Ref

Marks the block as selected when focused and not already selected. This
specifically handles the case where block does not set focus on its own
(via `setFocus`), typically if there is no focusable input in the block.

param: {WPSyntheticEvent} event

block_wrapper_ownKeys(object, enumerableOnly) X-Ref

No description

block_wrapper_objectSpread(target) X-Ref

No description

onMouseOver(event) X-Ref

No description

onMouseOut(event) X-Ref

No description

block_ownKeys(object, enumerableOnly) X-Ref

No description

block_objectSpread(target) X-Ref

No description

mergeWrapperProps(propsA, propsB) X-Ref

Merges wrapper props with special handling for classNames and styles.

param: {Object} propsA
param: {Object} propsB
return: {Object} Merged props.

block_BlockListBlock(_ref) X-Ref

No description

BlockNavigationBlockSelectButton(_ref, ref) X-Ref

No description

block_slot_ownKeys(object, enumerableOnly) X-Ref

No description

block_slot_objectSpread(target) X-Ref

No description

BlockNavigationBlockSlot(props, ref) X-Ref

No description

BlockNavigationBlock(_ref) X-Ref

No description

BlockNavigationAppender(_ref) X-Ref

No description

BlockNavigationBranch(props) X-Ref

No description

BlockNavigationTree(_ref) X-Ref

Wrap `BlockNavigationRows` with `TreeGrid`. BlockNavigationRows is a
recursive component (it renders itself), so this ensures TreeGrid is only
present at the very top of the navigation grid.

param: {Object} props Components props.
param: {Object} props.__experimentalFeatures Object used in context provider.

BlockNavigation(_ref) X-Ref

No description

BlockNavigationDropdownToggle(_ref) X-Ref

No description

BlockNavigationDropdown(_ref2, ref) X-Ref

No description

filePasteHandler(files) X-Ref

WordPress dependencies

rich_text_ownKeys(object, enumerableOnly) X-Ref

No description

rich_text_objectSpread(target) X-Ref

No description

getMultilineTag(multiline) X-Ref

Get the multiline tag based on the multiline prop.

param: {?(string|boolean)} multiline The multiline prop.
return: {?string} The multiline tag.

getAllowedFormats(_ref) X-Ref

No description

RichTextWrapper(_ref2, forwardedRef) X-Ref

No description

BlockNavigationEditor(_ref) X-Ref

No description

BlockVariationPicker(_ref) X-Ref

No description

block_vertical_alignment_toolbar_ownKeys(object, enumerableOnly) X-Ref

No description

block_vertical_alignment_toolbar_objectSpread(target) X-Ref

No description

BlockVerticalAlignmentToolbar(_ref) X-Ref

No description

applyOrUnset(align) X-Ref

No description

ColorPaletteControl(_ref) X-Ref

Internal dependencies

GradientPickerWithGradients(props) X-Ref

No description

GradientPickerControl(_ref) X-Ref

Internal dependencies

GradientPanel(props) X-Ref

Internal dependencies

ImageSizeControl(_ref) X-Ref

No description

updateDimensions(nextWidth, nextHeight) X-Ref

No description

useNestedSettingsUpdate(clientId, allowedBlocks, templateLock, captureToolbars, orientation) X-Ref

This hook is a side effect which updates the block-editor store when changes
happen to inner block settings. The given props are transformed into a
settings object, and if that is different from the current settings object in
the block-editor store, then the store is updated with the new settings which
came from props.

param: {string}   clientId        The client ID of the block to update.
param: {string[]} allowedBlocks   An array of block names which are permitted
param: {string}   [templateLock]  The template lock specified for the inner
param: {boolean}  captureToolbars Whether or children toolbars should be shown
param: {string}   orientation     The direction in which the block

useInnerBlockTemplateSync(clientId, template, templateLock, templateInsertUpdatesSelection) X-Ref

This hook makes sure that a block's inner blocks stay in sync with the given
block "template". The template is a block hierarchy to which inner blocks must
conform. If the blocks get "out of sync" with the template and the template
is meant to be locked (e.g. templateLock = "all"), then we replace the inner
blocks with the correct value after synchronizing it with the template.

param: {string} clientId The block client ID.
param: {Object} template The template to match.
param: {string} templateLock The template lock state for the inner blocks. For
param: {boolean} templateInsertUpdatesSelection Whether or not to update the

getBlockContext(attributes, blockType) X-Ref

Returns a cached context object value for a given set of attributes for the
block type.

param: {Record<string,*>} attributes Block attributes object.
param: {WPBlockType} blockType Block type settings.
return: {Record<string,*>} Context value.

inner_blocks_ownKeys(object, enumerableOnly) X-Ref

No description

inner_blocks_objectSpread(target) X-Ref

No description

UncontrolledInnerBlocks(props) X-Ref

InnerBlocks is a component which allows a single block to have multiple blocks
as children. The UncontrolledInnerBlocks component is used whenever the inner
blocks are not controlled by another entity. In other words, it is normally
used for inner blocks in the post editor

param: {Object} props The component props.

ControlledInnerBlocks(props) X-Ref

The controlled inner blocks component wraps the uncontrolled inner blocks
component with the blockSync hook. This keeps the innerBlocks of the block in
the block-editor store in sync with the blocks of the controlling entity. An
example of an inner block controller is a template part block, which provides
its own blocks from the template part entity data source.

param: {Object} props The component props.

settings_drawer_ownKeys(object, enumerableOnly) X-Ref

settings_drawer_objectSpread(target) X-Ref

No description

url_input_createSuper(Derived) X-Ref

No description

url_input_isNativeReflectConstruct() X-Ref

No description

URLInput(props) X-Ref

No description

selectSuggestionOrCurrentInputValue(event) X-Ref

No description

link_control_ownKeys(object, enumerableOnly) X-Ref

No description

link_control_objectSpread(target) X-Ref

No description

LinkControl(_ref) X-Ref

Renders a link control. A link control is a controlled input which maintains
a value associated with a link (HTML anchor element) and relevant settings
for how that link is expected to behave.

param: {WPLinkControlProps} props Component props.

stopEditing() X-Ref

Cancels editing state and marks that focus may need to be restored after
the next render, if focus was within the wrapper when editing finished.

isURLLike(val) X-Ref

Determines whether a given value could be a URL. Note this does not
guarantee the value is a URL only that it looks like it might be one. For
example, just because a string has `www.` in it doesn't make it a URL,
but it does make it highly likely that it will be so in the context of
creating a link it makes sense to treat it like one.

param: {string} val the candidate for being URL-like (or not).
return: {boolean} whether or not the value is potentially a URL.

MediaUploadCheck(_ref) X-Ref

WordPress dependencies

LinkViewerURL(_ref) X-Ref

No description

LinkViewer(_ref) X-Ref

Internal dependencies

LinkEditor(_ref) X-Ref

Internal dependencies

url_popover_createSuper(Derived) X-Ref

No description

url_popover_isNativeReflectConstruct() X-Ref

No description

URLPopover() X-Ref

No description

media_placeholder_createSuper(Derived) X-Ref

media_placeholder_isNativeReflectConstruct() X-Ref

No description

MediaPlaceholder() X-Ref

No description

ResponsiveBlockControlLabel(_ref) X-Ref

No description

ResponsiveBlockControl(props) X-Ref

No description

RichTextShortcut(_ref) X-Ref

WordPress dependencies

RichTextToolbarButton(_ref) X-Ref

WordPress dependencies

input_event_createSuper(Derived) X-Ref

No description

input_event_isNativeReflectConstruct() X-Ref

No description

__unstableRichTextInputEvent() X-Ref

No description

ToolSelector(props, ref) X-Ref

No description

button_createSuper(Derived) X-Ref

No description

button_isNativeReflectConstruct() X-Ref

No description

URLInputButton() X-Ref

No description

PreviewOptions(_ref) X-Ref

No description

getStyleSheetsThatMatchHostname() X-Ref

No description

isReplaceableMediaRule(rule) X-Ref

No description

replaceRule(styleSheet, newRuleText, index) X-Ref

No description

replaceMediaQueryWithWidthEvaluation(ruleText, widthValue) X-Ref

No description

useSimulatedMediaQuery(marker, width) X-Ref

Function that manipulates media queries from stylesheets to simulate a given
viewport width.

param: {string} marker CSS selector string defining start and end of
param: {number?} width Viewport width to simulate. If provided null, the

useResizeCanvas(deviceType) X-Ref

Function to resize the editor window.

param: {string} deviceType Used for determining the size of the container (e.g. Desktop, Tablet, Mobile)
return: {Object} Inline styles to be added to resizable container.

MultiSelectionInspector(_ref) X-Ref

No description

DefaultStylePicker(_ref) X-Ref

No description

block_selection_clearer_createSuper(Derived) X-Ref

No description

block_selection_clearer_isNativeReflectConstruct() X-Ref

No description

BlockSelectionClearer() X-Ref

No description

updatePosition(str) X-Ref

Update lineno and column based on `str`.

position() X-Ref

Mark position and patch `node.position`.

Position(start) X-Ref

Store position information for a node

error(msg) X-Ref

No description

stylesheet() X-Ref

Parse stylesheet.

open() X-Ref

Opening brace.

close() X-Ref

Closing brace.

rules() X-Ref

Parse ruleset.

match(re) X-Ref

Match `re` and return captures.

whitespace() X-Ref

Parse whitespace.

comments(accumulator) X-Ref

Parse comments;

comment() X-Ref

Parse comment.

selector() X-Ref

Parse selector.

declaration() X-Ref

Parse declaration.

declarations() X-Ref

Parse declarations.

keyframe() X-Ref

Parse keyframe.

atkeyframes() X-Ref

Parse keyframes.

atsupports() X-Ref

Parse supports.

athost() X-Ref

Parse host.

atmedia() X-Ref

Parse media.

atcustommedia() X-Ref

Parse custom-media.

atpage() X-Ref

Parse paged media.

atdocument() X-Ref

Parse document.

atfontface() X-Ref

Parse font-face.

_compileAtrule(name) X-Ref

Parse non-block at-rules

atrule() X-Ref

Parse at rule.

rule() X-Ref

Parse rule.

trim(str) X-Ref

Trim `str`.

addParent(obj, parent) X-Ref

Adds non-enumerable parent node reference to each node.

Compiler(opts) X-Ref

Initialize a compiler.

compress_Compiler(options) X-Ref

Initialize a new `Compiler`.

identity_Compiler(options) X-Ref

Initialize a new `Compiler`.

traverseCSS(css, callback) X-Ref

No description

url_rewrite_ownKeys(object, enumerableOnly) X-Ref

No description

url_rewrite_objectSpread(target) X-Ref

No description

isRemotePath(filePath) X-Ref

Return `true` if the given path is http/https.

param: {string} filePath path
return: {boolean} is remote path.

isAbsolutePath(filePath) X-Ref

Return `true` if the given filePath is an absolute url.

param: {string} filePath path
return: {boolean} is absolute path.

isValidURL(meta) X-Ref

Whether or not the url should be inluded.

param: {Object} meta url meta info
return: {boolean} is valid.

getResourcePath(str, baseURL) X-Ref

Get the absolute path of the url, relative to the basePath

param: {string} str          the url
param: {string} baseURL      base URL
return: {string}              the full path to the file

processURL(baseURL) X-Ref

Process the single `url()` pattern

param: {string} baseURL the base URL for relative URLs
return: {Promise} the Promise

getURLs(value) X-Ref

Get all `url()`s, and return the meta info

param: {string} value decl.value
return: {Array} the urls

replaceURLs(raw, URLs) X-Ref

Replace the raw value's `url()` segment to the new value

param: {string} raw  the raw value
param: {Array}  URLs the URLs to replace
return: {string}     the new value

wrap_ownKeys(object, enumerableOnly) X-Ref

No description

wrap_objectSpread(target) X-Ref

No description

EditorStyles(_ref) X-Ref

No description

InserterLibrary(_ref) X-Ref

No description

KeyboardShortcuts() X-Ref

No description

KeyboardShortcutsRegister() X-Ref

No description

MultiSelectScrollIntoView() X-Ref

Scrolls the multi block selection end into view if not in view already. This
is important to do after selection by keyboard.

isKeyDownEligibleForStartTyping(event) X-Ref

Returns true if a given keydown event can be inferred as intent to start
typing, or false otherwise. A keydown is considered eligible if it is a
text navigation without shift active.

param: {KeyboardEvent} event Keydown event to test.
return: {boolean} Whether event is eligible to start typing.

ObserveTyping(_ref) X-Ref

No description

toggleEventBindings(isBound) X-Ref

Bind or unbind events to the document when typing has started or stopped
respectively, or when component has become unmounted.

param: {boolean} isBound Whether event bindings should be applied.

stopTypingOnMouseMove(event) X-Ref

On mouse move, unset typing flag if user has moved cursor.

param: {MouseEvent} event Mousemove event.

stopTypingOnSelectionUncollapse() X-Ref

On selection change, unset typing flag if user has made an uncollapsed
(shift) selection.

stopTypingOnEscapeKey(event) X-Ref

Unsets typing flag if user presses Escape while typing flag is active.

param: {KeyboardEvent} event Keypress or keydown event to interpret.

startTypingInTextField(event) X-Ref

Handles a keypress or keydown event to infer intention to start typing.

param: {KeyboardEvent} event Keypress or keydown event to interpret.

stopTypingOnNonTextField(event) X-Ref

Stops typing when focus transitions to a non-text field element.

param: {FocusEvent} event Focus event.

PreserveScrollInReorder() X-Ref

WordPress dependencies

typewriter_createSuper(Derived) X-Ref

No description

typewriter_isNativeReflectConstruct() X-Ref

No description

Typewriter() X-Ref

No description

asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) X-Ref

No description

_asyncToGenerator(fn) X-Ref

No description

_next(value) X-Ref

No description

_throw(err) X-Ref

No description

_defineProperty(obj, key, value) X-Ref

No description

memize( fn, options ) X-Ref

Accepts a function to be memoized, and returns a new memoized function, with
optional options.

param: {F} fn Function to memoize.
param: {MemizeOptions} [options] Options object.
return: {F & MemizeMemoizedFunction} Memoized function.

memoized( ) X-Ref

No description

tinycolor(color, opts) X-Ref

No description

inputToRGB(color) X-Ref

No description

rgbToRgb(r, g, b) X-Ref

No description

rgbToHsl(r, g, b) X-Ref

No description

hslToRgb(h, s, l) X-Ref

No description