HTMLInputElement: setRangeText() method

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

The HTMLInputElement.setRangeText() method replaces a range of text in an <input> or <textarea> element with a new string.

Syntax

js
setRangeText(replacement)
setRangeText(replacement, start)
setRangeText(replacement, start, end)
setRangeText(replacement, start, end, selectMode)

Parameters

replacement

The string to insert.

start Optional

The 0-based index of the first character to replace. Defaults to the current selectionStart value (the start of the user's current selection).

end Optional

The 0-based index of the character after the last character to replace. Defaults to the current selectionEnd value (the end of the user's current selection).

selectMode Optional

A string defining how the selection should be set after the text has been replaced. Possible values:

  • "select" selects the newly inserted text.
  • "start" moves the selection to just before the inserted text.
  • "end" moves the selection to just after the inserted text.
  • "preserve" attempts to preserve the selection. This is the default.

Return value

None (undefined).

Examples

Click the button in this example to replace part of the text in the text box. The newly inserted text will be highlighted (selected) afterwards.

HTML

html
<input
  type="text"
  id="text-box"
  size="30"
  value="This text has NOT been updated." />
<button onclick="selectText()">Update text</button>

JavaScript

js
function selectText() {
  const input = document.getElementById("text-box");
  input.focus();
  input.setRangeText("ALREADY", 14, 17, "select");
}

Result

Specifications

Specification
HTML Standard
# dom-textarea/input-setrangetext-dev

Browser compatibility

BCD tables only load in the browser

See also