Selection

selection.Selection

ImplementsImplements

• ISelect

constructorconstructor

new Selection(jodit): Selection

ParametersParameters

ReturnsReturns

Selection

Defined inDefined in

src/core/selection/selection.ts#51

joditjodit

Readonly jodit: IJodit

Defined inDefined in

src/core/selection/selection.ts#51

selsel

get sel(): null | Selection

Return current selection object

ReturnsReturns

null | Selection

Implementation ofImplementation of

ISelect.sel

Defined inDefined in

src/core/selection/selection.ts#97

rangerange

get range(): Range

Return first selected range or create new

ReturnsReturns

Range

Implementation ofImplementation of

ISelect.range

Defined inDefined in

src/core/selection/selection.ts#111

isInsideAreaisInsideArea

get isInsideArea(): boolean

Checks if the selected text is currently inside the editor

ReturnsReturns

boolean

Implementation ofImplementation of

ISelect.isInsideArea

Defined inDefined in

src/core/selection/selection.ts#120

hasMarkershasMarkers

get hasMarkers(): boolean

Check if editor has selection markers

ReturnsReturns

boolean

Implementation ofImplementation of

ISelect.hasMarkers

Defined inDefined in

src/core/selection/selection.ts#222

markersmarkers

get markers(): HTMLElement[]

Check if editor has selection markers

ReturnsReturns

HTMLElement[]

Implementation ofImplementation of

ISelect.markers

Defined inDefined in

src/core/selection/selection.ts#229

htmlhtml

get html(): string

Return current selected HTML

ReturnsReturns

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 of

ISelect.html

Defined inDefined in

src/core/selection/selection.ts#1205

createRangecreateRange

createRange(select?): Range

Return current selection object

ParametersParameters

ReturnsReturns

Range

Implementation ofImplementation of

ISelect.createRange

Defined inDefined in

src/core/selection/selection.ts#132

removeremove

remove(): void

Remove all selected content

ReturnsReturns

void

Implementation ofImplementation of

ISelect.remove

Defined inDefined in

src/core/selection/selection.ts#145

clearclear

clear(): void

Clear all selection

ReturnsReturns

void

Implementation ofImplementation of

ISelect.clear

Defined inDefined in

src/core/selection/selection.ts#160

removeNoderemoveNode

removeNode(node): void

Remove node element from editor

ParametersParameters

ReturnsReturns

void

Implementation ofImplementation of

ISelect.removeNode

Defined inDefined in

src/core/selection/selection.ts#169

insertCursorAtPointinsertCursorAtPoint

insertCursorAtPoint(x, y): boolean

Insert the cursor to any point x, y

ParametersParameters

ReturnsReturns

boolean

false - Something went wrong

Implementation ofImplementation of

ISelect.insertCursorAtPoint

Defined inDefined in

src/core/selection/selection.ts#187

removeMarkersremoveMarkers

removeMarkers(): void

Remove all markers

ReturnsReturns

void

Implementation ofImplementation of

ISelect.removeMarkers

Defined inDefined in

src/core/selection/selection.ts#236

markermarker

marker(atStart?, range?): HTMLSpanElement

Create marker element

ParametersParameters

ReturnsReturns

HTMLSpanElement

Implementation ofImplementation of

ISelect.marker

Defined inDefined in

src/core/selection/selection.ts#243

restorerestore

restore(): void

Restores user selections using marker invisible elements in the DOM.

ReturnsReturns

void

Implementation ofImplementation of

ISelect.restore

Defined inDefined in

src/core/selection/selection.ts#288

fakesfakes

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

ReturnsReturns

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

Implementation ofImplementation of

ISelect.fakes

Defined inDefined in

src/core/selection/selection.ts#331

restoreFakesrestoreFakes

restoreFakes(fakes): void

ParametersParameters

ReturnsReturns

void

Implementation ofImplementation of

ISelect.restoreFakes

Defined inDefined in

src/core/selection/selection.ts#362

savesave

save(silent?): MarkerInfo[]

Saves selections using marker invisible elements in the DOM.

ParametersParameters

ReturnsReturns

MarkerInfo[]

Implementation ofImplementation of

ISelect.save

Defined inDefined in

src/core/selection/selection.ts#394

focusfocus

focus(options?): boolean

Set focus in editor

ParametersParameters

ReturnsReturns

boolean

Implementation ofImplementation of

ISelect.focus

Defined inDefined in

src/core/selection/selection.ts#474

isCollapsedisCollapsed

isCollapsed(): boolean

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

ReturnsReturns

boolean

true Selection does't have content

Implementation ofImplementation of

ISelect.isCollapsed

Defined inDefined in

src/core/selection/selection.ts#520

isFocusedisFocused

isFocused(): boolean

Checks whether the editor currently in focus

ReturnsReturns

boolean

Implementation ofImplementation of

ISelect.isFocused

