[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/js/dist/ -> format-library.js (summary)

WordPress dependencies

File Size: 1916 lines (67 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 46 functions

  onToggle()
  onClick()
  onClick()
  InlineUI()
  Edit()
  openModal()
  closeModal()
  onToggle()
  onClick()
  isValidHref()
  createLinkFormat()
  getFormatBoundary()
  walkToBoundary()
  InlineLinkUI()
  removeLink()
  onChangeLink()
  createButtonText()
  getRichTextValueFromSelection()
  link_Edit()
  setIsEditingLink()
  setIsCreatingLink()
  handleClick()
  addLink()
  stopAddingLink()
  onFocusOutside()
  onRemoveFormat()
  onClick()
  Icon()
  parseCSS()
  parseClassName()
  getActiveColors()
  setColors()
  ColorPicker()
  InlineColorUI()
  getComputedStyleProperty()
  fillComputedColors()
  TextColorEdit()
  onToggle()
  onClick()
  onToggle()
  onClick()
  onToggle()
  onClick()
  onClick()
  language_Edit()
  InlineLanguageUI()

Functions
Functions that are not part of a class:

onToggle()   X-Ref
No description

onClick()   X-Ref
No description

onClick()   X-Ref
No description

InlineUI({value,onChange,activeObjectAttributes,contentRef})   X-Ref
No description

Edit({value,onChange,onFocus,isObjectActive,activeObjectAttributes,contentRef})   X-Ref
No description

openModal()   X-Ref
No description

closeModal()   X-Ref
No description

onToggle()   X-Ref
No description

onClick()   X-Ref
No description

isValidHref(href)   X-Ref
Check for issues with the provided href.

param: {string} href The href.
return: {boolean} Is the href invalid?

createLinkFormat({url,type,id,opensInNewWindow,nofollow})   X-Ref
Generates the format object that will be applied to the link text.

param: {Object}  options
param: {string}  options.url              The href of the link.
param: {string}  options.type             The type of the link.
param: {string}  options.id               The ID of the link.
param: {boolean} options.opensInNewWindow Whether this link will open in a new window.
param: {boolean} options.nofollow         Whether this link is marked as no follow relationship.
return: {Object} The final format object.

getFormatBoundary(value, format, startIndex = value.start, endIndex = value.end)   X-Ref
Get the start and end boundaries of a given format from a rich text value.

param: {RichTextValue} value      the rich text value to interrogate.
param: {string}        format     the identifier for the target format (e.g. `core/link`, `core/bold`).
param: {number?}       startIndex optional startIndex to seek from.
param: {number?}       endIndex   optional endIndex to seek from.
return: {Object}    object containing start and end values for the given format.

walkToBoundary(formats, initialIndex, targetFormatRef, formatIndex, direction)   X-Ref
Walks forwards/backwards towards the boundary of a given format within an
array of format objects. Returns the index of the boundary.

param: {Array}  formats         the formats to search for the given format type.
param: {number} initialIndex    the starting index from which to walk.
param: {Object} targetFormatRef a reference to the format type object being sought.
param: {number} formatIndex     the index at which we expect the target format object to be.
param: {string} direction       either 'forwards' or 'backwards' to indicate the direction.
return: {number} the index of the boundary of the given format.

InlineLinkUI({isActive,activeAttributes,value,onChange,onFocusOutside,stopAddingLink,contentRef,focusOnMount})   X-Ref
No description

removeLink()   X-Ref
No description

onChangeLink(nextValue)   X-Ref
No description

createButtonText(searchTerm)   X-Ref
No description

getRichTextValueFromSelection(value, isActive)   X-Ref
No description

link_Edit({isActive,activeAttributes,value,onChange,onFocus,contentRef})   X-Ref
No description

setIsEditingLink(isEditing, {autoFocus = true} = {})   X-Ref
No description

setIsCreatingLink(isCreating)   X-Ref
No description

handleClick(event)   X-Ref
No description

addLink(target)   X-Ref
No description

stopAddingLink()   X-Ref
Runs when the popover is closed via escape keypress, unlinking the selected text,
but _not_ on a click outside the popover. onFocusOutside handles that.


onFocusOutside()   X-Ref
No description

onRemoveFormat()   X-Ref
No description

onClick()   X-Ref
No description

Icon({icon,size = 24,...props}, ref)   X-Ref
Return an SVG icon.

param: {IconProps}                                 props icon is the SVG component to render
param: {import('react').ForwardedRef<HTMLElement>} ref   The forwarded ref to the SVG element.
return: {JSX.Element}  Icon component

parseCSS(css = '')   X-Ref
No description

parseClassName(className = '', colorSettings)   X-Ref
No description

getActiveColors(value, name, colorSettings)   X-Ref
No description

setColors(value, name, colorSettings, colors)   X-Ref
No description

ColorPicker({name,property,value,onChange})   X-Ref
No description

InlineColorUI({name,value,onChange,onClose,contentRef,isActive})   X-Ref
No description

getComputedStyleProperty(element, property)   X-Ref
No description

fillComputedColors(element, {color,backgroundColor})   X-Ref
No description

TextColorEdit({value,onChange,isActive,activeAttributes,contentRef})   X-Ref
No description

onToggle()   X-Ref
No description

onClick()   X-Ref
No description

onToggle()   X-Ref
No description

onClick()   X-Ref
No description

onToggle()   X-Ref
No description

onClick()   X-Ref
No description

onClick()   X-Ref
No description

language_Edit({isActive,value,onChange,contentRef})   X-Ref
No description

InlineLanguageUI({value,contentRef,onChange,onClose})   X-Ref
No description



Generated : Mon Mar 18 08:20:01 2024 Cross-referenced by PHPXref