Améliorez le HTML avec des balises personnalisées et Shadow DOM

Dans mon article précédent, j'ai expliqué les bases de la création d'étiquettes personnalisées. En fait, les balises personnalisées éliminent une partie de la fragilité lors de la création d’applications Web de qualité. Cependant, la recherche du contrôle ne s’arrête pas et les balises personnalisées traditionnelles ne suffisent pas à créer des applications riches en performances. Par exemple, le nombre de sélecteurs de style dans votre code peut augmenter avec l'ajout de balises personnalisées. Ce n’est qu’un des nombreux facteurs pouvant entraîner des problèmes de performances.

Une façon de résoudre ce problème consiste à utiliser Shadow DOM.

Shadow DOM fonctionne en introduisant des styles étendus. Il ne nécessite aucune convention ou outil de dénomination particulier. Avec Shadow DOM, regrouper CSS avec du balisage est facile. De plus, cette fonctionnalité nous permet de masquer tous les détails sur l'implémentation en simple JavaScript.

Pourquoi utiliser Shadow DOM ?

Shadow DOM fournit les solutions suivantes :

• Autoriser les éléments indépendants dans le DOM. Les requêtes telles que document.querySelector ne renverront pas d'éléments orphelins.
• Autoriser le CSS étendu. Le CSS étendu garantit que toutes les règles de style restent dans la page. Cela signifie également des sélecteurs CSS plus simples, sans aucun conflit de noms et de nombreuses classes communes.

Notre exemple

Pour démontrer Shadow DOM, nous utiliserons un composant simple appelé tuts-tabs. Toutes les références dans cet article pointeront vers ce code. Pour découvrir Shadow DOM, jetez un œil à la démo ci-dessous :

Comprendre Shadow DOM

Qu'est-ce que Shadow DOM ?

Avant de commencer à coder avec Shadow DOM, vous devez comprendre le DOM standard.

Le HTML est l'épine dorsale de votre site Web. En quelques minutes seulement, vous pouvez créer une page. Lorsque vous ouvrez la page dans votre navigateur, le DOM entre en jeu. Une fois que le navigateur charge la page, il commence à analyser le code HTML dans un modèle de données. Le modèle de données est une structure arborescente dans laquelle les nœuds représentent des éléments en HTML. Le modèle de données est facile à modifier et à manipuler avec du code.

L'inconvénient est que des pages Web entières ou même des applications Web complexes sont traitées comme une structure de données unique. Ce n'est pas facile à déboguer ! Par exemple, un style CSS appliqué à un composant peut finir par affecter un autre composant ailleurs dans l'application.

Utilisez iframes lorsque vous souhaitez isoler une partie de votre interface du reste. Mais les iframes sont lourdes et extrêmement restrictives.

C'est pourquoi Shadow DOM a été introduit. Il s'agit d'une fonctionnalité puissante des navigateurs modernes qui permet aux développeurs Web d'inclure des sous-arbres de divers éléments dans le DOM. Ces sous-arborescences du DOM n'affectent pas l'arborescence principale du document. Techniquement, ils sont appelés Shadow Trees.

Un arbre d'ombre a une racine d'ombre, qui est attachée à un parent dans le DOM. Ce parent s'appelle le Shadow Host.

Par exemple, si vous branchez <input type="range"> sur un navigateur alimenté par WebKit, il sera converti en slider. Pourquoi? Il s'agit d'un curseur car l'un des éléments DOM du sous-arbre comprend la « portée » pour modifier son apparence et introduire une fonctionnalité de type curseur. C'est un avantage que Shadow DOM apporte aux onglets.

Wow, ça fait beaucoup de théories. Maintenant, vous souhaiterez peut-être écrire du code pour voir comment Shadow DOM est implémenté.

Guide étape par étape pour utiliser Shadow DOM

Étape 1 : Créer l'élément Shadow DOM

Utilisez element.attachShadow() pour créer des éléments Shadow DOM.

Dans notre exemple tuts-tab vous verrez le code utilisé pour créer un élément Shadow DOM.

 let shadowRoot = this.attachShadow({mode: 'open'});

Étape 2. Ajouter du contenu à Shadow Root

Ensuite, nous utiliserons .innerHTML pour ajouter du contenu à la racine fantôme. Notez que ce n'est pas la seule façon de remplir le Shadow DOM. Il existe de nombreuses API qui vous aident à remplir le Shadow DOM.

shadowRoot.innerHTML = ``

Étape 3 : Connectez les éléments personnalisés au Shadow DOM

