Shadow DOM 101

บทนำ

คอมโพเนนต์เว็บคือชุดมาตรฐานที่ล้ำสมัยซึ่งมีคุณสมบัติดังนี้

  1. ทำให้สร้างวิดเจ็ตได้
  2. …ซึ่งนำกลับมาใช้ซ้ำได้อย่างน่าเชื่อถือ
  3. …และจะไม่ทำให้หน้าเว็บเสียหายหากคอมโพเนนต์เวอร์ชันถัดไปมีการเปลี่ยนแปลงรายละเอียดการใช้งานภายใน

หมายความว่าคุณต้องตัดสินใจว่าจะใช้ HTML/JavaScript เมื่อใด และจะใช้คอมโพเนนต์เว็บเมื่อใดใช่ไหม ไม่เอาด้วยหรอก HTML และ JavaScript สามารถสร้างภาพแบบอินเทอร์แอกทีฟได้ วิดเจ็ตเป็นภาพแบบอินเทอร์แอกทีฟ การใช้ประโยชน์จากทักษะ HTML และ JavaScript ของคุณเมื่อพัฒนาวิดเจ็ตจึงเป็นเรื่องที่สมเหตุสมผล มาตรฐานคอมโพเนนต์เว็บออกแบบมาเพื่อช่วยให้คุณทำเช่นนั้นได้

แต่มีปัญหาพื้นฐานที่ทำให้วิดเจ็ตที่สร้างจาก HTML และ JavaScript ใช้งานได้ยาก นั่นคือแผนผัง DOM ภายในวิดเจ็ตไม่ได้ถูกแยกออกจากส่วนที่เหลือของหน้า การขาดการห่อหุ้มนี้หมายความว่าสไตล์ชีตของเอกสารอาจนำไปใช้กับส่วนต่างๆ ภายในวิดเจ็ตโดยไม่ตั้งใจ JavaScript ของคุณอาจแก้ไขส่วนต่างๆ ภายในวิดเจ็ตโดยไม่ตั้งใจ รหัสของคุณอาจทับซ้อนกับรหัสภายในวิดเจ็ต และอื่นๆ

Web Components ประกอบด้วย 3 ส่วน ได้แก่

  1. เทมเพลต
  2. Shadow DOM
  3. องค์ประกอบที่กำหนดเอง

Shadow DOM แก้ปัญหาการรวมแผนผัง DOM องค์ประกอบทั้ง 4 ส่วนของคอมโพเนนต์เว็บได้รับการออกแบบมาให้ทำงานร่วมกัน แต่คุณก็สามารถเลือกใช้เฉพาะบางส่วนของคอมโพเนนต์เว็บได้เช่นกัน บทแนะนำนี้จะแสดงวิธีใช้ Shadow DOM

สวัสดี Shadow World

เมื่อใช้ Shadow DOM องค์ประกอบจะได้รับโหนดประเภทใหม่ที่เชื่อมโยงกับองค์ประกอบนั้น โหนดประเภทใหม่นี้เรียกว่า Shadow Root องค์ประกอบที่มี Shadow Root เชื่อมโยงอยู่เรียกว่า Shadow Host เนื้อหาของโฮสต์ Shadow จะไม่แสดงผล แต่เนื้อหาของรูท Shadow จะแสดงผลแทน

ตัวอย่างเช่น หากคุณมีมาร์กอัปดังนี้

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

ไม่เพียงเท่านั้น หาก JavaScript ในหน้าเว็บถามว่า textContent ของปุ่มคืออะไร ก็จะไม่ได้รับคำตอบว่า "こんにちは、影の世界!" แต่จะเป็น "Hello, world!" เนื่องจากแผนผังย่อย DOM ภายใต้ Shadow Root ได้รับการแคปซูลไว้

การแยกเนื้อหาออกจากงานนำเสนอ

ตอนนี้เราจะมาดูการใช้ 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 ไม่มีแคปซูล โครงสร้างทั้งหมดของติดป้ายชื่อจึงแสดงต่อเอกสาร หากองค์ประกอบอื่นๆ ในหน้าเว็บใช้ชื่อคลาสเดียวกันโดยไม่ตั้งใจสำหรับการจัดรูปแบบหรือการเขียนสคริปต์ เราจะประสบปัญหา

เราจะหลีกเลี่ยงช่วงเวลาที่แย่ๆ ได้

ขั้นตอนที่ 1: ซ่อนรายละเอียดงานนำเสนอ

ในทางความหมาย เราอาจสนใจเพียงว่า

  • ป้ายชื่อ
  • ชื่อคือ "Bob"

