الگو، شکاف، و سایه

مزیت مؤلفه‌های وب قابلیت استفاده مجدد آن‌ها است: می‌توانید یک ابزاره میانای کاربر را یک‌بار ایجاد کنید و چندین‌بار از آن استفاده کنید. درحالی‌که برای ایجاد مؤلفه‌های وب به جاوا اسکریپت نیاز دارید، به کتابخانه جاوا اسکریپت نیازی ندارید. HTML و میاناهای برنامه‌سازی کاربردی مرتبط هرآنچه را نیاز دارید ارائه می‌دهند.

استاندارد «مؤلفه وب» از سه بخش تشکیل شده است: الگوهای HTML، عناصر سفارشی، و Shadow DOM. وقتی این فناوری‌ها باهم ترکیب شوند، می‌توانید عناصر سفارشی، مستقل (کپسوله‌شده)، و قابل‌استفاده مجدد بسازید که می‌توانند به‌طور یکپارچه در برنامه‌های موجود ادغام شوند، درست مانند سایر عناصر HTML که قبلاً پوشش داده‌ایم.

در این بخش، عنصر <star-rating> را ایجاد می‌کنیم، مؤلفه وبی که به کاربران اجازه می‌دهد به تجربه‌ای در مقیاس یک تا پنج ستاره امتیاز دهند. هنگام نام‌گذاری عنصر سفارشی، توصیه می‌شود از حروف کوچک استفاده کنید. خط تیره اضافه کنید، چون این کار به تشخیص عناصر معمولی و سفارشی کمک می‌کند.

ما درباره استفاده از عناصر <template> و <slot>، ویژگی slot، و جاوا اسکریپت برای ایجاد الگو با Shadow DOM کپسوله‌شده بحث می‌کنیم. ما از عنصر تعریف‌شده مجدداً استفاده می‌کنیم و بخشی از نوشتار را سفارشی‌سازی می‌کنیم، درست همان‌طور که هر عنصر یا مؤلفه وب را سفارشی‌سازی می‌کنید. همچنین به‌طور خلاصه درباره استفاده از CSS از داخل و خارج عنصر سفارشی بحث می‌کنیم.

عنصر <template>

از عنصر <template> برای اعلام قطعات HTML برای شبیه‌سازی و درج در DOM با جاوا اسکریپت استفاده می‌شود. محتوای عنصر به‌طور پیش‌فرض پرداز نمی‌شود. بلکه بااستفاده از جاوا اسکریپت نمونه‌سازی می‌شوند.

<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> در صفحه نوشته نمی‌شود، <form> و محتوای آن رندر نمی‌شود. برونداد CodePen زیر خالی به‌نظر می‌رسد. برگه HTML را باز کنید تا نشانه‌گذاری <template> را ببینید.

در این مثال، <form> فرزند <template> در DOM نیست. بلکه محتوای عناصر <template> فرزندان DocumentFragment هستند که توسط ویژگی HTMLTemplateElement.content برگردانده شده است. برای نمایان شدن، باید از جاوا اسکریپت برای گرفتن محتوا و افزودن آن محتوا به DOM استفاده شود.

این جاوا اسکریپت عنصر سفارشی ایجاد نکرد. بلکه این مثال محتوای <template> را به <body> پیوست کرده است. محتوا بخشی از DOM قابل‌مشاهده و قابل‌سبک‌بندی شده است.

CodePen همان‌طور که در DOM ظاهر می‌شود.

Requiring JavaScript to implement a template for just one star rating isn't very useful, but creating a web component for a repeatedly used, customizable star rating widget is useful.

عنصر <slot>

ما یک جایگاه برای گنجاندن یک راهنمای سفارشی‌شده برای هر رخداد در نظر گرفته‌ایم. HTML یک عنصر <slot> به‌عنوان جای‌بان در داخل <template> ارائه می‌دهد که اگر نامی برای آن ارائه شود، یک «جایگاه نام‌گذاری‌شده» ایجاد می‌کند. از جایگاه نام‌گذاری‌شده می‌توان برای سفارشی‌سازی محتوا در مؤلفه وب استفاده کرد. عنصر <slot> راهی برای کنترل جایی که فرزندان یک عنصر سفارشی باید در درخت سایه آن درج شوند به ما می‌دهد.

در الگوی ما، <legend> را به <slot> تغییر می‌دهیم:

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

از مشخصه name برای اختصاص دادن جایگاه به عناصر دیگر استفاده می‌شود، اگر عنصر مشخصه slot داشته باشد که مقدار آن با نام جایگاه نام‌گذاری‌شده مطابقت داشته باشد. اگر عنصر سفارشی مطابقتی برای جایگاه نداشته باشد، محتوای <slot> ارائه می‌شود. بنابراین یک <legend> با محتوای عمومی اضافه کردیم که وقتی کسی <star-rating></star-rating> را بدون محتوا در HTML خود اضافه می‌کند، قابل‌پرداخت باشد.

