PHPXRef 0.7.1 : WordPress : Detail view of editor.js

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

Since there may be many Autocomplete instances at one time, this component
applies the filter on demand, when the component is first focused after
receiving a new list of completers.

This function is exported for unit test.

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

FilteredAutocomplete() X-Ref

No description

defaultGetBlockInsertionParentClientId() X-Ref

Returns the client ID of the parent where a newly inserted block would be
placed.

return: {string} Client ID of the parent where a newly inserted block would

defaultGetInserterItems(parentClientId) X-Ref

Returns the inserter items for the specified parent block.

return: {Array<Editor.InserterItem>} The inserter items for the specified
param: {string} parentClientId Client ID of the block for which to retrieve

defaultGetSelectedBlockName() X-Ref

Returns the name of the currently selected block.

return: {string?} The name of the currently selected block or `null` if no

createBlockCompleter() X-Ref

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

return: {Completer} A blocks completer.

AutosaveMonitor() X-Ref

No description

BlockActions(_ref) X-Ref

No description

BlockAlignmentToolbar(_ref) X-Ref

No description

applyOrUnset(align) X-Ref

No description

BlockCompare() X-Ref

No description

BlockDropZone() X-Ref

No description

BlockEdit(props) X-Ref

No description

renderIcon(icon) X-Ref

No description

BlockIcon(_ref) X-Ref

No description

BlockListAppender(_ref) X-Ref

No description

BlockContextualToolbar() X-Ref

No description

BlockCrashBoundary() X-Ref

No description

BlockHTML(props) X-Ref

No description

BlockInvalidWarning(props) X-Ref

No description

BlockMobileToolbar(_ref) X-Ref

No description

BlockListBlock() X-Ref

No description

BlockBreadcrumb() X-Ref

No description

BlockList(props) X-Ref

No description

BlockInsertionPoint() X-Ref

No description

BlockListMultiControls(_ref) X-Ref

No description

WithHoverAreasComponent() X-Ref

No description

BlockMover() X-Ref

No description

