String.prototype.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

Polyfill

if (!String.prototype.anchor)
    String.prototype.anchor = function(x){
        return '<a name="' + x + '">' + this + '</a>'
    }

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

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

See also

• String.prototype.link()