abcabc123
` would produce `abc
abc123
`. | `DOMUtils` | | [toggleClass()](#toggleClass) | Toggles the specified class on/off. | `DOMUtils` | | [unbind()](#unbind) | Removes the specified event handler by name and function from an element or collection of elements. | `DOMUtils` | | [uniqueId()](#uniqueId) | Returns a unique id. This can be useful when generating elements on the fly. This method will not check if the element already exists. | `DOMUtils` | ## Methods ### add() ```javascript add(parentElm: String | Element | Array, name: String | Element, attrs: Object, html: String, create: Boolean): Element | Array ``` Adds the specified element to another element or elements. #### Examples ```javascript // Adds a new paragraph to the end of the active editor tinymce.activeEditor.dom.add(tinymce.activeEditor.getBody(), 'p', { title: 'my title' }, 'Some content'); ``` #### Parameters - `parentElm (String | Element | Array)` - Element id string, DOM node element or array of ids or elements to add to. - `name (String | Element)` - Name of new element to add or existing element to add. - `attrs (Object)` - Optional object collection with arguments to add to the new element(s). - `html (String)` - Optional inner HTML contents to add for each element. - `create (Boolean)` - Optional flag if the element should be created or added. #### Return value - `Element` - Element that got created, or an array of created elements if multiple input elements were passed in. - `Array` - Element that got created, or an array of created elements if multiple input elements were passed in. ### addClass() ```javascript addClass(elm: String | Element | Array, cls: String): String | Array ``` Adds a class to the specified element or elements. #### Examples ```javascript // Adds a class to all paragraphs in the active editor tinymce.activeEditor.dom.addClass(tinymce.activeEditor.dom.select('p'), 'myclass'); // Adds a class to a specific element in the current page tinymce.DOM.addClass('mydiv', 'myclass'); ``` #### Parameters - `elm (String | Element | Array)` - Element ID string or DOM element or array with elements or IDs. - `cls (String)` - Class name to add to each element. #### Return value - `String` - String with new class value or array with new class values for all elements. - `Array` - String with new class value or array with new class values for all elements. ### addStyle() ```javascript addStyle(cssText: String) ``` Adds a style element at the top of the document with the specified cssText content. #### Parameters - `cssText (String)` - CSS Text style to add to top of head of document. ### bind() ```javascript bind(target: Element | Document | Window | Array, name: String, func: Function, scope: Object): Function ``` Adds an event handler to the specified object. #### Parameters - `target (Element | Document | Window | Array)` - Target element to bind events to. handler to or an array of elements/ids/documents. - `name (String)` - Name of event handler to add, for example: click. - `func (Function)` - Function to execute when the event occurs. - `scope (Object)` - Optional scope to execute the function in. #### Return value - `Function` - Function callback handler the same as the one passed in. ### create() ```javascript create(name: String, attrs: Object, html: String): Element ``` Creates a new element. #### Examples ```javascript // Adds an element where the caret/selection is in the active editor var el = tinymce.activeEditor.dom.create('div', { id: 'test', 'class': 'myclass' }, 'some content'); tinymce.activeEditor.selection.setNode(el); ``` #### Parameters - `name (String)` - Name of new element. - `attrs (Object)` - Optional object name/value collection with element attributes. - `html (String)` - Optional HTML string to set as inner HTML of the element. #### Return value - `Element` - HTML DOM node element that got created. ### createFragment() ```javascript createFragment(html: String): DocumentFragment ``` Creates a document fragment out of the specified HTML string. #### Parameters - `html (String)` - Html string to create fragment from. #### Return value - `DocumentFragment` - Document fragment node. ### createHTML() ```javascript createHTML(name: String, attrs: Object, html: String): String ``` Creates HTML string for element. The element will be closed unless an empty inner HTML string is passed in. #### Examples ```javascript // Creates a html chunk and inserts it at the current selection/caret location tinymce.activeEditor.selection.setContent(tinymce.activeEditor.dom.createHTML('a', { href: 'test.html' }, 'some line')); ``` #### Parameters - `name (String)` - Name of new element. - `attrs (Object)` - Optional object name/value collection with element attributes. - `html (String)` - Optional HTML string to set as inner HTML of the element. #### Return value - `String` - String with new HTML element, for example: [test](#). ### createRng() ```javascript createRng(): DOMRange ``` Creates a new DOM Range object. This will use the native DOM Range API if it’s available. If it’s not, it will fall back to the custom TinyMCE implementation. #### Examples ```javascript const rng = tinymce.DOM.createRng(); alert(rng.startContainer + "," + rng.startOffset); ``` #### Return value - `DOMRange` - DOM Range object. ### decode() ```javascript decode(s: String): String ``` Entity decodes a string. This method decodes any HTML entities, such as `å`. #### Parameters - `s (String)` - String to decode entities on. #### Return value - `String` - Entity decoded string. ### destroy() ```javascript destroy() ``` Destroys all internal references to the DOM to solve memory leak issues. ### dispatch() ```javascript dispatch(target: Node | Document | Window, name: String, evt: Object): Event ``` Dispatches the specified event name and optional object on the specified target. #### Parameters - `target (Node | Document | Window)` - Target element or object to dispatch event on. - `name (String)` - Name of the event to fire. - `evt (Object)` - Event object to send. #### Return value - `Event` - Event object. ### encode() ```javascript encode(text: String): String ``` Entity encodes a string. This method encodes the most common entities, such as `<`, `>`, `"` and `&`. #### Parameters - `text (String)` - String to encode with entities. #### Return value - `String` - Entity encoded string. ### findCommonAncestor() ```javascript findCommonAncestor(a: Element, b: Element): Element ``` Find the common ancestor of two elements. This is a shorter method than using the DOM Range logic. #### Parameters - `a (Element)` - Element to find common ancestor of. - `b (Element)` - Element to find common ancestor of. #### Return value - `Element` - Common ancestor element of the two input elements. ### fire() ```javascript fire(target: Node | Document | Window, name: String, evt: Object): Event ``` Fires the specified event name and optional object on the specified target. *Deprecated in TinyMCE 6.0 and has been marked for removal in TinyMCE 7.0. Use `dispatch` instead.* #### Parameters - `target (Node | Document | Window)` - Target element or object to fire event on. - `name (String)` - Event name to fire. - `evt (Object)` - Event object to send. #### Return value - `Event` - Event object. ### get() ```javascript get(n: String | Element): Element ``` Returns the specified element by ID or the input element if it isn’t a string. #### Parameters - `n (String | Element)` - Element id to look for or element to just pass though. #### Return value - `Element` - Element matching the specified id or null if it wasn’t found. ### getAttrib() ```javascript getAttrib(elm: String | Element, name: String, defaultVal: String): String ``` Returns the specified attribute by name. #### Parameters - `elm (String | Element)` - Element string id or DOM element to get attribute from. - `name (String)` - Name of attribute to get. - `defaultVal (String)` - Optional default value to return if the attribute didn’t exist. #### Return value - `String` - Attribute value string, default value or null if the attribute wasn’t found. ### getAttribs() ```javascript getAttribs(elm: HTMLElement | string): NodeList ``` Returns a NodeList with attributes for the element. #### Parameters - `elm (HTMLElement | string)` - Element node or string id to get attributes from. #### Return value - `NodeList` - NodeList with attributes. ### getNext() ```javascript getNext(node: Node, selector: String | function): Node ``` Returns the next node that matches selector or function #### Parameters - `node (Node)` - Node to find siblings from. - `selector (String | function)` - Selector CSS expression or function. #### Return value - `Node` - Next node item matching the selector or null if it wasn’t found. ### getOuterHTML() ```javascript getOuterHTML(elm: String | Element): String ``` Returns the outer HTML of an element. #### Examples ```javascript tinymce.DOM.getOuterHTML(editorElement); tinymce.activeEditor.getOuterHTML(tinymce.activeEditor.getBody()); ``` #### Parameters - `elm (String | Element)` - Element ID or element object to get outer HTML from. #### Return value - `String` - Outer HTML string. ### getParent() ```javascript getParent(node: Node | String, selector: Function, root: Node): Node ``` Returns a node by the specified selector function. This function will loop through all parent nodes and call the specified function for each node. If the function then returns true indicating that it has found what it was looking for, the loop execution will then end and the node it found will be returned. #### Parameters - `node (Node | String)` - DOM node to search parents on or ID string. - `selector (Function)` - Selection function or CSS selector to execute on each node. - `root (Node)` - Optional root element, never go beyond this point. #### Return value - `Node` - DOM Node or null if it wasn’t found. ### getParents() ```javascript getParents(node: Node | String, selector: Function, root: Node): Array ``` Returns a node list of all parents matching the specified selector function or pattern. If the function then returns true indicating that it has found what it was looking for and that node will be collected. #### Parameters - `node (Node | String)` - DOM node to search parents on or ID string. - `selector (Function)` - Selection function to execute on each node or CSS pattern. - `root (Node)` - Optional root element, never go beyond this point. #### Return value - `Array` - Array of nodes or null if it wasn’t found. ### getPos() ```javascript getPos(elm: Element | String, rootElm: Element): Object ``` Returns the absolute x, y position of a node. The position will be returned in an object with x, y fields. #### Parameters - `elm (Element | String)` - HTML element or element id to get x, y position from. - `rootElm (Element)` - Optional root element to stop calculations at. #### Return value - `Object` - Absolute position of the specified element object with x, y fields. ### getPrev() ```javascript getPrev(node: Node, selector: String | function): Node ``` Returns the previous node that matches selector or function #### Parameters - `node (Node)` - Node to find siblings from. - `selector (String | function)` - Selector CSS expression or function. #### Return value - `Node` - Previous node item matching the selector or null if it wasn’t found. ### getRect() ```javascript getRect(elm: Element | String): Object ``` Returns the rectangle for a specific element. #### Parameters - `elm (Element | String)` - Element object or element ID to get rectangle from. #### Return value - `Object` - Rectangle for specified element object with x, y, w, h fields. ### getRoot() ```javascript getRoot(): Element ``` Returns the root node of the document. This is normally the body but might be a DIV. Parents like getParent will not go above the point of this root node. #### Return value - `Element` - Root element for the utility class. ### getSize() ```javascript getSize(elm: Element | String): Object ``` Returns the size dimensions of the specified element. #### Parameters - `elm (Element | String)` - Element object or element ID to get rectangle from. #### Return value - `Object` - Rectangle for specified element object with w, h fields. ### getStyle() ```javascript getStyle(elm: String | Element, name: String, computed: Boolean): String ``` Returns the current style or runtime/computed value of an element. #### Parameters - `elm (String | Element)` - HTML element or element id string to get style from. - `name (String)` - Style name to return. - `computed (Boolean)` - Computed style. #### Return value - `String` - Current style or computed style value of an element. ### getViewPort() ```javascript getViewPort(win: Window): Object ``` Returns the viewport of the window. #### Parameters - `win (Window)` - Optional window to get viewport of. #### Return value - `Object` - Viewport object with fields x, y, w and h. ### hasClass() ```javascript hasClass(elm: String | Element, cls: String): Boolean ``` Returns true if the specified element has the specified class. #### Parameters - `elm (String | Element)` - HTML element or element id string to check CSS class on. - `cls (String)` - CSS class to check for. #### Return value - `Boolean` - true/false if the specified element has the specified class. ### hide() ```javascript hide(elm: String | Element | Array) ``` Hides the specified element(s) by ID by setting the "display" style. #### Examples ```javascript // Hides an element by id in the document tinymce.DOM.hide('myid'); ``` #### Parameters - `elm (String | Element | Array)` - ID of DOM element or DOM element or array with elements or IDs to hide. ### insertAfter() ```javascript insertAfter(node: Element, referenceNode: Element | String | Array): Element | Array ``` Inserts an element after the reference element. #### Parameters - `node (Element)` - Element to insert after the reference. - `referenceNode (Element | String | Array)` - Reference element, element id or array of elements to insert after. #### Return value - `Element` - Element that got added or an array with elements. - `Array` - Element that got added or an array with elements. ### is() ```javascript is(elm: Node | NodeList, selector: String) ``` Returns true/false if the specified element matches the specified css pattern. #### Parameters - `elm (Node | NodeList)` - DOM node to match or an array of nodes to match. - `selector (String)` - CSS pattern to match the element against. ### isBlock() ```javascript isBlock(node: Node | String): Boolean ``` Returns true/false if the specified element is a block element or not. #### Parameters - `node (Node | String)` - Element/Node to check. #### Return value - `Boolean` - True/False state if the node is a block element or not. ### isEditable() ```javascript isEditable(node: Node): Boolean ``` Checks if the specified node is editable within the given context of its parents. #### Parameters - `node (Node)` - Node to check if it’s editable. #### Return value - `Boolean` - Will be true if the node is editable and false if it’s not editable. ### isEmpty() ```javascript isEmpty(elements: Object): Boolean ``` Returns true/false if the specified node is to be considered empty or not. #### Examples ```javascript tinymce.DOM.isEmpty(node, { img: true }); ``` #### Parameters - `elements (Object)` - Optional name/value object with elements that are automatically treated as non-empty elements. #### Return value - `Boolean` - true/false if the node is empty or not. ### isHidden() ```javascript isHidden(elm: String | Element): Boolean ``` Returns true/false if the element is hidden or not by checking the "display" style. #### Parameters - `elm (String | Element)` - Id or element to check display state on. #### Return value - `Boolean` - true/false if the element is hidden or not. ### loadCSS() ```javascript loadCSS(url: String) ``` Imports/loads the specified CSS file into the document bound to the class. #### Examples ```javascript // Loads a CSS file dynamically into the current document tinymce.DOM.loadCSS('somepath/some.css'); // Loads a CSS file into the currently active editor instance tinymce.activeEditor.dom.loadCSS('somepath/some.css'); // Loads a CSS file into an editor instance by id tinymce.get('someid').dom.loadCSS('somepath/some.css'); // Loads multiple CSS files into the current document tinymce.DOM.loadCSS('somepath/some.css,somepath/someother.css'); ``` #### Parameters - `url (String)` - URL to CSS file to load. ### nodeIndex() ```javascript nodeIndex(node: Node, normalized: Boolean): Number ``` Returns the index of the specified node within its parent. #### Parameters - `node (Node)` - Node to look for. - `normalized (Boolean)` - Optional true/false state if the index is what it would be after a normalization. #### Return value - `Number` - Index of the specified node. ### parseStyle() ```javascript parseStyle(cssText: String): Object ``` Parses the specified style value into an object collection. This parser will also merge and remove any redundant items that browsers might have added. It will also convert non-hex colors to hex values. Urls inside the styles will also be converted to absolute/relative based on settings. #### Parameters - `cssText (String)` - Style value to parse, for example: border:1px solid red;. #### Return value - `Object` - Object representation of that style, for example: {border: '1px solid red'} ### remove() ```javascript remove(node: String | Element | Array, keepChildren: Boolean): Element | Array ``` Removes/deletes the specified element(s) from the DOM. #### Examples ```javascript // Removes all paragraphs in the active editor tinymce.activeEditor.dom.remove(tinymce.activeEditor.dom.select('p')); // Removes an element by id in the document tinymce.DOM.remove('mydiv'); ``` #### Parameters - `node (String | Element | Array)` - ID of element or DOM element object or array containing multiple elements/ids. - `keepChildren (Boolean)` - Optional state to keep children or not. If set to true all children will be placed at the location of the removed element. #### Return value - `Element` - HTML DOM element that got removed, or an array of removed elements if multiple input elements were passed in. - `Array` - HTML DOM element that got removed, or an array of removed elements if multiple input elements were passed in. ### removeAllAttribs() ```javascript removeAllAttribs(e: Element | String | Array) ``` Removes all attributes from an element or elements. #### Parameters - `e (Element | String | Array)` - DOM element, element id string or array of elements/ids to remove attributes from. ### removeClass() ```javascript removeClass(elm: String | Element | Array, cls: String): String | Array ``` Removes a class from the specified element or elements. #### Examples ```javascript // Removes a class from all paragraphs in the active editor tinymce.activeEditor.dom.removeClass(tinymce.activeEditor.dom.select('p'), 'myclass'); // Removes a class from a specific element in the current page tinymce.DOM.removeClass('mydiv', 'myclass'); ``` #### Parameters - `elm (String | Element | Array)` - Element ID string or DOM element or array with elements or IDs. - `cls (String)` - Class name to remove from each element. #### Return value - `String` - String of remaining class name(s), or an array of strings if multiple input elements were passed in. - `Array` - String of remaining class name(s), or an array of strings if multiple input elements were passed in. ### rename() ```javascript rename(elm: Element, name: String): Element ``` Renames the specified element and keeps its attributes and children. #### Parameters - `elm (Element)` - Element to rename. - `name (String)` - Name of the new element. #### Return value - `Element` - New element or the old element if it needed renaming. ### replace() ```javascript replace(newElm: Element, oldElm: Element | String | Array, keepChildren: Boolean) ``` Replaces the specified element or elements with the new element specified. The new element will be cloned if multiple input elements are passed in. #### Parameters - `newElm (Element)` - New element to replace old ones with. - `oldElm (Element | String | Array)` - Element DOM node, element id or array of elements or ids to replace. - `keepChildren (Boolean)` - Optional keep children state, if set to true child nodes from the old object will be added to new ones. ### run() ```javascript run(elm: String | Element | Array, func: Function, scope: Object): Object | Array ``` Executes the specified function on the element by id or dom element node or array of elements/id. #### Parameters - `elm (String | Element | Array)` - ID or DOM element object or array with ids or elements. - `func (Function)` - Function to execute for each item. - `scope (Object)` - Optional scope to execute the function in. #### Return value - `Object` - Single object, or an array of objects if multiple input elements were passed in. - `Array` - Single object, or an array of objects if multiple input elements were passed in. ### select() ```javascript select(selector: String, scope: Object): Array ``` Returns a list of the elements specified by the given CSS selector. For example: `div#a1 p.test` #### Examples ```javascript // Adds a class to all paragraphs in the currently active editor tinymce.activeEditor.dom.addClass(tinymce.activeEditor.dom.select('p'), 'someclass'); // Adds a class to all spans that have the test class in the currently active editor tinymce.activeEditor.dom.addClass(tinymce.activeEditor.dom.select('span.test'), 'someclass') ``` #### Parameters - `selector (String)` - Target CSS selector. - `scope (Object)` - Optional root element/scope element to search in. #### Return value - `Array` - Array with all matched elements. ### serializeStyle() ```javascript serializeStyle(styles: Object, name: String): String ``` Serializes the specified style object into a string. #### Parameters - `styles (Object)` - Object to serialize as string, for example: {border: '1px solid red'} - `name (String)` - Optional element name. #### Return value - `String` - String representation of the style object, for example: border: 1px solid red. ### setAttrib() ```javascript setAttrib(elm: Element | String | Array, name: String, value: String) ``` Sets the specified attribute of an element or elements. #### Examples ```javascript // Sets class attribute on all paragraphs in the active editor tinymce.activeEditor.dom.setAttrib(tinymce.activeEditor.dom.select('p'), 'class', 'myclass'); // Sets class attribute on a specific element in the current page tinymce.dom.setAttrib('mydiv', 'class', 'myclass'); ``` #### Parameters - `elm (Element | String | Array)` - DOM element, element id string or array of elements/ids to set attribute on. - `name (String)` - Name of attribute to set. - `value (String)` - Value to set on the attribute - if this value is falsy like null, 0 or '' it will remove the attribute instead. ### setAttribs() ```javascript setAttribs(elm: Element | String | Array, attrs: Object) ``` Sets two or more specified attributes of an element or elements. #### Examples ```javascript // Sets class and title attributes on all paragraphs in the active editor tinymce.activeEditor.dom.setAttribs(tinymce.activeEditor.dom.select('p'), { 'class': 'myclass', title: 'some title' }); // Sets class and title attributes on a specific element in the current page tinymce.DOM.setAttribs('mydiv', { 'class': 'myclass', title: 'some title' }); ``` #### Parameters - `elm (Element | String | Array)` - DOM element, element id string or array of elements/ids to set attributes on. - `attrs (Object)` - Name/Value collection of attribute items to add to the element(s). ### setHTML() ```javascript setHTML(elm: Element | String | Array, html: String) ``` Sets the specified HTML content inside the element or elements. The HTML will first be processed. This means URLs will get converted, hex color values fixed etc. Check processHTML for details. #### Examples ```javascript // Sets the inner HTML of all paragraphs in the active editor tinymce.activeEditor.dom.setHTML(tinymce.activeEditor.dom.select('p'), 'some inner html'); // Sets the inner HTML of an element by id in the document tinymce.DOM.setHTML('mydiv', 'some inner html'); ``` #### Parameters - `elm (Element | String | Array)` - DOM element, element id string or array of elements/ids to set HTML inside of. - `html (String)` - HTML content to set as inner HTML of the element. ### setOuterHTML() ```javascript setOuterHTML(elm: Element | String | Array, html: Object) ``` Sets the specified outer HTML on an element or elements. #### Examples ```javascript // Sets the outer HTML of all paragraphs in the active editor tinymce.activeEditor.dom.setOuterHTML(tinymce.activeEditor.dom.select('p'), 'abcabc123
` would produce `abc
abc123
`. #### Parameters - `parentElm (Element)` - Parent element to split. - `splitElm (Element)` - Element to split at. - `replacementElm (Element)` - Optional replacement element to replace the split element with. #### Return value - `Element` - Returns the split element or the replacement element if that is specified. ### toggleClass() ```javascript toggleClass(elm: Element, cls: String, state: Boolean) ``` Toggles the specified class on/off. #### Parameters - `elm (Element)` - Element to toggle class on. - `cls (String)` - Class to toggle on/off. - `state (Boolean)` - Optional state to set. ### unbind() ```javascript unbind(target: Element | Document | Window | Array, name: String, func: Function): Boolean | Array ``` Removes the specified event handler by name and function from an element or collection of elements. #### Parameters - `target (Element | Document | Window | Array)` - Target element to unbind events on. - `name (String)` - Event handler name, for example: "click" - `func (Function)` - Function to remove. #### Return value - `Boolean` - Bool state of true if the handler was removed, or an array of states if multiple input elements were passed in. - `Array` - Bool state of true if the handler was removed, or an array of states if multiple input elements were passed in. ### uniqueId() ```javascript uniqueId(prefix: String): String ``` Returns a unique id. This can be useful when generating elements on the fly. This method will not check if the element already exists. #### Parameters - `prefix (String)` - Optional prefix to add in front of all ids - defaults to "mce_". #### Return value - `String` - Unique id.