getBlockMoverDescription(selectedCount, type, 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: {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

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

BlockPreview(props) X-Ref

Block Preview Component: It renders a preview given a block name and attributes.

return: {WPElement} Rendered element.
param: {Object} props Component props.

BlockPreviewContent(_ref) X-Ref

No description

BlockSelectionClearer() X-Ref

No description

BlockConvertButton(_ref) X-Ref

WordPress dependencies

BlockModeToggle(_ref) X-Ref

No description

BlockSettingsMenu(_ref) X-Ref

No description

ReusableBlockConvertButton(_ref) X-Ref

No description

ReusableBlockDeleteButton(_ref) 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

BlockSwitcher() X-Ref

No description

MultiBlocksSwitcher(_ref) X-Ref

Internal dependencies

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: {?string} props.name Block name.

BlockToolbar() X-Ref

No description

BlockTypesList() X-Ref

No description

ColorPaletteControl(_ref) X-Ref

No description

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.

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.

_class(props) X-Ref

No description

ContrastChecker(_ref) X-Ref

No description

CopyHandler() X-Ref

No description

DefaultBlockAppender(_ref) X-Ref

No description

DocumentOutlineCheck(_ref) X-Ref

No description

EditorGlobalKeyboardShortcuts() X-Ref

No description

EditorHistoryRedo(_ref) X-Ref

No description

EditorHistoryUndo(_ref) X-Ref

No description

EditorNotices(props) X-Ref

No description

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

_class(props) X-Ref

No description

IgnoreNestedEvents() X-Ref

No description

InnerBlocks() X-Ref

No description

InserterWithShortcuts(_ref) X-Ref

No description

ChildBlocks(_ref) X-Ref

No description

Inserter() X-Ref

No description

InserterMenu() X-Ref

No description

MediaPlaceholder() X-Ref

No description

MultiSelectScrollIntoView() X-Ref

No description

NavigableToolbar() X-Ref

No description

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

No description

PageAttributesCheck(_ref) X-Ref

WordPress dependencies

PageAttributesOrderWithChecks(props) X-Ref

No description

PageAttributesParent(_ref) X-Ref

Internal dependencies

PageTemplate(_ref) X-Ref

No description

PanelColorSettings(_ref2) X-Ref

No description

PanelColor(_ref) X-Ref

No description

PlainText(_ref) X-Ref

No description

PostAuthorCheck(_ref) X-Ref

Internal dependencies

PostAuthor() X-Ref

No description

PostComments(_ref) X-Ref

No description

PostExcerptCheck(props) X-Ref

Internal dependencies

PostExcerpt(_ref) X-Ref

No description

PostFeaturedImageCheck(props) X-Ref

No description

PostFeaturedImage(_ref) X-Ref

No description

PostFormatCheck(_ref) X-Ref

No description

PostFormat(_ref) X-Ref

No description

PostLastRevisionCheck(_ref) X-Ref

Internal dependencies

LastRevision(_ref) X-Ref

No description

PostLockedModal() X-Ref

No description

PostPendingStatusCheck(_ref) X-Ref

No description

PostPendingStatus(_ref) X-Ref

Internal dependencies

PostPermalinkEditor(_ref) X-Ref

No description

PostPermalink() X-Ref

No description

PostPingbacks(_ref) X-Ref

No description

PostPreviewButton() X-Ref

No description

PostPublishButton(props) X-Ref

No description

PublishButtonLabel(_ref) X-Ref

No description

PostPublishPanel() X-Ref

No description

MaybeTagsPanel(props) X-Ref

No description

PostPublishPanelPostpublish() X-Ref

No description

PostPublishPanelPrepublish(_ref) X-Ref

No description

PostPublishPanelToggle(_ref) X-Ref

Internal Dependencies

PostSavedState() X-Ref

No description

PostScheduleCheck(_ref) X-Ref

No description

PostSchedule(_ref) X-Ref

No description

PostScheduleLabel(_ref) X-Ref

No description

PostStickyCheck(_ref) X-Ref

No description

PostSticky(_ref) X-Ref

Internal dependencies

PostSwitchToDraftButton(_ref) X-Ref

No description

PostTaxonomiesCheck(_ref) X-Ref

No description

FlatTermSelector() X-Ref

No description

HierarchicalTermSelector() X-Ref

No description

PostTaxonomies(_ref) X-Ref

No description

PostTextEditor() X-Ref

No description

PostTitle() X-Ref

No description

PostTrashCheck(_ref) X-Ref

WordPress dependencies

PostTrash(_ref) X-Ref

No description

PostTypeSupportCheck(_ref) X-Ref

A component which renders its own children only if the current editor post
type supports one of the given `supportKeys` prop.

return: {WPElement} Rendered element.
param: {?Object} props.postType Current post type.
param: {WPElement} props.children Children to be rendered if post
param: {(string|string[])} props.supportKeys String or string array of keys

PostVisibilityCheck(_ref) X-Ref

No description

PostVisibility(props) X-Ref

No description

PostVisibilityLabel(_ref) X-Ref

No description

PreserveScrollInReorder() X-Ref

No description

EditorProvider(props) X-Ref

No description

FormatToolbar(_ref) X-Ref

No description

getLinkAttributesFromFormat() X-Ref

No description

createLinkFormat(_ref2) X-Ref

No description

isShowingInput(props, state) X-Ref

No description

LinkContainer() X-Ref

No description

getCurrentCaretPositionStyle() X-Ref

Returns a style object for applying as `position: absolute` for an element
relative to the bottom-center of the current selection. Includes `top` and
`left` style properties.

return: {Object} Style object.

PositionedAtSelection() X-Ref

No description

RichText(_ref) X-Ref

No description

getPatterns(_ref) X-Ref

No description

needsInternetExplorerInputFix(editorNode) X-Ref

Determines whether we need a fix to provide `input` events for contenteditable.

return: {boolean} A boolean indicating whether the fix is needed.
param: {Element} editorNode The root editor node.

applyInternetExplorerInputFix(editorNode) X-Ref

Applies a fix that provides `input` events for contenteditable in Internet Explorer.

return: {Function} A function to remove the fix (for cleanup).
param: {Element} editorNode The root editor node.

mapTextInputEvent(textInputEvent) X-Ref

Dispatches `input` events in response to `textinput` events.

IE provides a `textinput` event that is similar to an `input` event,
and we use it to manually dispatch an `input` event.
`textinput` is dispatched for text entry but for not deletions.

param: {Event} textInputEvent An Internet Explorer `textinput` event.

mapDeletionKeyUpEvents(_ref) X-Ref

Dispatches `input` events in response to Delete and Backspace keyup.

It would be better dispatch an `input` event after each deleting
`keydown` because the DOM is updated after each, but it is challenging
to determine the right time to dispatch `input` since propagation of
`keydown` can be stopped at any point.

It's easier to listen for `keyup` in the capture phase and dispatch
`input` before `keyup` propagates further. It's not perfect, but should
be good enough.

param: {KeyboardEvent} keyUp
param: {Node} keyUp.target The event target.
param: {number} keyUp.keyCode The key code.

TinyMCE() X-Ref

No description

validateTokenSettings(name, settings, state) X-Ref

Validates the token settings object.

return: {Object} Validated token settings.
param: {string} name Token name.
param: {Object} settings Token settings.
param: {Object} state core/editor state.

TokenUI() X-Ref

No description

TableOfContents(_ref) X-Ref

No description

TableOfContentsPanel(_ref) X-Ref

No description

TemplateValidationNotice(_ref) X-Ref

No description

ThemeSupportCheck(_ref) X-Ref

WordPress dependencies

UnsavedChangesWarning() X-Ref

No description

URLInputButton() X-Ref

No description

URLInput() X-Ref

No description

Warning(_ref) X-Ref

No description

WordCount(_ref) X-Ref

No description

WritingFlow() X-Ref

No description

isTabCandidate(node, i, array) 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.

return: {Type}
param: {Type} name

Compiler(options) X-Ref

Initialize a new `Compiler`.

Compiler(options) X-Ref

Initialize a new `Compiler`.

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
param: {string} absolutePath the absolute path

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

traverseCSS(css, callback) X-Ref

No description

addAttribute(settings) X-Ref

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

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

getBlockValidAlignments(blockName) X-Ref

Returns an array of valid alignments for a block type depending on its
defined supports. Returns an empty array if block does not support align.

return: {string[]} Valid alignments for block
param: {string} blockName Block name to check

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

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.

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

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.

setDefaultCompleters(completers, blockName) X-Ref

No description

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.

addAttribute(settings) X-Ref

Filters registered block settings, extending attributes with layout.

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 layout class. 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.

preserveLayoutAttribute(transformedBlock, blocks) X-Ref

Given a transformed block, assigns the layout from the original block. Since
layout is a "global" attribute implemented via hooks, the individual block
transforms are not expected to handle this themselves, and a transform would
otherwise lose assigned layout.

return: {Object} Modified transformed block, with layout preserved.
param: {Object} transformedBlock Original transformed block.
param: {Object} blocks Blocks on which transform was applied.

excludeLayoutFromUnmodifiedBlockCheck(attributeKeys) X-Ref

Excludes the layout from the list of attributes to check
when determining if a block is unmodified or not.

return: {Object} Modified list of attribute keys
param: {Object} attributeKeys Attribute keys to check

setupEditor(post, autosaveStatus) X-Ref

Returns an action object used in signalling that editor has initialized with
the specified post object and editor settings.

return: {Object} Action object.
param: {Object} post Post object.
param: {Object} autosaveStatus The Post's autosave status.

resetPost(post) X-Ref

Returns an action object used in signalling that the latest version of the
post has been received, either by initialization or save.

return: {Object} Action object.
param: {Object} post Post object.

resetAutosave(post) X-Ref

Returns an action object used in signalling that the latest autosave of the
post has been received, by initialization or autosave.

return: {Object} Action object.
param: {Object} post Autosave post object.

updatePost(edits) X-Ref

Returns an action object used in signalling that a patch of updates for the
latest version of the post have been received.

return: {Object} Action object.
param: {Object} edits Updated post fields.

setupEditorState(post, blocks, edits) X-Ref

Returns an action object used to setup the editor state when first opening an editor.

return: {Object} Action object.
param: {Object}  post            Post object.
param: {Array}   blocks          Array of blocks.
param: {Object}  edits           Initial edited attributes object.

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.

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.

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.

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.

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

startMultiSelect() X-Ref

No description

stopMultiSelect() X-Ref

No description

multiSelect(start, end) X-Ref

No description

clearSelectedBlock() X-Ref

No description

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

replaceBlocks(clientIds, blocks) X-Ref

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

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

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.

moveBlockToPosition(clientId, fromRootClientId, toRootClientId, layout, index) X-Ref

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

return: {Object} Action object.
param: {?string} clientId         The client ID of the block.
param: {?string} fromRootClientId Root client ID source.
param: {?string} toRootClientId   Root client ID destination.
param: {?string} layout           Layout to move the block into.
param: {number}  index            The index to move the block into.

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

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 cliente ID of block list on

showInsertionPoint() X-Ref

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

return: {Object} Action object.

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.

checkTemplateValidity() X-Ref

Returns an action object to check the template validity.

return: {Object} Action object.

synchronizeTemplate() X-Ref

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

return: {Object} Action object.

editPost(edits) X-Ref

No description

savePost() X-Ref

Returns an action object to save the post.

return: {Object} Action object.
param: {Object} options Options for the save.
param: {boolean} options.autosave Perform an autosave if true.

refreshPost() X-Ref

No description

trashPost(postId, postType) X-Ref

No description

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.

autosave() X-Ref

Returns an action object used in signalling that the post should autosave.

return: {Object} Action object.

redo() X-Ref

Returns an action object used in signalling that undo history should
restore last popped state.

return: {Object} Action object.

undo() X-Ref

Returns an action object used in signalling that undo history should pop.

return: {Object} Action object.

createUndoLevel() X-Ref

Returns an action object used in signalling that undo history record should
be created.

return: {Object} Action object.

removeBlocks(clientIds) X-Ref

Returns an action object used in signalling that the blocks corresponding to
the set of specified client IDs are to be removed.

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

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

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.

startTyping() X-Ref

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

return: {Object} Action object.

stopTyping() X-Ref

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

return: {Object} Action object.

createNotice(status, content) X-Ref

Returns an action object used to create a notice.

return: {Object} Action object.
param: {string} status The notice status.
param: {WPElement} content The notice content.
param: {?Object} options The notice options. Available options:

removeNotice(id) X-Ref

Returns an action object used to remove a notice.

return: {Object} Action object.
param: {string} id The notice id.

updatePostLock(lock) X-Ref

Returns an action object used to lock the editor.

return: {Object} Action object.
param: {Object} lock Details about the post lock status, user, and nonce.

fetchReusableBlocks(id) X-Ref

Returns an action object used to fetch a single reusable block or all
reusable blocks from the REST API into the store.

return: {Object} Action object.
param: {?string} id If given, only a single reusable block with this ID will

receiveReusableBlocks(results) X-Ref

Returns an action object used in signalling that reusable blocks have been
received. `results` is an array of objects containing:
- `reusableBlock` - Details about how the reusable block is persisted.
- `parsedBlock` - The original block.

return: {Object} Action object.
param: {Object[]} results Reusable blocks received.

saveReusableBlock(id) X-Ref

Returns an action object used to save a reusable block that's in the store to
the REST API.

return: {Object} Action object.
param: {Object} id The ID of the reusable block to save.

deleteReusableBlock(id) X-Ref

Returns an action object used to delete a reusable block via the REST API.

return: {Object} Action object.
param: {number} id The ID of the reusable block to delete.

updateReusableBlockTitle(id, title) X-Ref

Returns an action object used in signalling that a reusable block's title is
to be updated.

return: {Object} Action object.
param: {number} id The ID of the reusable block to update.
param: {string} title The new title.

convertBlockToStatic(clientId) X-Ref

Returns an action object used to convert a reusable block into a static block.

return: {Object} Action object.
param: {string} clientId The client ID of the block to attach.

convertBlockToReusable(clientIds) X-Ref

Returns an action object used to convert a static block into a reusable block.

return: {Object} Action object.
param: {string} clientIds The client IDs of the block to detach.

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.

updateEditorSettings(settings) X-Ref

No description

registerToken(name, settings) X-Ref

No description

unregisterToken(name) X-Ref

No description

enablePublishSidebar() X-Ref

Returns an action object used in signalling that the user has enabled the publish sidebar.

return: {Object} Action object

disablePublishSidebar() X-Ref

Returns an action object used in signalling that the user has disabled the publish sidebar.

return: {Object} Action object

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.

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.

selectPreviousBlock(action, store) X-Ref

Effect handler which will return a block select action to select the block
occurring before the selected block in the previous state, unless it is the
same block or the action includes a falsey `selectPrevious` option flag.

return: {?Object} Block select action to select previous, if applicable.
param: {Object} action Action which had initiated the effect handler.
param: {Object} store Store instance.

ensureDefaultBlock(action, store) X-Ref

Effect handler which will return a default block insertion action if there
are no other blocks at the root of the editor. This is expected to be used
in actions which may result in no blocks remaining in the editor (removal,
replacement, etc).

return: {?Object} Default block insert action, if no other blocks exist.
param: {Object} action Action which had initiated the effect handler.
param: {Object} store Store instance.

resolveSelector(namespace, selectorName) X-Ref

No description

applyMiddlewares(store) X-Ref

Applies the custom middlewares used specifically in the editor module.

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

getPostRawValue(value) X-Ref

Returns a post attribute value, flattening nested rendered content using its
raw value in place of its original object form.

return: {*} Raw value.
param: {*} value Original value.

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.

getFlattenedBlocks(blocks) X-Ref

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

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

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, previousAction) 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} previousAction Previously dispatched action.

