Cette page a été traduite à partir de l'anglais par la communauté. Vous pouvez contribuer en rejoignant la communauté francophone sur MDN Web Docs.

View in English Always switch to English

HTMLFencedFrameElement : propriété config

Limited availability

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

Expérimental: Cette fonction est expérimentale
Puisque cette fonction est toujours en développement dans certains navigateurs, veuillez consulter le tableau de compatibilité pour les préfixes à utiliser selon les navigateurs.
Il convient de noter qu'une fonctionnalité expérimentale peut voir sa syntaxe ou son comportement modifié dans le futur en fonction des évolutions de la spécification.

La propriété config de l'interface HTMLFencedFrameElement contient un objet FencedFrameConfig, qui représente la navigation d'un élément HTML <fencedframe>, c'est-à-dire le contenu qui y sera affiché. Un FencedFrameConfig est renvoyé par une source telle que l'API Protected Audience.

Valeur

La valeur par défaut de config est null.

Lorsque sa valeur est définie sur une instance d'objet FencedFrameConfig, les propriétés internes du FencedFrameConfig (par exemple mappedURL) déterminent ce qui est chargé à l'intérieur du <fencedframe> associé. De plus :

  • Le type de navigation sera "replace" (voir NavigateEvent.navigationType), ce qui signifie que l'entrée d'historique courante est remplacée par la nouvelle, au lieu d'ajouter une nouvelle entrée d'historique.
  • La Referrer-Policy de la navigation est définie sur "no-referrer".

Exemples

Pour définir le contenu affiché dans un <fencedframe>, une API d'utilisation (comme Protected Audience ou Shared Storage) génère un objet FencedFrameConfig, qui est ensuite affecté à la propriété config du <fencedframe>.

L'exemple suivant récupère un FencedFrameConfig depuis une enchère publicitaire de l'API Protected Audience, qui est ensuite utilisé pour afficher la publicité gagnante dans un <fencedframe> :

js
const frameConfig = await navigator.runAdAuction({
  // … configuration de l'enchère
  resolveToConfig: true,
});

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

Note : Il faut passer resolveToConfig: true à l'appel de runAdAuction() pour obtenir un objet FencedFrameConfig. Si ce n'est pas le cas, la promesse (Promise) résultante renverra un URN qui ne peut être utilisé que dans un élément HTML <iframe>.

Spécifications

Specification
Fenced Frame
# dom-htmlfencedframeelement-config

Compatibilité des navigateurs

Voir aussi