String.prototype.anchor()

{{Deprecated_Header}}

The anchor() method of {{jsxref("String")}} values creates a string that embeds this string in an {{HTMLElement("a")}} element with a name (<a name="...">str</a>).

[!NOTE] All HTML wrapper methods are deprecated and only standardized for compatibility purposes. Use DOM APIs such as document.createElement() instead.

The HTML specification no longer allows the {{HTMLElement("a")}} element to have a name attribute, so this method doesn't even create valid markup.

Syntax#

anchor(name)

Parameters#

• name
• : A string representing a name value to put into the generated <a name="..."> start tag.

Return value#

A string beginning with an <a name="name"> start tag (double quotes in name are replaced with "), then the text str, and then an </a> end tag.

Examples#

Using anchor()#

The code below creates an HTML string and then replaces the document's body with it:

const contentString = "Hello, world";

document.body.innerHTML = contentString.anchor("hello");

This will create the following HTML:

<a name="hello">Hello, world</a>

[!WARNING] This markup is invalid, because name is no longer a valid attribute of the {{HTMLElement("a")}} element.

Instead of using anchor() and creating HTML text directly, you should use DOM APIs such as document.createElement(). For example:

const contentString = "Hello, world";
const elem = document.createElement("a");
elem.innerText = contentString;
document.body.appendChild(elem);

Specifications#

{{Specifications}}

Browser compatibility#

{{Compat}}

See also#

• Polyfill of String.prototype.anchor in core-js
• es-shims polyfill of String.prototype.anchor
• HTML wrapper methods
• {{HTMLElement("a")}}