Skip to main content

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

MDN Reference

Inherited from

Selection.anchorNode

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21219


anchorOffset

Readonly anchorOffset: number

MDN Reference

Inherited from

Selection.anchorOffset

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21221


focusNode

Readonly focusNode: null | Node

MDN Reference

Inherited from

Selection.focusNode

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21223


focusOffset

Readonly focusOffset: number

MDN Reference

Inherited from

Selection.focusOffset

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21225


isCollapsed

Readonly isCollapsed: boolean

MDN Reference

Inherited from

Selection.isCollapsed

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21227


rangeCount

Readonly rangeCount: number

MDN Reference

Inherited from

Selection.rangeCount

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21229


type

Readonly type: string

MDN Reference

Inherited from

Selection.type

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21231

Methods

addRange

addRange(range): void

MDN Reference

Parameters

NameType
rangeRange

Returns

void

Inherited from

Selection.addRange

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21233


collapse

collapse(node, offset?): void

MDN Reference

Parameters

NameType
nodenull | Node
offset?number

Returns

void

Inherited from

Selection.collapse

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21235


collapseToEnd

collapseToEnd(): void

MDN Reference

Returns

void

Inherited from

Selection.collapseToEnd

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21237


collapseToStart

collapseToStart(): void

MDN Reference

Returns

void

Inherited from

Selection.collapseToStart

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21239


containsNode

containsNode(node, allowPartialContainment?): boolean

MDN Reference

Parameters

NameType
nodeNode
allowPartialContainment?boolean

Returns

boolean

Inherited from

Selection.containsNode

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21241


deleteFromDocument

deleteFromDocument(): void

MDN Reference

Returns

void

Inherited from

Selection.deleteFromDocument

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21243


empty

empty(): void

MDN Reference

Returns

void

Inherited from

Selection.empty

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21245


extend

extend(node, offset?): void

MDN Reference

Parameters

NameType
nodeNode
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

NameTypeDescription
options?GetComposedRangesOptionsConfiguration 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

MDN Reference

Parameters

NameType
indexnumber

Returns

Range

Inherited from

Selection.getRangeAt

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21249


modify

modify(alter?, direction?, granularity?): void

MDN Reference

Parameters

NameType
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

MDN Reference

Returns

void

Inherited from

Selection.removeAllRanges

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21253


removeRange

removeRange(range): void

MDN Reference

Parameters

NameType
rangeRange

Returns

void

Inherited from

Selection.removeRange

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21255


selectAllChildren

selectAllChildren(node): void

MDN Reference

Parameters

NameType
nodeNode

Returns

void

Inherited from

Selection.selectAllChildren

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21257


setBaseAndExtent

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

MDN Reference

Parameters

NameType
anchorNodeNode
anchorOffsetnumber
focusNodeNode
focusOffsetnumber

Returns

void

Inherited from

Selection.setBaseAndExtent

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21259


setPosition

setPosition(node, offset?): void

MDN Reference

Parameters

NameType
nodenull | 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

Defined in

node_modules/typescript/lib/lib.dom.d.ts:21262