ก่อนอื่น เราจะเขียนมาร์กอัปที่ใกล้เคียงกับความหมายที่แท้จริงที่เราต้องการ ดังนี้

<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> องค์ประกอบเหล่านั้นจึงไม่แสดงผล แต่สามารถเข้าถึงได้จาก JavaScript เราจะทำเช่นนั้นเพื่อสร้าง Shadow Root

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

เมื่อเราตั้งค่า Shadow Root แล้ว ระบบจะแสดงผลติดป้ายชื่ออีกครั้ง หากคุณคลิกขวาที่ติดป้ายชื่อและตรวจสอบองค์ประกอบ คุณจะเห็นว่านี่คือมาร์กอัปเชิงความหมายที่ยอดเยี่ยม

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

ซึ่งแสดงให้เห็นว่าการใช้ Shadow DOM ทำให้เราซ่อนรายละเอียดการนำเสนอของป้ายชื่อจากเอกสารได้ รายละเอียดการนำเสนอจะรวมอยู่ใน Shadow DOM

ขั้นตอนที่ 2: แยกเนื้อหาออกจากงานนำเสนอ

ตอนนี้แท็กชื่อของเราจะซ่อนรายละเอียดการนำเสนอจากหน้าเว็บ แต่ไม่ได้แยกการนำเสนอออกจากเนื้อหาจริงๆ เพราะแม้ว่าเนื้อหา (ชื่อ "Bob") จะอยู่ในหน้าเว็บ แต่ชื่อที่แสดงผลคือชื่อที่เราคัดลอกลงใน Shadow Root หากต้องการเปลี่ยนชื่อบนป้ายชื่อ เราจะต้องเปลี่ยนใน 2 ที่ และอาจไม่ซิงค์กัน

องค์ประกอบ HTML เป็นแบบองค์ประกอบ เช่น คุณสามารถใส่ปุ่มไว้ในตารางได้ องค์ประกอบคือสิ่งที่เราต้องการในที่นี้ โดยติดป้ายชื่อต้องเป็นองค์ประกอบของพื้นหลังสีแดง ข้อความ "สวัสดี" และเนื้อหาที่อยู่บนติดป้ายชื่อ

คุณซึ่งเป็นผู้เขียนคอมโพเนนต์จะกำหนดวิธีการทำงานขององค์ประกอบกับวิดเจ็ตโดยใช้องค์ประกอบใหม่ที่เรียกว่า <content> ซึ่งจะสร้างจุดแทรกในการนำเสนอวิดเจ็ต และจุดแทรกจะเลือกเนื้อหาจากโฮสต์ Shadow เพื่อนำเสนอ ณ จุดนั้น

หากเราเปลี่ยนมาร์กอัปใน 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 เบราว์เซอร์จะซิงค์ข้อมูลเหล่านี้โดยอัตโนมัติเมื่อถึงเวลาแสดงผลบางอย่าง

ขั้นตอนที่ 3: กำไร

การแยกเนื้อหาและการนำเสนอช่วยให้เราลดความซับซ้อนของโค้ดที่จัดการเนื้อหาได้ โดยในตัวอย่างติดป้ายชื่อ โค้ดดังกล่าวจะจัดการเฉพาะโครงสร้างที่เรียบง่ายซึ่งมี <div> เพียงรายการเดียวแทนที่จะมีหลายรายการ

ตอนนี้หากเราเปลี่ยนการนำเสนอ เราก็ไม่จำเป็นต้องเปลี่ยนโค้ดใดๆ เลย

ตัวอย่างเช่น สมมติว่าเราต้องการติดป้ายชื่อ ซึ่งยังคงเป็นแท็กชื่อ ดังนั้นเนื้อหาเชิงความหมายในเอกสารจึงไม่เปลี่ยนแปลง ดังนี้

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

โค้ดการตั้งค่า Shadow Root จะยังคงเหมือนเดิม สิ่งที่เปลี่ยนแปลงคือสิ่งที่ใส่ไว้ใน Shadow Root

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

