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

Calculate the `line-height` of a given node

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

_extends() X-Ref

No description

_objectWithoutPropertiesLoose(source, excluded) X-Ref

No description

_assertThisInitialized(self) X-Ref

No description

_getPrototypeOf(o) X-Ref

No description

error(type) X-Ref

A generic error utility function.

returns: {Error} Throws a `RangeError` with the applicable error message.
param: {String} type The error type.

map(array, fn) X-Ref

A generic `Array#map` utility function.

returns: {Array} A new array of values returned by the callback function.
param: {Array} array The array to iterate over.
param: {Function} callback The function that gets called for every array

mapDomain(string, fn) X-Ref

A simple `Array#map`-like wrapper to work with domain name strings or email
addresses.

returns: {Array} A new string of characters returned by the callback
param: {String} domain The domain name or email address.
param: {Function} callback The function that gets called for every

ucs2decode(string) X-Ref

Creates an array containing the numeric code points of each Unicode
character in the string. While JavaScript uses UCS-2 internally,
this function will convert a pair of surrogate halves (each of which
UCS-2 exposes as separate characters) into a single code point,
matching UTF-16.

returns: {Array} The new array of code points.
param: {String} string The Unicode input string (UCS-2).

ucs2encode(array) X-Ref

Creates a string based on an array of numeric code points.

returns: {String} The new Unicode string (UCS-2).
param: {Array} codePoints The array of numeric code points.

basicToDigit(codePoint) X-Ref

Converts a basic code point into a digit/integer.