Connecter des éléments personnalisés à Shadow DOM est très simple. Gardez à l'esprit que lorsque vous combinez des éléments personnalisés avec Shadow DOM, vous pourrez créer des composants encapsulés à l'aide de CSS, JavaScript et HTML. Par conséquent, vous allez créer un tout nouveau composant Web qui pourra être réutilisé dans votre application.

Dans notre exemple, nous utilisons customElements.define() pour créer un nouvel élément personnalisé. Comme mentionné dans le tutoriel précédent, les nouveaux éléments doivent contenir "-" dans leur nom. customElements.define() 创建一个新的自定义元素。正如上一教程中提到的，新元素的名称中应包含“-”。 tuts-tabs 组件扩展了 HTMLElement Le composant étend HTMLElement.

当我们扩展 HTMLElement 时，在构造函数中调用 super() 非常重要。另外，构造函数是需要创建 shadowRoot 的地方。

customElements.define('tuts-tabs', class extends HTMLElement {
    constructor() {
    super(); // always call super() first in the constructor.

    // Attach a shadow root to <tuts-tabs>.
    const shadowRoot = this.attachShadow({mode: 'open'});
    ...
});

创建 shadowRoot 后，您可以为其创建 CSS 规则。 CSS 规则可以包含在 <style></style> 标记中，并且这些样式的范围仅限于 tuts-tab。

customElements.define('tuts-tabs', class extends HTMLElement {
    constructor() {
    super(); 
    const shadowRoot = this.attachShadow({mode: 'open'});
    shadowRoot.innerHTML = `
         <!-- styles are scoped to tuts-tabs! -->
         <style>#tabs { ... }</style>
    `;
    }
    ...
});

第 4 步：向 Shadow DOM 添加样式

与tuts-tab相关的CSS可以写在<style></style>标签内。请记住，此处声明的所有样式都将作用于 tuts-tab Web 组件。 作用域 CSS 是 Shadow DOM 的一项有用功能，它具有以下属性：

• CSS 选择器不会影响 Shadow DOM 之外的组件。
• Shadow DOM 中的元素不受其外部选择器的影响。
• 样式的范围仅限于宿主元素。

如果你想在 Shadow DOM 中选择自定义元素，你可以使用 :host 伪类。当 :host 伪类用于普通 DOM 结构时，它不会产生任何影响。但在 Shadow DOM 内部，它会产生很大的差异。您将在 tuts-tab 组件中找到以下 :host 样式。它决定显示和字体样式。这只是一个简单的示例，展示如何将 :host 合并到 Shadow DOM 中。

:host 的一个问题是它的特殊性。如果父页面有 :host，它将具有更高的特异性。父样式内的所有样式都会获胜。这是从外部覆盖自定义元素内部样式的一种方法。

 :host {
  display: inline-block;
  width: 650px;
  font-family: 'Roboto Slab';
  contain: content;
}

随着 CSS 变得更简单，Shadow DOM 的整体效率也会提高。

下面定义的所有样式都是影子根的本地样式。

shadowRoot.innerHTML = `
<style>
:host {
  display: inline-block;
  width: 650px;
  font-family: 'Roboto Slab';
  contain: content;
}
#panels {
  box-shadow: 0 2px 2px rgba(0, 0, 0, .3);
  background: white;
  border-radius: 3px;
  padding: 16px;
  height: 250px;
  overflow: auto;
}
#tabs slot {
  display: inline-flex; /* Safari bug. Treats <slot> as a parent */
}
...
</style>

同样，您可以自由地在 Shadow DOM 中引入样式表。当您在 Shadow DOM 内链接样式表时，它们的作用域将位于 Shadow 树内。这是一个简单的例子来帮助您理解这个概念。

shadowRoot.innerHTML = `
<style>
:host {
  display: inline-block;
  width: 650px;
  font-family: 'Roboto Slab';
  contain: content;
}
#panels {
  box-shadow: 0 2px 2px rgba(0, 0, 0, .3);
  background: white;
  border-radius: 3px;
  padding: 16px;
  height: 250px;
  overflow: auto;
}
...
</style>
<link rel="stylesheet" href="styles.css">
...

步骤 5. 在自定义组件中定义 HTML 元素

接下来，我们可以定义 tuts-tab 的 HTML 元素。

在简单的选项卡结构中，应该有可单击的标题和反映所选标题内容的面板。这显然意味着我们的自定义元素应该有一个带有标题的 div 和一个用于面板的 div 。 HTML 组件将定义如下：

