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

A generic error utility function.

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

map(array, fn) X-Ref

A generic `Array#map` utility function.

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

mapDomain(string, fn) X-Ref

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

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

ucs2decode(string) X-Ref

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

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

ucs2encode(array) X-Ref

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

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

basicToDigit(codePoint) X-Ref

Converts a basic code point into a digit/integer.

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

digitToBasic(digit, flag) X-Ref

Converts a digit/integer into a basic code point.

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

adapt(delta, numPoints, firstTime) X-Ref

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

decode(input) X-Ref

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

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

encode(input) X-Ref

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

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

toUnicode(input) X-Ref

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

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

toASCII(input) X-Ref

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

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

hasOwnProperty(obj, prop) X-Ref

No description

map(xs, f) X-Ref

No description

_setPrototypeOf(o, p) X-Ref

No description

_inherits(subClass, superClass) X-Ref

No description

_arrayWithoutHoles(arr) X-Ref

No description

_nonIterableSpread() X-Ref

No description

_toConsumableArray(arr) X-Ref

No description

_objectWithoutProperties(source, excluded) X-Ref

No description

_iterableToArrayLimit(arr, i) X-Ref

No description

_slicedToArray(arr, i) X-Ref

No description

_arrayLikeToArray(arr, len) X-Ref

No description

_classCallCheck(instance, Constructor) X-Ref

No description

_defineProperties(target, props) X-Ref

No description

_createClass(Constructor, protoProps, staticProps) X-Ref

No description

_slicedToArray(arr, i) X-Ref

No description

_arrayWithHoles(arr) X-Ref

No description

_iterableToArrayLimit(arr, i) X-Ref

No description

_nonIterableRest() X-Ref

No description

FastAverageColor() X-Ref

No description

_unsupportedIterableToArray(o, minLen) X-Ref

No description

_typeof(obj) X-Ref

No description

_iterableToArray(iter) X-Ref

No description

_arrayWithHoles(arr) X-Ref

No description

_nonIterableRest() X-Ref

No description

ownKeys(object, enumerableOnly) X-Ref

No description

_objectSpread(target) X-Ref

No description

edit_ownKeys(object, enumerableOnly) X-Ref

No description

edit_objectSpread(target) X-Ref

No description

ParagraphRTLToolbar(_ref) X-Ref

No description

useDropCapMinimumHeight(isDropCap, deps) X-Ref

No description

ParagraphBlock(_ref2) X-Ref

No description

save_save(_ref) X-Ref

WordPress dependencies

util_ownKeys(object, enumerableOnly) X-Ref

No description

util_objectSpread(target) X-Ref

No description

getClassNames(html) X-Ref

Returns class names with any relevant responsive aspect ratio names.

return: {string} Deduped class names.
param: {string}  html               The preview HTML that possibly contains an iframe with width and height set.
param: {string}  existingClassNames Any existing class names.
param: {boolean} allowResponsive    If the responsive class names should be added, or removed.

util_fallback(url, onReplace) X-Ref

Fallback behaviour for unembeddable URLs.
Creates a paragraph block containing a link to the URL, and calls `onReplace`.

param: {string} url The URL that could not be embedded.
param: {Function} onReplace Function to call with the created fallback block.

calculatePreferedImageSize(image, container) X-Ref

Internal dependencies

removeNewTabRel(currentRel) X-Ref

No description

getUpdatedLinkTargetSettings(value, _ref) X-Ref

Helper to get the link target settings to be stored.

return: {Object} Updated link target settings.
param: {boolean} value The new link target value.
param: {Object} attributes Block attributes.
param: {Object} attributes.rel Image block's rel attribute.

ImageSize() X-Ref

No description

image_edit_ownKeys(object, enumerableOnly) X-Ref

No description

image_edit_objectSpread(target) X-Ref

No description

ImageEdit() X-Ref

No description

image_save_save(_ref) X-Ref

WordPress dependencies

transforms_ownKeys(object, enumerableOnly) X-Ref

No description

transforms_objectSpread(target) X-Ref

No description

stripFirstImage(attributes, _ref) X-Ref

WordPress dependencies

getFirstAnchorAttributeFormHTML(html, attributeName) X-Ref

No description

HeadingLevelIcon(_ref) X-Ref

WordPress dependencies

HeadingToolbar() X-Ref

No description

heading_edit_ownKeys(object, enumerableOnly) X-Ref

No description

heading_edit_objectSpread(target) X-Ref

No description

HeadingEdit(_ref) X-Ref

No description

heading_save_save(_ref) X-Ref

WordPress dependencies

getLevelFromHeadingNodeName(nodeName) X-Ref