isUpdatingSamePostProperty(action, previousAction) X-Ref

Returns true if, given the currently dispatching action and the previously
dispatched action, the two actions are editing the same post property, or
false otherwise.

return: {boolean} Whether actions are updating the same post property.
param: {Object} action Currently dispatching action.
param: {Object} previousAction Previously dispatched action.

shouldOverwriteState(action, previousAction) X-Ref

Returns true if, given the currently dispatching action and the previously
dispatched action, the two actions are modifying the same property such that
undo history should be batched.

return: {boolean} Whether to overwrite present state.
param: {Object} action Currently dispatching action.
param: {Object} previousAction Previously dispatched action.

currentPost() X-Ref

No description

isTyping() X-Ref

Reducer returning typing state.

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

blockSelection() X-Ref

Reducer returning the block selection's state.

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

blocksMode() X-Ref

No description

isInsertionPointVisible() X-Ref

Reducer returning the block insertion point visibility, a boolean value
reflecting whether the insertion point should be shown.

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

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.

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.

saving() X-Ref

Reducer returning current network request state (whether a request to
the WP REST API is in progress, successful, or failed).

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

notices() X-Ref

No description

postLock() X-Ref

Reducer returning the post lock status.

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

autosave() X-Ref

Reducer returning the most recent autosave.

