Shadow DOM 101

مقدمه

«مؤلفه‌های وب» مجموعه‌ای از استانداردهای پیشرفته است که:

  1. امکان ساختن ابزاره را فراهم می‌کند
  2. …که می‌توان به‌طور مطمئن از آن دوباره استفاده کرد
  3. …و اگر نسخه بعدی مؤلفه جزئیات پیاده‌سازی داخلی را تغییر دهد، صفحه‌ها را خراب نمی‌کند.

آیا این بدان معناست که باید تصمیم بگیرید چه زمانی از HTML/JavaScript استفاده کنید و چه زمانی از Web Components استفاده کنید؟ نه! HTML و جاوا اسکریپت می‌توانند عناصر دیداری تعاملی بسازند. ابزارک‌ها چیزهای دیداری تعاملی هستند. هنگام توسعه ابزاره، منطقی است که از مهارت‌های HTML و JavaScript خود استفاده کنید. استانداردهای «عناصر وب» برای کمک به شما در انجام این کار طراحی شده‌اند.

اما مشکل اساسی‌ای وجود دارد که استفاده از ابزاره‌های ساخته‌شده از HTML و JavaScript را دشوار می‌کند: درخت DOM داخل ابزاره از بقیه صفحه کپسوله‌سازی نشده است. این عدم کپسوله‌سازی به این معنی است که برگه سبک نگارش سند شما ممکن است به‌طور تصادفی در بخش‌هایی از ابزاره اعمال شود؛ جاوا اسکریپت شما ممکن است به‌طور تصادفی بخش‌هایی از ابزاره را تغییر دهد؛ شناسه‌های شما ممکن است با شناسه‌های داخل ابزاره هم‌پوشانی داشته باشند؛ و غیره.

«عناصر وب» از سه بخش تشکیل شده است:

  1. الگوها
  2. Shadow DOM
  3. عناصر سفارشی

Shadow DOM مشکل کپسوله‌سازی درخت DOM را برطرف می‌کند. چهار بخش «عناصر وب» برای کار کردن با یکدیگر طراحی شده‌اند، اما می‌توانید انتخاب کنید که از کدام بخش‌های «عناصر وب» استفاده کنید. این آموزش نحوه استفاده از Shadow DOM را به شما نشان می‌دهد.

سلام، دنیای سایه

با Shadow DOM، عناصر می‌توانند نوع جدیدی از گره را دریافت کنند که با آن‌ها مرتبط است. این نوع جدید گره ریشه سایه نامیده می‌شود. عنصری که ریشه سایه مرتبط با آن دارد، میزبان سایه نامیده می‌شود. محتوای میزبان سایه رندر نمی‌شود؛ درعوض، محتوای ریشه سایه رندر می‌شود.

برای مثال، اگر نشان‌گذاری‌ای مانند این داشتید:

<button>Hello, world!</button>
<script>
var host = document.querySelector('button');
var root = host.createShadowRoot();
root.textContent = 'こんにちは、影の世界!';
</script>

سپس به‌جای

<button id="ex1a">Hello, world!</button>
<script>
function remove(selector) {
  Array.prototype.forEach.call(
      document.querySelectorAll(selector),
      function (node) { node.parentNode.removeChild(node); });
}

if (!HTMLElement.prototype.createShadowRoot) {
  remove('#ex1a');
  document.write('<img src="SS1.png" alt="Screenshot of a button with \'Hello, world!\' on it.">');
}
</script>

صفحه شما شبیه این است

<button id="ex1b">Hello, world!</button>
<script>
(function () {
  if (!HTMLElement.prototype.createShadowRoot) {
    remove('#ex1b');
    document.write('<img src="SS2.png" alt="Screenshot of a button with \'Hello, shadow world!\' in Japanese on it.">');
    return;
  }
  var host = document.querySelector('#ex1b');
  var root = host.createShadowRoot();
  root.textContent = 'こんにちは、影の世界!';
})();
</script>

نه تنها این، بلکه اگر جاوا اسکریپت در صفحه بپرسد که textContent دکمه چیست، «こんにちは、影の世界!» را دریافت نخواهد کرد، بلکه «Hello, world!» را دریافت می‌کند زیرا زیردرخت DOM زیر ریشه سایه کپسوله‌سازی شده است.

جدا کردن محتوا از ارائه

اکنون به استفاده از Shadow DOM برای جدا کردن محتوا از ارائه نگاه خواهیم کرد. فرض کنید این برچسب نام را داریم:

