Şablon, alan ve gölge

Web bileşenlerinin avantajı, yeniden kullanılabilir olmalarıdır: Bir kullanıcı arayüzü widget'ını bir kez oluşturup birden çok kez yeniden kullanabilirsiniz. Web bileşenleri oluşturmak için JavaScript'e ihtiyacınız olsa da JavaScript kitaplığına ihtiyacınız yoktur. HTML ve ilişkili API'ler, ihtiyacınız olan her şeyi sağlar.

Web Bileşeni standardı üç bölümden oluşur: HTML şablonları, Özel Öğeler ve Gölge DOM. Bunları birleştirerek, daha önce ele aldığımız diğer HTML öğeleri gibi mevcut uygulamalara sorunsuz bir şekilde entegre edilebilen özelleştirilmiş, bağımsız (kapsüllenmiş) ve yeniden kullanılabilir öğeler oluşturabilirsiniz.

Bu bölümde, kullanıcıların bir deneyimi bir ila beş yıldız arasında derecelendirmesine olanak tanıyan bir web bileşeni olan <star-rating> öğesini oluşturacağız. Özel öğeleri adlandırırken tüm harfleri küçük yazmanız önerilir. Normal ve özel öğeleri ayırt etmeye yardımcı olduğu için tire kullanın.

Kapsüllenmiş bir gölge DOM ile şablon oluşturmak için <template> ve <slot> öğelerini, slot özelliğini ve JavaScript'i kullanmayı ele alıyoruz. Tanımlanan öğeyi yeniden kullanır, metnin bir bölümünü özelleştiririz. Bu, herhangi bir öğeyi veya web bileşenini özelleştirmeye benzer. Ayrıca özel öğenin içinden ve dışından CSS kullanma konusuna da kısaca değineceğiz.

<template> öğesi

<template> öğesi, kopyalanacak ve JavaScript ile DOM'a eklenecek HTML parçalarını bildirmek için kullanılır. Öğenin içeriği varsayılan olarak oluşturulmaz. Bunun yerine JavaScript kullanılarak örneklendirilirler.

<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>

<template> öğesinin içeriği ekrana yazılmadığından <form> ve içeriği oluşturulmaz. Aşağıdaki CodePen'in çıkışı boş görünüyor. <template> işaretlemesini görmek için HTML sekmesini açın.

Bu örnekte, <form>, DOM'da bir <template> öğesinin alt öğesi değildir. Bunun yerine, <template> öğelerinin içerikleri, HTMLTemplateElement.content özelliği tarafından döndürülen bir DocumentFragment öğesinin alt öğeleridir. Görünür hale getirilmesi için JavaScript kullanılarak içeriklerin alınması ve bu içeriklerin DOM'a eklenmesi gerekir.

Bu JavaScript, özel bir öğe oluşturmadı. Bu örnekte, <template> içeriği <body> içine eklenmiştir. İçerik, görünür ve stil uygulanabilir DOM'un bir parçası haline gelmiştir.

DOM'da göründüğü şekliyle CodePen.

Yalnızca bir yıldız puanı için şablon uygulamak üzere JavaScript kullanmak pek kullanışlı değildir ancak tekrar tekrar kullanılan, özelleştirilebilir bir yıldız puanı widget'ı için web bileşeni oluşturmak faydalıdır.

<slot> öğesi

Özelleştirilmiş bir olay başına açıklama eklemek için bir alan ekleriz. HTML, bir <template> içinde yer tutucu olarak <slot> öğesi sağlar. Bu öğe, bir ad verilirse "adlandırılmış alan" oluşturur. Adlandırılmış bir alan, bir web bileşenindeki içeriği özelleştirmek için kullanılabilir. <slot> öğesi, özel bir öğenin alt öğelerinin gölge ağacında nereye yerleştirileceğini kontrol etmemizi sağlar.

Şablonumuzda <legend> değerini <slot> olarak değiştiriyoruz:

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

name özelliği, öğenin değeri adlandırılmış bir alanın adıyla eşleşen bir slot özelliği varsa diğer öğelere alan atamak için kullanılır. Özel öğenin bir alanla eşleşmesi yoksa <slot> içeriği oluşturulur. Bu nedenle, HTML'sine içerik olmadan <star-rating></star-rating> ekleyen herkes için oluşturulabilecek genel içerikli bir <legend> ekledik.

<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>