return: {Object} Updated state.
param: {Object} state The autosave object.
param: {Object} action Dispatched action.

tokens() X-Ref

Reducer managing the block types

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

hasEditorUndo(state) X-Ref

Returns true if any past editor history snapshots exist, or false otherwise.

return: {boolean} Whether undo history exists.
param: {Object} state Global application state.

hasEditorRedo(state) X-Ref

Returns true if any future editor history snapshots exist, or false
otherwise.

return: {boolean} Whether redo history exists.
param: {Object} state Global application state.

isEditedPostNew(state) X-Ref

Returns true if the currently edited post is yet to be saved, or false if
the post has been saved.

return: {boolean} Whether the post is new.
param: {Object} state Global application state.

isEditedPostDirty(state) X-Ref

Returns true if there are unsaved values for the current edit session, or
false if the editing state matches the saved or new post.

return: {boolean} Whether unsaved values exist.
param: {Object} state Global application state.

isCleanNewPost(state) X-Ref

Returns true if there are no unsaved values for the current edit session and
if the currently edited post is new (has never been saved before).

return: {boolean} Whether new post and unsaved values exist.
param: {Object} state Global application state.

getCurrentPost(state) X-Ref

Returns the post currently being edited in its last known saved state, not
including unsaved edits. Returns an object containing relevant default post
values if the post has not yet been saved.

