Interface: SelectionWithComposedRanges
lexical.SelectionWithComposedRanges
Extended Selection interface that includes the modern getComposedRanges() method. This API is available in Chrome 125+, Firefox 132+, and other modern browsers. It provides a standardized way to get selection ranges across shadow DOM boundaries.
Hierarchy
-
Selection
↳
SelectionWithComposedRanges
Properties
anchorNode
• Readonly
anchorNode: null
| Node
Inherited from
Selection.anchorNode
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21219
anchorOffset
• Readonly
anchorOffset: number
Inherited from
Selection.anchorOffset
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21221
focusNode
• Readonly
focusNode: null
| Node
Inherited from
Selection.focusNode
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21223
focusOffset
• Readonly
focusOffset: number
Inherited from
Selection.focusOffset
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21225
isCollapsed
• Readonly
isCollapsed: boolean
Inherited from
Selection.isCollapsed
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21227
rangeCount
• Readonly
rangeCount: number
Inherited from
Selection.rangeCount
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21229
type
• Readonly
type: string
Inherited from
Selection.type
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21231
Methods
addRange
▸ addRange(range
): void
Parameters
Name | Type |
---|---|
range | Range |
Returns
void
Inherited from
Selection.addRange
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21233
collapse
▸ collapse(node
, offset?
): void
Parameters
Name | Type |
---|---|
node | null | Node |
offset? | number |
Returns
void
Inherited from
Selection.collapse
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21235
collapseToEnd
▸ collapseToEnd(): void
Returns
void
Inherited from
Selection.collapseToEnd
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21237
collapseToStart
▸ collapseToStart(): void
Returns
void
Inherited from
Selection.collapseToStart
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21239
containsNode
▸ containsNode(node
, allowPartialContainment?
): boolean
Parameters
Name | Type |
---|---|
node | Node |
allowPartialContainment? | boolean |
Returns
boolean
Inherited from
Selection.containsNode
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21241
deleteFromDocument
▸ deleteFromDocument(): void
Returns
void
Inherited from
Selection.deleteFromDocument
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21243
empty
▸ empty(): void
Returns
void
Inherited from
Selection.empty
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21245
extend
▸ extend(node
, offset?
): void
Parameters
Name | Type |
---|---|
node | Node |
offset? | number |
Returns
void
Inherited from
Selection.extend
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21247
getComposedRanges
▸ getComposedRanges(options?
): StaticRange
[]
Returns an array of StaticRange objects representing the current selection across shadow DOM boundaries. This is the modern replacement for the experimental ShadowRoot.getSelection() method.
Parameters
Name | Type | Description |
---|---|---|
options? | GetComposedRangesOptions | Configuration options for the composed ranges |
Returns
StaticRange
[]
Array of StaticRange objects representing the selection
Defined in
packages/lexical/src/LexicalSelection.ts:117
getRangeAt
▸ getRangeAt(index
): Range
Parameters
Name | Type |
---|---|
index | number |
Returns
Range
Inherited from
Selection.getRangeAt
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21249
modify
▸ modify(alter?
, direction?
, granularity?
): void
Parameters
Name | Type |
---|---|
alter? | string |
direction? | string |
granularity? | string |
Returns
void
Inherited from
Selection.modify
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21251
removeAllRanges
▸ removeAllRanges(): void
Returns
void
Inherited from
Selection.removeAllRanges
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21253
removeRange
▸ removeRange(range
): void
Parameters
Name | Type |
---|---|
range | Range |
Returns
void
Inherited from
Selection.removeRange
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21255
selectAllChildren
▸ selectAllChildren(node
): void
Parameters
Name | Type |
---|---|
node | Node |
Returns
void
Inherited from
Selection.selectAllChildren
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21257
setBaseAndExtent
▸ setBaseAndExtent(anchorNode
, anchorOffset
, focusNode
, focusOffset
): void
Parameters
Name | Type |
---|---|
anchorNode | Node |
anchorOffset | number |
focusNode | Node |
focusOffset | number |
Returns
void
Inherited from
Selection.setBaseAndExtent
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21259
setPosition
▸ setPosition(node
, offset?
): void
Parameters
Name | Type |
---|---|
node | null | Node |
offset? | number |
Returns
void
Inherited from
Selection.setPosition
Defined in
node_modules/typescript/lib/lib.dom.d.ts:21261
toString
▸ toString(): string
Returns
string
Inherited from
Selection.toString