PHPXRef 0.7 : WordPress Trunk (Updated Daily) : Detail view of editor.js

Calculate the `line-height` of a given node

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

_classCallCheck(instance, Constructor) X-Ref

No description

_possibleConstructorReturn(self, call) X-Ref

No description

_getPrototypeOf(o) X-Ref

No description

_setPrototypeOf(o, p) X-Ref

No description

_inherits(subClass, superClass) X-Ref

No description

classNames() X-Ref

No description

_arrayWithoutHoles(arr) X-Ref

No description

_nonIterableSpread() X-Ref

No description

_toConsumableArray(arr) X-Ref

No description

_extends() X-Ref

No description

_objectWithoutPropertiesLoose(source, excluded) X-Ref

No description

_objectWithoutProperties(source, excluded) X-Ref

No description

_iterableToArrayLimit(arr, i) X-Ref

No description

_slicedToArray(arr, i) X-Ref

No description

_iterableToArray(iter) X-Ref

No description

_typeof2(obj) X-Ref

No description

_typeof(obj) X-Ref

No description

_objectWithoutProperties(obj, keys) X-Ref

No description

optimist(fn) X-Ref

No description

beginReducer(state, action) X-Ref

No description

commitReducer(state, action) X-Ref

No description

revertReducer(state, action) X-Ref

No description

baseReducer(optimist, innerState, action) X-Ref

No description

matchesTransaction(action, id) X-Ref

No description

validateState(newState, action) X-Ref

No description

separateState(state) X-Ref

No description

getPostRawValue(value) X-Ref

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

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

hasSameKeys(a, b) X-Ref

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

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

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.

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

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.

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

reducer_postId() X-Ref

No description

reducer_postType() X-Ref

No description

reducer_template() X-Ref

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

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

preferences() X-Ref

Reducer returning the user preferences.

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

saving() X-Ref

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

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

postLock() X-Ref

Reducer returning the post lock status.

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

postSavingLock() X-Ref

Post saving lock.

When post saving is locked, the post cannot be published or updated.

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

postAutosavingLock() X-Ref

Post autosaving lock.

When post autosaving is locked, the post will not autosave.

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

reducer_isReady() X-Ref

Reducer returning whether the editor is ready to be rendered.
The editor is considered ready to be rendered once
the post object is loaded properly and the initial blocks parsed.

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

reducer_editorSettings() X-Ref

Reducer returning the post editor setting.

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

getNotificationArgumentsForSaveSuccess(data) X-Ref

Builds the arguments for a success notification dispatch.

param: {Object} data Incoming data to build the arguments from.
return: {Array} Arguments for dispatch. An empty array signals no

getNotificationArgumentsForSaveFail(data) X-Ref

Builds the fail notification arguments for dispatch.

param: {Object} data Incoming data to build the arguments with.
return: {Array} Arguments for dispatch. An empty array signals no

getNotificationArgumentsForTrashFail(data) X-Ref

Builds the trash fail notification arguments for dispatch.

param: {Object} data
return: {Array} Arguments for dispatch.

awaitNextStateChange() X-Ref

Returns a control descriptor signalling to subscribe to the registry and
resolve the control promise only when the next state change occurs.

return: {Object} Control descriptor.

getRegistry() X-Ref

Returns a control descriptor signalling to resolve with the current data
registry.

return: {Object} Control descriptor.

postKey(postId) X-Ref

Function returning a sessionStorage key to set or retrieve a given post's
automatic session backup.

Keys are crucially prefixed with 'wp-autosave-' so that wp-login.php's
`loggedout` handler can clear sessionStorage of any user-private content.

param: {string} postId Post ID.
return: {string} sessionStorage key

localAutosaveGet(postId) X-Ref

No description

localAutosaveSet(postId, title, content, excerpt) X-Ref

No description

localAutosaveClear(postId) X-Ref

No description

getDependencies() X-Ref

Store control invoked upon a state change, responsible for returning an
object of dependencies. When a change in dependencies occurs (by shallow
equality of the returned object), blocks are reset to apply the new sourced
value.

return: {Object} Dependencies as object.

apply(schema, _ref) X-Ref

Given an attribute schema and dependencies data, returns a source value.

param: {Object} schema Block type attribute schema.
param: {Object} dependencies Source dependencies.
param: {Object} dependencies.meta Post meta.
return: {Object} Block attribute value.

update(schema, value) X-Ref

Store control invoked upon a block attributes update, responsible for
reflecting an update in a meta value.

param: {Object} schema Block type attribute schema.
param: {*} value Updated block attribute value.

getBlocksWithSourcedAttributes(blocks) X-Ref

Given a blocks array, returns a blocks array with sourced attribute values
applied. The reference will remain consistent with the original argument if
no attribute values must be overridden. If sourced values are applied, the
return value will be a modified copy of the original array.

param: {WPBlock[]} blocks Original blocks array.
return: {WPBlock[]} Blocks array with sourced values applied.

resetLastBlockSourceDependencies() X-Ref

Refreshes the last block source dependencies, optionally for a given subset
of sources (defaults to the full set of sources).

param: {?Array} sourcesToUpdate Optional subset of sources to reset.

setupEditor(post, edits, template) X-Ref

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

param: {Object} post      Post object.
param: {Object} edits     Initial edited attributes object.
param: {Array?} template  Block Template.

__experimentalTearDownEditor() X-Ref

Returns an action object signalling that the editor is being destroyed and
that any necessary state or side-effect cleanup should occur.

return: {Object} Action object.

__experimentalSubscribeSources() X-Ref

Returns an action generator which loops to await the next state change,
calling to reset blocks when a block source dependencies change.

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.

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

resetAutosave(newAutosave) X-Ref

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

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

__experimentalRequestPostUpdateStart() X-Ref

Action for dispatching that a post update request has started.

param: {Object} options
return: {Object} An action object

__experimentalRequestPostUpdateFinish() X-Ref

Action for dispatching that a post update request has finished.

param: {Object} options
return: {Object} An action 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.

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

setupEditorState(post) X-Ref

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

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

actions_editPost(edits, options) X-Ref

Returns an action object used in signalling that attributes of the post have
been edited.

param: {Object} edits Post attributes to edit.
param: {Object} options Options for the edit.

__experimentalOptimisticUpdatePost(edits) X-Ref

Returns action object produced by the updatePost creator augmented by
an optimist option that signals optimistically applying updates.

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

savePost() X-Ref

Action generator for saving the current post in the editor.

param: {Object} options

refreshPost() X-Ref

Action generator for handling refreshing the current post.

trashPost() X-Ref

Action generator for trashing the current post in the editor.

actions_autosave(options) X-Ref

Action generator used in signalling that the post should autosave.

param: {Object?} options Extra flags to identify the autosave.

actions_experimentalLocalAutosave() X-Ref

No description

actions_redo() X-Ref

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

actions_undo() X-Ref

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

createUndoLevel() X-Ref

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

return: {Object} Action object.

updatePostLock(lock) X-Ref

Returns an action object used to lock the editor.

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

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

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

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

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

__experimentalSaveReusableBlock(id) X-Ref

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

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

__experimentalDeleteReusableBlock(id) X-Ref

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

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

__experimentalUpdateReusableBlock(id, changes) X-Ref

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

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

__experimentalConvertBlockToStatic(clientId) X-Ref

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

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

__experimentalConvertBlockToReusable(clientIds) X-Ref

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

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

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

lockPostSaving(lockName) X-Ref

Returns an action object used to signal that post saving is locked.

param: {string} lockName The lock name.
return: {Object} Action object

unlockPostSaving(lockName) X-Ref

Returns an action object used to signal that post saving is unlocked.

param: {string} lockName The lock name.
return: {Object} Action object

actions_resetEditorBlocks(blocks) X-Ref

Returns an action object used to signal that the blocks have been updated.

param: {Array} blocks Block Array.
param: {?Object} options Optional options.

updateEditorSettings(settings) X-Ref

No description

selectors_isEditedPostNew(state) X-Ref

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

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

