ISelect | Jodit Editor

Hierarchy

ISelect

Implemented by

Select

Methods

applyStyle

applyStyle(style: CanUndef<IStyle>, options?: {
    attributes?: IDictionary<string | number, string>;
    className?: string;
    defaultTag?: keyof HTMLElementTagNameMap;
    element?: keyof HTMLElementTagNameMap;
}): void
Deprecated
Instead use commitStyle
Parameters
- style: CanUndef<IStyle>
- Optional options: {
      attributes?: IDictionary<string | number, string>;
      className?: string;
      defaultTag?: keyof HTMLElementTagNameMap;
      element?: keyof HTMLElementTagNameMap;
  }
  - Optional attributes?: IDictionary<string | number, string>
  - Optional className?: string
    
    Deprecated
    Instead use attributes.class
  - Optional defaultTag?: keyof HTMLElementTagNameMap
  - Optional element?: keyof HTMLElementTagNameMap
Returns void

clear

clear(): void
Returns void

commitStyle

commitStyle(options: IStyleOptions): void
Parameters
- options: IStyleOptions
Returns void

createRange

createRange(select?: boolean): Range
Parameters
- Optional select: boolean
Returns Range

current

current(checkChild?: boolean): Nullable<Node>
Parameters
- Optional checkChild: boolean
Returns Nullable<Node>

cursorInTheEdge

cursorInTheEdge(start: boolean, parentBlock: HTMLElement, fake?: null | Node): Nullable<boolean>
Parameters
- start: boolean
- parentBlock: HTMLElement
- Optional fake: null | Node
Returns Nullable<boolean>

cursorOnTheLeft

cursorOnTheLeft(parentBlock: HTMLElement, fake?: null | Node): Nullable<boolean>
Parameters
- parentBlock: HTMLElement
- Optional fake: null | Node
Returns Nullable<boolean>

cursorOnTheRight

cursorOnTheRight(parentBlock: HTMLElement, fake?: null | Node): Nullable<boolean>
Parameters
- parentBlock: HTMLElement
- Optional fake: null | Node
Returns Nullable<boolean>

eachSelection

eachSelection(callback: ((current: Node) => void)): void
Parameters
- callback: ((current: Node) => void)
  - - (current: Node): void
    - Parameters
      
      current: Node
      
      Returns void
Returns void

expandSelection

expandSelection(): ISelect
Returns ISelect

focus

focus(options?: FocusOptions): boolean
Parameters
- Optional options: FocusOptions
Returns boolean

insertCursorAtPoint

insertCursorAtPoint(x: number, y: number): boolean
Parameters
- x: number
- y: number
Returns boolean

insertHTML

insertHTML(html: string | number | Node, insertCursorAfter?: boolean): void
Parameters
- html: string | number | Node
- Optional insertCursorAfter: boolean
Returns void

insertImage

insertImage(url: string | HTMLImageElement, styles?: Nullable<IDictionary<string, string>>, defaultWidth?: Nullable<string | number>): void
Parameters
- url: string | HTMLImageElement
- Optional styles: Nullable<IDictionary<string, string>>
- Optional defaultWidth: Nullable<string | number>
Returns void

insertNode

insertNode(node: Node, insertCursorAfter?: boolean, fireChange?: boolean): void
Parameters
- node: Node
- Optional insertCursorAfter: boolean
- Optional fireChange: boolean
Returns void

isCollapsed

isCollapsed(): boolean
Returns boolean

isFocused

isFocused(): boolean
Returns boolean

marker

marker(atStart?: boolean, range?: Range): HTMLSpanElement
Parameters
- Optional atStart: boolean
- Optional range: Range
Returns HTMLSpanElement

remove

remove(): void
Returns void

removeMarkers

removeMarkers(): void
Returns void

removeNode

removeNode(node: Node): void
Parameters
- node: Node
Returns void

restore

restore(): void
Returns void

save

save(silent?: boolean): MarkerInfo[]
Parameters
- Optional silent: boolean
Returns MarkerInfo[]

select

select(node: Node | HTMLElement | HTMLTableCellElement | HTMLTableElement, inward?: boolean): ISelect
Parameters
- node: Node | HTMLElement | HTMLTableCellElement | HTMLTableElement
- Optional inward: boolean
Returns ISelect

selectRange

selectRange(range: Range, focus?: boolean): ISelect
Parameters
- range: Range
- Optional focus: boolean
Returns ISelect

setCursorAfter

