HTMLAnchorElement.referrerPolicy
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The
HTMLAnchorElement.referrerPolicy
property reflect the HTML referrerpolicy
attribute of the
<a>
element defining which referrer is sent when fetching the resource.
Value
A DOMString
; one of the following:
- no-referrer
-
The
Referer
header will be omitted entirely. No referrer information is sent along with requests. - no-referrer-when-downgrade
-
The URL is sent as a referrer when the protocol security level stays the same (e.g.HTTP→HTTP, HTTPS→HTTPS), but isn't sent to a less secure destination (e.g. HTTPS→HTTP).
- origin
-
Only send the origin of the document as the referrer in all cases. The document
https://example.com/page.html
will send the referrerhttps://example.com/
. - origin-when-cross-origin
-
Send a full URL when performing a same-origin request, but only send the origin of the document for other cases.
- same-origin
-
A referrer will be sent for same-site origins, but cross-origin requests will contain no referrer information.
- strict-origin
-
Only send the origin of the document as the referrer when the protocol security level stays the same (e.g. HTTPS→HTTPS), but don't send it to a less secure destination (e.g. HTTPS→HTTP).
- strict-origin-when-cross-origin (default)
-
This is the user agent's default behavior if no policy is specified. Send a full URL when performing a same-origin request, only send the origin when the protocol security level stays the same (e.g. HTTPS→HTTPS), and send no header to a less secure destination (e.g. HTTPS→HTTP).
- unsafe-url
-
Send a full URL when performing a same-origin or cross-origin request. This policy will leak origins and paths from TLS-protected resources to insecure origins. Carefully consider the impact of this setting.
Examples
var elt = document.createElement("a");
var linkText = document.createTextNode("My link");
elt.appendChild(linkText);
elt.href = "https://developer.mozilla.org/en-US/";
elt.referrerPolicy = "no-referrer";
var div = document.getElementById("divAround");
div.appendChild(elt); // When clicked, the link will not send a referrer header.
Specifications
Specification |
---|
HTML Standard # dom-a-referrerpolicy |
Browser compatibility
BCD tables only load in the browser