HTMLFencedFrameElement: config-Eigenschaft

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Die config-Eigenschaft des HTMLFencedFrameElement enthält ein FencedFrameConfig-Objekt, das die Navigation eines <fencedframe> darstellt, d.h. welche Inhalte darin angezeigt werden. Ein FencedFrameConfig wird von einer Quelle wie der Protected Audience API zurückgegeben.

Wert

Der anfängliche Wert von config ist null.

Wenn der Wert auf eine Instanz eines FencedFrameConfig-Objekts gesetzt wird, bestimmen die internen Eigenschaften des FencedFrameConfig (zum Beispiel mappedURL), was im zugehörigen <fencedframe> geladen wird. Zusätzlich:

  • Der Navigationstyp wird "replace" sein (siehe NavigateEvent.navigationType), was bedeutet, dass der aktuelle Verlaufs-Eintrag durch den neuen Eintrag ersetzt wird, anstatt einen neuen Verlaufseintrag hinzuzufügen.
  • Die Referrer-Policy der Navigation ist auf "no-referrer" gesetzt.

Beispiele

Um festzulegen, welche Inhalte in einem <fencedframe> angezeigt werden, generiert eine nutzende API (wie die Protected Audience oder Shared Storage) ein FencedFrameConfig-Objekt, das dann als Wert der config-Eigenschaft des <fencedframe> gesetzt wird.

Das folgende Beispiel erhält ein FencedFrameConfig von einer Werbeauktion der Protected Audience API, das dann verwendet wird, um die gewonnene Anzeige in einem <fencedframe> anzuzeigen:

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

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

Hinweis: resolveToConfig: true muss an den Aufruf von runAdAuction() übergeben werden, um ein FencedFrameConfig-Objekt zu erhalten. Wenn es nicht gesetzt ist, wird das resultierende Promise zu einem URN aufgelöst, das nur in einem <iframe> verwendet werden kann.

Spezifikationen

Specification
Fenced Frame
# dom-htmlfencedframeelement-config

Browser-Kompatibilität

Siehe auch