setCursorAfter(node: Node): Nullable<Text>
Parameters
- node: Node
Returns Nullable<Text>

setCursorBefore

setCursorBefore(node: Node): Nullable<Text>
Parameters
- node: Node
Returns Nullable<Text>

setCursorIn

setCursorIn(node: Node, inStart?: boolean): Node
Parameters
- node: Node
- Optional inStart: boolean
Returns Node

splitSelection

splitSelection(currentBox: HTMLElement, edge?: Node): Nullable<Element>
Parameters
- currentBox: HTMLElement
- Optional edge: Node
Returns Nullable<Element>

wrapInTag

wrapInTag(tagOrCallback: keyof HTMLElementTagNameMap | ((font: HTMLElement) => any)): HTMLElement[]
Parameters
- tagOrCallback: keyof HTMLElementTagNameMap | ((font: HTMLElement) => any)
Returns HTMLElement[]

wrapInTagGen

wrapInTagGen(): Generator<HTMLElement, any, unknown>
Returns Generator<HTMLElement, any, unknown>

Properties

`Readonly` hasMarkers

hasMarkers: boolean

`Readonly` html

html: string

`Readonly` isInsideArea

isInsideArea: boolean

`Readonly` markers

markers: HTMLElement[]

`Readonly` range

range: Range

`Readonly` sel

sel: null | Selection

Jodit PRO

If you like Jodit - try Jodit PRO

Hierarchy

Implemented by

Index

Methods

Properties

Methods

applyStyle

Deprecated

Parameters

style: CanUndef<IStyle>

Optional options: { attributes?: IDictionary<string | number, string>; className?: string; defaultTag?: keyof HTMLElementTagNameMap; element?: keyof HTMLElementTagNameMap; }

Optional attributes?: IDictionary<string | number, string>

Optional className?: string

Deprecated

Optional defaultTag?: keyof HTMLElementTagNameMap

Optional element?: keyof HTMLElementTagNameMap

Returns void

clear

Returns void

commitStyle

Parameters

options: IStyleOptions

Returns void

createRange

Parameters

Optional select: boolean

Returns Range

current

Parameters

Optional checkChild: boolean

Returns Nullable<Node>

cursorInTheEdge

Parameters

start: boolean

parentBlock: HTMLElement

Optional fake: null | Node

Returns Nullable<boolean>

cursorOnTheLeft

Parameters

parentBlock: HTMLElement

Optional fake: null | Node

Returns Nullable<boolean>

cursorOnTheRight

Parameters

parentBlock: HTMLElement

Optional fake: null | Node

Returns Nullable<boolean>

eachSelection

Parameters

callback: ((current: Node) => void)

Parameters

current: Node

Returns void

Returns void

expandSelection

Returns ISelect

focus

Parameters

Optional options: FocusOptions

Returns boolean

insertCursorAtPoint

Parameters

x: number

y: number

Returns boolean

insertHTML

Parameters

html: string | number | Node

Optional insertCursorAfter: boolean

Returns void

insertImage

Parameters

url: string | HTMLImageElement

Optional styles: Nullable<IDictionary<string, string>>

Optional defaultWidth: Nullable<string | number>

Returns void

insertNode

Parameters

node: Node

Optional insertCursorAfter: boolean

`Optional` options: {
attributes?: IDictionary<string | number, string>;
className?: string;
defaultTag?: keyof HTMLElementTagNameMap;
element?: keyof HTMLElementTagNameMap;
}

`Optional` attributes?: IDictionary<string | number, string>

`Optional` className?: string

`Optional` defaultTag?: keyof HTMLElementTagNameMap

`Optional` element?: keyof HTMLElementTagNameMap

`Optional` select: boolean

`Optional` checkChild: boolean

`Optional` fake: null | Node

`Optional` fake: null | Node

`Optional` fake: null | Node

`Optional` options: FocusOptions

`Optional` insertCursorAfter: boolean

`Optional` styles: Nullable<IDictionary<string, string>>

`Optional` defaultWidth: Nullable<string | number>

`Optional` insertCursorAfter: boolean

`Optional` fireChange: boolean

`Optional` atStart: boolean

`Optional` range: Range

`Optional` silent: boolean

`Optional` inward: boolean

`Optional` focus: boolean

`Optional` inStart: boolean

`Optional` edge: Node

`Readonly` hasMarkers

`Readonly` html

`Readonly` isInsideArea

`Readonly` markers

`Readonly` range

`Readonly` sel