From dfd589e43fc6c94f3bb8b522c03496508f7d962b Mon Sep 17 00:00:00 2001 From: SphinxKnight Date: Tue, 12 Oct 2021 12:39:06 +0200 Subject: Fixes #2473 (#2494) * Revamp fr version to match current en-US - fixes #2473 * Reword per review --- .../using_templates_and_slots/index.html | 302 +++++++++++---------- 1 file changed, 157 insertions(+), 145 deletions(-) diff --git a/files/fr/web/web_components/using_templates_and_slots/index.html b/files/fr/web/web_components/using_templates_and_slots/index.html index 04f5b6e023..860628ec06 100644 --- a/files/fr/web/web_components/using_templates_and_slots/index.html +++ b/files/fr/web/web_components/using_templates_and_slots/index.html @@ -1,42 +1,41 @@ --- -title: Utilisation des templates et des slots +title: Utiliser les éléments template et slot slug: Web/Web_Components/Using_templates_and_slots -tags: - - Composant web - - HTML - - Template - - shadow dom - - slot translation_of: Web/Web_Components/Using_templates_and_slots original_slug: Web/Web_Components/Utilisation_des_templates_et_des_slots ---
{{DefaultAPISidebar("Web Components")}}
-

Cet article explique comment vous pouvez utiliser les éléments {{htmlelement("template")}} et {{htmlelement("slot")}} pour créer un template flexible qui peut ensuite être utilisé pour alimenter le Shadow DOM d'un composant Web.

+

Cet article explique comment utiliser les éléments <template> et <slot> pour créer un modèle (template) flexible qui peut ensuite être utilisé pour alimenter le Shadow DOM d'un composant web.

-

La vérité sur les templates

+

La vérité sur les modèmes

-

Lorsqu'une structure de balises se répète sur une page Web, il est judicieux d'utiliser un template plutôt que d'écrire cette même structure encore et encore. Il était déjà possible de le faire, mais l'élément HTML {{htmlelement("template")}} (bien supporté par les navigateurs modernes) nous facilite la tâche. Cet élément et ce qu'il renferme n'est pas directement retranscrit dans le DOM, mais peut par contre toujours être manipulé avec JavaScript.

+

Lorsqu'une structure de balises se répète sur une page web, il est judicieux d'utiliser un modèle plutôt que d'écrire cette même structure encore et encore. Il était déjà possible de le faire, mais l'élément HTML <template> (pris en charge par les navigateurs modernes) nous facilite la tâche. Cet élément et ce qu'il renferme n'est pas directement retranscrit dans le DOM, mais peut par contre toujours être manipulé avec JavaScript.

-

Voyons un exemple simple:

+

Voyons un exemple simple :

-
<template id="my-paragraph">
+
+<template id="my-paragraph">
   <p>My paragraph</p>
-</template>

+</template>
+
-

Le tag <template> et ce qu'il contient restera invisible sur la page tant qu'aucune référence n'y sera faite dans le code JavaScript puis ajouté au DOM, en utilisant par exemple:

+

Ceci restera invisible sur la page tant qu'aucune référence n'y sera faite dans le code JavaScript puis ajouté au DOM, en utilisant par exemple :

-
let template = document.getElementById('my-paragraph');
+
+let template = document.getElementById('my-paragraph');
 let templateContent = template.content;
-document.body.appendChild(templateContent);

+document.body.appendChild(templateContent);
+
-

Quoique trivial, cet exemple vous permet d'entrevoir l'interêt d'utiliser des templates.

+

Quoique trivial, cet exemple vous permet d'entrevoir l'interêt d'utiliser des modèles.

-

Accorder templates et composants Web

+

Accorder modèles et composants web

-

Les templates sont utiles en eux-mêmes, mais ils fonctionnent encore mieux avec des composants Web. Créons un composant Web qui utilise notre template comme contenu de son Shadow DOM. Nous l'appellerons <my-paragraph>:

+

Les modèles sont utiles en eux-mêmes, mais ils fonctionnent encore mieux avec des composants web. Créons un composant web qui utilise notre modèle comme contenu de son Shadow DOM. Nous l'appellerons <my-paragraph> :

-
customElements.define('my-paragraph',
+
+customElements.define('my-paragraph',
   class extends HTMLElement {
     constructor() {
       super();
@@ -48,13 +47,14 @@ document.body.appendChild(templateContent);

   }
 })
-

Le point important à noter est que l'on ajoute un clone du contenu du template à la racine du DOM, créé à l'aide de la méthode {{domxref("Node.cloneNode()")}}.

+

Le point important à noter est que l'on ajoute un clone du contenu du modèle à la racine du DOM, créé à l'aide de la méthode Node.cloneNode().

-

Et parce que nous ajoutons son contenu à un Shadow DOM, on peut inclure des informations de mises en forme à l'intérieur du template dans d'un élément {{htmlelement("style")}}, qui est ensuite encapsulé à l'intérieur de l'élément personnalisé. Cette procédure n'aurait pas fonctionné si on avait ajouté le contenu à un DOM standard.

+

Et parce que nous ajoutons son contenu à un Shadow DOM, on peut inclure des informations de mise en forme à l'intérieur de l'élément <template> dans d'un élément <style>, qui est ensuite encapsulé à l'intérieur de l'élément personnalisé. Cette procédure n'aurait pas fonctionné si on avait ajouté le contenu à un DOM standard.

-

Par exemple:

+

Par exemple :

-
<template id="my-paragraph">
+
+<template id="my-paragraph">
   <style>
     p {
       color: white;
@@ -63,197 +63,209 @@ document.body.appendChild(templateContent);

     }
   </style>
   <p>My paragraph</p>
-</template>
+</template> + -

On peut maintenent utiliser le template dans le document HTML:

+

On peut maintenent utiliser le modèle dans le document HTML:

-
<my-paragraph></my-paragraph>
+
+<my-paragraph></my-paragraph>
 

 
 

-
Note: Les templates sont bien supportés par les navigateurs; l'API Shadow DOM est pris en charge par défaut dans Firefox (version 63 onwards), Chrome, Opera, et Safari. Edge travail également sur une implémentation.

+
Note : Les modèles sont bien pris en charge par les navigateurs ; l'API Shadow DOM est pris en charge par défaut dans Firefox (à partir de la version 63), Chrome, Opera, Safari et Edge (à partir de la version 70).

 

 
-
Plus de flexibilité avec les slots

+
Plus de flexibilité avec les slots

 
-
Jusque là, nous avons vu une première utilisation du tag template. Cette implémentation n'est pas très fexible; elle ne permet d'afficher que du texte, c'est à dire que son utilité est presque nulle! Il est possible d'insérer du texte dans chaque instance d'élément de façon déclarative grâce à {{htmlelement("slot")}}. Cette fonction est moins bien prise en charge que {{htmlelement("template")}}, disponible sur Chrome 53, Opera 40, Safari 10, Firefox 59, mais pas encore sur Edge.

+
Jusque-là, nous avons vu une première utilisation de l'élément <template>. Cette implémentation n'est pas très flexible ; elle ne permet d'afficher que du texte, c'est-à-dire qu'il est aussi utile qu'un paragraphe classique ! Il est possible d'insérer du texte dans chaque instance d'élément de façon déclarative grâce à <slot>. Cette fonction est moins bien prise en charge que <template>, disponible sur Chrome 53, Opera 40, Safari 10, Firefox 59 et Edge 79.

 
-
Les slots sont identifiés par leur attribut name, et permettent de définir des champs dans le template qui peuvent être alimentés avec n'importe quelle structure HTML.

+
Les emplacements (slots) sont identifiés par leur attribut name, et permettent de définir des emplacements dans le modèle qui peuvent être alimentés avec n'importe quelle structure HTML.

 
-
Donc, si on souhaite ajouter un slot dans le précédent exemple sur les templates, on peut modifier l'élément paragraphe de cette façon:

+
Donc, si on souhaite ajouter un emplacement dans le précédent exemple, on peut modifier l'élément de cette façon :

 
-
<p><slot name="my-text">My default text</slot></p>

+
+<p><slot name="my-text">Texte par défaut</slot></p>
+

 
-
Si le contenu du slot n'est pas défini quand l'élément est inclu dans la page, ou si les slots ne sont pas supportés par le navigateur, <my-paragraph>  contient simplement le texte statique précisé dans le template.

+
Si le contenu de l'emplacement n'est pas défini quand l'élément est inclus dans la page, ou si les emplacements ne sont pas pris en charge par le navigateur, <my-paragraph> contiendra simplement le texte statique précisé dans le modèle.

 
-
Pour définir le contenu du slot, on insère une structure HTML dans <my-paragraph> avec un attribut {{htmlattrxref("slot")}} dont la valeur est égale au nom du slot que l'on veut alimenter. Comme précédemment, on peut utiliser n'importe quelle structure HTML, par exemple:

+
Pour définir le contenu de l'emplacement, on insère une structure HTML dans <my-paragraph> avec un attribut slot dont la valeur est égale au nom de l'emplacement que l'on veut alimenter. Comme précédemment, on peut utiliser n'importe quelle structure HTML, par exemple :

 
-
<my-paragraph>
-  <span slot="my-text">Let's have some different text!</span>
-</my-paragraph>

+
+<my-paragraph>
+  <span slot="my-text">Voici un autre texte&nbsp;!</span>
+</my-paragraph>
+

 
 
ou

 
-
<my-paragraph>
+
+<my-paragraph>
   <ul slot="my-text">
-    <li>Let's have some different text!</li>
-    <li>In a list!</li>
+    <li>Voici un autre texte&nbsp;!</li>
+    <li>dans une liste!</li>
   </ul>
 </my-paragraph>
 

 
-

-
Note: Les éléments qui peuvent être insérés dans un slot sont dits {{domxref("Slotable")}}; quand un élément a été inséré dans un slot, il est dit slotted.

+

+  
Note : Un élément <slot> sans nom sera rempli avec l'ensemble des nœuds-fils de plus haut niveau de l'élément personnalisé qui n'ont pas d'attribut slot. Cela inclut les nœuds texte.

 

 
-
Et c'est tout pour ce premier exemple. Si vous souhaitez manipuler les slots, vous pouvez voir la page sur GitHub (voir aussi le résultat).

+
Et c'est tout pour ce premier exemple. Si vous souhaitez manipuler les emplacements, vous pouvez voir la page sur GitHub (voir aussi le résultat).

 
-
Un exemple plus complexe

+
Un exemple plus complexe

 
 
Pour finir, voyons un exemple un peu moins trivial.

 
-
The following set of code snippets show how to use {{HTMLElement("slot")}} together with {{HTMLElement("template")}} and some JavaScript to:

+
L'ensemble de fragments de code qui suit illustre comment utiliser <slot> avec <template> et un peu de JavaScript afin de :

 
 
 
-
Note that it is technically possible to use {{HTMLElement("slot")}} element without a {{HTMLElement("template")}} element, e.g., within say a regular {{HTMLElement("div")}} element, and still take advantage of the place-holder features of {{HTMLElement("slot")}} for Shadow DOM content, and doing so may indeed avoid the small trouble of needing to first access the template element's content property (and clone it). However, it is generally more practical to add slots within a {{HTMLElement("template")}} element, since you are unlikely to need to define a pattern based on an already-rendered element.

+
Il est techniquement possible d'utiliser un élément <slot> sans élément <template> (par exemple au sein d'un <div> classique) tout en tirant parti des fonctionnalités d'emplacement fournies par <slot> pour le contenu du Shadow DOM. On peut ainsi éviter d'avoir à d'abord accéder à la propriété content du modèle (et de la cloner). Toutefois, il est souvent plus pratique d'ajouter des emplacements au sein d'un élément <template>, car il est peu probable de définir un composant à partir d'un élément déjà rendu.

 
-
In addition, even if it is not already rendered, the purpose of the container as a template should be more semantically clear when using the {{HTMLElement("template")}}. In addition, {{HTMLElement("template")}} can have items directly added to it, like {{HTMLElement("td")}}, which would disappear when added to a {{HTMLElement("div")}}.