return: {Object} Post object.
param: {Object} state Global application state.

getCurrentPostType(state) X-Ref

Returns the post type of the post currently being edited.

return: {string} Post type.
param: {Object} state Global application state.

getCurrentPostId(state) X-Ref

Returns the ID of the post currently being edited, or null if the post has
not yet been saved.

return: {?number} ID of current post.
param: {Object} state Global application state.

getCurrentPostRevisionsCount(state) X-Ref

Returns the number of revisions of the post currently being edited.

return: {number} Number of revisions.
param: {Object} state Global application state.

getCurrentPostLastRevisionId(state) X-Ref

Returns the last revision ID of the post currently being edited,
or null if the post has no revisions.

return: {?number} ID of the last revision.
param: {Object} state Global application state.

getPostEdits(state) X-Ref

Returns any post values which have been changed in the editor but not yet
been saved.

return: {Object} Object of key value pairs comprising unsaved edits.
param: {Object} state Global application state.

getCurrentPostAttribute(state, attributeName) X-Ref

Returns an attribute value of the saved post.

return: {*} Post attribute value.
param: {Object} state Global application state.
param: {string} attributeName Post attribute name.

getEditedPostAttribute(state, attributeName) X-Ref

Returns a single attribute of the post being edited, preferring the unsaved
edit if one exists, but falling back to the attribute for the last known
saved state of the post.

