W3cubDocs

/Web APIs

Document: anchors property

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The anchors read-only property of the Document interface returns a list of all of the anchors in the document.

Value

An HTMLCollection.

Examples

>

Basic usage

if (document.anchors.length >= 5) {
  console.log("found too many anchors");
}

Creating a table of contents

The following is an example that auto populates a Table of Contents with every anchor on the page:

<h1>Title</h1>
<h2><a name="contents">Contents</a></h2>
<ul id="toc"></ul>

<h2><a name="plants">Plants</a></h2>
<ol>
  <li>Apples</li>
  <li>Oranges</li>
  <li>Pears</li>
</ol>

<h2><a name="veggies">Veggies</a></h2>
<ol>
  <li>Carrots</li>
  <li>Celery</li>
  <li>Beats</li>
</ol>
const toc = document.getElementById("toc");
for (const anchor of document.anchors) {
  const li = document.createElement("li");
  const newAnchor = document.createElement("a");
  newAnchor.href = `#${anchor.name}`;
  newAnchor.textContent = anchor.text;
  li.appendChild(newAnchor);
  toc.appendChild(li);
}

Notes

For reasons of backwards compatibility, the returned set of anchors only contains those anchors created with the name attribute, not those created with the id attribute.

Specifications

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Opera Safari Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet WebView Android WebView on iOS
anchors 1 12 61
1–61Only supported for HTMLDocument, not all Document objects.
≤12.1 4
1–4Only supported for HTMLDocument, not all Document objects.
18 61
4–61Only supported for HTMLDocument, not all Document objects.
≤12.1 3.2
1–3.2Only supported for HTMLDocument, not all Document objects.
1.0 4.4 3.2
1–3.2Only supported for HTMLDocument, not all Document objects.

© 2005–2025 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Document/anchors