Template, slot, dan bayangan

Manfaat komponen web adalah dapat digunakan kembali: Anda dapat membuat widget UI sekali, dan menggunakannya kembali beberapa kali. Meskipun Anda memerlukan JavaScript untuk membuat komponen web, Anda tidak memerlukan library JavaScript. HTML dan API terkait menyediakan semua yang Anda butuhkan.

Standar Komponen Web terdiri dari tiga bagian: Template HTML, Elemen Kustom, dan Shadow DOM. Jika digabungkan, Anda dapat membuat elemen yang disesuaikan, mandiri (dienkapsulasi), dan dapat digunakan kembali yang dapat diintegrasikan dengan lancar ke dalam aplikasi yang ada, seperti elemen HTML lain yang telah kita bahas.

Di bagian ini, kita akan membuat elemen <star-rating>, komponen web yang memungkinkan pengguna memberi rating pengalaman dalam skala satu hingga lima bintang. Saat memberi nama elemen kustom, sebaiknya gunakan semua huruf kecil. Sertakan tanda hubung, karena ini membantu membedakan antara elemen reguler dan kustom.

Kita akan membahas penggunaan elemen <template> dan <slot>, atribut slot, dan JavaScript untuk membuat template dengan Shadow DOM yang dienkapsulasi. Kita menggunakan kembali elemen yang ditentukan, menyesuaikan bagian teks, seperti yang Anda lakukan pada elemen atau komponen web apa pun. Kami juga membahas secara singkat penggunaan CSS dari dalam dan luar elemen kustom.

Elemen <template>

Elemen <template> digunakan untuk mendeklarasikan fragmen HTML yang akan di-clone dan disisipkan ke dalam DOM dengan JavaScript. Konten elemen tidak dirender secara default. Namun, elemen tersebut dibuat menggunakan JavaScript.

<template id="star-rating-template">
  <form>
    <fieldset>
      <legend>Rate your experience:</legend>
      <rating>
        <input type="radio" name="rating" value="1" aria-label="1 star" required />
        <input type="radio" name="rating" value="2" aria-label="2 stars" />
        <input type="radio" name="rating" value="3" aria-label="3 stars" />
        <input type="radio" name="rating" value="4" aria-label="4 stars" />
        <input type="radio" name="rating" value="5" aria-label="5 stars" />
      </rating>
    </fieldset>
    <button type="reset">Reset</button>
    <button type="submit">Submit</button>
  </form>
</template>

Karena konten elemen <template> tidak ditulis ke layar, <form> dan kontennya tidak dirender. Output CodePen berikut tampak kosong. Buka tab HTML untuk melihat markup <template>.

Dalam contoh ini, <form> bukan turunan dari <template> di DOM. Sebaliknya, konten elemen <template> adalah turunan dari DocumentFragment yang ditampilkan oleh properti HTMLTemplateElement.content. Agar dapat terlihat, JavaScript harus digunakan untuk mengambil konten dan menambahkan konten tersebut ke DOM.

JavaScript ini tidak membuat elemen kustom. Namun, contoh ini telah menambahkan konten <template> ke dalam <body>. Konten telah menjadi bagian dari DOM yang terlihat dan dapat diberi gaya.

CodePen seperti yang muncul di DOM.

Mewajibkan JavaScript untuk menerapkan template hanya untuk satu rating bintang tidak terlalu berguna, tetapi membuat komponen web untuk widget rating bintang yang dapat disesuaikan dan digunakan berulang kali akan berguna.

Elemen <slot>

Kami menyertakan slot untuk menyertakan legenda yang disesuaikan per kemunculan. HTML menyediakan elemen <slot> sebagai placeholder di dalam <template> yang, jika diberi nama, akan membuat "slot bernama". Slot bernama dapat digunakan untuk menyesuaikan konten dalam komponen web. Elemen <slot> memberi kita cara untuk mengontrol tempat turunan elemen kustom harus disisipkan dalam shadow tree-nya.

Dalam template, kita mengubah <legend> menjadi <slot>:

<template id="star-rating-template">
  <form>
    <fieldset>
      <slot name="star-rating-legend">
        <legend>Rate your experience:</legend>
      </slot>

Atribut name digunakan untuk menetapkan slot ke elemen lain jika elemen tersebut memiliki atribut slot yang nilainya cocok dengan nama slot bernama. Jika elemen kustom tidak memiliki kecocokan untuk slot, konten <slot> akan dirender. Jadi, kami menyertakan <legend> dengan konten generik yang dapat dirender saat siapa pun menambahkan <star-rating></star-rating>, tanpa konten, dalam HTML mereka.

<star-rating>
  <legend slot="star-rating-legend">Blendan Smooth</legend>
</star-rating>
<star-rating>
  <legend slot="star-rating-legend">Hoover Sukhdeep</legend>
</star-rating>
<star-rating>
  <legend slot="star-rating-legend">Toasty McToastface</legend>
  <p>Is this text visible?</p>
</star-rating>

Atribut slot adalah atribut global yang digunakan untuk mengganti konten <slot> dalam <template>. Dalam elemen kustom kami, elemen dengan atribut slot adalah <legend>. Hal itu tidak diperlukan. Dalam template kami, <slot name="star-rating-legend"> diganti dengan <anyElement slot="star-rating-legend">, dengan <anyElement> dapat berupa elemen apa pun, bahkan elemen kustom lainnya.

Elemen yang tidak ditentukan

Dalam <template>, kita menggunakan elemen <rating>. Elemen ini bukan elemen kustom. Sebaliknya, elemen ini adalah elemen yang tidak diketahui. Browser tidak akan gagal saat tidak mengenali elemen. Elemen HTML yang tidak dikenali diperlakukan oleh browser sebagai elemen inline anonim yang dapat diberi gaya dengan CSS. Serupa dengan <span>, elemen <rating> dan <star-rating> tidak memiliki gaya atau semantik yang diterapkan agen pengguna.

Di CodePen ini, <template> dan konten tidak dirender. <template> adalah elemen yang diketahui berisi konten yang tidak akan dirender. Elemen <star-rating> belum ditentukan. Sebelum kita menentukan elemen, browser akan menampilkannya seperti semua elemen yang tidak dikenali. Untuk saat ini, <star-rating> yang tidak dikenali diperlakukan sebagai elemen inline anonim, sehingga konten termasuk legenda dan <p> di <star-rating> ketiga ditampilkan seperti jika berada di <span>.

Mari kita tentukan elemen kita untuk mengonversi elemen yang tidak dikenali ini menjadi elemen kustom.

Elemen khusus

JavaScript diperlukan untuk menentukan elemen kustom. Saat ditentukan, konten elemen <star-rating> diganti dengan root shadow yang berisi semua konten template yang kita kaitkan dengannya. Elemen <slot> dari template diganti dengan konten elemen dalam <star-rating> yang nilai atribut slot-nya cocok dengan nilai nama <slot>, jika ada. Jika tidak, konten slot template akan ditampilkan.

Konten dalam elemen kustom yang tidak terkait dengan slot—<p>Is this text visible?</p> di <star-rating> ketiga—tidak disertakan dalam root bayangan sehingga tidak ditampilkan.

Kita menentukan elemen kustom bernama star-rating dengan memperluas HTMLElement:

customElements.define('star-rating',
  class extends HTMLElement {
    constructor() {
      super(); // Always call super first in constructor
      const starRating = document.getElementById('star-rating-template').content;
      const shadowRoot = this.attachShadow({
        mode: 'open'
      });
      shadowRoot.appendChild(starRating.cloneNode(true));
    }
  });

Setelah elemen ditentukan, setiap kali browser menemukan elemen <star-rating>, elemen tersebut akan dirender seperti yang ditentukan oleh elemen dengan #star-rating-template, yang merupakan template kita. Browser akan melampirkan hierarki shadow DOM ke node, menambahkan clone konten template ke shadow DOM tersebut.

const shadowRoot = this.attachShadow({mode: 'open'});
shadowRoot.appendChild(starRating.cloneNode(true));

Jika Anda melihat alat developer, Anda akan melihat <form> dari <template> adalah bagian dari shadow root setiap elemen kustom. Klon konten <template> terlihat di setiap elemen kustom di alat developer dan terlihat di browser, tetapi konten elemen kustom itu sendiri tidak dirender ke layar.

Screenshot DevTools yang menampilkan konten template yang di-clone di setiap elemen kustom.

Dalam contoh <template>, kita menambahkan konten template ke isi dokumen, sehingga menambahkan konten ke DOM reguler. Dalam definisi customElements, kita menggunakan appendChild() yang sama, tetapi konten template yang di-clone ditambahkan ke shadow DOM yang dienkapsulasi.

Apakah Anda melihat bagaimana bintang-bintang kembali menjadi tombol pilihan tanpa gaya? Karena merupakan bagian dari shadow DOM, bukan DOM standar, gaya visual dalam tab CSS CodePen tidak berlaku. Gaya CSS tab tersebut dicakupkan ke dokumen, bukan ke shadow DOM, sehingga gaya tidak diterapkan. Kita harus membuat gaya yang dienkapsulasi untuk menata gaya konten Shadow DOM yang dienkapsulasi.

Shadow DOM

Shadow DOM mencakup gaya CSS ke setiap shadow tree, sehingga mengisolasinya dari bagian dokumen lainnya. Artinya, CSS eksternal tidak berlaku untuk komponen Anda, dan gaya komponen tidak berpengaruh pada bagian dokumen lainnya, kecuali jika kita sengaja mengarahkannya.

Karena kita telah menambahkan konten ke shadow DOM, kita dapat menyertakan elemen <style> yang menyediakan CSS yang dienkapsulasi ke elemen kustom.

Karena ini dicakupkan ke elemen kustom, kita tidak perlu khawatir gaya akan merembes ke bagian dokumen lainnya. Kita dapat mengurangi kekhususan pemilih secara signifikan. Misalnya, karena satu-satunya input yang digunakan dalam elemen kustom adalah tombol pilihan, kita dapat menggunakan input, bukan input[type="radio"] sebagai pemilih.

 <template id="star-rating-template">
  <style>
    rating {
      display: inline-flex;
    }
    input {
      appearance: none;
      margin: 0;
      box-shadow: none;
    }
    input::after {
      content: '\2605'; /* solid star */
      font-size: 32px;
    }
    rating:hover input:invalid::after,
    rating:focus-within input:invalid::after {
      color: #888;
    }
    input:invalid::after,
      rating:hover input:hover ~ input:invalid::after,
      input:focus ~ input:invalid::after  {
      color: #ddd;
    }
    input:valid {
      color: orange;
    }
    input:checked ~ input:not(:checked)::after {
      color: #ccc;
      content: '\2606'; /* hollow star */
    }
  </style>
  <form>
    <fieldset>
      <slot name="star-rating-legend">
        <legend>Rate your experience:</legend>
      </slot>
      <rating>
        <input type="radio" name="rating" value="1" aria-label="1 star" required/>
        <input type="radio" name="rating" value="2" aria-label="2 stars"/>
        <input type="radio" name="rating" value="3" aria-label="3 stars"/>
        <input type="radio" name="rating" value="4" aria-label="4 stars"/>
        <input type="radio" name="rating" value="5" aria-label="5 stars"/>
      </rating>
    </fieldset>
    <button type="reset">Reset</button>
    <button type="submit">Submit</button>
  </form>
</template>

Meskipun komponen web dienkapsulasi dengan markup dalam <template> dan gaya CSS dicakupkan ke shadow DOM dan disembunyikan dari semua hal di luar komponen, konten slot yang dirender, bagian <anyElement slot="star-rating-legend"> dari <star-rating>, tidak dienkapsulasi.

Menata gaya di luar cakupan saat ini

Meskipun memungkinkan, tidaklah mudah untuk menata gaya dokumen dari dalam shadow DOM dan menata gaya konten shadow DOM dari gaya global. Batas shadow, tempat shadow DOM berakhir dan DOM reguler dimulai, dapat dilintasi, tetapi hanya dengan sengaja.

Hierarki shadow adalah hierarki DOM di dalam shadow DOM. Root bayangan adalah node root dari hierarki bayangan.

Class pseudo :host memilih <star-rating>, elemen host shadow. Shadow host adalah node DOM yang menjadi tempat shadow DOM dilampirkan. Untuk menargetkan hanya versi host tertentu, gunakan :host(). Fungsi ini hanya memilih elemen shadow host yang cocok dengan parameter yang diteruskan, seperti pemilih class atau atribut. Untuk memilih semua elemen kustom, Anda dapat menggunakan star-rating { /* styles */ } di CSS global, atau :host(:not(#nonExistantId)) di gaya template. Dalam hal kekhususan, CSS global lebih diprioritaskan.

Elemen semu ::slotted() melintasi batas shadow DOM dari dalam shadow DOM. Pemilih ini memilih elemen slot jika cocok dengan pemilih. Dalam contoh kita, ::slotted(legend) cocok dengan tiga legenda kita.

Untuk menargetkan shadow DOM dari CSS dalam cakupan global, template perlu diedit. Atribut part dapat ditambahkan ke elemen apa pun yang ingin Anda beri gaya. Kemudian, gunakan elemen semu ::part() untuk mencocokkan elemen dalam shadow tree yang cocok dengan parameter yang diteruskan. Elemen anchor atau asal untuk pseudo-elemen adalah host, atau nama elemen kustom, dalam hal ini star-rating. Parameter adalah nilai atribut part.

Jika markup template kita dimulai seperti ini:

<template id="star-rating-template">
  <form part="formPart">
    <fieldset part="fieldsetPart">

Kita dapat menargetkan <form> dan <fieldset> dengan:

star-rating::part(formPart) { /* styles */ }
star-rating::part(fieldsetPart) { /* styles */ }

Nama bagian berfungsi mirip dengan class: elemen dapat memiliki beberapa nama bagian yang dipisahkan spasi, dan beberapa elemen dapat memiliki nama bagian yang sama.

Google memiliki checklist yang fantastis untuk membuat elemen kustom. Anda mungkin juga ingin mempelajari shadow DOM deklaratif.

Uji pemahaman Anda

Uji pengetahuan Anda tentang template, slot, dan shadow.

Secara default, gaya dari luar shadow DOM akan menata gaya elemen di dalamnya.

Benar.
Coba lagi.
Salah.
Benar.

Jawaban mana yang merupakan deskripsi yang benar tentang elemen <template>?

Elemen umum yang digunakan untuk menampilkan konten apa pun di halaman Anda.
Coba lagi.
Elemen placeholder.
Coba lagi.
Elemen yang digunakan untuk mendeklarasikan fragmen HTML, yang tidak akan dirender secara default.
Benar.