readInputState

v0.0.5tested

Reads the value and current selection of an <input>/<textarea> into a plain InputState. A null selection (some input types report it) falls back to a collapsed caret at the end of the value.

Source Tests

Example

const { value, selection } = readInputState(inputEl);

Signature

export function readInputState(element: TextFieldElement): InputState{ ... }

Parameters

Parameter	Type	Default	Description
`element`	`TextFieldElement`	—	The input or textarea to read

Returns

InputStateThe element's { value, selection }

Property	Type	Default	Description
`value`	`string`	—	The element's current `value`.
`selection`	`readonly [from: number, to: number]`	—	The selection as `[from, to]` (collapsed caret when `from === to`).

Related Types

InputState

The editable state of a text field: its current text and selection bounds. Framework-agnostic and structurally compatible with any { value, selection } pair (e.g. an input-masking engine's element state).

interface InputState

Property	Type	Default	Description
`value`readonly	`string`	—	The element's current `value`.
`selection`readonly	`readonly [from: number, to: number]`	—	The selection as `[from, to]` (collapsed caret when `from === to`).

TextFieldElement

A text field whose value and selection can be read and written.

export type TextFieldElement = HTMLInputElement | HTMLTextAreaElement;