Given a node name string for a heading node, returns its numeric level.

return: {number} Heading level.
param: {string} nodeName Heading node name.

deprecated_ownKeys(object, enumerableOnly) X-Ref

No description

deprecated_objectSpread(target) X-Ref

No description

quote_edit_ownKeys(object, enumerableOnly) X-Ref

No description

quote_edit_objectSpread(target) X-Ref

No description

QuoteEdit(_ref) X-Ref

No description

quote_save_save(_ref) X-Ref

WordPress dependencies

quote_transforms_ownKeys(object, enumerableOnly) X-Ref

No description

quote_transforms_objectSpread(target) X-Ref

No description

quote_ownKeys(object, enumerableOnly) X-Ref

No description

quote_objectSpread(target) X-Ref

No description

defaultColumnsNumber(attributes) X-Ref

External dependencies

gallery_deprecated_ownKeys(object, enumerableOnly) X-Ref

No description

gallery_deprecated_objectSpread(target) X-Ref

No description

GalleryImage() X-Ref

No description

gallery_edit_ownKeys(object, enumerableOnly) X-Ref

No description

gallery_edit_objectSpread(target) X-Ref

No description

GalleryEdit() X-Ref

No description

gallery_save_save(_ref) X-Ref

Internal dependencies

ArchivesEdit(_ref) X-Ref

No description

AudioEdit() X-Ref

No description

audio_save_save(_ref) X-Ref

WordPress dependencies

button_deprecated_ownKeys(object, enumerableOnly) X-Ref

No description

button_deprecated_objectSpread(target) X-Ref

No description

button_edit_ownKeys(object, enumerableOnly) X-Ref

No description

button_edit_objectSpread(target) X-Ref

No description

BorderPanel(_ref) X-Ref

No description

URLPicker(_ref2) X-Ref

No description

ButtonEdit(_ref5) X-Ref

No description

button_save_save(_ref) X-Ref

WordPress dependencies

ButtonsEdit(_ref) X-Ref

No description

buttons_save_save() X-Ref

WordPress dependencies

calendar_edit_ownKeys(object, enumerableOnly) X-Ref

No description

calendar_edit_objectSpread(target) X-Ref

No description

CalendarEdit() X-Ref

No description

CategoriesEdit() X-Ref

No description

CodeEdit(_ref) X-Ref

Internal dependencies

utils_escape(content) X-Ref

Escapes ampersands, shortcodes, and links.

return: {string} The given content with some characters escaped.
param: {string} content The content of a code block.

escapeOpeningSquareBrackets(content) X-Ref

