[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/js/dist/ -> element.js (summary)

Internal dependencies

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

Defines 21 functions

  createFrame()
  proceed()
  nextToken()
  addText()
  addChild()
  closeOuterElement()
  concatChildren()
  switchChildrenNodeName()
  RawHTML()
  hasPrefix()
  isInternalAttribute()
  getNormalAttributeValue()
  getNormalAttributeName()
  getNormalStylePropertyName()
  getNormalStylePropertyValue()
  renderElement()
  renderNativeComponent()
  renderComponent()
  renderChildren()
  renderAttributes()
  renderStyle()

Functions
Functions that are not part of a class:

createFrame(element, tokenStart, tokenLength, prevOffset, leadingTextStart)   X-Ref
Tracks recursive-descent parse state.

This is a Stack frame holding parent elements until all children have been
parsed.

param: {WPElement} element            A parent element which may still have
param: {number}    tokenStart         Offset at which parent element first
param: {number}    tokenLength        Length of string marking start of parent
param: {number}    [prevOffset]       Running offset at which parsing should
param: {number}    [leadingTextStart] Offset at which last closing element
return: {Frame} The stack frame tracking parse progress.

proceed(conversionMap)   X-Ref
This is the iterator over the matches in the string.

param: {Object} conversionMap The conversion map for the string.
return: {boolean} true for continuing to iterate, false for finished.

nextToken()   X-Ref
Grabs the next token match in the string and returns it's details.

return: {Array}  An array of details for the token matched.

addText()   X-Ref
Pushes text extracted from the indoc string to the output stack given the
current rawLength value and offset (if rawLength is provided ) or the
indoc.length and offset.


addChild(frame)   X-Ref
Pushes a child element to the associated parent element's children for the
parent currently active in the stack.

param: {Frame} frame The Frame containing the child element and it's

closeOuterElement(endOffset)   X-Ref
This is called for closing tags. It creates the element currently active in
the stack.

param: {number} endOffset Offset at which the closing tag for the element

concatChildren()   X-Ref
Concatenate two or more React children objects.

param: {...?Object} childrenArguments Array of children arguments (array of arrays/strings/objects) to concatenate.
return: {Array} The concatenated value.

switchChildrenNodeName(children, nodeName)   X-Ref
Switches the nodeName of all the elements in the children object.

param: {?Object} children Children object.
param: {string}  nodeName Node name.
return: {?Object} The updated children object.

RawHTML(_ref)   X-Ref
Component used as equivalent of Fragment with unescaped HTML, in cases where
it is desirable to render dangerous HTML without needing a wrapper element.
To preserve additional props, a `div` wrapper _will_ be created if any props
aside from `children` are passed.

param: {RawHTMLProps} props Children should be a string of HTML or an array
return: {JSX.Element} Dangerously-rendering component.

hasPrefix(string, prefixes)   X-Ref
Returns true if the specified string is prefixed by one of an array of
possible prefixes.

param: {string}   string   String to check.
param: {string[]} prefixes Possible prefixes.
return: {boolean} Whether string has prefix.

isInternalAttribute(attribute)   X-Ref
Returns true if the given prop name should be ignored in attributes
serialization, or false otherwise.

param: {string} attribute Attribute to check.
return: {boolean} Whether attribute should be ignored.

getNormalAttributeValue(attribute, value)   X-Ref
Returns the normal form of the element's attribute value for HTML.

param: {string} attribute Attribute name.
param: {*}      value     Non-normalized attribute value.
return: {*} Normalized attribute value.

getNormalAttributeName(attribute)   X-Ref
Returns the normal form of the element's attribute name for HTML.

param: {string} attribute Non-normalized attribute name.
return: {string} Normalized attribute name.

getNormalStylePropertyName(property)   X-Ref
Returns the normal form of the style property name for HTML.

- Converts property names to kebab-case, e.g. 'backgroundColor' → 'background-color'
- Leaves custom attributes alone, e.g. '--myBackgroundColor' → '--myBackgroundColor'
- Converts vendor-prefixed property names to -kebab-case, e.g. 'MozTransform' → '-moz-transform'

param: {string} property Property name.
return: {string} Normalized property name.

getNormalStylePropertyValue(property, value)   X-Ref
Returns the normal form of the style property value for HTML. Appends a
default pixel unit if numeric, not a unitless property, and not zero.

param: {string} property Property name.
param: {*}      value    Non-normalized property value.
return: {*} Normalized property value.

renderElement(element, context)   X-Ref
Serializes a React element to string.

param: {import('react').ReactNode} element         Element to serialize.
param: {Object}                    [context]       Context object.
param: {Object}                    [legacyContext] Legacy context object.
return: {string} Serialized element.

renderNativeComponent(type, props, context)   X-Ref
Serializes a native component type to string.

param: {?string} type            Native component type to serialize, or null if
param: {Object}  props           Props object.
param: {Object}  [context]       Context object.
param: {Object}  [legacyContext] Legacy context object.
return: {string} Serialized element.

renderComponent(Component, props, context)   X-Ref
Serializes a non-native component type to string.

param: {WPComponent} Component       Component type to serialize.
param: {Object}      props           Props object.
param: {Object}      [context]       Context object.
param: {Object}      [legacyContext] Legacy context object.
return: {string} Serialized element

renderChildren(children, context)   X-Ref
Serializes an array of children to string.

param: {import('react').ReactNodeArray} children        Children to serialize.
param: {Object}                         [context]       Context object.
param: {Object}                         [legacyContext] Legacy context object.
return: {string} Serialized children.

renderAttributes(props)   X-Ref
Renders a props object as a string of HTML attributes.

param: {Object} props Props object.
return: {string} Attributes string.

renderStyle(style)   X-Ref
Renders a style object as a string attribute value.

param: {Object} style Style object.
return: {string} Style attribute value.



Generated: Sun Aug 14 01:00:02 2022 Cross-referenced by PHPXref 0.7.1