Defined inDefined in

src/core/selection/selection.ts#535

currentcurrent

current(checkChild?): Nullable<Node>

Returns the current element under the cursor inside editor

ParametersParameters

ReturnsReturns

Nullable<Node>

Implementation ofImplementation of

ISelect.current

Defined inDefined in

src/core/selection/selection.ts#546

insertNodeinsertNode

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

Insert element in editor

ParametersParameters

ReturnsReturns

void

Implementation ofImplementation of

ISelect.insertNode

Defined inDefined in

src/core/selection/selection.ts#598

insertHTMLinsertHTML

insertHTML(html, insertCursorAfter?): void

Inserts in the current cursor position some HTML snippet

ParametersParameters

ReturnsReturns

void

Example

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

Implementation ofImplementation of

ISelect.insertHTML

Defined inDefined in

src/core/selection/selection.ts#683

insertImageinsertImage

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

Insert image in editor

ParametersParameters

ReturnsReturns

void

Implementation ofImplementation of

ISelect.insertImage

Defined inDefined in

src/core/selection/selection.ts#738

eachSelectioneachSelection

eachSelection(callback): void

Call callback for all selection node

ParametersParameters

ReturnsReturns

void

Implementation ofImplementation of

ISelect.eachSelection

Defined inDefined in

src/core/selection/selection.ts#812

cursorInTheEdgecursorInTheEdge

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

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

ParametersParameters

ReturnsReturns

Nullable<boolean>

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

Implementation ofImplementation of

ISelect.cursorInTheEdge

Defined inDefined in

src/core/selection/selection.ts#936

cursorOnTheLeftcursorOnTheLeft

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

Wrapper for cursorInTheEdge

ParametersParameters

ReturnsReturns

Nullable<boolean>

Implementation ofImplementation of

ISelect.cursorOnTheLeft

Defined inDefined in

src/core/selection/selection.ts#1005

cursorOnTheRightcursorOnTheRight

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

Wrapper for cursorInTheEdge

ParametersParameters

ReturnsReturns

Nullable<boolean>

Implementation ofImplementation of

ISelect.cursorOnTheRight

Defined inDefined in

src/core/selection/selection.ts#1015

setCursorAftersetCursorAfter

setCursorAfter(node): Nullable<Text>

Set cursor after the node

ParametersParameters

ReturnsReturns

Nullable<Text>

fake invisible textnode. After insert it can be removed

Implementation ofImplementation of

ISelect.setCursorAfter

Defined inDefined in

src/core/selection/selection.ts#1027

setCursorBeforesetCursorBefore

setCursorBefore(node): Nullable<Text>

Set cursor before the node

ParametersParameters

ReturnsReturns

Nullable<Text>

fake invisible textnode. After insert it can be removed

Implementation ofImplementation of

ISelect.setCursorBefore

Defined inDefined in

src/core/selection/selection.ts#1036

setCursorInsetCursorIn

setCursorIn(node, inStart?): Node

Set cursor in the node

ParametersParameters

ReturnsReturns

Node

Implementation ofImplementation of

ISelect.setCursorIn

Defined inDefined in

src/core/selection/selection.ts#1089

selectRangeselectRange

selectRange(range, focus?): this

Set range selection

ParametersParameters

ReturnsReturns

this

Implementation ofImplementation of

ISelect.selectRange

Defined inDefined in

src/core/selection/selection.ts#1147

selectselect

select(node, inward?): this

Select node

ParametersParameters

ReturnsReturns

this

Implementation ofImplementation of

ISelect.select

Defined inDefined in

src/core/selection/selection.ts#1172

wrapInTagGenwrapInTagGen

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

Wrap all selected fragments inside Tag or apply some callback

ParametersParameters

ReturnsReturns

Generator<HTMLElement, undefined, unknown>

Implementation ofImplementation of

ISelect.wrapInTagGen

Defined inDefined in

src/core/selection/selection.ts#1224

wrapInTagwrapInTag

wrapInTag(tagOrCallback): HTMLElement[]

Wrap all selected fragments inside Tag or apply some callback

ParametersParameters

ReturnsReturns

HTMLElement[]

Implementation ofImplementation of

ISelect.wrapInTag

Defined inDefined in

src/core/selection/selection.ts#1292

commitStylecommitStyle

commitStyle(options): void

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

ParametersParameters

ReturnsReturns

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 of

ISelect.commitStyle

Defined inDefined in

src/core/selection/selection.ts#1346

splitSelectionsplitSelection

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

Split selection on two parts: left and right

ParametersParameters

ReturnsReturns

Nullable<Element>

Implementation ofImplementation of

ISelect.splitSelection

Defined inDefined in

src/core/selection/selection.ts#1357

expandSelectionexpandSelection

expandSelection(): this

ReturnsReturns

this

Implementation ofImplementation of

ISelect.expandSelection

Defined inDefined in

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