Module: @lexical/selection
Functions
$addNodeStyle
▸ $addNodeStyle(node
): void
Parameters
Name | Type |
---|---|
node | TextNode |
Returns
void
Defined in
lexical-selection/src/lexical-node.ts:244
$cloneWithProperties
▸ $cloneWithProperties<T
>(node
): T
Type parameters
Name | Type |
---|---|
T | extends LexicalNode <T > |
Parameters
Name | Type |
---|---|
node | T |
Returns
T
Defined in
lexical-selection/src/lexical-node.ts:60
$getSelectionStyleValueForProperty
▸ $getSelectionStyleValueForProperty(selection
, styleProperty
, defaultValue?
): string
Parameters
Name | Type | Default value |
---|---|---|
selection | RangeSelection | undefined |
styleProperty | string | undefined |
defaultValue | string | '' |
Returns
string
Defined in
lexical-selection/src/range-selection.ts:444
$isAtNodeEnd
▸ $isAtNodeEnd(point
): boolean
Parameters
Name | Type |
---|---|
point | Point |
Returns
boolean
Defined in
lexical-selection/src/lexical-node.ts:124
$isParentElementRTL
▸ $isParentElementRTL(selection
): boolean
Parameters
Name | Type |
---|---|
selection | RangeSelection |
Returns
boolean
Defined in
lexical-selection/src/range-selection.ts:375
$moveCaretSelection
▸ $moveCaretSelection(selection
, isHoldingShift
, isBackward
, granularity
): void
Parameters
Name | Type |
---|---|
selection | RangeSelection |
isHoldingShift | boolean |
isBackward | boolean |
granularity | "character" | "word" | "lineboundary" |
Returns
void
Defined in
lexical-selection/src/range-selection.ts:366
$moveCharacter
▸ $moveCharacter(selection
, isHoldingShift
, isBackward
): void
Parameters
Name | Type |
---|---|
selection | RangeSelection |
isHoldingShift | boolean |
isBackward | boolean |
Returns
void
Defined in
lexical-selection/src/range-selection.ts:384
$patchStyleText
▸ $patchStyleText(selection
, patch
): void
Parameters
Name | Type |
---|---|
selection | RangeSelection | GridSelection |
patch | Record <string , null | string > |
Returns
void
Defined in
lexical-selection/src/lexical-node.ts:271
$selectAll
▸ $selectAll(selection
): void
Parameters
Name | Type |
---|---|
selection | RangeSelection |
Returns
void
Defined in
lexical-selection/src/range-selection.ts:398
$setBlocksType_experimental
▸ $setBlocksType_experimental(selection
, createElement
): void
Converts all nodes in the selection that are of one block type to another specified by parameter
Parameters
Name | Type |
---|---|
selection | RangeSelection | GridSelection |
createElement | () => ElementNode |
Returns
void
Defined in
lexical-selection/src/range-selection.ts:43
$shouldOverrideDefaultCharacterSelection
▸ $shouldOverrideDefaultCharacterSelection(selection
, isBackward
): boolean
Parameters
Name | Type |
---|---|
selection | RangeSelection |
isBackward | boolean |
Returns
boolean
Defined in
lexical-selection/src/range-selection.ts:352
$sliceSelectedTextNodeContent
▸ $sliceSelectedTextNodeContent(selection
, textNode
): LexicalNode
Parameters
Name | Type |
---|---|
selection | RangeSelection | NodeSelection | GridSelection |
textNode | TextNode |
Returns
Defined in
lexical-selection/src/lexical-node.ts:80
$wrapNodes
▸ $wrapNodes(selection
, createElement
, wrappingElement?
): void
Parameters
Name | Type | Default value |
---|---|---|
selection | RangeSelection | GridSelection | undefined |
createElement | () => ElementNode | undefined |
wrappingElement | null | ElementNode | null |
Returns
void
Defined in
lexical-selection/src/range-selection.ts:98
createDOMRange
▸ createDOMRange(editor
, anchorNode
, _anchorOffset
, focusNode
, _focusOffset
): Range
| null
Parameters
Name | Type |
---|---|
editor | LexicalEditor |
anchorNode | LexicalNode |
_anchorOffset | number |
focusNode | LexicalNode |
_focusOffset | number |
Returns
Range
| null
Defined in
lexical-selection/src/utils.ts:38
createRectsFromDOMRange
▸ createRectsFromDOMRange(editor
, range
): ClientRect
[]
Parameters
Name | Type |
---|---|
editor | LexicalEditor |
range | Range |
Returns
ClientRect
[]
Defined in
lexical-selection/src/utils.ts:109
getStyleObjectFromCSS
▸ getStyleObjectFromCSS(css
): Record
<string
, string
>
Parameters
Name | Type |
---|---|
css | string |
Returns
Record
<string
, string
>
Defined in
lexical-selection/src/utils.ts:168
trimTextContentFromAnchor
▸ trimTextContentFromAnchor(editor
, anchor
, delCount
): void
Parameters
Name | Type |
---|---|
editor | LexicalEditor |
anchor | Point |
delCount | number |
Returns
void
Defined in
lexical-selection/src/lexical-node.ts:132