hasChangedContent(state) X-Ref

Returns true if content includes unsaved changes, or false otherwise.

param: {Object} state Editor state.
return: {boolean} Whether content includes unsaved changes.

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

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

selectors_getCurrentPostType(state) X-Ref

Returns the post type of the post currently being edited.

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

selectors_getCurrentPostId(state) X-Ref

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

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

getCurrentPostRevisionsCount(state) X-Ref

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

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

getCurrentPostLastRevisionId(state) X-Ref

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

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

selectors_getCurrentPostAttribute(state, attributeName) X-Ref

Returns an attribute value of the saved post.

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

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

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

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

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

isCurrentPostPending(state) X-Ref

Returns true if post is pending review.

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

selectors_isCurrentPostPublished(state, currentPost) X-Ref

Return true if the current post has already been published.

param: {Object} state Global application state.
param: {Object?} currentPost Explicit current post for bypassing registry selector.
return: {boolean} Whether the post has been published.

selectors_isCurrentPostScheduled(state) X-Ref

Returns true if post is already scheduled.

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

selectors_isEditedPostPublishable(state) X-Ref

Return true if the post being edited can be published.

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

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

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

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.

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

selectors_isEditedPostBeingScheduled(state) X-Ref

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

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

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.

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

selectors_isAutosavingPost(state) X-Ref

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

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

isPreviewingPost(state) X-Ref

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

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

selectors_getEditedPostPreviewLink(state) X-Ref

Returns the post preview link

param: {Object} state Global application state.
return: {string?} Preview Link.

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

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

getBlocksForSerialization(state) X-Ref

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

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

__experimentalIsSavingReusableBlock(state, ref) X-Ref

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

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

__experimentalIsFetchingReusableBlock(state, ref) X-Ref

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

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

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.

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

selectors_isPublishingPost(state) X-Ref

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

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

selectors_isPermalinkEditable(state) X-Ref

Returns whether the permalink is editable or not.

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

getPermalink(state) X-Ref

Returns the permalink for the post.

param: {Object} state Editor state.
return: {?string} The permalink, or null if the post is not viewable.

selectors_getPermalinkParts(state) X-Ref

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

param: {Object} state Editor state.
return: {Object} An object containing the prefix, postName, and suffix for

inSomeHistory(state, predicate) X-Ref

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

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

isPostLocked(state) X-Ref

Returns whether the post is locked.

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

selectors_isPostSavingLocked(state) X-Ref

Returns whether post saving is locked.

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

isPostAutosavingLocked(state) X-Ref

Returns whether post autosaving is locked.

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

isPostLockTakeover(state) X-Ref

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

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

getPostLockUser(state) X-Ref

Returns details about the post lock user.

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

getActivePostLock(state) X-Ref

Returns the active post lock.

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

selectors_canUserUseUnfilteredHTML(state) X-Ref

Returns whether or not the user has the unfiltered_html capability.

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

selectors_isPublishSidebarEnabled(state) X-Ref

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

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

selectors_getEditorBlocks(state) X-Ref

Return the current block list.

param: {Object} state
return: {Array} Block list.

__unstableIsEditorReady(state) X-Ref

Is the editor ready

param: {Object} state
return: {boolean} is Ready.

selectors_getEditorSettings(state) X-Ref

Returns the post editor settings.

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

getBlockEditorSelector(name) X-Ref

No description

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

Returns the inserter items for the specified parent block.

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

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

DocumentOutlineCheck(_ref) X-Ref

No description

SaveShortcut(_ref) X-Ref

No description

VisualEditorGlobalKeyboardShortcuts() X-Ref

No description

EditorGlobalKeyboardShortcuts() X-Ref

No description

TextEditorGlobalKeyboardShortcuts() X-Ref

Internal dependencies

EditorHistoryRedo(_ref) X-Ref

No description

EditorHistoryUndo(_ref) X-Ref

No description

TemplateValidationNotice(_ref) X-Ref

No description

EditorNotices(_ref) X-Ref

Internal dependencies

ErrorBoundary() X-Ref

No description

useAutosaveNotice() X-Ref

