Selection

selection.Selection

ImplementsImplementsImplements

• ISelect

constructorconstructorconstructor

new Selection(jodit): Selection

ParametersParametersParameters

ReturnsReturnsReturns

Selection

Defined inDefined inDefined in

src/core/selection/selection.ts#50

joditjoditjodit

Readonly jodit: IJodit

Defined inDefined inDefined in

src/core/selection/selection.ts#50

selselsel

get sel(): null | Selection

Return current selection object

ReturnsReturnsReturns

null | Selection

Implementation ofImplementation ofImplementation of

ISelect.sel

Defined inDefined inDefined in

src/core/selection/selection.ts#96

rangerangerange

get range(): Range

Return first selected range or create new

ReturnsReturnsReturns

Range

Implementation ofImplementation ofImplementation of

ISelect.range

Defined inDefined inDefined in

src/core/selection/selection.ts#110

isInsideAreaisInsideAreaisInsideArea

get isInsideArea(): boolean

Checks if the selected text is currently inside the editor

ReturnsReturnsReturns

boolean

Implementation ofImplementation ofImplementation of

ISelect.isInsideArea

Defined inDefined inDefined in

src/core/selection/selection.ts#119

hasMarkershasMarkershasMarkers

get hasMarkers(): boolean

Check if editor has selection markers

ReturnsReturnsReturns

boolean

Implementation ofImplementation ofImplementation of

ISelect.hasMarkers

Defined inDefined inDefined in

src/core/selection/selection.ts#221

markersmarkersmarkers

get markers(): HTMLElement[]

Check if editor has selection markers

ReturnsReturnsReturns

HTMLElement[]

Implementation ofImplementation ofImplementation of

ISelect.markers

Defined inDefined inDefined in

src/core/selection/selection.ts#228

htmlhtmlhtml

get html(): string

Return current selected HTML

ReturnsReturnsReturns

string

Example

const editor = Jodit.make();
console.log(editor.s.html); // html
console.log(Jodit.modules.Helpers.stripTags(editor.s.html)); // plain text

Implementation ofImplementation ofImplementation of

ISelect.html

Defined inDefined inDefined in

src/core/selection/selection.ts#1198

createRangecreateRangecreateRange

createRange(select?): Range

Return current selection object

ParametersParametersParameters

ReturnsReturnsReturns

Range

Implementation ofImplementation ofImplementation of

ISelect.createRange

Defined inDefined inDefined in

src/core/selection/selection.ts#131

removeremoveremove

remove(): void

Remove all selected content

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

ISelect.remove

Defined inDefined inDefined in

src/core/selection/selection.ts#144

clearclearclear

clear(): void

Clear all selection

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

ISelect.clear

Defined inDefined inDefined in

src/core/selection/selection.ts#159

removeNoderemoveNoderemoveNode

removeNode(node): void

Remove node element from editor

ParametersParametersParameters

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

ISelect.removeNode

Defined inDefined inDefined in

src/core/selection/selection.ts#168

insertCursorAtPointinsertCursorAtPointinsertCursorAtPoint

insertCursorAtPoint(x, y): boolean

Insert the cursor to any point x, y

ParametersParametersParameters

ReturnsReturnsReturns

boolean

false - Something went wrong

Implementation ofImplementation ofImplementation of

ISelect.insertCursorAtPoint

Defined inDefined inDefined in

src/core/selection/selection.ts#186

removeMarkersremoveMarkersremoveMarkers

removeMarkers(): void

Remove all markers

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

ISelect.removeMarkers

Defined inDefined inDefined in

src/core/selection/selection.ts#235

markermarkermarker

marker(atStart?, range?): HTMLSpanElement

Create marker element

ParametersParametersParameters

ReturnsReturnsReturns

HTMLSpanElement

Implementation ofImplementation ofImplementation of

ISelect.marker

Defined inDefined inDefined in

src/core/selection/selection.ts#242

restorerestorerestore

restore(): void

Restores user selections using marker invisible elements in the DOM.

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

ISelect.restore

Defined inDefined inDefined in

src/core/selection/selection.ts#287

fakesfakesfakes

fakes(): [] | [Node] | [Node, Node]