customElements.define('tuts-tabs', class extends HTMLElement {
    constructor() {
    super(); const shadowRoot = this.attachShadow({mode: 'open'});
    shadowRoot.innerHTML = `
        <style>#tabs { ... }</style>
        
        ....
        
        // Our HTML elements for tuts-tab
        <div id="tabs">...</div>
        <div id="panels">...</div>
        ...
    `;
    }
    ...
});

在面板的 div 中，您会遇到一个有趣的标签，名为 <slot></slot>。我们的下一步是了解有关插槽的更多信息。

第 6 步：在 Shadow DOM 中使用槽

Slot 在 Shadow DOM API 中起着至关重要的作用。插槽充当自定义组件内的占位符。这些组件可以由您自己的标记填充。槽声明分为三种不同类型：

1. 您可以拥有零个插槽的组件。
2. 您可以创建一个包含后备内容或空内容的槽位。
3. 您可以使用整个 DOM 树创建槽。

在我们的 tuts-tabs 中，我们有一个用于选项卡标题的命名槽，以及另一个用于面板的槽。命名槽会创建您可以通过名称引用的孔。

customElements.define('tuts-tabs', class extends HTMLElement {
    constructor() {
    super(); const shadowRoot = this.attachShadow({mode: 'open'});
    shadowRoot.innerHTML = `
        <style>#tabs { ... }</style>
        
        ....
        
        // Our HTML elements for tuts-tab
        <div id="tabs">
            <slot id="tabsSlot" name="title"></slot>
         </div>
        <div id="panels">
            <slot id="panelsSlot"></slot>
        </div>
        ...
    `;
    }
    ...
});

第 7 步：填充插槽

现在，是时候填充插槽了。在之前的教程中，我们了解了定义自定义元素的四种不同方法，并且 tuts-tabs 使用其中两种方法来构建选项卡：connectedCallback 和 disconnectedCallback。

在 connectedCallback 中，我们将填充步骤 6 中定义的槽。我们的 connectedCallback 将定义如下。我们使用 querySelector 来识别 tabsSlot 和 panelsSlot。当然，这并不是识别 HTML 中插槽的唯一方法。

识别槽后，您需要为其分配节点。在 tuts-tab 中，我们使用以下 tabsSlot.assignedNodes 来标识选项卡的数量。

connectedCallback() {
    ...
    const tabsSlot = this.shadowRoot.querySelector('#tabsSlot');
    const panelsSlot = this.shadowRoot.querySelector('#panelsSlot');

    this.tabs = tabsSlot.assignedNodes({flatten: true});
    this.panels = panelsSlot.assignedNodes({flatten: true}).filter(el => {
      return el.nodeType === Node.ELEMENT_NODE;
    });
    ...
  }

此外，connectedCallback 是我们注册所有事件监听器的地方。每当用户单击选项卡标题时，面板的内容都需要更改。可以在 connectedCallback 函数中注册用于实现此目的的事件侦听器。

第 8 步：实现逻辑和交互性

我们不会深入探讨如何实现选项卡及其功能的逻辑。但是，请记住，我们的自定义 tuts-tab 组件中实现了以下方法，用于在选项卡之间切换：

1. onTitleClick： 该方法捕获选项卡标题上的点击事件。它有助于在选项卡面板内切换内容。
2. selectTab：该函数负责隐藏面板和显示右侧面板。此外，它还负责突出显示所选的选项卡。
3. findFirstSelected：此方法用于在第一次加载时选择选项卡。
4. selected：这是一个用于获取所选选项卡的 getter 和 setter。

第 9 步.定义生命周期方法

继续，不要忘记定义 disconnectedCallback。这是自定义元素中的生命周期方法。当自定义元素从视图中销毁时，会触发此回调。这是在应用程序中删除操作侦听器和重置控件的最佳位置之一。但是，回调的范围仅限于自定义元素。在我们的例子中，它将是 tuts-tab。

第 10 步。使用新组件！

最后一步是在 HTML 中使用 tuts-tab 。我们可以很容易地在 HTML 标记中插入 tuts-tab 。这是一个简单的例子来演示其用法。

<tuts-tabs background>
  <button slot="title">Tab 1</button>
  <button slot="title" selected>Tab 2</button>
  <button slot="title">Tab 3</button>
  <section>content panel 1</section>
  <section>content panel 2</section>
  <section>content panel 3</section>
</tuts-tabs>

结论

我们开始了！我们已经完成了一个重要教程，在该教程中我们创建并使用了自定义元素。该过程很简单，并且在开发网页时被证明非常有用。我希望您尝试创建自定义元素并与我们分享您的经验。

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!