slot özelliği, bir <template> içindeki <slot> öğesinin içeriğini değiştirmek için kullanılan global bir özelliktir. Özel öğemizde, slot özelliğine sahip öğe bir <legend>. Böyle olmak zorunda değil. Şablonumuzda, <slot name="star-rating-legend">, <anyElement slot="star-rating-legend"> ile değiştirilir. Burada <anyElement>, başka bir özel öğe de dahil olmak üzere herhangi bir öğe olabilir.

Tanımlanmamış öğeler

<template> örneğimizde <rating> öğesini kullandık. Bu özel bir öğe değil. Bilinmeyen bir öğedir. Tarayıcılar, bir öğeyi tanımadıklarında hata vermez. Tanınmayan HTML öğeleri, tarayıcı tarafından CSS ile stillendirilebilen anonim satır içi öğeler olarak değerlendirilir. <span> öğesine benzer şekilde, <rating> ve <star-rating> öğelerinde kullanıcı aracısı tarafından uygulanan stiller veya semantikler yoktur.

Bu CodePen'de <template> ve içerikler oluşturulmaz. <template>, oluşturulmayacak içerik barındıran bilinen bir öğedir. <star-rating> öğesi henüz tanımlanmadı. Biz bir öğeyi tanımlayana kadar tarayıcı, bu öğeyi tanınmayan diğer öğeler gibi gösterir. Şu anda tanınmayan <star-rating>, anonim bir satır içi öğe olarak değerlendiriliyor. Bu nedenle, üçüncü <star-rating> içindeki açıklamalar ve <p> dahil olmak üzere içerik, <span> içinde yer alıyormuş gibi gösteriliyor.

Tanınmayan bu öğeyi özel bir öğeye dönüştürmek için öğemizi tanımlayalım.

Özel öğeler

Özel öğeleri tanımlamak için JavaScript gerekir. Tanımlandığında, <star-rating> öğesinin içeriği, ilişkilendirdiğimiz şablonun tüm içeriğini barındıran bir gölge kökle değiştirilir. Şablondaki <slot> öğeleri, varsa slot özellik değeri <slot>'nin ad değeriyle eşleşen <star-rating> içindeki öğenin içeriğiyle değiştirilir. Aksi takdirde, şablonun alanlarının içeriği gösterilir.

Bir yuvayla ilişkilendirilmemiş özel öğe içindeki içerik (üçüncü <star-rating> öğemizdeki <p>Is this text visible?</p>) gölge köke dahil edilmez ve bu nedenle gösterilmez.

HTMLElement öğesini genişleterek star-rating adlı özel öğeyi tanımlarız:

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));
    }
  });

Öğe tanımlandığına göre, tarayıcı her <star-rating> öğesiyle karşılaştığında öğe, şablonumuz olan #star-rating-template öğesi tarafından tanımlandığı şekilde oluşturulur. Tarayıcı, düğüme bir gölge DOM ağacı ekler ve şablon içeriklerinin bir klonunu bu gölge DOM'a ekler.

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

Geliştirici araçlarına bakarsanız <template> öğesindeki <form> öğesinin her bir özel öğenin gölge kökünün bir parçası olduğunu görürsünüz. <template> içeriğinin bir kopyası, geliştirici araçlarındaki her özel öğede görünür ve tarayıcıda görünür ancak özel öğenin içeriği ekrana oluşturulmaz.

Her bir özel öğedeki klonlanmış şablon içeriklerini gösteren Geliştirici Araçları ekran görüntüsü.

<template> örneğinde, şablon içeriklerini doküman gövdesine ekleyerek içeriği normal DOM'a ekledik. customElements tanımında aynı appendChild() öğesini kullandık ancak klonlanan şablon içerikleri kapsüllenmiş bir gölge DOM'a eklendi.

Yıldızların nasıl stil uygulanmamış radyo düğmelerine dönüştüğünü fark ettiniz mi? Standart DOM yerine gölge DOM'un bir parçası olduğu için CodePen'in CSS sekmesindeki stil uygulanmaz. Bu sekmenin CSS stilleri, gölge DOM'a değil, dokümana göre ayarlandığından stiller uygulanmaz. Kapsüllenmiş Shadow DOM içeriğimizi biçimlendirmek için kapsüllenmiş stiller oluşturmamız gerekir.

Gölge DOM

Gölge DOM, CSS stillerini her gölge ağacına göre kapsamlandırarak belgenin geri kalanından ayırır. Bu, harici CSS'nin bileşeniniz için geçerli olmadığı ve bileşen stillerinin, biz kasıtlı olarak yönlendirmediğimiz sürece belgenin geri kalanı üzerinde hiçbir etkisi olmadığı anlamına gelir.

İçerikleri bir gölge DOM'ye eklediğimiz için özel öğeye kapsüllenmiş CSS sağlayan bir <style> öğesi ekleyebiliriz.

Bu, özel öğe kapsamında olduğundan stillerin belgenin geri kalanına sızması konusunda endişelenmemiz gerekmez. Seçicilerin özgüllüğünü önemli ölçüde azaltabiliriz. Örneğin, özel öğede kullanılan tek girişler radyo düğmeleri olduğundan seçici olarak input[type="radio"] yerine input kullanabiliriz.

 <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>

Web bileşenleri <template> işaretlemesiyle kapsüllenirken ve CSS stilleri gölge DOM'un kapsamına alınıp bileşenlerin dışındaki her şeyden gizlenirken, oluşturulan alan içeriği (<star-rating> öğesinin <anyElement slot="star-rating-legend"> kısmı) kapsüllenmez.

Mevcut kapsamın dışında stil oluşturma

Dokümanı bir gölge DOM'un içinden ve gölge DOM'un içeriğini genel stillerden biçimlendirmek mümkündür ancak kolay değildir. Gölge DOM'un bittiği ve normal DOM'un başladığı gölge sınırı geçilebilir ancak bu yalnızca çok bilinçli bir şekilde yapılabilir.

Gölge ağacı, gölge DOM'un içindeki DOM ağacıdır. Gölge kök, gölge ağacının kök düğümüdür.

:host sözde sınıfı, gölge ana öğe olan <star-rating> öğesini seçer. Gölge ana makine, gölge DOM'un bağlı olduğu DOM düğümüdür. Yalnızca ana makinenin belirli sürümlerini hedeflemek için :host() kullanın. Bu, yalnızca iletilen parametreyle eşleşen gölge ana makine öğelerini seçer (ör. sınıf veya özellik seçici). Tüm özel öğeleri seçmek için genel CSS'de star-rating { /* styles */ } veya şablon stillerinde :host(:not(#nonExistantId)) kullanabilirsiniz. Belirlilik açısından global CSS kazanır.

::slotted() sözde öğesi, gölge DOM'un içinden gölge DOM sınırını geçer. Seçiciyle eşleşen bir yuvalı öğeyi seçer. Örneğimizde ::slotted(legend), üç açıklama metnimizle eşleşiyor.

Genel kapsamda CSS'den bir gölge DOM'u hedeflemek için şablonun düzenlenmesi gerekir. part özelliği, stilini belirlemek istediğiniz herhangi bir öğeye eklenebilir. Ardından, gölge ağacındaki öğeleri iletilen parametreyle eşleştirmek için ::part() sözde öğesini kullanın. Sözde öğenin sabitleyicisi veya kaynak öğesi, ana makine ya da özel öğe adıdır (bu örnekte star-rating). Parametre, part özelliğinin değeridir.

Şablon işaretlememiz şu şekilde başlarsa:

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

<form> ve <fieldset> için şu hedeflemeleri kullanabiliriz:

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

Parça adları, sınıflara benzer şekilde çalışır: Bir öğenin boşlukla ayrılmış birden fazla parça adı olabilir ve birden fazla öğe aynı parça adına sahip olabilir.

Google'ın özel öğeler oluşturma ile ilgili harika bir yapılacaklar listesi vardır. Bildirimsel gölge DOM'lar hakkında da bilgi edinmek isteyebilirsiniz.

Bilgilerinizi sınayın

Şablon, yuva ve gölge hakkındaki bilginizi test edin.

Varsayılan olarak, gölge DOM'un dışındaki stiller, içindeki öğeleri stillendirir.

Doğru.
Tekrar deneyin.
Yanlış.
Doğru!

Aşağıdakilerden hangisi <template> öğesinin doğru açıklamasıdır?

Sayfanızdaki herhangi bir içeriği görüntülemek için kullanılan genel bir öğe.
Tekrar deneyin.
Yer tutucu öğe.
Tekrar deneyin.
HTML parçalarını bildirmek için kullanılan ve varsayılan olarak oluşturulmayan bir öğe.
Doğru!