returns: {Number} The numeric value of a basic code point (for use in
param: {Number} codePoint The basic numeric code point value.

digitToBasic(digit, flag) X-Ref

Converts a digit/integer into a basic code point.

returns: {Number} The basic code point whose value (when used for
param: {Number} digit The numeric value of a basic code point.

adapt(delta, numPoints, firstTime) X-Ref

Bias adaptation function as per section 3.4 of RFC 3492.
http://tools.ietf.org/html/rfc3492#section-3.4

decode(input) X-Ref

Converts a Punycode string of ASCII-only symbols to a string of Unicode
symbols.

returns: {String} The resulting string of Unicode symbols.
param: {String} input The Punycode string of ASCII-only symbols.

encode(input) X-Ref

Converts a string of Unicode symbols (e.g. a domain name label) to a
Punycode string of ASCII-only symbols.

returns: {String} The resulting Punycode string of ASCII-only symbols.
param: {String} input The string of Unicode symbols.

toUnicode(input) X-Ref

Converts a Punycode string representing a domain name or an email address
to Unicode. Only the Punycoded parts of the input will be converted, i.e.
it doesn't matter if you call it on a string that has already been
converted to Unicode.

returns: {String} The Unicode representation of the given Punycode
param: {String} input The Punycoded domain name or email address to

toASCII(input) X-Ref

Converts a Unicode string representing a domain name or an email address to
Punycode. Only the non-ASCII parts of the domain name will be converted,
i.e. it doesn't matter if you call it with a domain that's already in
ASCII.

returns: {String} The Punycode representation of the given domain name or
param: {String} input The domain name or email address to convert, as a

hasOwnProperty(obj, prop) X-Ref

No description

map(xs, f) X-Ref

No description

_setPrototypeOf(o, p) X-Ref

No description

_inherits(subClass, superClass) X-Ref

No description

_arrayWithoutHoles(arr) X-Ref

No description

_nonIterableSpread() X-Ref

No description

_toConsumableArray(arr) X-Ref

No description

_objectWithoutProperties(source, excluded) X-Ref

No description

ownKeys(object, enumerableOnly) X-Ref

No description

_objectSpread(target) X-Ref

No description

Icon(_ref) X-Ref

WordPress dependencies

_iterableToArrayLimit(arr, i) X-Ref

No description

_slicedToArray(arr, i) X-Ref

No description

_arrayLikeToArray(arr, len) X-Ref

No description

multi(_ref) X-Ref

Redux dispatch multiple actions

__webpack_require__(moduleId) X-Ref

No description

_interopRequireDefault(obj) 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

_interopRequireDefault(obj) X-Ref

No description

diffChars(oldStr, newStr, options) X-Ref

No description

_interopRequireDefault(obj) X-Ref

No description

diffWords(oldStr, newStr, options) X-Ref

No description

diffWordsWithSpace(oldStr, newStr, options) X-Ref

No description

generateOptions(options, defaults) X-Ref

No description

_interopRequireDefault(obj) X-Ref

No description

diffLines(oldStr, newStr, callback) X-Ref

No description

diffTrimmedLines(oldStr, newStr, callback) X-Ref

No description

_interopRequireDefault(obj) X-Ref

No description

diffSentences(oldStr, newStr, callback) X-Ref

No description

_interopRequireDefault(obj) X-Ref

No description

diffCss(oldStr, newStr, callback) X-Ref

No description

_interopRequireDefault(obj) X-Ref

No description

diffJson(oldObj, newObj, options) X-Ref

No description

canonicalize(obj, stack, replacementStack, replacer, key) X-Ref

No description

_interopRequireDefault(obj) X-Ref

No description

diffArrays(oldArr, newArr, callback) X-Ref

No description

_interopRequireDefault(obj) X-Ref

No description

applyPatch(source, uniDiff) X-Ref

No description

hunkFits(hunk, toPos) X-Ref

Checks if the hunk exactly fits on the provided location

applyPatches(uniDiff, options) X-Ref

No description

processIndex() X-Ref

No description

parsePatch(uniDiff) X-Ref

No description

parseIndex() X-Ref

No description

parseFileHeader(index) X-Ref

No description

parseHunk() X-Ref

No description

_toConsumableArray(arr) X-Ref

No description

calcLineCount(hunk) X-Ref

No description

merge(mine, theirs, base) X-Ref

No description

loadPatch(param, base) X-Ref

No description

fileNameChanged(patch) X-Ref

No description

selectField(index, mine, theirs) X-Ref

No description

hunkBefore(test, check) X-Ref

No description

cloneHunk(hunk, offset) X-Ref

No description

mergeLines(hunk, mineOffset, mineLines, theirOffset, theirLines) X-Ref

No description

mutualChange(hunk, mine, their) X-Ref

No description

removal(hunk, mine, their, swap) X-Ref

No description

conflict(hunk, mine, their) X-Ref

No description

insertLeading(hunk, insert, their) X-Ref

No description

insertTrailing(hunk, insert) X-Ref

No description

collectChange(state) X-Ref

No description

collectContext(state, matchChanges) X-Ref

No description

allRemoves(changes) X-Ref

No description

skipRemoveSuperset(state, removeChanges, delta) X-Ref

No description

calcOldNewLineCount(lines) X-Ref

No description

_toConsumableArray(arr) X-Ref

No description

structuredPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader, options) X-Ref

No description

contextLines(lines) X-Ref

No description

createTwoFilesPatch(oldFileName, newFileName, oldStr, newStr, oldHeader, newHeader, options) X-Ref

No description

createPatch(fileName, oldStr, newStr, oldHeader, newHeader, options) X-Ref

No description

arrayEqual(a, b) X-Ref

No description

arrayStartsWith(array, start) X-Ref

No description

convertChangesToDMP(changes) X-Ref

No description

convertChangesToXML(changes) X-Ref

No description

escapeHTML(s) 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

_typeof(obj) X-Ref

No description

_iterableToArray(iter) X-Ref

No description

_arrayWithHoles(arr) X-Ref

No description

_nonIterableRest() X-Ref

No description

arrayOf( value ) X-Ref

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

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

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.

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

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.

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

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.

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

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.

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

getColorClassName(colorContextName, colorSlug) X-Ref

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

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

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.

return: {string} String with the color value of the most readable color.
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.

ownKeys(object, enumerableOnly) X-Ref

No description

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

return: {WPComponent} The component that can be used as a HOC.
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.

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

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

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.

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

useBlockEditContext() X-Ref

A hook that returns the block edit context.

return: {Object} Block edit context

BlockEdit() X-Ref

No description

__experimentalGetGradientClass(gradientSlug) X-Ref

Internal dependencies

getGradientValueBySlug(gradients, slug) X-Ref

No description

__experimentalGetGradientObjectByGradientValue(gradients, value) X-Ref

No description

getGradientSlugByValue(gradients, value) X-Ref

No description

__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

panel_color_settings_ownKeys(object, enumerableOnly) X-Ref

No description

panel_color_settings_objectSpread(target) X-Ref

No description

ContrastCheckerMessage(_ref) X-Ref

No description

ContrastChecker(_ref2) X-Ref

No description

use_colors_ownKeys(object, enumerableOnly) X-Ref

use_colors_objectSpread(target) X-Ref

No description

__experimentalUseColors(colorConfigs) X-Ref

No description

getFontSizeClass(fontSizeSlug) X-Ref

Returns a class based on fontSizeName.

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

with_font_sizes_ownKeys(object, enumerableOnly) X-Ref

No description

with_font_sizes_objectSpread(target) 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

withFilteredAutocompleters(Autocomplete) X-Ref

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

This function is exported for unit test.

return: {Function} Wrapped component
param: {Function} Autocomplete Original component.

block_alignment_toolbar_ownKeys(object, enumerableOnly) X-Ref

No description

block_alignment_toolbar_objectSpread(target) X-Ref

No description

BlockAlignmentToolbar(_ref) X-Ref

No description

applyOrUnset(align) 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.

return: {?string} Block title.
param: {Object} props
param: {?string} props.name Block name.

BlockIcon(_ref) X-Ref

WordPress dependencies

insertAt(array, elements, index) X-Ref

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

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

moveTo(array, from, to) X-Ref

Moves an element in an array.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

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.

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

hasSameKeys(a, b) X-Ref

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

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

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.

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

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.

return: {Function} Enhanced reducer function.
param: {Function} reducer Original 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.

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

reducer_isTyping() X-Ref

No description

reducer_isDraggingBlocks() X-Ref

Reducer returning dragging state.

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

reducer_isCaretWithinFormattedText() X-Ref

Reducer returning whether the caret is within formatted text.

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

reducer_selection() X-Ref

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

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

reducer_selectionStart() X-Ref

Reducer returning the block selection's start.

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

reducer_selectionEnd() X-Ref

Reducer returning the block selection's end.

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

reducer_isMultiSelecting() X-Ref

Reducer returning whether the user is multi-selecting.

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

reducer_isSelectionEnabled() X-Ref

Reducer returning whether selection is enabled.

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

reducer_initialPosition(state, action) X-Ref

Reducer returning the intial block selection.

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

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

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

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

reducer_template() X-Ref

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

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

reducer_settings() X-Ref

Reducer returning the editor setting.

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

preferences() X-Ref

Reducer returning the user preferences.

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

reducer_isNavigationMode() X-Ref

Reducer returning whether the navigation mode is enabled or not.

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

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.

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

automaticChangeStatus(state, action) X-Ref

Reducer returning automatic change state.

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

controls_select(storeName, selectorName) X-Ref

Calls a selector using the current state.

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

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.

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

actions_resetSelection(selectionStart, selectionEnd) X-Ref

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

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

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.

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

actions_updateBlockAttributes(clientId, attributes) X-Ref

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

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

actions_updateBlock(clientId, updates) X-Ref

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

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

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.

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

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.

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

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.

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

getBlocksWithDefaultStylesApplied(blocks, blockEditorSettings) X-Ref

No description

actions_replaceBlocks(clientIds, blocks, indexToSelect) 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

replaceBlock(clientId, block) X-Ref

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

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

createOnMove(type) X-Ref

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

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

actions_moveBlockToPosition(clientId) X-Ref

Returns an action object signalling that an indexed block should be moved
to a new index.

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

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.

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

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.

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

actions_showInsertionPoint(rootClientId, index) X-Ref

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

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

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.

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

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

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

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.

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

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.

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

toggleBlockMode(clientId) X-Ref

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

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

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.

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

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.

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

updateBlockListSettings(clientId, settings) X-Ref

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

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

actions_updateSettings(settings) X-Ref

No description

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

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

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.

__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_duplicateBlocks(clientIds) X-Ref

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

param: {string[]} clientIds

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

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.

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

selectors_isBlockValid(state, clientId) X-Ref

Returns whether a block is valid or not.

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

getBlockAttributes(state, clientId) X-Ref

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

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

selectors_getBlockCount(state, rootClientId) X-Ref

Returns the number of blocks currently present in the post.

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

selectors_getSelectionStart(state) X-Ref

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

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

selectors_getSelectionEnd(state) X-Ref

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

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

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.

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

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.

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

selectors_getSelectedBlockCount(state) X-Ref

Returns the number of blocks currently selected in the post.

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

hasSelectedBlock(state) X-Ref

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

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

selectors_getSelectedBlockClientId(state) X-Ref

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

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

selectors_getSelectedBlock(state) X-Ref

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

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

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.

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

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.

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

getLowestCommonAncestorWithSelectedBlock(state, clientId) X-Ref

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

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

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.

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

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.

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

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.

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

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

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

getMultiSelectedBlockClientIds(state) X-Ref

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

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

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.

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

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

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

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

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

selectors_isBlockMultiSelected(state, clientId) X-Ref

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

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

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.

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

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.

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

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.

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

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.

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

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

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

selectors_hasSelectedInnerBlock(state, clientId) X-Ref

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

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

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.

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

selectors_hasMultiSelection(state) X-Ref

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

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

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.

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

selectors_isSelectionEnabled(state) X-Ref

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

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

selectors_getBlockMode(state, clientId) X-Ref

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

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

selectors_isTyping(state) X-Ref

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

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

selectors_isDraggingBlocks(state) X-Ref

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

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

selectors_isCaretWithinFormattedText(state) X-Ref

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

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

getBlockInsertionPoint(state) X-Ref

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

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

isBlockInsertionPointVisible(state) X-Ref

Returns true if we should show the block insertion point.

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

isValidTemplate(state) X-Ref

Returns whether the blocks matches the template or not.

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

getTemplate(state) X-Ref

Returns the defined block template

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

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.

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

getInsertUsage(state, id) X-Ref

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

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

selectors_getBlockListSettings(state, clientId) X-Ref

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

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

selectors_getSettings(state) X-Ref

Returns the editor settings.

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

selectors_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`.

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

selectors_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`.

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

__experimentalGetLastBlockAttributeChanges(state) X-Ref

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

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

getReusableBlocks(state) X-Ref

Returns the available reusable blocks

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

selectors_isNavigationMode(state) X-Ref

Returns whether the navigation mode is enabled.

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

selectors_didAutomaticChange(state) X-Ref

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

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

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.

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

applyMiddlewares(store) X-Ref

Applies the custom middlewares used specifically in the editor module.

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

store_ownKeys(object, enumerableOnly) X-Ref

No description

store_objectSpread(target) X-Ref

No description

BlockEditorProvider() X-Ref

No description

Warning(_ref) X-Ref

No description

BlockCompare() X-Ref

No description

BlockInvalidWarning(props) X-Ref

No description

BlockCrashBoundary() X-Ref

No description

BlockHTML(_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.

return: {Element} Block DOM node.
param: {string} clientId Block client ID.
param: {Element} scope an optional DOM Element to which the selector should be scoped

getBlockPreviewContainerDOMNode(clientId) X-Ref

No description

isBlockFocusStop(element) X-Ref

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

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

isInSameBlock(a, b) X-Ref

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

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

isInsideRootBlock(blockElement, element) X-Ref

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

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

hasInnerBlocksContext(element) X-Ref

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

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

getBlockClientId(node) X-Ref

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

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

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.

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

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

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.

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

getClosestTabbable(target, isReverse, containerElement) 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.

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

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.

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.

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

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

breadcrumb_BlockBreadcrumb(_ref) X-Ref

Block breadcrumb 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.

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

onKeyDown(event) X-Ref

No description

NavigableToolbar(_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_ownKeys(object, enumerableOnly) X-Ref

No description

block_objectSpread(target) X-Ref

No description

block_BlockListBlock(_ref) X-Ref

No description

default_block_appender_DefaultBlockAppender(_ref) X-Ref

Internal dependencies

block_list_appender_stopPropagation(event) X-Ref

No description

BlockListAppender(_ref) X-Ref

No description

useBlockDropZone(_ref) X-Ref

No description

selector(select) X-Ref

No description

BlockList(_ref) X-Ref

No description

selector(select) X-Ref

No description

ScaledBlockPreview(_ref) X-Ref

No description

BlockPreview(_ref2) X-Ref

No description

InserterListItem(_ref) X-Ref

No description

block_types_list_ownKeys(object, enumerableOnly) X-Ref

No description

block_types_list_objectSpread(target) X-Ref

No description

BlockTypesList(_ref) X-Ref

No description

BlockCard(_ref) X-Ref

Internal dependencies

ChildBlocks(_ref) X-Ref

No description

search_items_ownKeys(object, enumerableOnly) X-Ref

No description

search_items_objectSpread(target) X-Ref

No description

menu_ownKeys(object, enumerableOnly) X-Ref

No description

menu_objectSpread(target) X-Ref

No description

InserterMenu() X-Ref

No description

getInsertionIndex() X-Ref

No description

Inserter() X-Ref

No description

getInsertionIndex() X-Ref

No description

button_block_appender_ButtonBlockAppender(_ref) X-Ref

No description

BlockNavigationList(_ref) X-Ref

No description

BlockNavigation(_ref) X-Ref

No description

BlockNavigationDropdownToggle(_ref) X-Ref

No description

BlockNavigationDropdown(_ref2) 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

useHTMLClass(className) X-Ref

No description

EditorSkeleton(_ref) X-Ref

No description

GradientPickerWithGradients(props) X-Ref

No description

GradientPanel(props) X-Ref

Internal dependencies

ImageSizeControl(props) X-Ref

No description

InnerBlocks() X-Ref

No description

settings_drawer_ownKeys(object, enumerableOnly) X-Ref

No description

settings_drawer_objectSpread(target) 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

No description

MediaUploadCheck(_ref) X-Ref

WordPress dependencies

URLInput(props) X-Ref

No description

LinkEditor(_ref) X-Ref

Internal dependencies

LinkViewerUrl(_ref) X-Ref

No description

LinkViewer(_ref2) X-Ref

No description

URLPopover() X-Ref

No description

MediaPlaceholder() X-Ref

No description

ResponsiveBlockControlLabel(_ref) X-Ref

No description

ResponsiveBlockControl(props) X-Ref

No description

filePasteHandler(files) X-Ref

WordPress dependencies

RichTextShortcut() X-Ref

No description

RichTextToolbarButton(_ref) X-Ref

WordPress dependencies

__unstableRichTextInputEvent() X-Ref

No description

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.

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

getAllowedFormats(_ref) X-Ref

No description

RichTextWrapper(_ref2, forwardedRef) X-Ref

No description

ToolSelector() X-Ref

No description

URLInputButton() X-Ref

No description

default_templates_ownKeys(object, enumerableOnly) X-Ref

No description

default_templates_objectSpread(target) X-Ref

No description

block_styles_ownKeys(object, enumerableOnly) X-Ref

No description

block_styles_objectSpread(target) X-Ref

No description

getActiveStyle(styles, className) X-Ref

Returns the active style from the given className.

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

replaceActiveStyle(className, activeStyle, newStyle) X-Ref

Replaces the active style in the block's className.

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

BlockStyles(_ref) X-Ref

No description

updateClassName(style) X-Ref

No description

MultiSelectionInspector(_ref) X-Ref

No description

DefaultStylePicker(_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.

return: {string} Label for the block movement controls.
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.

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

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

return: {string} Label for the block movement controls.
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

BlockMover() X-Ref

No description

BlockSelectionClearer() X-Ref

No description

BlockActions(_ref) X-Ref

No description

BlockModeToggle(_ref) X-Ref

No description

BlockConvertButton(_ref) X-Ref

WordPress dependencies

BlockSettingsMenu(_ref) X-Ref

No description

block_switcher_ownKeys(object, enumerableOnly) X-Ref

No description

block_switcher_objectSpread(target) X-Ref

No description

BlockSwitcher() X-Ref

No description

MultiBlocksSwitcher(_ref) X-Ref

Internal dependencies

BlockToolbar(_ref) X-Ref

No description

getPasteEventData(_ref) X-Ref

WordPress dependencies

CopyHandler(_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.

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

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

return: {string[]} Valid alignments.
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.

addAttribute(settings) X-Ref

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

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

addAssignedAlign(props, blockType, attributes) X-Ref

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

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

anchor_addAttribute(settings) X-Ref

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

return: {Object} Filtered block settings.
param: {Object} settings Original 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.

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

custom_class_name_addAttribute(settings) X-Ref

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

return: {Object} Filtered block settings.
param: {Object} settings Original 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.

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

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.

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

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.

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

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.

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

isAbsolutePath(filePath) X-Ref

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

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

isValidURL(meta) X-Ref

Whether or not the url should be inluded.

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

getResourcePath(str, baseURL) X-Ref

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

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

processURL(baseURL) X-Ref

Process the single `url()` pattern

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

getURLs(value) X-Ref

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

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

replaceURLs(raw, URLs) X-Ref

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

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

wrap_ownKeys(object, enumerableOnly) X-Ref

No description

wrap_objectSpread(target) X-Ref

No description

_objectWithoutPropertiesLoose(source, excluded) X-Ref

No description

memize( fn, options ) X-Ref

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

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

memoized( ) 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

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

hue2rgb(p, q, t) X-Ref

No description

rgbToHsv(r, g, b) X-Ref

No description

hsvToRgb(h, s, v) X-Ref

No description

rgbToHex(r, g, b, allow3Char) X-Ref

No description

rgbaToHex(r, g, b, a, allow4Char) X-Ref

No description

rgbaToArgbHex(r, g, b, a) X-Ref

No description

desaturate(color, amount) X-Ref

No description

saturate(color, amount) X-Ref

No description

greyscale(color) X-Ref

No description

lighten(color, amount) X-Ref

No description

brighten(color, amount) X-Ref

No description

darken(color, amount) X-Ref

No description

spin(color, amount) X-Ref

No description

complement(color) X-Ref

No description

triad(color) X-Ref

No description

tetrad(color) X-Ref

No description

splitcomplement(color) X-Ref

No description

analogous(color, results, slices) X-Ref

No description

monochromatic(color, results) X-Ref

No description

flip(o) X-Ref

No description

boundAlpha(a) X-Ref

No description

bound01(n, max) X-Ref

No description

clamp01(val) X-Ref

No description

parseIntFromHex(val) X-Ref

No description

isOnePointZero(n) X-Ref

No description

isPercentage(n) X-Ref

No description

pad2(c) X-Ref

No description

convertToPercentage(n) X-Ref

No description

convertDecimalToHex(d) X-Ref

No description

convertHexToDecimal(h) X-Ref

No description

isValidCSSUnit(color) X-Ref

No description

stringInputToObject(color) X-Ref

No description

validateWCAG2Parms(parms) X-Ref

No description

_assertThisInitialized(self) X-Ref

No description

_interopDefault(ex) X-Ref

No description

merge(target, lowercase) X-Ref

No description

useForceUpdate() X-Ref

No description

withDefault(value, defaultValue) X-Ref

No description

toArray(a) X-Ref

No description

callProp(obj) X-Ref

No description

getForwardProps(props) X-Ref

No description

interpolateTo(props) X-Ref

No description

handleRef(ref, forward) X-Ref

No description

Animated() X-Ref

No description

AnimatedArray() X-Ref

No description

AnimatedObject() X-Ref

No description

injectApplyAnimatedValues(fn, transform) X-Ref

No description

injectColorNames(names) X-Ref

No description

injectFrame(raf, caf) X-Ref

No description

injectStringInterpolator(fn) X-Ref

No description

injectNow(nowFn) X-Ref

No description

injectDefaultElement(el) X-Ref

No description

injectAnimatedApi(fn) X-Ref

No description

injectCreateAnimatedStyle(factory) X-Ref

No description

injectManualFrameloop(callback) X-Ref

No description

AnimatedProps(props, callback) X-Ref

No description

createInterpolator(range, output, extrapolate) X-Ref

No description

interpolate(input, inputMin, inputMax, outputMin, outputMax, easing, extrapolateLeft, extrapolateRight, map) X-Ref

No description

findRange(input, inputRange) X-Ref

No description

AnimatedInterpolation(parents, range, output, extrapolate) X-Ref

No description

useChain(refs, timeSteps, timeFrame) X-Ref

No description

addAnimatedStyles(node, styles) X-Ref

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