Class: CustomComponentType

CustomComponentType(options)

new CustomComponentType(options)

Represents a custom component type, eg. .

Parameters:
Name Type Description
options Object

Options.

Properties
Name Type Description
name String

The component's name, eg. 'chart'.
Source:

Members

attributes :Array.<String>

Gets or sets the custom attributes for this tag, eg. ["src-preview"]. Used so that when the user-supplied html is sanitized, these attributes are not stripped.

Type:
  • Array.<String>
Source:

furtherProcessing :Array.<Object>

Gets or sets an array of objects with additional processNode and shouldProcessNode functions, as above.

Type:
  • Array.<Object>
Source:

isCorresponding :CustomComponentType~isCorresponding

Gets or sets a function which checks a ReactComponent and returns a Boolean indicating if that react component corresponds to this type. "Correspondence" is whatever the component wants it to be. It is used by CustomComponents.find. CustomComponents.find is used by the feature info template to find if any custom components self-update.

Type:
  • CustomComponentType~isCorresponding
Source:

name :String

Gets or sets the tag name, eg. "chart". This is converted to lower case.

Type:
  • String
Source:

processNode :CustomComponentType~processNode

Gets or sets a function which is called when an element of this custom component is created.

Type:
  • CustomComponentType~processNode
Source:

selfUpdateSeconds :CustomComponentType~selfUpdateSeconds

Gets or sets a function which checks a ReactComponent and returns an integer if it both contains this custom component type, and that component would self-update (eg. from a "poll-seconds" attribute).

Type:
  • CustomComponentType~selfUpdateSeconds
Source: