HTMLFencedFrameElement:config 属性

实验性: 这是一种 实验性技术
在生产环境中使用此技术之前,请仔细查看 浏览器兼容性表

config 属性是 HTMLFencedFrameElement 的一个 FencedFrameConfig 对象,它表示 <fencedframe> 的导航,即将在其中显示什么内容。FencedFrameConfig 来自诸如 Protected Audience API 之类的来源。

config 的初始值为 null

当其值被设置为 FencedFrameConfig 对象实例时,FencedFrameConfig 的内部属性(例如 mappedURL)会决定在关联的 <fencedframe> 中加载什么内容。此外

  • 导航类型将为 "replace"(见 NavigateEvent.navigationType),这意味着当前历史条目将被新的条目替换,而不是为其添加新的历史条目。
  • 导航的 Referrer-Policy 设置为 "no-referrer"

示例

要设置在 <fencedframe> 中显示什么内容,可以使用 API(例如 Protected AudienceShared Storage)生成一个 FencedFrameConfig 对象,然后将其设置为 <fencedframe>config 属性的值。

以下示例从 Protected Audience API 的广告拍卖中获取 FencedFrameConfig,然后将其用于在 <fencedframe> 中显示中标广告

js
const frameConfig = await navigator.runAdAuction({
  // ...auction configuration
  resolveToConfig: true,
});

const frame = document.createElement("fencedframe");
frame.config = frameConfig;

注意: 必须将 resolveToConfig: true 传递给 runAdAuction() 调用以获取 FencedFrameConfig 对象。如果没有设置,则结果 Promise 将解析为只能在 <iframe> 中使用的 URN。

规范

规范
Fenced Frame
# dom-htmlfencedframeelement-config

浏览器兼容性

BCD 表只在启用 JavaScript 的浏览器中加载。

另请参阅