Skip to main content

Class: RangeSelection

lexical.RangeSelection

Implements

Constructors

constructor

new RangeSelection(anchor, focus, format)

Parameters

NameType
anchorPointType
focusPointType
formatnumber

Defined in

lexical/src/LexicalSelection.ts:512

Properties

_cachedNodes

_cachedNodes: null | LexicalNode[]

Defined in

lexical/src/LexicalSelection.ts:510


anchor

anchor: PointType

Defined in

lexical/src/LexicalSelection.ts:506


dirty

dirty: boolean

Implementation of

BaseSelection.dirty

Defined in

lexical/src/LexicalSelection.ts:508


focus

focus: PointType

Defined in

lexical/src/LexicalSelection.ts:507


format

format: number

Defined in

lexical/src/LexicalSelection.ts:509

Methods

applyDOMRange

applyDOMRange(range): void

Parameters

NameType
rangeStaticRange

Returns

void

Defined in

lexical/src/LexicalSelection.ts:654


clone

clone(): RangeSelection

Returns

RangeSelection

Implementation of

BaseSelection.clone

Defined in

lexical/src/LexicalSelection.ts:685


deleteCharacter

deleteCharacter(isBackward): void

Parameters

NameType
isBackwardboolean

Returns

void

Defined in

lexical/src/LexicalSelection.ts:1735


deleteLine

deleteLine(isBackward): void

Parameters

NameType
isBackwardboolean

Returns

void

Defined in

lexical/src/LexicalSelection.ts:1801


deleteWord

deleteWord(isBackward): void

Parameters

NameType
isBackwardboolean

Returns

void

Defined in

lexical/src/LexicalSelection.ts:1818


extract

extract(): LexicalNode[]

Returns

LexicalNode[]

Implementation of

BaseSelection.extract

Defined in

lexical/src/LexicalSelection.ts:1595


formatText

formatText(formatType): void

Parameters

NameType
formatTypeTextFormatType

Returns

void

Defined in

lexical/src/LexicalSelection.ts:1044


getCharacterOffsets

getCharacterOffsets(): [number, number]

Returns

[number, number]

Defined in

lexical/src/LexicalSelection.ts:1591


getNodes

getNodes(): LexicalNode[]

Returns

LexicalNode[]

Implementation of

BaseSelection.getNodes

Defined in

lexical/src/LexicalSelection.ts:543


getTextContent

getTextContent(): string

Returns

string

Implementation of

BaseSelection.getTextContent

Defined in

lexical/src/LexicalSelection.ts:598


hasFormat

hasFormat(type): boolean

Parameters

NameType
typeTextFormatType

Returns

boolean

Defined in

lexical/src/LexicalSelection.ts:701


insertLineBreak

insertLineBreak(selectStart?): void

Parameters

NameType
selectStart?boolean

Returns

void

Defined in

lexical/src/LexicalSelection.ts:1573


insertNodes

insertNodes(nodes, selectStart?): boolean

Parameters

NameType
nodesLexicalNode[]
selectStart?boolean

Returns

boolean

Defined in

lexical/src/LexicalSelection.ts:1168


insertParagraph

insertParagraph(): void

Returns

void

Defined in

lexical/src/LexicalSelection.ts:1463


insertRawText

insertRawText(text): void

Parameters

NameType
textstring

Returns

void

Implementation of

BaseSelection.insertRawText

Defined in

lexical/src/LexicalSelection.ts:706


insertText

insertText(text): void

Parameters

NameType
textstring

Returns

void

Defined in

lexical/src/LexicalSelection.ts:726


is

is(selection): boolean

Parameters

NameType
selectionnull | RangeSelection | NodeSelection | GridSelection

Returns

boolean

Implementation of

BaseSelection.is

Defined in

lexical/src/LexicalSelection.ts:522


isBackward

isBackward(): boolean

Returns

boolean

Defined in

lexical/src/LexicalSelection.ts:535


isCollapsed

isCollapsed(): boolean

Returns

boolean

Defined in

lexical/src/LexicalSelection.ts:539


modify

modify(alter, isBackward, granularity): void

Parameters

NameType
alter"move" | "extend"
isBackwardboolean
granularity"character" | "word" | "lineboundary"

Returns

void

Defined in

lexical/src/LexicalSelection.ts:1644


removeText

removeText(): void

Returns

void

Defined in

lexical/src/LexicalSelection.ts:1040


setTextNodeRange

setTextNodeRange(anchorNode, anchorOffset, focusNode, focusOffset): void

Parameters

NameType
anchorNodeTextNode
anchorOffsetnumber
focusNodeTextNode
focusOffsetnumber

Returns

void

Defined in

lexical/src/LexicalSelection.ts:586


toggleFormat

toggleFormat(format): void

Parameters

NameType
formatTextFormatType

Returns

void

Defined in

lexical/src/LexicalSelection.ts:696