return: {*} Post attribute value.
param: {Object} state Global application state.
param: {string} attributeName Post attribute name.

getAutosaveAttribute(state, attributeName) X-Ref

Returns an attribute value of the current autosave revision for a post, or
null if there is no autosave for the post.

return: {*} Autosave attribute value.
param: {Object} state Global application state.
param: {string} attributeName Autosave attribute name.

getEditedPostVisibility(state) X-Ref

Returns the current visibility of the post being edited, preferring the
unsaved value if different than the saved post. The return value is one of
"private", "password", or "public".

return: {string} Post visibility.
param: {Object} state Global application state.

isCurrentPostPending(state) X-Ref

Returns true if post is pending review.

return: {boolean} Whether current post is pending review.
param: {Object} state Global application state.

isCurrentPostPublished(state) X-Ref

Return true if the current post has already been published.

return: {boolean} Whether the post has been published.
param: {Object} state Global application state.

isCurrentPostScheduled(state) X-Ref

Returns true if post is already scheduled.

return: {boolean} Whether current post is scheduled to be posted.
param: {Object} state Global application state.

isEditedPostPublishable(state) X-Ref

Return true if the post being edited can be published.

return: {boolean} Whether the post can been published.
param: {Object} state Global application state.

isEditedPostSaveable(state) X-Ref

Returns true if the post can be saved, or false otherwise. A post must
contain a title, an excerpt, or non-empty content to be valid for save.

return: {boolean} Whether the post can be saved.
param: {Object} state Global application state.

isEditedPostEmpty(state) X-Ref

Returns true if the edited post has content. A post has content if it has at
least one saveable block or otherwise has a non-empty content property
assigned.

return: {boolean} Whether post has content.
param: {Object} state Global application state.

isEditedPostAutosaveable(state) X-Ref

Returns true if the post can be autosaved, or false otherwise.

return: {boolean} Whether the post can be autosaved.
param: {Object} state Global application state.

getAutosave(state) X-Ref

Returns the current autosave, or null if one is not set (i.e. if the post
has yet to be autosaved, or has been saved or published since the last
autosave).

return: {?Object} Current autosave, if exists.
param: {Object} state Editor state.

hasAutosave(state) X-Ref

Returns the true if there is an existing autosave, otherwise false.

return: {boolean} Whether there is an existing autosave.
param: {Object} state Global application state.

isEditedPostBeingScheduled(state) X-Ref

Return true if the post being edited is being scheduled. Preferring the
unsaved status values.

return: {boolean} Whether the post has been published.
param: {Object} state Global application state.

isEditedPostDateFloating(state) X-Ref

Returns whether the current post should be considered to have a "floating"
date (i.e. that it would publish "Immediately" rather than at a set time).

Unlike in the PHP backend, the REST API returns a full date string for posts
where the 0000-00-00T00:00:00 placeholder is present in the database. To
infer that a post is set to publish "Immediately" we check whether the date
and modified date are the same.

return: {boolean} Whether the edited post has a floating date value.
param: {Object} state Editor state.

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.

getPostMeta(state, key) X-Ref

No description

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.

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.

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.

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.

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.

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.

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

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.

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.

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.

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 mult-selection.
param: {Object} state Editor state.
param: {string} clientId Block client ID.

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.

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.

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.

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.

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

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.

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.

isSelectionEnabled(state) X-Ref

