String.prototype.link()

The link() method creates a string representing the code for an <a> HTML element to be used as a hypertext link to another URL.

Syntax

str.link(url)

Parameters

url

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

Return value

A string containing an <a> HTML element.

Description

Use the link() method to create an HTML snippet for a hypertext link. The returned string can then be added to the document via document.write() or element.innerHTML.

Links created with the link() method become elements in the links array of the document object. See document.links.

Examples

Using link()

The following example displays the word "MDN" as a hypertext link that returns the user to the Mozilla Developer Network.

var hotText = 'MDN';
var URL = 'https://developer.mozilla.org/';

console.log('Click to return to ' + hotText.link(URL));
// Click to return to <a href="https://developer.mozilla.org/">MDN</a>

Specifications

Browser compatibility

Gecko-specific notes

• Starting Gecko 17.0 (Firefox 17 / Thunderbird 17 / SeaMonkey 2.14) the " (quotation mark) is now automatically replaced by its HTML reference character " in the url parameter.

See also

• String.prototype.anchor()