<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 یک مشخصه سراسری است که برای جایگزین کردن محتوای <slot> در <template> استفاده می‌شود. در عنصر سفارشی ما، عنصر دارای ویژگی slot <legend> است. لازم نیست این‌طور باشد. در الگوی ما، <slot name="star-rating-legend"> با <anyElement slot="star-rating-legend"> جایگزین می‌شود، که در آن <anyElement> می‌تواند هر عنصری باشد، حتی یک عنصر سفارشی دیگر.

عناصر تعریف‌نشده

در <template>، از عنصر <rating> استفاده کردیم. این عنصر سفارشی نیست. بلکه عنصری ناشناخته است. مرورگرها وقتی عنصری را تشخیص نمی‌دهند، خراب نمی‌شوند. عناصر اچ‌تی‌ام‌ال ناشناخته توسط مرورگر به‌عنوان عناصر درون‌خطی ناشناس درنظر گرفته می‌شوند که می‌توان با CSS به آن‌ها سبک داد. مشابه <span>، عناصر <rating> و <star-rating> هیچ سبک یا معناشناسی اعمال‌شده توسط نماینده کاربر ندارند.

در این CodePen،‏ <template> و محتواها ارائه نمی‌شوند. <template> عنصری شناخته‌شده است که حاوی محتوایی است که نباید ارائه شود. عنصر <star-rating> هنوز تعریف نشده است. تا زمانی که عنصری را تعریف نکنیم، مرورگر آن را مانند همه عناصر ناشناخته نمایش می‌دهد. For now, the unrecognized <star-rating> is treated as an anonymous inline element, so the content including legends and the <p> in the third <star-rating> are displayed as they would be if they were in a <span> instead.

بیایید عنصر خود را تعریف کنیم تا این عنصر ناشناخته را به عنصر سفارشی تبدیل کنیم.

عناصر سفارشی

جاوا اسکریپت برای تعریف عناصر سفارشی لازم است. وقتی تعریف شد، محتوای عنصر <star-rating> با ریشه سایه‌ای جایگزین می‌شود که حاوی همه محتوای الگویی است که با آن مرتبط می‌کنیم. عناصر <slot> از الگو با محتوای عنصر درون <star-rating> که مقدار مشخصه slot آن با مقدار نام <slot> مطابقت دارد (درصورت وجود) جایگزین می‌شوند. اگر نه، محتوای جایگاه‌های الگو نمایش داده می‌شود.

محتوای درون عنصر سفارشی که با جایگاه مرتبط نیست—<p>Is this text visible?</p> در <star-rating> سوم ما—در ریشه سایه گنجانده نمی‌شود و بنابراین نمایش داده نمی‌شود.

ما عنصر سفارشی را تعریف می‌کنیم به نام star-rating با گسترش 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));
    }
  });

اکنون که عنصر تعریف شده است، هر بار که مرورگر با عنصر <star-rating> مواجه می‌شود، عنصر به‌صورت تعریف‌شده توسط عنصر با #star-rating-template، که الگوی ما است، ارائه می‌شود. مرورگر یک درخت DOM سایه را به گره متصل می‌کند و یک کلون از محتویات الگو را به آن DOM سایه اضافه می‌کند.

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

اگر به ابزارهای توسعه‌دهنده نگاه کنید، خواهید دید که <form> از <template> بخشی از ریشه سایه هر عنصر سفارشی است. یک کلون از محتوای <template> در هر عنصر سفارشی در ابزارهای توسعه‌دهنده آشکار است و در مرورگر قابل مشاهده است، اما محتوای خود عنصر سفارشی در صفحه نمایش داده نمی‌شود.

نماگرفت DevTools که محتوای الگوی کلون‌شده را در هر عنصر سفارشی نشان می‌دهد.

در مثال <template>، محتوای الگو را به بدنه سند پیوست کردیم و محتوا را به DOM معمولی اضافه کردیم. در تعریف customElements، از همان appendChild() استفاده کردیم، اما محتوای الگوی کلون‌شده به یک DOM سایه کپسوله‌شده اضافه شد.

متوجه شدید که چطور ستاره‌ها دوباره به دکمه‌های رادیویی بدون سبک تبدیل شدند؟ Being part of a shadow DOM rather than the standard DOM, the styling within CodePen's CSS tab does not apply. سبک‌های CSS آن برگه در محدوده سند است، نه در محدوده DOM سایه، بنابراین سبک‌ها اعمال نمی‌شوند. باید سبک‌های کپسوله‌شده ایجاد کنیم تا بتوانیم محتوای کپسوله‌شده Shadow DOM را سبک‌بندی کنیم.

Shadow DOM

‫Shadow DOM سبک‌های CSS را برای هر درخت سایه محدود می‌کند و آن را از بقیه سند جدا می‌کند. این یعنی CSS خارجی برای مؤلفه شما اعمال نمی‌شود و سبک‌های مؤلفه بر بقیه سند تأثیری ندارد، مگراینکه ما عمداً آن‌ها را هدایت کنیم.

چون محتوا را به DOM سایه اضافه کرده‌ایم، می‌توانیم عنصر <style> را که CSS کپسوله‌شده را به عنصر سفارشی ارائه می‌دهد اضافه کنیم.

ازآنجایی‌که این مورد به عنصر سفارشی محدود می‌شود، لازم نیست نگران نفوذ سبک‌ها به بقیه سند باشیم. می‌توانیم ویژگی انتخابگرها را به‌طور قابل‌توجهی کاهش دهیم. برای مثال، چون تنها ورودی‌های استفاده‌شده در عنصر سفارشی دکمه‌های رادیویی هستند، می‌توانیم به‌جای input[type="radio"] از input به‌عنوان انتخاب‌گر استفاده کنیم.

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

While web components are encapsulated with in-<template> markup and CSS styles are scoped to the shadow DOM and hidden from everything outside of the components, the slot content which gets rendered, the <anyElement slot="star-rating-legend"> portion of the <star-rating>, isn't encapsulated.

سبک‌پردازی خارج از محدوده فعلی

امکان‌پذیر است، اما ساده نیست، که سند را از داخل یک DOM سایه سبک‌بندی کرد و محتویات یک DOM سایه را از سبک‌های جهانی سبک‌بندی کرد. مرز سایه، جایی که DOM سایه تمام می‌شود و DOM معمولی شروع می‌شود، قابل‌پیمایش است، اما فقط به‌صورت کاملاً عمدی.

درخت سایه درخت DOM درون DOM سایه است. ریشه سایه، گره ریشه درخت سایه است.

کلاس کاذب :host <star-rating>، عنصر میزبان سایه، را انتخاب می‌کند. میزبان سایه گره DOM است که DOM سایه به آن متصل است. برای هدف‌یابی نسخه‌های خاصی از میزبان، از :host() استفاده کنید. این فقط عناصر میزبان سایه را که با پارامتر ارسال‌شده مطابقت دارند انتخاب می‌کند، مانند انتخابگر کلاس یا مشخصه. برای انتخاب همه عناصر سفارشی، می‌توانید از star-rating { /* styles */ } در CSS جهانی، یا :host(:not(#nonExistantId)) در سبک‌های الگو استفاده کنید. ازنظر ویژگی، CSS سراسری برنده می‌شود.

شبه‌عنصر ::slotted() از داخل Shadow DOM از مرز Shadow DOM عبور می‌کند. اگر عنصر شکاف‌دار با گزینشگر مطابقت داشته باشد، آن را انتخاب می‌کند. در مثال ما، ::slotted(legend) با سه راهنمای ما مطابقت دارد.

برای هدف‌یابی DOM سایه از CSS در دامنه سراسری، الگو باید ویرایش شود. مشخصه part را می‌توان به هر عنصری که می‌خواهید سبک‌بندی کنید اضافه کرد. سپس از ::part() شبه‌عنصر برای مطابقت دادن عناصر درون درخت سایه که با پارامتر ارسال‌شده مطابقت دارند استفاده کنید. The anchor or originating element for the pseudo-element is the host, or custom element name, in this case star-rating. پارامتر مقدار مشخصه part است.

اگر نشانه‌گذاری الگوی ما به این صورت شروع شود:

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

می‌توانیم <form> و <fieldset> را با این موارد هدف‌یابی کنیم:

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

نام‌های بخش مشابه کلاس‌ها عمل می‌کنند: یک عنصر می‌تواند چندین نام بخش داشته باشد که با فاصله از هم جدا شده‌اند، و چندین عنصر می‌توانند نام بخش یکسانی داشته باشند.

Google بازبینه فوق‌العاده‌ای برای ایجاد عناصر سفارشی دارد. همچنین ممکن است بخواهید درباره DOM سایه اعلانی بیشتر بدانید.

میزان درک خود را بررسی کنید

دانش خود را درباره الگو، شکاف، و سایه محک بزنید.

به‌طور پیش‌فرض، سبک‌های خارج از shadow DOM عناصر داخل آن را سبک‌بندی می‌کنند.

درست.
دوباره امتحان کنید.
نادرست.
صحیح!

کدام پاسخ توصیف درستی از عنصر <template> است؟

عنصری عمومی که برای نمایش هر محتوایی در صفحه شما استفاده می‌شود.
دوباره امتحان کنید.
عنصر جای‌بان.
دوباره امتحان کنید.
عنصری که برای اعلام قطعات HTML استفاده می‌شود و به‌طور پیش‌فرض ارائه نمی‌شود.
صحیح!