Skip to main content

Module: @lexical/selection

Functions

$addNodeStyle

$addNodeStyle(node): void

Parameters

NameType
nodeTextNode

Returns

void

Defined in

lexical-selection/src/lexical-node.ts:298


$cloneContents

$cloneContents(selection): ICloneSelectionContent

Parameters

NameType
selectionRangeSelection | NodeSelection | GridSelection

Returns

ICloneSelectionContent

Defined in

lexical-selection/src/lexical-node.ts:255


$cloneWithProperties

$cloneWithProperties<T>(node): T

Type parameters

NameType
Textends LexicalNode<T>

Parameters

NameType
nodeT

Returns

T

Defined in

lexical-selection/src/lexical-node.ts:64


$getSelectionStyleValueForProperty

$getSelectionStyleValueForProperty(selection, styleProperty, defaultValue?): string

Parameters

NameTypeDefault value
selectionRangeSelectionundefined
stylePropertystringundefined
defaultValuestring''

Returns

string

Defined in

lexical-selection/src/range-selection.ts:577


$isAtNodeEnd

$isAtNodeEnd(point): boolean

Parameters

NameType
pointPoint

Returns

boolean

Defined in

lexical-selection/src/lexical-node.ts:126


$isParentElementRTL

$isParentElementRTL(selection): boolean

Parameters

NameType
selectionRangeSelection

Returns

boolean

Defined in

lexical-selection/src/range-selection.ts:327


$moveCaretSelection

$moveCaretSelection(selection, isHoldingShift, isBackward, granularity): void

Parameters

NameType
selectionRangeSelection
isHoldingShiftboolean
isBackwardboolean
granularity"character" | "word" | "lineboundary"

Returns

void

Defined in

lexical-selection/src/range-selection.ts:318


$moveCharacter

$moveCharacter(selection, isHoldingShift, isBackward): void

Parameters

NameType
selectionRangeSelection
isHoldingShiftboolean
isBackwardboolean

Returns

void

Defined in

lexical-selection/src/range-selection.ts:336


$patchStyleText

$patchStyleText(selection, patch): void

Parameters

NameType
selectionRangeSelection | GridSelection
patchRecord<string, string>

Returns

void

Defined in

lexical-selection/src/lexical-node.ts:312


$selectAll

$selectAll(selection): void

Parameters

NameType
selectionRangeSelection

Returns

void

Defined in

lexical-selection/src/range-selection.ts:350


$shouldOverrideDefaultCharacterSelection

$shouldOverrideDefaultCharacterSelection(selection, isBackward): boolean

Parameters

NameType
selectionRangeSelection
isBackwardboolean

Returns

boolean

Defined in

lexical-selection/src/range-selection.ts:309


$sliceSelectedTextNodeContent

$sliceSelectedTextNodeContent(selection, textNode): LexicalNode

Parameters

NameType
selectionRangeSelection | NodeSelection | GridSelection
textNodeTextNode

Returns

LexicalNode

Defined in

lexical-selection/src/lexical-node.ts:82


$wrapNodes

$wrapNodes(selection, createElement, wrappingElement?): void

Attempts to wrap all nodes in the Selection in ElementNodes returned from createElement. If wrappingElement is provided, all of the wrapped leaves are appended to the wrappingElement. It attempts to append the resulting sub-tree to the nearest safe insertion target.

Parameters

NameTypeDefault value
selectionRangeSelectionundefined
createElement() => ElementNodeundefined
wrappingElementnull | ElementNodenull

Returns

void

Defined in

lexical-selection/src/range-selection.ts:65


$wrapNodesImpl

$wrapNodesImpl(selection, nodes, nodesLength, createElement, wrappingElement?): void

Parameters

NameTypeDefault value
selectionRangeSelectionundefined
nodesLexicalNode[]undefined
nodesLengthnumberundefined
createElement() => ElementNodeundefined
wrappingElementnull | ElementNodenull

Returns

void

Defined in

lexical-selection/src/range-selection.ts:142


createDOMRange

createDOMRange(editor, anchorNode, _anchorOffset, focusNode, _focusOffset): Range | null

Parameters

NameType
editorLexicalEditor
anchorNodeLexicalNode
_anchorOffsetnumber
focusNodeLexicalNode
_focusOffsetnumber

Returns

Range | null

Defined in

lexical-selection/src/utils.ts:38


createRectsFromDOMRange

createRectsFromDOMRange(editor, range): ClientRect[]

Parameters

NameType
editorLexicalEditor
rangeRange

Returns

ClientRect[]

Defined in

lexical-selection/src/utils.ts:109


getStyleObjectFromCSS

getStyleObjectFromCSS(css): Record<string, string>

Parameters

NameType
cssstring

Returns

Record<string, string>

Defined in

lexical-selection/src/utils.ts:168


trimTextContentFromAnchor

trimTextContentFromAnchor(editor, anchor, delCount): void

Parameters

NameType
editorLexicalEditor
anchorPoint
delCountnumber

Returns

void

Defined in

lexical-selection/src/lexical-node.ts:134