Returns the given content with all opening shortcode characters converted
into their HTML entity counterpart (i.e. [ => [). For instance, a
shortcode like [embed] becomes [embed]

This function replicates the escaping of HTML tags, where a tag like
<strong> becomes <strong>.

return: {string} The given content with its opening shortcode characters
param: {string} content The content of a code block.

escapeProtocolInIsolatedUrls(content) X-Ref

Converts the first two forward slashes of any isolated URL into their HTML
counterparts (i.e. // => //). For instance, https://youtube.com/watch?x
becomes https://youtube.com/watch?x.

An isolated URL is a URL that sits in its own line, surrounded only by spacing
characters.

See https://github.com/WordPress/wordpress-develop/blob/5.1.1/src/wp-includes/class-wp-embed.php#L403

return: {string} The given content with its ampersands converted into
param: {string} content The content of a code block.

code_save_save(_ref) X-Ref

Internal dependencies

getDeprecatedLayoutColumn(originalContent) X-Ref

Given an HTML string for a deprecated columns inner block, returns the
column index to which the migrated inner block should be assigned. Returns
undefined if the inner block was not assigned to a column.

return: {?number} Column to which inner block is to be assigned.
param: {string} originalContent Deprecated Columns inner block HTML.

getEffectiveColumnWidth(block, totalBlockCount) X-Ref

Returns an effective width for a given block. An effective width is equal to
its attribute value if set, or a computed value assuming equal distribution.

return: {number} Effective column width.
param: {WPBlock} block Block object.
param: {number} totalBlockCount Total number of blocks in Columns.

getTotalColumnsWidth(blocks) X-Ref

Returns the total width occupied by the given set of column blocks.

return: {number} Total width occupied by blocks.
param: {WPBlock[]} blocks Block objects.
param: {?number} totalBlockCount Total number of blocks in Columns.

getColumnWidths(blocks) X-Ref

Returns an object of `clientId` → `width` of effective column widths.

return: {Object<string,number>} Column widths.
param: {WPBlock[]} blocks Block objects.
param: {?number} totalBlockCount Total number of blocks in Columns.

getRedistributedColumnWidths(blocks, availableWidth) X-Ref

Returns an object of `clientId` → `width` of column widths as redistributed
proportional to their current widths, constrained or expanded to fit within
the given available width.

return: {Object<string,number>} Redistributed column widths.
param: {WPBlock[]} blocks          Block objects.
param: {number}    availableWidth  Maximum width to fit within.
param: {?number}   totalBlockCount Total number of blocks in Columns.

hasExplicitColumnWidths(blocks) X-Ref

Returns true if column blocks within the provided set are assigned with
explicit widths, or false otherwise.

return: {boolean} Whether columns have explicit widths.
param: {WPBlock[]} blocks Block objects.

getMappedColumnWidths(blocks, widths) X-Ref

Returns a copy of the given set of blocks with new widths assigned from the
provided object of redistributed column widths.

return: {WPBlock[]} blocks Mapped block objects.
param: {WPBlock[]} blocks Block objects.
param: {Object<string,number>} widths Redistributed column widths.

ColumnsEditContainer(_ref) X-Ref

No description

columns_save_save(_ref) X-Ref

WordPress dependencies

ColumnEdit(_ref) X-Ref

No description

column_save_save(_ref) X-Ref

WordPress dependencies

backgroundImageStyles(url) X-Ref

No description

dimRatioToClass(ratio) X-Ref

No description

cover_deprecated_ownKeys(object, enumerableOnly) X-Ref

No description

cover_deprecated_objectSpread(target) X-Ref

No description

cover_edit_ownKeys(object, enumerableOnly) X-Ref

No description

cover_edit_objectSpread(target) X-Ref

No description

retrieveFastAverageColor() X-Ref

No description

ResizableCover(_ref2) X-Ref

No description

onCoverSelectMedia(setAttributes) X-Ref

No description

useCoverIsDark(url) X-Ref

useCoverIsDark is a hook that returns a boolean variable specifying if the cover
background is dark or not.

return: {boolean} True if the cover background is considered "dark" and false otherwise.
param: {?string} url          Url of the media background.
param: {?number} dimRatio     Transparency of the overlay color. If an image and
param: {?string} overlayColor String containing the overlay color value if one exists.
param: {?Object} elementRef   If a media background is set, elementRef should contain a reference to a

CoverEdit(_ref3) X-Ref

No description

cover_save_save(_ref) X-Ref

Internal dependencies

WpEmbedPreview() X-Ref

No description

EmbedPreview() X-Ref

No description

embed_edit_ownKeys(object, enumerableOnly) X-Ref

No description

embed_edit_objectSpread(target) X-Ref

No description

getEmbedEditComponent(title, icon) X-Ref

No description

_class() X-Ref

No description

settings_ownKeys(object, enumerableOnly) X-Ref

No description

settings_objectSpread(target) X-Ref

No description

getEmbedBlockSettings(_ref) X-Ref

No description

embed_ownKeys(object, enumerableOnly) X-Ref

No description

embed_objectSpread(target) X-Ref

No description

FileBlockInspector(_ref) X-Ref

No description

FileEdit() X-Ref

No description

file_save_save(_ref) X-Ref

WordPress dependencies

HTMLEdit() X-Ref

No description

html_save_save(_ref) X-Ref

WordPress dependencies

imageFillStyles(url, focalPoint) X-Ref

Constants

MediaContainer() X-Ref

No description

media_text_deprecated_ownKeys(object, enumerableOnly) X-Ref

No description

media_text_deprecated_objectSpread(target) X-Ref

No description

MediaTextEdit() X-Ref

No description

media_text_save_save(_ref) X-Ref

No description

LatestComments() X-Ref

No description

latest_posts_edit_ownKeys(object, enumerableOnly) X-Ref

No description

latest_posts_edit_objectSpread(target) X-Ref

No description

LatestPostsEdit() X-Ref

No description

list_edit_ownKeys(object, enumerableOnly) X-Ref

No description

list_edit_objectSpread(target) X-Ref

No description

ListEdit(_ref) X-Ref

No description

list_save_save(_ref) X-Ref

WordPress dependencies

list_transforms_ownKeys(object, enumerableOnly) X-Ref

No description

list_transforms_objectSpread(target) X-Ref

No description

getListContentSchema(_ref) X-Ref

No description

list_ownKeys(object, enumerableOnly) X-Ref

No description

list_objectSpread(target) X-Ref

No description

MissingBlockWarning(_ref) X-Ref

No description

missing_save_save(_ref) X-Ref

WordPress dependencies

MoreEdit() X-Ref

No description

more_save_save(_ref) X-Ref

WordPress dependencies

NextPageEdit() X-Ref

WordPress dependencies

nextpage_save_save() X-Ref

WordPress dependencies

PreformattedEdit(_ref) X-Ref

WordPress dependencies

preformatted_save_save(_ref) X-Ref

WordPress dependencies

pullquote_deprecated_ownKeys(object, enumerableOnly) X-Ref

No description

pullquote_deprecated_objectSpread(target) X-Ref

No description

parseBorderColor(styleString) X-Ref

No description

PullQuoteEdit(props) X-Ref

No description

pullquote_save_save(_ref) X-Ref

Internal dependencies

ReusableBlockEditPanel() X-Ref

No description

ReusableBlockEdit(_ref) X-Ref

No description

RSSEdit() X-Ref

No description

SearchEdit(_ref) X-Ref

WordPress dependencies

GroupEdit(_ref) X-Ref

No description

group_save_save(_ref) X-Ref

WordPress dependencies

SeparatorEdit(_ref) X-Ref

No description

separatorSave(_ref) X-Ref

WordPress dependencies

ShortcodeEdit(_ref) X-Ref

No description

shortcode_save_save(_ref) X-Ref

WordPress dependencies

spacer_save_save(_ref) X-Ref

No description

SubheadEdit(_ref) X-Ref

No description

subhead_save_save(_ref) X-Ref

WordPress dependencies

state_ownKeys(object, enumerableOnly) X-Ref

No description

state_objectSpread(target) X-Ref

No description

createTable(_ref) X-Ref

Creates a table state.

return: {Object} New table state.
param: {Object} options
param: {number} options.rowCount Row count for the table to create.
param: {number} options.columnCount Column count for the table to create.

getFirstRow(state) X-Ref

Returns the first row in the table.

return: {Object} The first table row.
param: {Object} state Current table state.

getCellAttribute(state, cellLocation, attributeName) X-Ref

Gets an attribute for a cell.

return: {*} The attribute value.
param: {Object} state Current table state.
param: {Object} cellLocation The location of the cell
param: {string} attributeName The name of the attribute to get the value of.

updateSelectedCell(state, selection, updateCell) X-Ref

Returns updated cell attributes after applying the `updateCell` function to the selection.

return: {Object} New table state including the updated cells.
param: {Object} state The block attributes.
param: {Object} selection The selection of cells to update.
param: {Function} updateCell A function to update the selected cell attributes.

isCellSelected(cellLocation, selection) X-Ref

Returns whether the cell at `cellLocation` is included in the selection `selection`.

return: {boolean} True if the cell is selected, false otherwise.
param: {Object} cellLocation An object containing cell location properties.
param: {Object} selection An object containing selection properties.

insertRow(state, _ref2) X-Ref

Inserts a row in the table state.

return: {Object} New table state.
param: {Object} state Current table state.
param: {Object} options
param: {string} options.sectionName Section in which to insert the row.
param: {number} options.rowIndex Row index at which to insert the row.

deleteRow(state, _ref4) X-Ref

Deletes a row from the table state.

return: {Object} New table state.
param: {Object} state Current table state.
param: {Object} options
param: {string} options.sectionName Section in which to delete the row.
param: {number} options.rowIndex Row index to delete.

insertColumn(state, _ref6) X-Ref

Inserts a column in the table state.

return: {Object} New table state.
param: {Object} state Current table state.
param: {Object} options
param: {number} options.columnIndex Column index at which to insert the column.

deleteColumn(state, _ref7) X-Ref

Deletes a column from the table state.

return: {Object} New table state.
param: {Object} state Current table state.
param: {Object} options
param: {number} options.columnIndex Column index to delete.

toggleSection(state, sectionName) X-Ref

Toggles the existance of a section.

return: {Object} New table state.
param: {Object} state Current table state.
param: {string} sectionName Name of the section to toggle.

isEmptyTableSection(section) X-Ref

Determines whether a table section is empty.

return: {boolean} True if the table section is empty, false otherwise.
param: {Object} section Table section state.

isEmptyRow(row) X-Ref

Determines whether a table row is empty.

return: {boolean} True if the table section is empty, false otherwise.
param: {Object} row Table row state.

table_edit_ownKeys(object, enumerableOnly) X-Ref

No description

table_edit_objectSpread(target) X-Ref

No description

TableEdit() X-Ref

No description

table_save_save(_ref) X-Ref

WordPress dependencies

TextColumnsEdit(_ref) X-Ref

No description

text_columns_save_save(_ref) X-Ref

WordPress dependencies