Skip to content

Selection

Types

t

A Selection object represents the range of text selected by the user or the current position of the caret. To obtain a Selection object for examination or modification, call Window.getSelection(). See Selection on MDN

type t = private {
anchorNode: Null.t<WebAPI.DOMTree.node>,
anchorOffset: int,
focusNode: Null.t<WebAPI.DOMTree.node>,
focusOffset: int,
isCollapsed: bool,
rangeCount: int,
type_: string,
direction: string,
}

Record fields

anchorOffset
int
focusOffset
int
isCollapsed
bool
rangeCount
int
type_
string
direction
string

Values

addRange

let addRange: (t, WebAPI.Range.t) => unit

Parameters

tWebAPI.Range.t

Return type

unit

collapse

let collapse: (t, ~node: WebAPI.DOMTree.node, ~offset: int=?) => unit

Parameters

tWebAPI.DOMTree.nodeoption<int>

Return type

unit

collapseToEnd

let collapseToEnd: t => unit

Parameters

t

Return type

unit

collapseToStart

let collapseToStart: t => unit

Parameters

t

Return type

unit

containsNode

let containsNode: (
t,
~node: WebAPI.DOMTree.node,
~allowPartialContainment: bool=?,
) => bool

Parameters

tWebAPI.DOMTree.nodeoption<bool>

Return type

bool

deleteFromDocument

let deleteFromDocument: t => unit

Parameters

t

Return type

unit

empty

let empty: t => unit

Parameters

t

Return type

unit

extend

let extend: (t, ~node: WebAPI.DOMTree.node, ~offset: int=?) => unit

Parameters

tWebAPI.DOMTree.nodeoption<int>

Return type

unit

getRangeAt

let getRangeAt: (t, int) => WebAPI.Range.t

Parameters

tint

Return type

WebAPI.Range.t

modify

let modify: (
t,
~alter: string=?,
~direction: string=?,
~granularity: string=?,
) => unit

Parameters

toption<string>option<string>option<string>

Return type

unit

removeAllRanges

let removeAllRanges: t => unit

Parameters

t

Return type

unit

removeRange

let removeRange: (t, WebAPI.Range.t) => unit

Parameters

tWebAPI.Range.t

Return type

unit

selectAllChildren

let selectAllChildren: (t, WebAPI.DOMTree.node) => unit

Parameters

tWebAPI.DOMTree.node

Return type

unit

setBaseAndExtent

let setBaseAndExtent: (
t,
~anchorNode: WebAPI.DOMTree.node,
~anchorOffset: int,
~focusNode: WebAPI.DOMTree.node,
~focusOffset: int,
) => unit

Parameters

tWebAPI.DOMTree.nodeintWebAPI.DOMTree.nodeint

Return type

unit

setPosition

let setPosition: (t, ~node: WebAPI.DOMTree.node, ~offset: int=?) => unit

Parameters

tWebAPI.DOMTree.nodeoption<int>

Return type

unit