ReturnsReturnsReturns

[] | [Node] | [Node, Node]

Implementation ofImplementation ofImplementation of

ISelect.fakes

Defined inDefined inDefined in

src/core/selection/selection.ts#330

restoreFakesrestoreFakesrestoreFakes

restoreFakes(fakes): void

ParametersParametersParameters

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

ISelect.restoreFakes

Defined inDefined inDefined in

src/core/selection/selection.ts#361

savesavesave

save(silent?): MarkerInfo[]

Saves selections using marker invisible elements in the DOM.

ParametersParametersParameters

ReturnsReturnsReturns

MarkerInfo[]

Implementation ofImplementation ofImplementation of

ISelect.save

Defined inDefined inDefined in

src/core/selection/selection.ts#393

focusfocusfocus

focus(options?): boolean

Set focus in editor

ParametersParametersParameters

ReturnsReturnsReturns

boolean

Implementation ofImplementation ofImplementation of

ISelect.focus

Defined inDefined inDefined in

src/core/selection/selection.ts#473

isCollapsedisCollapsedisCollapsed

isCollapsed(): boolean

Checks whether the current selection is something or just set the cursor is

ReturnsReturnsReturns

boolean

true Selection does't have content

Implementation ofImplementation ofImplementation of

ISelect.isCollapsed

Defined inDefined inDefined in

src/core/selection/selection.ts#519

isFocusedisFocusedisFocused

isFocused(): boolean

Checks whether the editor currently in focus

ReturnsReturnsReturns

boolean

Implementation ofImplementation ofImplementation of

ISelect.isFocused

Defined inDefined inDefined in

src/core/selection/selection.ts#534

currentcurrentcurrent

current(checkChild?): Nullable<Node>

Returns the current element under the cursor inside editor

ParametersParametersParameters

ReturnsReturnsReturns

Nullable<Node>

Implementation ofImplementation ofImplementation of

ISelect.current

Defined inDefined inDefined in

src/core/selection/selection.ts#545

insertNodeinsertNodeinsertNode

insertNode(node, insertCursorAfter?, fireChange?): void

Insert element in editor

ParametersParametersParameters

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

ISelect.insertNode

Defined inDefined inDefined in

src/core/selection/selection.ts#597

insertHTMLinsertHTMLinsertHTML

insertHTML(html, insertCursorAfter?): void

Inserts in the current cursor position some HTML snippet

ParametersParametersParameters

ReturnsReturnsReturns

void

Example

parent.s.insertHTML('<img src="image.png"/>');

Implementation ofImplementation ofImplementation of

ISelect.insertHTML

Defined inDefined inDefined in

src/core/selection/selection.ts#682

insertImageinsertImageinsertImage

insertImage(url, styles?, defaultWidth?): void

Insert image in editor

ParametersParametersParameters

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

ISelect.insertImage

Defined inDefined inDefined in

src/core/selection/selection.ts#737

eachSelectioneachSelectioneachSelection

eachSelection(callback): void

Call callback for all selection node

ParametersParametersParameters

ReturnsReturnsReturns

void

Implementation ofImplementation ofImplementation of

ISelect.eachSelection

Defined inDefined inDefined in

src/core/selection/selection.ts#805

cursorInTheEdgecursorInTheEdgecursorInTheEdge

cursorInTheEdge(start, parentBlock, fake?): Nullable<boolean>

Checks if the cursor is at the end(start) block

ParametersParametersParameters

ReturnsReturnsReturns

Nullable<boolean>

true - the cursor is at the end(start) block, null - cursor somewhere outside

Implementation ofImplementation ofImplementation of

ISelect.cursorInTheEdge

Defined inDefined inDefined in

src/core/selection/selection.ts#929

cursorOnTheLeftcursorOnTheLeftcursorOnTheLeft

cursorOnTheLeft(parentBlock, fake?): Nullable<boolean>

Wrapper for cursorInTheEdge

ParametersParametersParameters

ReturnsReturnsReturns

Nullable<boolean>

Implementation ofImplementation ofImplementation of

ISelect.cursorOnTheLeft

Defined inDefined inDefined in

src/core/selection/selection.ts#998

