string.anchor

The anchor() method creates an <a> HTML anchor element that is used as a hypertext target.

Syntax

str.anchor(name)

Parameters

name

A string representing the name attribute of the a tag to be created.

Return value

A string containing an <a> HTML element.

Description

Use the anchor() method to programmatically create and display an anchor in a document.

In the syntax, the text string represents the literal text that you want the user to see. The name parameter string represents the name attribute of the <a> element.

Anchors created with the anchor() method become elements in the document.anchors array.

Examples

Using anchor()

var myString = 'Table of Contents';

document.body.innerHTML = myString.anchor('contents_anchor');

will output the following HTML:

<a name="contents_anchor">Table of Contents</a>

Specifications

Specification	Status	Comment
ECMAScript 2015 (6th Edition, ECMA-262) The definition of 'String.prototype.anchor' in that specification.	Standard	Initial definition. Implemented in JavaScript 1.0. Defined in the (normative) Annex B for Additional ECMAScript Features for Web Browsers.

Browser compatibility

[1] Starting with Gecko version 17, the " (quotation mark) is replaced by its HTML reference character " in strings supplied for the name parameter.

See also

• String.prototype.link()