+
De plus, même si l'élément n'est pas déjà rendu, le rôle de conteneur porté par le modèle sera sémantiquement plus clair en utilisant <template>. De plus, <template> peut avoir des éléments qui lui sont directement rattachés comme <td>. Ce même élément disparaîtrait s'il était ajouté à un élément <div>.

 
 

-
Note: You can find this complete example at element-details (see it running live also).

+
Note : Vous pourrez retrouver l'exemple complet sur le dépôt GitHub pour element-details (voir également le résultat en action).

 

 
-
Creating a template with some slots

-
-
First of all, we use the {{HTMLElement("slot")}} element within a {{HTMLElement("template")}} element to create a new "element-details-template" document fragment containing some named slots:

-
-
<template id="element-details-template">
-  <style>
-  details {font-family: "Open Sans Light",Helvetica,Arial}
-  .name {font-weight: bold; color: #217ac0; font-size: 120%}
-  h4 { margin: 10px 0 -8px 0; }
-  h4 span { background: #217ac0; padding: 2px 6px 2px 6px }
-  h4 span { border: 1px solid #cee9f9; border-radius: 4px }
-  h4 span { color: white }
-  .attributes { margin-left: 22px; font-size: 90% }
-  .attributes p { margin-left: 16px; font-style: italic }
-  </style>
-  <details>
-    <summary>
-      <span>
-        <code class="name">&lt;<slot name="element-name">NEED NAME</slot>&gt;</code>
-        <i class="desc"><slot name="description">NEED DESCRIPTION</slot></i>
-      </span>
-    </summary>
-    <div class="attributes">
-      <h4><span>Attributes</span></h4>
-      <slot name="attributes"><p>None</p></slot>
-    </div>
-  </details>
-  <hr>
+
Créer un modèle avec des emplacements

+
+
Tout d'abord, on utilise l'élément <slot> au sein d'un élément <template> afin de créer notre nouveau fragment de document "element-details-template" qui contient quelques emplacements nommés :

+
+
+<template id="element-details-template">
+  <style>
+  details {font-family: "Open Sans Light",Helvetica,Arial}
+  .name {font-weight: bold; color: #217ac0; font-size: 120%}
+  h4 { margin: 10px 0 -8px 0; }
+  h4 span { background: #217ac0; padding: 2px 6px 2px 6px }
+  h4 span { border: 1px solid #cee9f9; border-radius: 4px }
+  h4 span { color: white }
+  .attributes { margin-left: 22px; font-size: 90% }
+  .attributes p { margin-left: 16px; font-style: italic }
+  </style>
+  <details>
+    <summary>
+      <span>
+        <code class="name">&lt;<slot name="element-name">BESOIN D'UN NOM</slot>&gt;</code>
+        <i class="desc"><slot name="description">BESOIN D'UNE DESCRIPTION</slot></i>
+      </span>
+    </summary>
+    <div class="attributes">
+      <h4><span>Attributs</span></h4>
+      <slot name="attributes"><p>Aucun</p></slot>
+    </div>
+  </details>
+  <hr>
 </template>
 

 
-
That {{HTMLElement("template")}} element has several features:

+
Voyons les caractéristiques de cet élément <template> :

 
 
    
- 
  • The {{HTMLElement("template")}} has a {{HTMLElement("style")}} element with a set of CSS styles that are scoped just to the document fragment the  {{HTMLElement("template")}} creates.
    • 
- 
  • The {{HTMLElement("template")}} uses {{HTMLElement("slot")}} and its {{htmlattrxref("name", "slot")}} attribute to make three named slots:
-  
      
-   
    • <slot name="element-name">
      • 
-   
    • <slot name="description">
      • 
-   
    • <slot name="attributes">
      • 
-  
    
- 
    • 
- 
  • The {{HTMLElement("template")}} wraps the named slots in a {{HTMLElement("details")}} element.
    • 
+	
  • Ce <template> contient un élément <style> avec un ensemble de règles CSS dont la portée est celle du fragment de document créé par l'élément <template>.
    • 
+	
  • Ce <template> utilise un élément <slot> et l'attribut name correspondant afin d'avoir trois emplacements nommés :
+	
      
+		
    • <slot name="element-name">
      • 
+		
    • <slot name="description">
      • 
+		
    • <slot name="attributes">
      • 
+	
    
+	
    • 
+	
  • L'élément <template> intègre les emplacements nommés slots dans un élément <details>.
    • 
 

 
-
Creating a new <element-details> element from the <template>

+
Créer un nouvel élément element-details avec le modèle

 
-
Next, let’s create a new custom element named <element-details> and use {{DOMXref("Element.attachShadow")}} to attach to it, as its shadow root, that document fragment we created with our {{HTMLElement("template")}} element above. This uses exactly the same pattern as we saw in our earlier trivial example.

+
Ensuite, voyons comment créer un nouvel élément personnalisé, intitulé <element-details>, et comment utiliser Element.attachShadow pour lui rattacher, comme racine virtuelle, le fragment de document créé avec l'élément <template> ci-dessus. Pour cela, on utilisera la même méthode qu'avec notre exemple plus simple.

 
-
customElements.define('element-details',
+
+customElements.define('element-details',
   class extends HTMLElement {
-    constructor() {
-      super();
-      var template = document
+    constructor() {
+      super();
+      const template = document
         .getElementById('element-details-template')
         .content;
-      const shadowRoot = this.attachShadow({mode: 'open'})
-        .appendChild(template.cloneNode(true));
-  }
-})
+      const shadowRoot = this.attachShadow({mode: 'open'})
+        .appendChild(template.cloneNode(true));
+    }
+  }
+);
 

 
-
Using the <element-details> custom element with named slots

+
Utiliser l'élément element-details avec les emplacements nommés

 
-
Now let’s take that <element-details> element and actually use it in our document:

+
Prenons maintenant un élément <element-details> et utilisons le dans notre document :

 
-
<element-details>
+
+<element-details>
   <span slot="element-name">slot</span>
-  <span slot="description">A placeholder inside a web
-    component that users can fill with their own markup,
-    with the effect of composing different DOM trees
-    together.</span>
+  <span slot="description">Un emplacement dans un
+    composant web que les utilisateurs pourront remplir
+    avec leur propre contenu pour composer plusieurs
+    arbres DOM ensemble.</span>
   <dl slot="attributes">
     <dt>name</dt>
-    <dd>The name of the slot.</dd>
+    <dd>Le nom de l'emplacement.</dd>
   </dl>
 </element-details>
 
 <element-details>
   <span slot="element-name">template</span>
-  <span slot="description">A mechanism for holding client-
-    side content that is not to be rendered when a page is
-    loaded but may subsequently be instantiated during
-    runtime using JavaScript.</span>
+  <span slot="description">Un mécanisme pour stocker
+    du contenu côté client qui n'est pas affiché lorsque la
+    page est chargée mais lors de l'exécution avec du code
+    JavaScript.</span>
 </element-details>
 

 
-
About that snippet, notice these points:

+
En voyant ce fragment, notons quelques points :

 
 
    
- 
  • The snippet has two instances of <element-details> elements which both use the {{htmlattrxref("slot")}} attribute to reference the named slots "element-name" and "description" we put in the <element-details> shadow root .
    • 
- 
  • Only the first of those two <element-details> elements references the "attributes" named slot. The second <element-details> element lacks any reference to the "attributes" named slot.
    • 
- 
  • The first <element-details> element references the "attributes" named slot using a {{HTMLElement("dl")}} element with {{HTMLElement("dt")}} and {{HTMLElement("dd")}} children.
    • 
+	
  • Ce fragment contient deux exemplaires <element-details> qui utilisent tous les deux l'attribut slot afin de référencer les emplacements nommés "element-name" et "description" qui sont inscrits dans la racine virtuelle <element-details>.
    • 
+	
  • Seul le premier élément <element-details> fait référence à l'emplacement nommé "attributes". Le deuxième élément <element-details> n'y fait pas référence.
    • 
+	
  • Le premier élément <element-details> fait référence à l'emplacement nommé "attributes" en utilisant un élément <dl> contenant comme enfants un élément <dt> et un élément <dd>.
    • 
 

 
-
Adding a final bit of style

+
Mettre le tout en forme

 
-
As a finishing touch, we'll add a tiny bit more CSS for the {{HTMLElement("dl")}}, {{HTMLElement("dt")}}, and {{HTMLElement("dd")}} elements in our doc:

+
Pour finir, ajoutons un peu de CSS pour les éléments <dl>, <dt> et <dd> de notre document :

 
-
  dl { margin-left: 6px; }
-  dt { font-weight: bold; color: #217ac0; font-size: 110% }
-  dt { font-family: Consolas, "Liberation Mono", Courier }
-  dd { margin-left: 16px }
+
+dl { margin-left: 6px; }
+dt { font-weight: bold; color: #217ac0; font-size: 110% }
+dt { font-family: Consolas, "Liberation Mono", Courier }
+dd { margin-left: 16px }
 

 
 
 
-
Result

+
Résultat

 
-
Finally let’s put all the snippets together and see what the rendered result looks like.

+
Assemblons l'ensemble des fragments pour voir le résultat final.

 
-
{{ EmbedLiveSample('full_example', '300','400','https://mdn.mozillademos.org/files/14553/element-details.png','') }}

+
{{ EmbedLiveSample('exemple_complet', '300','400','element-details.png','') }}

 
-
Notice the following points about this rendered result:

+
Quelques notes à propos du résultat affiché :

 
 
    
- 
  • Even though the instances of the <element-details> element in the document do not directly use the {{HTMLElement("details")}} element, they get rendered using {{HTMLElement("details")}} because the shadow root causes them to get populated with that.
    • 
- 
  • Within the rendered {{HTMLElement("details")}} output, the content in the <element-details> elements fills the named slots from the shadow root. In other words, the DOM tree from the <element-details> elements get composed together with the content of the shadow root.
    • 
- 
  • For both <element-details> elements, an Attributes heading gets automatically added from the shadow root before the position of the "attributes" named slot.
    • 
- 
  • Because the first <element-details> has a {{HTMLElement("dl")}} element which explicitly references the "attributes" named slot from its shadow root, the contents of that {{HTMLElement("dl")}} replace the "attributes" named slot from the shadow root.
    • 
- 
  • Because the second <element-details> doesn’t explicitly reference the "attributes" named slot from its shadow root, its content for that named slot gets filled with the default content for it from the shadow root.
    • 
+	
  • Bien que les exemplaires des éléments <element-details> du document n'utilisent pas directement d'élément <details>, ils sont rendus comme celui-ci, car <details> la racine virtuelle les peuple avec ceci.
    • 
+	
  • Au sein de l'élément <details> affiché, le contenu des éléments <element-details> remplit les emplacements nommés de la racine virtuelle. Autrement dit, l'arbre du DOM pour les éléments <element-details> est composé avec le contenu de la racine virtuelle.
    • 
+	
  • Pour les deux éléments <element-details>, un titre Attributs est automatiquement ajouté à partir de la racine virtuelle avant la position de l'emplacement nommé "attributes".
    • 
+	
  • Étant donné que le premier élément <element-details> possède un élément <dl> qui référence explicitement l'emplacement nommé "attributes" depuis sa racine virtuelle, les contenus de <dl> remplacent l'emplacement nommé "attributes" de la racine virtuelle.
    • 
+	
  • Comme le second élément <element-details> ne fait pas explicitement référence à l'emplacement nommé "attributes" depuis sa racine virtuelle, le contenu de cet emplacement nommé est rempli avec le contenu par défaut fourni par la racine virtuelle.
    • 
 

 
-

 
     <element-details>
       <span slot="element-name">slot</span>
-      <span slot="description">A placeholder inside a web
-        component that users can fill with their own markup,
-        with the effect of composing different DOM trees
-        together.</span>
+      <span slot="description">Un emplacement dans un
+        composant web que les utilisateurs pourront remplir
+        avec leur propre contenu pour composer plusieurs
+        arbres DOM ensemble.</span>
       <dl slot="attributes">
         <dt>name</dt>
-        <dd>The name of the slot.</dd>
+        <dd>Le nom de l'emplacement.</dd>
       </dl>
     </element-details>
 
     <element-details>
       <span slot="element-name">template</span>
-      <span slot="description">A mechanism for holding client-
-        side content that is not to be rendered when a page is
-        loaded but may subsequently be instantiated during
-        runtime using JavaScript.</span>
+      <span slot="description">Un mécanisme pour stocker
+        du contenu côté client qui n'est pas affiché lorsque la
+        page est chargée mais lors de l'exécution avec du code
+        JavaScript.</span>
     </element-details>
 
     <script>
-- 
cgit v1.2.3-54-g00ecf