cursorOnTheRightcursorOnTheRightcursorOnTheRight

cursorOnTheRight(parentBlock, fake?): Nullable<boolean>

Wrapper for cursorInTheEdge

ParametersParametersParameters

ReturnsReturnsReturns

Nullable<boolean>

Implementation ofImplementation ofImplementation of

ISelect.cursorOnTheRight

Defined inDefined inDefined in

src/core/selection/selection.ts#1008

setCursorAftersetCursorAftersetCursorAfter

setCursorAfter(node): Nullable<Text>

Set cursor after the node

ParametersParametersParameters

ReturnsReturnsReturns

Nullable<Text>

fake invisible textnode. After insert it can be removed

Implementation ofImplementation ofImplementation of

ISelect.setCursorAfter

Defined inDefined inDefined in

src/core/selection/selection.ts#1020

setCursorBeforesetCursorBeforesetCursorBefore

setCursorBefore(node): Nullable<Text>

Set cursor before the node

ParametersParametersParameters

ReturnsReturnsReturns

Nullable<Text>

fake invisible textnode. After insert it can be removed

Implementation ofImplementation ofImplementation of

ISelect.setCursorBefore

Defined inDefined inDefined in

src/core/selection/selection.ts#1029

setCursorInsetCursorInsetCursorIn

setCursorIn(node, inStart?): Node

Set cursor in the node

ParametersParametersParameters

ReturnsReturnsReturns

Node

Implementation ofImplementation ofImplementation of

ISelect.setCursorIn

Defined inDefined inDefined in

src/core/selection/selection.ts#1082

selectRangeselectRangeselectRange

selectRange(range, focus?): this

Set range selection

ParametersParametersParameters

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

ISelect.selectRange

Defined inDefined inDefined in

src/core/selection/selection.ts#1140

selectselectselect

select(node, inward?): this

Select node

ParametersParametersParameters

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

ISelect.select

Defined inDefined inDefined in

src/core/selection/selection.ts#1165

wrapInTagGenwrapInTagGenwrapInTagGen

wrapInTagGen(fakes?): Generator<HTMLElement, undefined, any>

Wrap all selected fragments inside Tag or apply some callback

ParametersParametersParameters

ReturnsReturnsReturns

Generator<HTMLElement, undefined, any>

Implementation ofImplementation ofImplementation of

ISelect.wrapInTagGen

Defined inDefined inDefined in

src/core/selection/selection.ts#1217

wrapInTagwrapInTagwrapInTag

wrapInTag(tagOrCallback): HTMLElement[]

Wrap all selected fragments inside Tag or apply some callback

ParametersParametersParameters

ReturnsReturnsReturns

HTMLElement[]

Implementation ofImplementation ofImplementation of

ISelect.wrapInTag

Defined inDefined inDefined in

src/core/selection/selection.ts#1285

commitStylecommitStylecommitStyle

commitStyle(options): void

Apply some css rules for all selections. It method wraps selections in nodeName tag.

ParametersParametersParameters

ReturnsReturnsReturns

void

Example

const editor = Jodit.make('#editor');
editor.value = 'test';
editor.execCommand('selectall');

editor.s.commitStyle({
  style: {color: 'red'}
}) // will wrap `text` in `span` and add style `color:red`
editor.s.commitStyle({
  style: {color: 'red'}
}) // will remove `color:red` from `span`

Implementation ofImplementation ofImplementation of

ISelect.commitStyle

Defined inDefined inDefined in

src/core/selection/selection.ts#1339

splitSelectionsplitSelectionsplitSelection

splitSelection(currentBox, edge?): Nullable<Element>

Split selection on two parts: left and right

ParametersParametersParameters

ReturnsReturnsReturns

Nullable<Element>

Implementation ofImplementation ofImplementation of

ISelect.splitSelection

Defined inDefined inDefined in

src/core/selection/selection.ts#1350

expandSelectionexpandSelectionexpandSelection

expandSelection(): this

ReturnsReturnsReturns

this

Implementation ofImplementation ofImplementation of

ISelect.expandSelection

Defined inDefined inDefined in

jodit/src/core/selection/selection.ts:1459