Custom hook which manages the creation of a notice prompting the user to
restore a local autosave, if one exists.

useAutosavePurge() X-Ref

Custom hook which ejects a local autosave after a successful save occurs.

LocalAutosaveMonitor() X-Ref

No description

PageAttributesCheck(_ref) X-Ref

WordPress dependencies

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.

param: {Object}            props
param: {string}            [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
return: {WPElement} Rendered element.

PageAttributesOrderWithChecks(props) X-Ref

No description

buildTermsTree(flatTerms) X-Ref

Returns terms in a tree form.

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

PageAttributesParent(_ref) X-Ref

Internal dependencies

PageTemplate(_ref) X-Ref

No description

PostAuthorCheck(_ref) X-Ref

Internal dependencies

PostAuthor() X-Ref

No description

PostComments(_ref) X-Ref

No description

PostExcerpt(_ref) X-Ref

No description

PostExcerptCheck(props) X-Ref

Internal dependencies

ThemeSupportCheck(_ref) X-Ref

WordPress dependencies

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

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.

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

cleanForSlug(string) X-Ref

Performs some basic cleanup of a string for use as a post slug

This replicates some of what sanitize_title() does in WordPress core, but
is only designed to approximate what the slug will be.

Converts whitespace, periods, forward slashes and underscores to hyphens.
Converts Latin-1 Supplement and Latin Extended-A letters to basic Latin
letters. Removes combining diacritical marks. Converts remaining string
to lowercase. It does not touch octets, HTML entities, or other encoded
characters.

param: {string} string Title or slug to be processed
return: {string} Processed string

LastRevision(_ref) X-Ref

No description

writeInterstitialMessage(targetDocument) X-Ref

No description

PostPreviewButton() X-Ref

No description

PostLockedModal() X-Ref

No description

PostPendingStatusCheck(_ref) X-Ref

No description

PostPendingStatus(_ref) X-Ref

Internal dependencies

PostPingbacks(_ref) X-Ref

No description

PublishButtonLabel(_ref) X-Ref

No description

PostPublishButton(props) X-Ref

No description

PostVisibility(props) X-Ref

No description

PostVisibilityLabel(_ref) X-Ref

No description

PostSchedule(_ref) X-Ref

No description

PostScheduleLabel(_ref) X-Ref

No description

FlatTermSelector() X-Ref

No description

MaybeTagsPanel(props) X-Ref

No description

PostPublishPanelPrepublish(_ref) X-Ref

No description

PostPublishPanelPostpublish() X-Ref

No description

PostPublishPanel() X-Ref

No description

PostSwitchToDraftButton(_ref) X-Ref

No description

PostSavedState() X-Ref

No description

PostScheduleCheck(_ref) X-Ref

No description

PostStickyCheck(_ref) X-Ref

No description

PostSticky(_ref) X-Ref

Internal dependencies

HierarchicalTermSelector() X-Ref

No description

PostTaxonomies(_ref) X-Ref

No description

PostTaxonomiesCheck(_ref) X-Ref

No description

PostTextEditor() X-Ref

No description

PostPermalinkEditor(_ref) X-Ref

No description

PostPermalink() X-Ref

No description

PostTitle() X-Ref

No description

PostTrash(_ref) X-Ref

No description

PostTrashCheck(_ref) X-Ref

WordPress dependencies

PostVisibilityCheck(_ref) X-Ref

No description

WordCount(_ref) X-Ref

No description

TableOfContentsPanel(_ref) X-Ref

No description

TableOfContents(_ref) X-Ref

No description

UnsavedChangesWarning() X-Ref

No description

ReusableBlockConvertButton(_ref) X-Ref

No description

ReusableBlockDeleteButton(_ref) X-Ref

No description

ReusableBlocksButtons(_ref) X-Ref

No description

ConvertToGroupButton(_ref) X-Ref

Internal dependencies

ConvertToGroupButtons(_ref) X-Ref

No description

isRequestingDownloadableBlocks(state) X-Ref

Returns true if application is requesting for downloadable blocks.

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

selectors_getDownloadableBlocks(state, filterValue) X-Ref

Returns the available uninstalled blocks

param: {Object} state Global application state.
param: {string} filterValue Search string.
return: {Array} Downloadable blocks

selectors_hasInstallBlocksPermission(state) X-Ref

Returns true if user has permission to install blocks.

param: {Object} state Global application state.
return: {boolean} User has permission to install blocks.

selectors_getInstalledBlockTypes(state) X-Ref

Returns the block types that have been installed on the server.

param: {Object} state Global application state.
return: {Array} Block type items.

controls_select(storeName, selectorName) X-Ref

Calls a selector using the current state.

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

controls_dispatch(storeName, dispatcherName) X-Ref

Calls a dispatcher using the current state.

param: {string} storeName Store name.
param: {string} dispatcherName Dispatcher name.
param: {Array} args Selector arguments.
return: {Object} Control descriptor.

apiFetch(request) X-Ref

Trigger an API Fetch request.

param: {Object} request API Fetch Request Object.
return: {Object} Control descriptor.

loadAssets(assets) X-Ref

Load the asset files for a block

param: {Array} assets A collection of URL for the assets.
return: {Object} Control descriptor.

fetchDownloadableBlocks() X-Ref

Returns an action object used in signalling that the downloadable blocks have been requested and is loading.

return: {Object} Action object.

receiveDownloadableBlocks(downloadableBlocks, filterValue) X-Ref

Returns an action object used in signalling that the downloadable blocks have been updated.

param: {Array} downloadableBlocks Downloadable blocks.
param: {string} filterValue Search string.
return: {Object} Action object.

setInstallBlocksPermission(hasPermission) X-Ref

Returns an action object used in signalling that the user does not have permission to install blocks.

return: {Object} Action object.

actions_downloadBlock(item, onSuccess, onError) X-Ref

Action triggered to download block assets.

param: {Object} item The selected block item
param: {Function} onSuccess The callback function when the action has succeeded.
param: {Function} onError The callback function when the action has failed.

actions_installBlock(_ref, onSuccess, onError) X-Ref

Action triggered to install a block plugin.

param: {string} item The block item returned by search.
param: {Function} onSuccess The callback function when the action has succeeded.
param: {Function} onError The callback function when the action has failed.

uninstallBlock(_ref2, onSuccess, onError) X-Ref

Action triggered to uninstall a block plugin.

param: {string} item The block item returned by search.
param: {Function} onSuccess The callback function when the action has succeeded.
param: {Function} onError The callback function when the action has failed.

addInstalledBlockType(item) X-Ref

Returns an action object used to add a newly installed block type.

param: {string} item The block item with the block id and name.
return: {Object} Action object.

removeInstalledBlockType(item) X-Ref

Returns an action object used to remove a newly installed block type.

param: {string} item The block item with the block id and name.
return: {Object} Action object.

Stars(_ref) X-Ref

No description

DownloadableBlockHeader(_ref) X-Ref

No description

DownloadableBlockAuthorInfo(_ref) X-Ref

No description

DownloadableBlockInfo(_ref) X-Ref

No description

DownloadableBlockListItem(_ref) X-Ref

No description

DownloadableBlocksList(_ref) X-Ref

No description

DownloadableBlocksPanel(_ref) X-Ref

No description

InserterMenuDownloadableBlocksPanel() X-Ref

No description

EditorProvider(props) X-Ref

No description

deprecateComponent(name, Wrapped) X-Ref

No description

deprecateFunction(name, func) X-Ref

No description

setDefaultCompleters() X-Ref

No description

arrayOf( value ) X-Ref

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

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

isObjectLike( value ) X-Ref

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

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

createCache() X-Ref

Creates and returns a new cache object.

return: {Object} Cache object.

isShallowEqual( a, b, fromIndex ) X-Ref

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

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

getRootCache() X-Ref

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

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

getWeakMapCache( dependants ) X-Ref

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

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

clear() X-Ref

Resets root memoization cache.

callSelector( ) X-Ref

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

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

_arrayWithHoles(arr) X-Ref

No description

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