DOMHelper | RoosterJs API Reference

A helper class to provide DOM access APIs

Hierarchy

DOMHelper

Index

Methods

calculateZoomScale

calculateZoomScale(): number

- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:41
Calculate current zoom scale of editor

Returns number

findClosestBlockElement

findClosestBlockElement(startFrom: Node): HTMLElement

- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:88
Find the closest block element ancestor from the given node within current editing scope

Parameters
- startFrom: Node
  
  The node to start the search from
Returns HTMLElement

The closest block element ancestor

findClosestElementAncestor

findClosestElementAncestor<T>(node: Node, selector?: T): HTMLElementTagNameMap[T]
findClosestElementAncestor(node: Node, selector?: string): HTMLElement

- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:69
Find closest element ancestor start from the given node which matches the given selector

Type parameters
- T: keyof HTMLElementTagNameMap
Parameters
- node: Node
  
  Find ancestor start from this node
- Optional selector: T
  
  The expected selector. If null, return the first HTML Element found from start node
Returns HTMLElementTagNameMap[T]

An HTML element which matches the given selector. If the given start node matches the selector, returns the given node
- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:81
Find closest element ancestor start from the given node which matches the given selector

Parameters
- node: Node
  
  Find ancestor start from this node
- Optional selector: string
  
  The expected selector. If null, return the first HTML Element found from start node
Returns HTMLElement

An HTML element which matches the given selector. If the given start node matches the selector, returns the given node

getClientWidth

getClientWidth(): number

- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:104
Get the width of the editable area of the editor content div

Returns number

getClonedRoot

getClonedRoot(): HTMLElement

- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:109
Get a deep cloned root element

Returns HTMLElement

getContainerFormat

getContainerFormat(isInDarkMode?: boolean, darkColorHandler?: DarkColorHandler): ContentModelSegmentFormat

- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:116
Get format of the container element

Parameters
- Optional isInDarkMode: boolean
  
  Optional flag to indicate if the environment is in dark mode
- Optional darkColorHandler: DarkColorHandler
  
  Optional DarkColorHandler to retrieve dark mode colors
Returns ContentModelSegmentFormat

getDomAttribute

getDomAttribute(name: string): string

- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:54
Get DOM attribute of editor content DIV, null if there is no such attribute.

Parameters
- name: string
  
  Name of the attribute
Returns string

getDomStyle

getDomStyle<T>(style: T): CSSStyleDeclaration[T]

- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:60
Get DOM style of editor content DIV

Type parameters
- T: keyof CSSStyleDeclaration
Parameters
- style: T
  
  Name of the style
Returns CSSStyleDeclaration[T]

getRangesByText

getRangesByText(text: string, matchCase: boolean, wholeWord: boolean): Range[]

- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:129
Get text ranges by searching for a specific text, with options to match case and whole word. This will only search within editable elements.

Parameters
- text: string
  
  The text to search for
- matchCase: boolean
  
  Whether to match case
- wholeWord: boolean
  
  Whether to match whole word
Returns Range[]

An array of Ranges that match the search criteria

getTextContent

getTextContent(): string

- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:36
Get plain text content of editor using textContent property

Returns string

hasFocus

hasFocus(): boolean

- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:94
Check if the editor has focus now

Returns boolean

True if the editor has focus, otherwise false

isNodeInEditor

isNodeInEditor(node: Node, excludeRoot?: boolean): boolean

- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:13
Check if the given DOM node is in editor

Parameters
- node: Node
  
  The node to check
- Optional excludeRoot: boolean
  
  When pass true, the function will return false if the passed in node is the root node itself
Returns boolean

isRightToLeft

isRightToLeft(): boolean

- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:99
Check if the root element is in RTL mode

Returns boolean

queryElements

queryElements<TTag>(tag: TTag): HTMLElementTagNameMap[TTag][]
queryElements(selector: string): HTMLElement[]

- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:21
Query HTML elements in editor by tag name. Be careful of this function since it will also return element under entity.

Type parameters
- TTag: keyof HTMLElementTagNameMap
Parameters
- tag: TTag
  
  Tag name of the element to query
Returns HTMLElementTagNameMap[TTag][]

HTML Element array of the query result
- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:31
Query HTML elements in editor by a selector string Be careful of this function since it will also return element under entity.

Parameters
- selector: string
  
  Selector string to query
Returns HTMLElement[]

HTML Element array of the query result

setDomAttribute

setDomAttribute(name: string, value: string): void

- Defined in roosterjs-content-model-types/lib/parameter/DOMHelper.ts:48
Set DOM attribute of editor content DIV

Parameters
- name: string
  
  Name of the attribute
- value: string
  
  Value of the attribute
Returns void

Hierarchy

Index

Methods

Methods

calculateZoomScale

Returns number

findClosestBlockElement

Parameters

startFrom: Node

Returns HTMLElement

findClosestElementAncestor

Type parameters

T: keyof HTMLElementTagNameMap

Parameters

node: Node

Optional selector: T

Returns HTMLElementTagNameMap[T]

Parameters

node: Node

Optional selector: string

Returns HTMLElement

getClientWidth

Returns number

getClonedRoot

Returns HTMLElement

getContainerFormat

Parameters

Optional isInDarkMode: boolean

Optional darkColorHandler: DarkColorHandler

Returns ContentModelSegmentFormat

getDomAttribute

Parameters

name: string

Returns string

getDomStyle

Type parameters

T: keyof CSSStyleDeclaration

Parameters

style: T

Returns CSSStyleDeclaration[T]

getRangesByText

Parameters

text: string

matchCase: boolean

wholeWord: boolean

Returns Range[]

getTextContent

Returns string

hasFocus

Returns boolean

isNodeInEditor

Parameters

node: Node

Optional excludeRoot: boolean

Returns boolean

isRightToLeft

Returns boolean

queryElements

Type parameters

TTag: keyof HTMLElementTagNameMap

Parameters

tag: TTag

Returns HTMLElementTagNameMap[TTag][]

Parameters

selector: string

Returns HTMLElement[]

setDomAttribute

Parameters

name: string

value: string

Returns void