ซึ่งเป็นการปรับปรุงครั้งใหญ่เมื่อเทียบกับสถานการณ์บนเว็บในปัจจุบัน เนื่องจากโค้ดอัปเดตชื่ออาจขึ้นอยู่กับโครงสร้างของคอมโพเนนต์ที่เรียบง่ายและสอดคล้องกัน โค้ดอัปเดตชื่อไม่จำเป็นต้องทราบโครงสร้างที่ใช้สำหรับการแสดงผล หากพิจารณาจากสิ่งที่แสดงผล ชื่อจะปรากฏเป็นอันดับ 2 ในภาษาอังกฤษ (ต่อจาก "Hi! My name is") แต่จะอยู่ก่อนในภาษาญี่ปุ่น (ก่อน "と申します") ความแตกต่างดังกล่าวไม่มีความหมายในเชิงความหมายจากมุมมองของการอัปเดตชื่อที่แสดง ดังนั้นโค้ดการอัปเดตชื่อจึงไม่จำเป็นต้องทราบรายละเอียดดังกล่าว

เครดิตพิเศษ: การฉายภาพขั้นสูง

ในตัวอย่างข้างต้น องค์ประกอบ <content> จะเลือกเนื้อหาทั้งหมดจากโฮสต์ Shadow คุณสามารถควบคุมสิ่งที่องค์ประกอบเนื้อหาแสดงได้โดยใช้แอตทริบิวต์ select นอกจากนี้ คุณยังใช้องค์ประกอบเนื้อหาหลายรายการได้ด้วย

เช่น หากคุณมีเอกสารที่มีข้อความต่อไปนี้

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

และ Shadow Root ซึ่งใช้ตัวเลือก 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"> อีเมลของ Bob ปรากฏกี่ครั้งและเป็นสีอะไรบ้าง

คำตอบคืออีเมลของ Bob จะปรากฏเพียงครั้งเดียวและเป็นสีเหลือง

เหตุผลก็คือ ตามที่ผู้ที่แฮ็ก Shadow DOM ทราบ การสร้างต้นไม้ของสิ่งที่แสดงผลบนหน้าจอจริงๆ นั้นเหมือนกับปาร์ตี้ขนาดใหญ่ องค์ประกอบเนื้อหาคือคำเชิญที่อนุญาตให้เนื้อหาจากเอกสารเข้าสู่การแสดงผล Shadow DOM เบื้องหลัง ระบบจะส่งคำเชิญเหล่านี้ตามลำดับ โดยผู้ที่ได้รับคำเชิญจะขึ้นอยู่กับผู้ที่ระบุไว้ (นั่นคือแอตทริบิวต์ select) เมื่อได้รับเชิญแล้ว เนื้อหาจะยอมรับคำเชิญเสมอ (ใครจะไม่ยอมรับล่ะ) และเริ่มทำงาน หากมีการส่งคำเชิญครั้งถัดไปไปยังอีเมลนั้นอีกครั้ง ก็จะไม่มีใครได้รับคำเชิญและไม่ได้เข้าร่วมปาร์ตี้ของคุณ

ในตัวอย่างข้างต้น <div class="email"> ตรงกับทั้งตัวเลือก div และตัวเลือก .email แต่เนื่องจากองค์ประกอบเนื้อหาที่มีตัวเลือก div อยู่ก่อนในเอกสาร <div class="email"> จึงไปที่ปาร์ตี้สีเหลือง และไม่มีใครว่างไปปาร์ตี้สีน้ำเงิน (นั่นอาจเป็นเหตุผลที่ทำให้มันเศร้ามาก แต่คนเศร้าก็ชอบอยู่กับคนเศร้าด้วยกัน คุณจึงไม่มีทางรู้ได้เลย)

หากไม่มีการเชิญสิ่งใดให้เข้าร่วมปาร์ตี้เลย สิ่งนั้นก็จะไม่แสดงผลเลย ซึ่งเป็นสิ่งที่เกิดขึ้นกับข้อความ "Hello, world" ในตัวอย่างแรกสุด ซึ่งจะเป็นประโยชน์เมื่อคุณต้องการให้มีการแสดงผลที่แตกต่างไปจากเดิมอย่างสิ้นเชิง โดยเขียนโมเดลเชิงความหมายในเอกสาร ซึ่งเป็นสิ่งที่สคริปต์ในหน้าเข้าถึงได้ แต่ซ่อนไว้เพื่อวัตถุประสงค์ในการแสดงผล และเชื่อมต่อกับโมเดลการแสดงผลที่แตกต่างไปจากเดิมอย่างสิ้นเชิงใน Shadow DOM โดยใช้ JavaScript

เช่น 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 เดียว หรือ Shadow ที่ซ้อนกันสำหรับการห่อหุ้ม หรือออกแบบหน้าเว็บโดยใช้ Model-Driven Views (MDV) และ Shadow DOM และคอมโพเนนต์เว็บเป็นมากกว่าแค่ Shadow DOM

เราจะอธิบายเรื่องนี้ในโพสต์ถัดไป