tinymce.html.Schema

Schema validator class.

Examples

if (tinymce.activeEditor.schema.isValidChild('p', 'span'))
   alert('span is valid child of p.');

 if (tinymce.activeEditor.schema.getElementRule('p'))
   alert('P is a valid element.');

Summary

Methods

Name Summary Defined by

addCustomElements()

Adds custom non-HTML elements to the schema.

Schema

addValidChildren()

Parses a valid children string and adds them to the schema structure. The valid children format is for example element[child1|child2].

Schema

addValidElements()

Parses a valid elements string and adds it to the schema. The valid elements format is for example element[attr=default|otherattr]. Existing rules will be replaced with the ones specified, so this extends the schema.

Schema

getBlockElements()

Returns a map with block elements.

Schema

getBoolAttrs()

Returns a map with boolean attributes.

Schema

getCustomElements()

Returns an map object of all custom elements.

Schema

getElementRule()

Returns true/false if the specified element is valid or not according to the schema.

Schema

getInvalidStyles()

Name/value map object with valid styles for each element.

Schema

getMoveCaretBeforeOnEnterElements()

Returns a map with elements that the caret should be moved in front of after enter is pressed.

Schema

getNonEmptyElements()

Returns a map with elements that should be treated as contents regardless if it has text content in them or not. For example: <td>, <video> or <img>.

Schema

getSelfClosingElements()

Returns a map with self closing tags. For example: <li>.

Schema

getShortEndedElements()

Returns a map with short ended elements. For example: <br> or <img>.

Schema

getSpecialElements()

Returns a map with special elements. These are elements that needs to be parsed in a special way such as script, style, textarea etc. The map object values are regexps used to find the end of the element.

Deprecated in TinyMCE 5.10 and has been marked for removal in TinyMCE 6.0.

Schema

getTextBlockElements()

Returns a map with text block elements. For example: <p>, <h1> to <h6>, <div> or <address>.

Schema

getTextInlineElements()

Returns a map of inline text format nodes. For example: <strong>, <span> or <ins>.

Schema

getValidClasses()

Name/value map object with valid classes for each element.

Schema

getValidStyles()

Name/value map object with valid styles for each element.

Schema

getWhiteSpaceElements()

Returns a map with elements where white space is to be preserved. For example: <pre> or <script>.

Schema

isValid()

Returns true/false if the specified element name and optional attribute is valid according to the schema.

Schema

isValidChild()

Returns true/false if the specified element and it’s child is valid or not according to the schema.

Schema

setValidElements()

Parses a valid elements string and sets it to the schema. The valid elements format is for example element[attr=default|otherattr]. Existing rules will be replaced with the ones specified, so this extends the schema.

Schema

Methods

addCustomElements()

addCustomElements(custom_elements: String)

Adds custom non-HTML elements to the schema.

Parameters

  • custom_elements (String) - Comma separated list of custom elements to add.

addValidChildren()

addValidChildren(valid_children: String)

Parses a valid children string and adds them to the schema structure. The valid children format is for example element[child1|child2].

Parameters

  • valid_children (String) - Valid children elements string to parse

addValidElements()

addValidElements(valid_elements: String)

Parses a valid elements string and adds it to the schema. The valid elements format is for example element[attr=default|otherattr]. Existing rules will be replaced with the ones specified, so this extends the schema.

Parameters

  • valid_elements (String) - String in the valid elements format to be parsed.

getBlockElements()

getBlockElements(): Object

Returns a map with block elements.

Return value

  • Object - Name/value lookup map for block elements.

getBoolAttrs()

getBoolAttrs(): Object

Returns a map with boolean attributes.

Return value

  • Object - Name/value lookup map for boolean attributes.

getCustomElements()

getCustomElements(): Object

Returns an map object of all custom elements.

Return value

  • Object - Name/value map object of all custom elements.

getElementRule()

getElementRule(name: String): Object

Returns true/false if the specified element is valid or not according to the schema.

Parameters

  • name (String) - Element name to check for.

Return value

  • Object - Element object or undefined if the element isn’t valid.

getInvalidStyles()

getInvalidStyles()

Name/value map object with valid styles for each element.

getMoveCaretBeforeOnEnterElements()

getMoveCaretBeforeOnEnterElements(): Object

Returns a map with elements that the caret should be moved in front of after enter is pressed.

Return value

  • Object - Name/value lookup map for elements to place the caret in front of.

getNonEmptyElements()

getNonEmptyElements(): Object

Returns a map with elements that should be treated as contents regardless if it has text content in them or not. For example: <td>, <video> or <img>.

Return value

  • Object - Name/value lookup map for non empty elements.

getSelfClosingElements()

getSelfClosingElements(): Object

Returns a map with self closing tags. For example: <li>.

Return value

  • Object - Name/value lookup map for self closing tags elements.

getShortEndedElements()

getShortEndedElements(): Object

Returns a map with short ended elements. For example: <br> or <img>.

Return value

  • Object - Name/value lookup map for short ended elements.

getSpecialElements()

getSpecialElements(): Object

Returns a map with special elements. These are elements that needs to be parsed in a special way such as script, style, textarea etc. The map object values are regexps used to find the end of the element.

Deprecated in TinyMCE 5.10 and has been marked for removal in TinyMCE 6.0.

Return value

  • Object - Name/value lookup map for special elements.

getTextBlockElements()

getTextBlockElements(): Object

Returns a map with text block elements. For example: <p>, <h1> to <h6>, <div> or <address>.

Return value

  • Object - Name/value lookup map for block elements.

getTextInlineElements()

getTextInlineElements(): Object

Returns a map of inline text format nodes. For example: <strong>, <span> or <ins>.

Return value

  • Object - Name/value lookup map for text format elements.

getValidClasses()

getValidClasses()

Name/value map object with valid classes for each element.

getValidStyles()

getValidStyles()

Name/value map object with valid styles for each element.

getWhiteSpaceElements()

getWhiteSpaceElements(): Object

Returns a map with elements where white space is to be preserved. For example: <pre> or <script>.

Return value

  • Object - Name/value lookup map for white space elements.

isValid()

isValid(name: String, attr: String): Boolean

Returns true/false if the specified element name and optional attribute is valid according to the schema.

Parameters

  • name (String) - Name of element to check.

  • attr (String) - Optional attribute name to check for.

Return value

  • Boolean - True/false if the element and attribute is valid.

isValidChild()

isValidChild(name: String, child: String): Boolean

Returns true/false if the specified element and it’s child is valid or not according to the schema.

Parameters

  • name (String) - Element name to check for.

  • child (String) - Element child to verify.

Return value

  • Boolean - True/false if the element is a valid child of the specified parent.

setValidElements()

setValidElements(valid_elements: String)

Parses a valid elements string and sets it to the schema. The valid elements format is for example element[attr=default|otherattr]. Existing rules will be replaced with the ones specified, so this extends the schema.

Parameters

  • valid_elements (String) - String in the valid elements format to be parsed.