<style>
.ex2a.outer {
  border: 2px solid brown;
  border-radius: 1em;
  background: red;
  font-size: 20pt;
  width: 12em;
  height: 7em;
  text-align: center;
}
.ex2a .boilerplate {
  color: white;
  font-family: sans-serif;
  padding: 0.5em;
}
.ex2a .name {
  color: black;
  background: white;
  font-family: "Marker Felt", cursive;
  font-size: 45pt;
  padding-top: 0.2em;
}
</style>
<div class="ex2a outer">
  <div class="boilerplate">
    Hi! My name is
  </div>
  <div class="name">
    Bob
  </div>
</div>

نشانه‌گذاری در اینجا آمده است. این چیزی است که امروز می‌نویسید. از Shadow DOM استفاده نمی‌کند:

<style>
.outer {
  border: 2px solid brown;
  border-radius: 1em;
  background: red;
  font-size: 20pt;
  width: 12em;
  height: 7em;
  text-align: center;
}
.boilerplate {
  color: white;
  font-family: sans-serif;
  padding: 0.5em;
}
.name {
  color: black;
  background: white;
  font-family: "Marker Felt", cursive;
  font-size: 45pt;
  padding-top: 0.2em;
}
</style>
<div class="outer">
  <div class="boilerplate">
    Hi! My name is
  </div>
  <div class="name">
    Bob
  </div>
</div>

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

می‌توانیم از اوقات بد دوری کنیم.

مرحله ۱: پنهان کردن جزئیات ارائه

ازنظر معنایی احتمالاً فقط به این موضوع اهمیت می‌دهیم که:

  • این یک برچسب نام است.
  • نام «باب» است.

ابتدا نشانه‌گذاری‌ای می‌نویسیم که به معناشناسی واقعی موردنظر ما نزدیک‌تر است:

<div id="nameTag">Bob</div>

سپس همه سبک‌ها و divهای استفاده‌شده برای ارائه را در عنصر <template> قرار می‌دهیم:

