Web ve Geliştirme

Web Components: Vanilla JavaScript ile Yeniden Kullanılabilir Arayüz Bileşenleri Oluşturma

Web Components: Build Reusable UI Components with Vanilla JavaScript

Custom Elements, Shadow DOM, HTML Templates, slot'lar ve JavaScript modülleri kullanarak yeniden kullanılabilir bir arayüz kartı oluşturarak Web Components'i adım adım öğrenin. Hiçbir framework veya derleme aracı gerekmez.

Web Bileşenleri: Vanilla JavaScript ile Tekrar Kullanılabilir UI Bileşenleri Oluşturma

Bir web siteniz için bir kart oluşturup, ardından WordPress temalarında, Joomla uzantılarında veya bağımsız uygulamalarda, her ortam için tekrar yazmadan kullanabilirsiniz.

Web Bileşenleri'nin vaadi: tarayıcı native araçları ile tekrar kullanılabilecek HTML elementleri oluşturmaktır. İnceleyeceğimiz örnek için React, Vue, npm paketleri veya bir bundler gerekmez.

Bu eğitimin sonunda, özelleştirilebilir içeriği, izole stilleri, bir öne çıkan varyantı, bir kapatma düğmesi ve herkese açık bir olayı olan çalışır durumda bir <ui-card> bileşenine sahip olacaksınız. Her teknolojinin katkısını görmek için küçük adımlarla inşa edeceğiz.

Inşa Edeceğiniz Şey

Bitmiş bileşenimiz şu HTML'yi destekleyecek:

<ui-card variant="featured">
  <span slot="title">Learn Web Components</span>
  <p>Build reusable interfaces with native JavaScript.</p>
  <a slot="action" href="/tutorial">Read the tutorial</a>
</ui-card>

Görsel ön izleme — standart ve öne çıkan kartlar

Visual preview of standard and featured Web Component cards

Bu ön izleme, ilgisiz bir kitaplık'nin ekran Görüntüsü değil, tasarım hedefidir. Aşağıdaki kodu kullanarak bunu yeniden oluşturacağız.

1. Dört Temel Bileşeni Anlama

Özel Elementler, yeni bir HTML etiketi ve JavaScript davranışını kaydeder. Shadow DOM, elementin kendi iç DOM'una ve sınırlı stillerine sahip olmasını sağlar. HTML şablonları ve slotlar, her örneğe farklı içeri eklerken yapıyı tekrar kullanmamızı sağlar. ES Modülleri, bileşeni normal bir JavaScript dosyasından yüklememizi sağlar.

Bu ayrı özelliklerdir. Bir Özel Element Shadow DOM kullanmak zorunda değildir ve herhangi birini kullanmak için bir framework'e ihtiyaç duymezsiniz.

2. Proje Dosyaları Oluşturma

Editörünüzde bu yapıayı oluşturun:

web-components-demo/
├── index.html
├── components/
│   └── ui-card.js
└── css/
    └── main.css

Bunu index.html'e koyun:

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>Web Components Demo</title>
  <link rel="stylesheet" href="./css/main.css">
  <script type="module" src="./components/ui-card.js"></script>
</head>
<body>
  <main class="container">
    <h1>Reusable UI Components</h1>
    <p>Let's build a reusable card without a framework.</p>
    <ui-card></ui-card>
  </main>
</body>
</html>

Sayfa düzeyindeki stilleri css/main.css'e ekleyin:

body {
  margin: 0;
  background: #f4f6f9;
  color: #1f2937;
  font-family: system-ui, sans-serif;
}
.container {
  max-width: 900px;
  margin: 60px auto;
  padding: 0 20px;
}
ui-card {
  display: block;
  margin-top: 24px;
}

Proje dizinden yerel bir HTTP sunucusu başlatın, örneğin:

python -m http.server 8000

http://localhost:8000'ı ziyaret edin. Başlık görünür, ancak kartın görünür içeriği yoktur. Yerel dosya ithalatlarını engelleyen tarayıcı modül yükleme kuralları nedeniyle index.html'ı file:// ile açmak yerine bir HTTP sunucusu kullanın.

3. İlk Özel Elementinizi Kaydetme

components/ui-card.js oluşturun:

class UiCard extends HTMLElement {
  connectedCallback() {
    this.textContent = 'Hello from a Web Component!';
  }
}

customElements.define('ui-card', UiCard);

Sayfayı yenileyin. Şimdi şu görmeniz gerekir:

Beklenen sonuç — Adım 3

First custom element output

HTMLElement normal DOM davranışını sağlar. connectedCallback(), element belgeye bağlandığında çalışır. customElements.define(), sınıfı HTML etiketiyle eşleştirir.

ui-card'daki tire, otonom Özel Element isimleri için gereklidir. Callback, element çıkarılıp tekrar eklenirse tekrar çalışabilir, bu da initialization mantığı eklediğimizde önemli olur.

4. Kartın Kendi Tasarımını Shadow DOM ile Verme

ui-card.js'i değiştir:

class UiCard extends HTMLElement {
  connectedCallback() {
    if (this.shadowRoot) return;

    const shadow = this.attachShadow({ mode: 'open' });

    shadow.innerHTML = `
      <style>
        article {
          padding: 24px;
          background: white;
          border: 1px solid #dce3ec;
          border-radius: 12px;
        }
        h2 {
          margin: 0 0 12px;
          color: #2563eb;
        }
      </style>
      <article>
        <h2>My reusable card</h2>
        <p>This content lives inside Shadow DOM.</p>
      </article>
    `;
  }
}

customElements.define('ui-card', UiCard);

Beklenen sonuç — Adım 4

Styled card inside Shadow DOM

DevTools'ı açın, <ui-card>'ı inceleyin ve #shadow-root (open)'ı genişletin. İç makale ve stil sayfasını göreceksiniz.

Normal belge seçicilerinden farklı olarak, article { border: none } gibi global CSS bu shadow tree'ye normalde ulaşamaz. Miras özellikler ve CSS özel Stillar hala sınıra geçebilir. Shadow DOM sunumu kapsüller; ancak bir güvenlik kumandadır (not).

if (this.shadowRoot) koruması, element tekrar bağlanırsa ikinci bir shadow root eklenmesini engeller.

5. HTML Şablonu ile Düzeni Ayırma

connectedCallback()'in içine her şeyi yerleştirmek, bileşen büdükçe zorlaşır. Bir kez mark-up tanımlayıp her kart için kopyalayalım.

Dosyayı değiştir:

const template = document.createElement('template');

template.innerHTML = `
  <style>
    article {
      padding: 24px;
      background: white;
      border: 1px solid #dce3ec;
      border-radius: 12px;
    }
    h2 {
      margin: 0 0 12px;
      color: #2563eb;
    }
  </style>
  <article>
    <h2>My reusable card</h2>
    <p>Created from an HTML template.</p>
  </article>
`;

class UiCard extends HTMLElement {
  connectedCallback() {
    if (this.shadowRoot) return;
    const shadow = this.attachShadow({ mode: 'open' });
    shadow.appendChild(template.content.cloneNode(true));
  }
}

customElements.define('ui-card', UiCard);

template.content bir belge parçasıdır. cloneNode(true), tüm yapıyı her kartın shadow tree'sine kopyalar. Şablon, kopyalayıp ekleyene kadar render olmaz.

Bu versiyon neredeyse aynı görünür. İyileşme mimariDIR: bir şablon birçok örneği hizmet edebilir.

6. Farklı İçerikleri Slotlar Kullanarak Ekleme

Her örneğin aynı başlığı varsa, tekrar kullanılabilecek bir kart faydalı değildir. ui-card.js'in tepesindeki yalnızca şablon deklarasyonunu aşağıdakilerle değiştirin; Sınıf ve kayıt kodunu 5. Adım'da tutun.

const template = document.createElement('template');

template.innerHTML = `
  <style>
    article {
      padding: 24px;
      background: white;
      border: 1px solid #dce3ec;
      border-radius: 12px;
    }
    h2 { margin: 0 0 12px; color: #2563eb; }
    .content { line-height: 1.6; }
    .action { margin-top: 16px; }
  </style>
  <article>
    <h2><slot name="title">Untitled card</slot></h2>
    <div class="content"><slot></slot></div>
    <div class="action"><slot name="action"></slot></div>
  </article>
`;

Şimdi index.html'deki <ui-card></ui-card>'i değiştir:

<ui-card>
  <span slot="title">Learn Web Components</span>
  <p>Build reusable interfaces with native JavaScript.</p>
  <a slot="action" href="/tutorial">Read the tutorial</a>
</ui-card>

Beklenen sonuç — Adım 6

Card with named slots and action link

İsimli slot, slot="title" ile işaretlendirilmiş elementi alır. İsimlisiz slot, paragrafı alır. Eylem slotu, linki alır. Bir slot'a herhangi bir şey atanmazsa, geri metin gösterilir.

Düzen bileşende yaşar; gerçek kelimeler ve linkler sayfa HTML'sinde kalır. Bu özellikle CMS içeriği için faydalıdır. /tutorial'ı projenizdeki gerçek bir hedefle değiştirin.

7. CSS ile Öne Çıkan Bir Varyant Oluşturma

<style> bloğunun içinde, şunu ekleyin:

:host {
  display: block;
}
:host([variant="featured"]) article {
  background: #eff6ff;
  border-color: #93c5fd;
}

Daha sonra index.html'deki tek kartı iki kartla değiştirin:

<ui-card>
  <span slot="title">Standard card</span>
  <p>This card uses the default appearance.</p>
</ui-card>

<ui-card variant="featured">
  <span slot="title">Featured card</span>
  <p>This card has a highlighted appearance.</p>
</ui-card>

Beklenen sonuç — Adım 7

Standard and featured card variants

Bu, :host() için özellikle faydalı bir özelliktir: özel elementin atributlarına göre bileşeni stiller. JavaScript daha sonra variant'i değiştirirse, CSS otomatik olarak更新. Saf CSS驱动 bir değişiklik için attributeChangedCallback() gerekmez.

8. Bir Kapatma Düğmesi ve Herkese Açıklamalı Bir Olay Ekleme

Kartı etkileşimli hale getirelim. <article>'in içinde, başlıkdan önce bu düğmeyi ekleyin:

<button class="dismiss" type="button" aria-label="Dismiss card">
  ×
</button>

Bu kuralları şablonun CSS'sine ekleyin:

article { position: relative; }
.dismiss {
  position: absolute;
  top: 12px;
  right: 12px;
  width: 32px;
  height: 32px;
  border: 0;
  border-radius: 6px;
  background: transparent;
  color: #475569;
  font-size: 24px;
  cursor: pointer;
}
.dismiss:focus-visible {
  outline: 2px solid #2563eb;
  outline-offset: 2px;
}

Sınıf içindeki connectedCallback()'i değiştir:

connectedCallback() {
  if (this.shadowRoot) return;

  const shadow = this.attachShadow({ mode: 'open' });
  shadow.appendChild(template.content.cloneNode(true));

  shadow.querySelector('.dismiss').addEventListener('click', () => {
    this.dispatchEvent(new CustomEvent('card-dismissed', {
      bubbles: true,
      composed: true
    }));
    this.remove();
  });
}

index.html'de, </body>'den önce bu scripti ekleyin:

<script type="module">
  document.addEventListener('card-dismissed', () => {
    console.log('A card was dismissed.');
  });
</script>

Tarayıcı konsolunu açın ve ×'i tıklayın. kart kaybolur ve konsol mesajı gösterilir.

Olay, herkese açık bir entegrasyon noktası sağlar: çevredeki uygulamanın kartın içeriği düğmesi hakkında bilmesi gerekmez. bubbles olayın kabarcığını sağlar; composed, uygulandığında bir shadow sınırını geçmeye izin verir. Burada olay host elementin kendisinde kaynaklanır.

9. Tam Son Sürüm: Kopyala ve Kullan

components/ui-card.js'in tüm içeriğini bu birleştirilmiş versiyonla değiştirabilirsiniz. Bu, önceki adımlarda inşa edilen davranışları korurken CSS özelleştirmesi ve dışa aktarılmış parçaları ekler.

const template = document.createElement('template');

template.innerHTML = `
  <style>
    :host {
      display: block;
      color: #1f2937;
      font-family: system-ui, sans-serif;
    }
    article {
      position: relative;
      box-sizing: border-box;
      padding: 24px;
      background: var(--card-background, #fff);
      border: 1px solid var(--card-border, #dce3ec);
      border-radius: 12px;
    }
    :host([variant="featured"]) article {
      background: var(--card-featured-background, #eff6ff);
      border-color: var(--card-featured-border, #93c5fd);
    }
    h2 {
      margin: 0 36px 12px 0;
      color: var(--card-title-color, #2563eb);
      font-size: 1.25rem;
    }
    .content { line-height: 1.6; }
    .action { margin-top: 16px; }
    .dismiss {
      position: absolute;
      top: 12px;
      right: 12px;
      width: 32px;
      height: 32px;
      border: 0;
      border-radius: 6px;
      background: transparent;
      color: #475569;
      font-size: 24px;
      cursor: pointer;
    }
    .dismiss:hover { background: rgba(0, 0, 0, 0.06); }
    .dismiss:focus-visible {
      outline: 2px solid #2563eb;
      outline-offset: 2px;
    }
  </style>
  <article part="container">
    <button class="dismiss" type="button"
            aria-label="Dismiss card">×</button>
    <h2 part="title"><slot name="title">Untitled card</slot></h2>
    <div class="content"><slot></slot></div>
    <div class="action"><slot name="action"></slot></div>
  </article>
`;

class UiCard extends HTMLElement {
  connectedCallback() {
    if (this.shadowRoot) return;

    const shadow = this.attachShadow({ mode: 'open' });
    shadow.appendChild(template.content.cloneNode(true));

    shadow.querySelector('.dismiss').addEventListener('click', () => {
      this.dispatchEvent(new CustomEvent('card-dismissed', {
        bubbles: true,
        composed: true,
        detail: {
          variant: this.getAttribute('variant') || 'default'
        }
      }));
      this.remove();
    });
  }
}

if (!customElements.get('ui-card')) {
  customElements.define('ui-card', UiCard);
}

Hızlı bir demo farklı olarak, bu versiyon ikinci bir shadow root eklemeyi denemez, innerHTML ile güvenilmeyen içeriği ekmez ve bir framework'e dayanmaz. Şablon dizi, geliştirici kontrolündedir; asla güvenilmeyen kullanıcı girdisini bunun içine interpolate etmeyin.

10. Barındırma Sitesinden Stil Verme

Shadow DOM, özelleştirmeyi imkansız kılmak için değil. Kasıtlı bir stil arayüzü tanımlamanızı teşvik eder.

css/main.css'de şunu ekleyin:

ui-card {
  --card-border: #cbd5e1;
  --card-title-color: #0f766e;
}
ui-card::part(container) {
  box-shadow: 0 8px 24px rgba(0, 0, 0, 0.08);
}

Özel stillar shadow tree miras alır ve bizim gösterdiği değerleri kontrol eder. part="container" atributu, ::part(container) ile seçili bir iç elementi hedef almak için dış CSS'e izin verir.

Farklı bir öne çıkan arka plana ihtiyaç duyarsanız, --card-featured-background kullanın. Bu, tüketicilerin iç DOM yapısına bağlı kalmasını zorlamaktan daha iyidir.

11. Kartı WordPress, Joomla veya Plain HTML'de Tekrar Kullanma

ui-card.js'ı hedef siteye kopyalayın ve JavaScript modülü olarak yükleyin:

<script type="module" src="/assets/js/ui-card.js"></script>

Ardından <ui-card>'ı sayfa işaretlemede kullanın. WordPress'te, tema veya eklentinin desteklenen script yükleme API'leri üzerinden varlıkları kaydırın, WordPress sürümünüze uygun modül desteğini kullanın. Joomla'da, modülü kaydetmek ve yüklemek için Web Asset Manager'ı kullanın. Üretim şablonları içinde kodlu script etiketleri yaymayın.

CMS tarafından oluşturulan bir kart için, başlık, paragraf ve linki slotlu HTML olarak render edin. İçerik ve atributları CMS'nin çıkış kurallarına göre kaçının.

Pratik fayda: bir Joomla modülü ve bir WordPress bloku, aynı özel etiketi, bir bileşen uygulamasını paylashken output edebilir. Her CMS, kendi içeriğini getirmek ve kaçınmak için sorumludur.

12. Erişilebilirlik, SEO ve Progressive Enhancement

Mümkün olduğunda bileşenler içinde native HTML kontrolleri kullanın. Kapatma eylemiz, klavye etkinleme semantikleri sunan gerçek bir button kullanır ve × tek başına açıklayıcı olmadığı için bir aria-label.

Bir kullanıcı klavye odakla bir kartı kapatırsa, daha karmaşık bir arayüzde odak nereye gitmeliyi düşünün. Diyaloglar, menüler ve comboboxlar, bu örnekle karşılaştırıldığında çok daha fazla erişilebilirlik davranışına ihtiyaç duyar.

Önemli içeriği, pratik olan anlamlı light-DOM işaretlemede tutun. JavaScript失败 olursa, tarayıcı <ui-card>'i upgraded etmez; slotlu başlık ve paragraf belgede kalır, ancak bileşenin stilli kabuğu ve kapatma düğmesi olmayacak.

Arama motorları için, sadece JavaScript içeriğinin her crawler'da aynı şekilde indekslen olduğunu varsaymayın. Kritik içeriğin başlangıç HTML'sinde veya uygun bir render stratejisi ile kullanılabilir olması gerekir.

Shadow DOM'nin de sınırları vardır: gewöhnliche document CSS seçicileri iç düğümleri stiller ve bazı ARIA ID ilişkileri shadow sınırlarını geçemez. Bu sınırları düşünerek bileşen API'lerini tasarlayın.

13. Web Bileşenleri Her zaman Hızlı mıdır?

Gerekli değildir. Web Components, belirli bir framework runtime gereksinimini ortadan kaldırır, ancak performans JavaScript miktarına, DOM karmaşıklığına, render sıklığına ve uygulama mimarisine bağlıdır.

Küçük bir kart iyi bir adaydır. Gereksiz DOM yeniden inşası olan yüzlerce karmaşık element hala yavaş olabilir. Şablonları tekrar kullanın, tekrarlanan tam render'ı kaçının ve gerçek performansı ölçün.

Zaten bir framework'in state management ve routing etrafında inşa edilmiş bir büyük uygulama için, framework'in kendi bileşenleri kullanmak daha basit olabilir. Web Components, kararlı bir UI elementinin framework veya CMS sınırlarını geçmesi gereken ışık parlaklığı gösterir.

14. Sorun Giderme

Belirti Olası neden Ne kontrol edilmeli
Kart boş Modül yüklemedi DevTools konsolu, URL, sunucu MIME türü
customElements.define hata verir Geçersiz veya yinelenen isim Tire gereksinimi ve kayıt koruması
Kartın içinde CSS uygulanmaz Shadow DOM sınırı Özel stillar kullanın, :host veya ::part
İçerik yanlış yerde görünür Slot ismi uyumsuzluğu slot="title" ile <slot name="title"> karşılaştırın
Kapatma tıklaması yapmaz Şablon düğmesi eksik Shadow tree'yi ve konsolu inceleyin
Bileşen taşındığında失败 olur Başlatma iki kez çalışır Shadow root oluşturmayı koruyun
Link 404'e işaret eder Örnek URL değiştirilmemiş Var olan bir hedef kullanın

connectedCallback()'dan fazla kez çalışabileceğini unutun. Son örneğimizdeki koruma, başlatıcı'yı bir kez tutar; daha karmaşık bileşenler, bağlanma döngüsü sırasında dış gözlemcileri veya global olay dinleyicilerini ekleyip kaldırabilir.

15. Web Bileşenleri Ne Zaman Kullanılmeli?

Bir bileşen, birden fazla web sitesi, framework veya CMS ortamında tekrar kullanılabilecek, belgelenmiş bir HTML arayüzüne ihtiyaç duyarsa, onları seçin. Kartlar, bildirimler, ürün widget'ları ve küçük etkileşimli araçlar iyi adaylardır.

Birkaç satır gewöhnliche HTML ve CSS zaten sorunu çözdüyse, soyutlamayı atın. Ve güçlü bir neden yoksa, native kontrolleri tekrar oluşturmayın.

Faydalı bir test: başka bir uygulama, bu elementin nasıl implemente edildiğini bilmeden kullanından fayda sağlar mı? Evetse, bir Web Component değerindedir.

Sonuç

Gerçek bir tekrar kullanılabilecek bileşen inşa ettiniz, sadece bir tarayıcı API'si okumak değil. Özel bir etiketi, sınırlı stilleri, yapılandırılabilecek içeriği, bir öne çıkan varyantı ve diğer kodların dinleyebildiği bir olaya sahip.

Projelerinizde tekrar tekrar görünen bir bileşenle başlatin. Küçük bir herkese açık API sağlayın, birden fazla düzenlemede test edin ve bağımlılıkları minimal tutun.

Web Components'in uzun vadeli değeri, her framework'i replace etmeleri değil. Yararlı arayüz elementlerinin onları ilk barındıran framework veya CMS'den daha uzun yaşamalarına izin verirler.

Resmi Referanslar