String.prototype.link()

{{Deprecated_Header}}

The link() method of {{jsxref("String")}} values creates a string that embeds this string in an {{HTMLElement("a")}} element (<a href="...">str</a>), to be used as a hypertext link to another URL.

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

Syntax#

link(url)

Parameters#

• url
• : Any string that specifies the href attribute of the <a> element; it should be a valid URL (relative or absolute), with any & characters escaped as &.

Return value#

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

Examples#

Using link()#

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

const contentString = "MDN Web Docs";

document.body.innerHTML = contentString.link("https://developer.mozilla.org/");

This will create the following HTML:

<a href="https://developer.mozilla.org/">MDN Web Docs</a>

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

const contentString = "MDN Web Docs";
const elem = document.createElement("a");
elem.href = "https://developer.mozilla.org/";
elem.innerText = contentString;
document.body.appendChild(elem);

Specifications#

{{Specifications}}

Browser compatibility#

{{Compat}}

See also#

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