<div id="nameTag">Bob</div>
<template id="nameTagTemplate">
<span class="unchanged"><style>
.outer {
  border: 2px solid brown;

  … same as above …

</style>
<div class="outer">
  <div class="boilerplate">
    Hi! My name is
  </div>
  <div class="name">
    Bob
  </div>
</div></span>
</template>

در این مرحله، «Bob» تنها چیزی است که ارائه می‌شود. چون عناصر DOM نمایشی را به داخل عنصر <template> منتقل کردیم، این عناصر رندر نمی‌شوند، اما ازطریق جاوا اسکریپت می‌توان به آن‌ها دسترسی پیدا کرد. اکنون این کار را برای پر کردن ریشه سایه انجام می‌دهیم:

<script>
var shadow = document.querySelector('#nameTag').createShadowRoot();
var template = document.querySelector('#nameTagTemplate');
var clone = document.importNode(template.content, true);
shadow.appendChild(clone);

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

<div id="nameTag">Bob</div>

این نشان می‌دهد که بااستفاده از Shadow DOM، جزئیات ارائه برچسب نام را از سند پنهان کرده‌ایم. جزئیات ارائه در Shadow DOM کپسوله‌سازی شده است.

مرحله ۲: جدا کردن محتوا از ارائه

برچسب نام ما اکنون جزئیات ارائه را از صفحه پنهان می‌کند، اما درواقع ارائه را از محتوا جدا نمی‌کند، زیرا اگرچه محتوا (نام «باب») در صفحه است، نامی که ارائه می‌شود همان نامی است که در ریشه سایه کپی کرده‌ایم. اگر بخواهیم نام را در برچسب نام تغییر دهیم، باید این کار را در دو جا انجام دهیم و ممکن است این دو جا باهم همگام‌سازی نشوند.

عناصر HTML ترکیبی هستند — برای مثال، می‌توانید دکمه‌ای را داخل جدول قرار دهید. ترکیب‌بندی چیزی است که در اینجا نیاز داریم: برچسب نام باید ترکیبی از پس‌زمینه قرمز، نوشتار «سلام!»، و محتوای روی برچسب نام باشد.

شما، نویسنده مؤلفه، نحوه عملکرد ترکیب‌بندی با ابزاره‌تان را بااستفاده از عنصر جدیدی به‌نام <content> تعریف می‌کنید. این یک نقطه درج در ارائه ابزاره ایجاد می‌کند و نقطه درج محتوا را از میزبان سایه گلچین می‌کند تا در آن نقطه ارائه دهد.

اگر نشانه‌گذاری را در Shadow DOM به این تغییر دهیم:

<span class="unchanged"><template id="nameTagTemplate">
<style>
  …
</style></span>
<div class="outer">
  <div class="boilerplate">
    Hi! My name is
  </div>
  <div class="name">
    <content></content>
  </div>
</div>
<span class="unchanged"></template></span>

وقتی برچسب نام ارائه می‌شود، محتوای میزبان سایه در نقطه‌ای که عنصر <content> ظاهر می‌شود، نمایش داده می‌شود.

اکنون ساختار سند ساده‌تر است چون نام فقط در یک جا وجود دارد — سند. اگر صفحه‌تان نیاز به به‌روزرسانی نام کاربر داشته باشد، فقط می‌نویسید:

document.querySelector('#nameTag').textContent = 'Shellie';

و همین. مرورگر به‌طور خودکار برچسب نام را به‌روز می‌کند، زیرا ما محتوای برچسب نام را با <content> در جای خود نمایش می‌دهیم.

<div id="ex2b">

اکنون محتوا و ارائه را از هم جدا کرده‌ایم. محتوا در سند است؛ ارائه در Shadow DOM است. وقتی زمان ارائه چیزی می‌رسد، مرورگر به‌طور خودکار آن‌ها را همگام‌سازی می‌کند.

مرحله ۳: سود

با جدا کردن محتوا و ارائه، می‌توانیم کدی را که محتوا را دستکاری می‌کند ساده کنیم — در مثال برچسب نام، آن کد فقط باید با ساختار ساده‌ای که حاوی یک <div> به‌جای چندتا است سروکار داشته باشد.

اکنون اگر ارائه خود را تغییر دهیم، نیازی به تغییر هیچ‌یک از کدها نداریم!

برای مثال، فرض کنید می‌خواهیم برچسب ناممان را بومی‌سازی کنیم. این هنوز یک برچسب نام است، بنابراین محتوای معنایی در سند تغییر نمی‌کند:

<div id="nameTag">Bob</div>

کد راه‌اندازی ریشه سایه بدون تغییر باقی می‌ماند. فقط آنچه در ریشه سایه قرار می‌گیرد تغییر می‌کند:

<template id="nameTagTemplate">
<style>
.outer {
  border: 2px solid pink;
  border-radius: 1em;
  background: url(sakura.jpg);
  font-size: 20pt;
  width: 12em;
  height: 7em;
  text-align: center;
  font-family: sans-serif;
  font-weight: bold;
}
.name {
  font-size: 45pt;
  font-weight: normal;
  margin-top: 0.8em;
  padding-top: 0.2em;
}
</style>
<div class="outer">
  <div class="name">
    <content></content>
  </div>
  と申します。
</div>
</template>

این بهبود بزرگی نسبت به وضعیت فعلی در وب است، زیرا کد به‌روزرسانی نام شما می‌تواند به ساختار مؤلفه بستگی داشته باشد که ساده و سازگار است. کد به‌روزرسانی نام شما نیازی به دانستن ساختار مورداستفاده برای پردازش ندارد. اگر آنچه را ارائه شده است درنظر بگیریم، نام در زبان انگلیسی در جایگاه دوم (پس‌از «Hi! My name is»)، اما ابتدا به زبان ژاپنی (قبل‌از «と申します»). این تمایز از دیدگاه به‌روزرسانی نامی که نمایش داده می‌شود، ازنظر معنایی بی‌معنی است، بنابراین کد به‌روزرسانی نام نیازی به دانستن این جزئیات ندارد.

اعتبار اضافی: پیش‌بینی پیشرفته

در مثال بالا، عنصر <content> همه محتوا را از میزبان سایه گلچین می‌کند. بااستفاده از مشخصه select، می‌توانید کنترل کنید که عنصر محتوا چه چیزی را نمایش دهد. همچنین می‌توانید از چند عنصر محتوا استفاده کنید.

برای مثال، اگر سندی دارید که حاوی این مورد است:

<div id="nameTag">
  <div class="first">Bob</div>
  <div>B. Love</div>
  <div class="email">bob@</div>
</div>

و یک ریشه سایه که از گزینشگرهای CSS برای انتخاب محتوای خاص استفاده می‌کند:

<div style="background: purple; padding: 1em;">
  <div style="color: red;">
    <content **select=".first"**></content>
  </div>
  <div style="color: yellow;">
    <content **select="div"**></content>
  </div>
  <div style="color: blue;">
    <content **select=".email">**</content>
  </div>
</div>

عنصر <div class="email"> با هر دو عنصر <content select="div"> و <content select=".email"> مطابقت دارد. نشانی ایمیل باب چند بار نشان داده می‌شود و با چه رنگ‌هایی؟

پاسخ این است که نشانی ایمیل باب یک‌بار نشان داده می‌شود و رنگ آن زرد است.

دلیلش این است که، همان‌طور که افرادی که روی Shadow DOM کار می‌کنند می‌دانند، ساختن درخت آنچه واقعاً روی صفحه نمایش داده می‌شود مانند یک مهمانی بزرگ است. عنصر محتوا دعوتی است که به محتوای سند اجازه می‌دهد وارد مهمانی پردازش Shadow DOM پشت صحنه شود. این دعوت‌نامه‌ها به‌ترتیب ارسال می‌شوند؛ اینکه چه کسی دعوت‌نامه را دریافت می‌کند بستگی به این دارد که دعوت‌نامه برای چه کسی ارسال شده است (یعنی ویژگی select). محتوا، پس‌از دعوت شدن، همیشه دعوت را می‌پذیرد (چه کسی نمی‌پذیرد؟!) و می‌رود. اگر دعوت بعدی دوباره به آن نشانی ارسال شود، کسی در خانه نیست و به مهمانی شما نمی‌آید.

در مثال بالا، <div class="email"> با هر دو گزینشگر div و .email مطابقت دارد، اما چون عنصر محتوا با گزینشگر div زودتر در سند می‌آید، <div class="email"> به مهمانی زرد می‌رود و هیچ‌کس برای آمدن به مهمانی آبی دردسترس نیست. (شاید به‌همین دلیل است که این‌قدر غمگین است، هرچند که غمگین‌ها دوست دارند دیگران هم غمگین باشند، بنابراین هیچ‌وقت نمی‌توان مطمئن بود.)

اگر چیزی به هیچ حزبی دعوت نشود، اصلاً ارائه نمی‌شود. این همان اتفاقی است که برای نوشتار «سلام، دنیا» در اولین مثال افتاد. این کار زمانی مفید است که می‌خواهید به یک پرداخت کاملاً متفاوت دست یابید: مدل معنایی را در سند بنویسید، که همان چیزی است که برای اسکریپت‌ها در صفحه قابل دسترسی است، اما آن را برای اهداف پرداخت پنهان کنید و بااستفاده از جاوا اسکریپت آن را به یک مدل پرداخت واقعاً متفاوت در Shadow DOM متصل کنید.

برای مثال، HTML انتخاب‌گر تاریخ خوبی دارد. اگر <input type="date"> را بنویسید، تقویم بالاپر مرتبی دریافت می‌کنید. اما اگر بخواهید به کاربر اجازه دهید برای تعطیلاتش در جزیره دسر (می‌دانید… با تخت‌آویزهایی که از پاستیل‌های Red Vines ساخته شده‌اند) گستره‌ای از تاریخ‌ها را انتخاب کند، چه؟ شما سندتان را به این صورت تنظیم کرده‌اید:

<div class="dateRangePicker">
  <label for="start">Start:</label>
  <input type="date" name="startDate" id="start">
  <br>
  <label for="end">End:</label>
  <input type="date" name="endDate" id="end">
</div>

اما Shadow DOM ایجاد کنید که از جدول برای ایجاد تقویم شیک استفاده می‌کند که محدوده تاریخ‌ها و غیره را برجسته می‌کند. وقتی کاربر روی روزهای تقویم کلیک می‌کند، مؤلفه وضعیت را در ورودی‌های startDate و endDate به‌روز می‌کند؛ وقتی کاربر فرم را ارسال می‌کند، مقادیر آن عناصر ورودی ارسال می‌شوند.

چرا برچسب‌ها را در سند اضافه کردم اگر قرار نیست ارائه شوند؟ دلیلش این است که اگر کاربری فرم را با مرورگری مشاهده کند که از Shadow DOM پشتیبانی نمی‌کند، فرم همچنان قابل‌استفاده است، فقط ظاهر زیبایی ندارد. کاربر چیزی شبیه این می‌بیند:

<div class="dateRangePicker">
  <label for="start">Start:</label>
  <input type="date" name="startDate" id="start">
  <br>
  <label for="end">End:</label>
  <input type="date" name="endDate" id="end">
</div>

شما Shadow DOM 101 را گذراندید

این‌ها اصول اولیه Shadow DOM هستند — شما Shadow DOM 101 را گذراندید! می‌توانید کارهای بیشتری با Shadow DOM انجام دهید، برای مثال، می‌توانید از چند shadow در یک shadow host، یا shadowهای تودرتو برای کپسوله‌سازی استفاده کنید، یا صفحه‌تان را بااستفاده از Model-Driven Views (MDV) و Shadow DOM معماری کنید. و قطعات وب چیزی فراتر از Shadow DOM هستند.

این موارد را در پست‌های بعدی توضیح می‌دهیم.