Latest web development tutorials
 

HTML DOM links Collection

< Document Object

Example

Find out how many links there are in the document:

var x = document.links.length;

The result of x will be:

5
Try it Yourself »

More "Try it Yourself" examples below.


Definition and Usage

The links collection returns a collection of all links in the document.

The links in the collection represents <a> elements and/or <area> elements with a href attribute.

Note: If the element is missing the href attribute, nothing is returned.

Note: The elements in the collection are sorted as they appear in the source code.

Tip: Also look at the Anchor Object and the Area Object.


Browser Support

Collection
links Yes Yes Yes Yes Yes

Syntax

document.links

Properties

Property Description
length Returns the number of <a> and/or <area> elements in the collection.

Note: This property is read-only

Methods

Method Description
[index] Returns the <a> and/or <area> element from the collection with the specified index (starts at 0).

Note: Returns null if the index number is out of range
item(index) Returns the <a> and/or <area> element from the collection with the specified index (starts at 0).

Note: Returns null if the index number is out of range
namedItem(id) Returns the <a> and/or <area> element from the collection with the specified id.

Note: Returns null if the id does not exist

Technical Details

DOM Version: Core Level 1 Document Object
Return Value: An HTMLCollection Object, representing all <a> elements and/or <area> elements in the document. The elements in the collection are sorted as they appear in the source code

Examples

More Examples

Example

[index]

Get the URL of the first link (index 0) in the document:

var x = document.links[0].href;

The result of x will be:

http://www.w3ii.com/jsref/sun.htm
Try it Yourself »

Example

item(index)

Get the URL of the first link (index 0) in the document:

var x = document.links.item(0).href;

The result of x will be:

http://www.w3ii.com/jsref/sun.htm
Try it Yourself »

Example

namedItem(id)

Get the URL of the element with id="myLink" in the document:

var x = document.links.namedItem("myLink").href;

The result of x will be:

http://www.w3ii.com/html/default.html
Try it Yourself »

Example

Add a red border to the first link in the document:

document.links[0].style.border = "5px solid red";
Try it Yourself »

Example

Loop through all links in the document, and output the URL (href) of each link:

var x = document.links;
var txt = "";
var i;
for (i = 0; i < x.length; i++) {
    txt = txt + x[i].href + "<br>";
}

The result of txt will be:

http://www.w3ii.com/jsref/sun.htm
http://www.w3ii.com/jsref/mercur.htm
http://www.w3ii.com/jsref/venus.htm
http://www.w3ii.com/html/default.html
http://www.w3ii.com/css/default.html
Try it Yourself »

Related Pages

JavaScript reference: HTML DOM Anchor Object

JavaScript reference: HTML DOM Area Object

HTML tutorial: HTML Links

HTML reference: HTML <a> tag

HTML reference: HTML <area> tag


< Document Object