HTMLIFrameElement: browsingTopics property

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

Non-standard: This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

Warning: This feature is currently opposed by two browser vendors. See the Standards positions section for details of opposition.

The browsingTopics property of the HTMLIFrameElement interface is a boolean specifying that the selected topics for the current user should be sent with the request for the associated <iframe>'s source in a Sec-Browsing-Topics header. This reflects the browsingtopics HTML attribute.

See Using the Topics API for more details.

Value

A boolean. The default value is false; set it to true to send the associated <iframe> source request with a Sec-Browsing-Topics header containing the selected topics for the current user.

Examples

Get

Set browsingtopics to true then load the <iframe> contents declaratively:

html
<iframe browsingtopics title="Advertising container" src="ad-tech1.example">
  ...
</iframe>

Log the browsingTopics value via script:

js
const iframeElem = document.querySelector("iframe");
console.log(iframeElem.browsingTopics); // will return true in supporting browsers

Set

Specify a minimum <iframe>:

html
<iframe> ... </iframe>

Set browsingtopics to true then load the <iframe> contents via script:

js
const iframeElem = document.querySelector("iframe");

iframeElem.browsingTopics = true;
iframeElem.title = "Advertising container";
iframeElem.src = "ad-tech1.example";

Specifications

This feature is not part of an official standard, although it is specified in the Topics API Unofficial Proposal Draft.

Browser compatibility

Loading BCD table

See also