Whether is selection disable or not.

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

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.

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.

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`, `layout`,
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

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.

isSavingPost(state) X-Ref

Returns true if the post is currently being saved, or false otherwise.

return: {boolean} Whether post is being saved.
param: {Object} state Global application state.

didPostSaveRequestSucceed(state) X-Ref

Returns true if a previous post save was attempted successfully, or false
otherwise.

return: {boolean} Whether the post was saved successfully.
param: {Object} state Global application state.

didPostSaveRequestFail(state) X-Ref

Returns true if a previous post save was attempted but failed, or false
otherwise.

return: {boolean} Whether the post save failed.
param: {Object} state Global application state.

isAutosavingPost(state) X-Ref

Returns true if the post is autosaving, or false otherwise.

return: {boolean} Whether the post is autosaving.
param: {Object} state Global application state.

getSuggestedPostFormat(state) X-Ref

Returns a suggested post format for the current post, inferred only if there
is a single block within the post and it is of a type known to match a
default post format. Returns null if the format cannot be determined.

return: {?string} Suggested post format.
param: {Object} state Global application state.

getBlocksForSerialization(state) X-Ref

Returns a set of blocks which are to be used in consideration of the post's
generated save content.

return: {WPBlock[]} Filtered set of blocks for save.
param: {Object} state Editor state.

getNotices(state) X-Ref

Returns the user notices array.

return: {Array} List of notices.
param: {Object} state Global application state.

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'

isSavingReusableBlock(state, ref) X-Ref

Returns whether or not the reusable block with the given ID is being saved.

return: {boolean} Whether or not the reusable block is being saved.
param: {Object} state Global application state.
param: {string} ref The reusable block's ID.

isFetchingReusableBlock(state, ref) X-Ref

Returns true if the reusable block with the given ID is being fetched, or
false otherwise.

return: {boolean} Whether the reusable block is being fetched.
param: {Object} state Global application state.
param: {string} ref The reusable block's ID.

getReusableBlocks(state) X-Ref

Returns an array of all reusable blocks.

return: {Array} An array of all reusable blocks.
param: {Object} state Global application state.

getStateBeforeOptimisticTransaction(state, transactionId) X-Ref

Returns state object prior to a specified optimist transaction ID, or `null`
if the transaction corresponding to the given ID cannot be found.

return: {Object} Global application state prior to transaction.
param: {Object} state Current global application state.
param: {Object} transactionId Optimist transaction ID.

isPublishingPost(state) X-Ref

Returns true if the post is being published, or false otherwise.

return: {boolean} Whether post is being published.
param: {Object} state Global application state.

isPermalinkEditable(state) X-Ref

Returns whether the permalink is editable or not.

return: {boolean} Whether or not the permalink is editable.
param: {Object} state Editor state.

getPermalink(state) X-Ref

Returns the permalink for the post.

return: {string} The permalink.
param: {Object} state Editor state.

getPermalinkParts(state) X-Ref

Returns the permalink for a post, split into it's three parts: the prefix, the postName, and the suffix.

return: {Object} The prefix, postName, and suffix for the permalink.
param: {Object} state Editor state.

inSomeHistory(state, predicate) X-Ref

Returns true if an optimistic transaction is pending commit, for which the
before state satisfies the given predicate function.

return: {boolean} Whether predicate matches for some history.
param: {Object} state Editor state.
param: {Function} predicate Function given state, returning true if match.

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.

getEditorSettings(state) X-Ref

No description

getTokenSettings(state, name) X-Ref

No description

isPostLocked(state) X-Ref

Returns whether the post is locked.

return: {boolean} Is locked.
param: {Object} state Global application state.

isPostLockTakeover(state) X-Ref

Returns whether the edition of the post has been taken over.

return: {boolean} Is post lock takeover.
param: {Object} state Global application state.

getPostLockUser(state) X-Ref

Returns details about the post lock user.

return: {Object} A user object.
param: {Object} state Global application state.

getActivePostLock(state) X-Ref

Returns the active post lock.

return: {Object} The lock object.
param: {Object} state Global application state.

canUserUseUnfilteredHTML(state) X-Ref

Returns whether or not the user has the unfiltered_html capability.

return: {boolean} Whether the user can or can't post unfiltered HTML.
param: {Object} state Editor state.

isPublishSidebarEnabled(state) X-Ref

Returns whether the pre-publish panel should be shown
or skipped when the user clicks the "publish" button.

return: {boolean} Whether the pre-publish panel should be shown or not.
param: {Object} state Global application state.

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.

getBlockFocusableWrapper(clientId) X-Ref

Given a block client ID, returns the corresponding DOM node for the block
focusable wrapper, 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.

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.

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.

getMimeTypesArray(wpMimeTypesObject) X-Ref

Browsers may use unexpected mime types, and they differ from browser to browser.
This function computes a flexible array of mime types from the mime type structured provided by the server.
Converts { jpg|jpeg|jpe: "image/jpeg" } into [ "image/jpeg", "image/jpg", "image/jpeg", "image/jpe" ]
The computation of this array instead of directly using the object,
solves the problem in chrome where mp3 files have audio/mp3 as mime type instead of audio/mpeg.
https://bugs.chromium.org/p/chromium/issues/detail?id=227004

return: {?Array} An array of mime types or the parameter passed if it was "falsy".
param: {?Object} wpMimeTypesObject Mime type object received from the server.

mediaUpload(_ref) X-Ref

Media Upload is used by audio, image, gallery, video, and file blocks to
handle uploading a media file when a file upload button is activated.

TODO: future enhancement to add an upload indicator.

param: {Object}   $0                    Parameters object passed to the function.
param: {?Array}   $0.allowedTypes       Array with the types of media that can be uploaded, if unset all types are allowed.
param: {?Object}  $0.additionalData     Additional data to include in the request.
param: {Array}    $0.filesList          List of files.
param: {?number}  $0.maxUploadFileSize  Maximum upload size in bytes allowed for the site.
param: {Function} $0.onError            Function called when an error happens.
param: {Function} $0.onFileChange       Function called each time a file or a temporary representation of the file is available.
param: {?Object}  $0.wpAllowedMimeTypes List of allowed mime types and file extensions.

createMediaFromFile(file, additionalData) X-Ref

return: {Promise} Media Object Promise.
param: {File} file Media File to Save.
param: {?Object} additionalData Additional data to include in the request.

buildTermsTree(flatTerms) X-Ref

Returns terms in a tree form.

return: {Array} Array of terms in tree format.
param: {Array} flatTerms Array of terms in flat format.

getWPAdminURL(page, query) X-Ref

Returns the URL of a WPAdmin Page.

TODO: This should be moved to a module less specific to the editor.

return: {string} WPAdmin URL.
param: {string} page Page to navigate to.
param: {Object} query Query Args.

filterURLForDisplay(url) X-Ref

Returns a URL for display.

return: {string} Displayed URL.
param: {string} url Original URL.

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

classNames() X-Ref

No description

__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

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

lineHeight(node) X-Ref

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.

memoized( ) X-Ref

No description

toObject(val) X-Ref

No description

shouldUseNative() X-Ref

No description

checkPropTypes(typeSpecs, values, location, componentName, getStack) X-Ref

Assert that the values match with the type specs.
Error messages are memorized and will only be shown once.

param: {object} typeSpecs Map of name to a ReactPropType
param: {object} values Runtime values that need to be type-checked
param: {string} location e.g. "prop", "context", "child context"
param: {string} componentName Name of the component for error messages.
param: {?Function} getStack Returns the component stack.

emptyFunctionThatReturnsNull() X-Ref

No description

getIteratorFn(maybeIterable) X-Ref

Returns the iterator method function contained on the iterable object.

Be sure to invoke the function with the iterable as context:

var iteratorFn = getIteratorFn(myIterable);
if (iteratorFn) {
var iterator = iteratorFn.call(myIterable);
...
}

return: {?function}
param: {?object} maybeIterable

is(x, y) X-Ref

inlined Object.is polyfill to avoid requiring consumers ship their own
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/is

PropTypeError(message) X-Ref

We use an Error-like object for backward compatibility as people may call
PropTypes directly and inspect their output. However, we don't use real
Errors anymore. We don't inspect their stack anyway, and creating them
is prohibitively expensive if they are created too often, such as what
happens in oneOfType() for any type before the one that matched.

createChainableTypeChecker(validate) X-Ref

No description

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

No description

createPrimitiveTypeChecker(expectedType) X-Ref

No description

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

No description

createAnyTypeChecker() X-Ref

No description

createArrayOfTypeChecker(typeChecker) X-Ref

No description