Heim > Artikel > Web-Frontend > Erstellen Sie benutzerdefinierte Tags, um die HTML-Funktionalität zu erweitern

Erstellen Sie benutzerdefinierte Tags, um die HTML-Funktionalität zu erweitern

PHPzOriginal: 2023-09-04 20:37:071042Durchsuche

In diesem Tutorial zeige ich Ihnen, wie einfach es ist, die HTML-Sprache mit benutzerdefinierten Tags zu erweitern. Mit benutzerdefinierten Tags können verschiedene Verhaltensweisen implementiert werden. Sie sind daher eine sehr praktische Möglichkeit, weniger Code zu schreiben und Ihre HTML-Dokumente einfacher zu gestalten.

Um mehr über benutzerdefinierte Tags zu erfahren, lesen Sie meinen Artikel zum Erstellen gekapselter benutzerdefinierter Tags mit Shadow DOM.

Was ist ein benutzerdefiniertes HTML-Tag?

Für HTML können Sie beispielsweise <b></b> 标记来显示粗体文本。如果您需要列表，则可以对每个列表项使用 <ul></ul> 标签及其子标签 <li> verwenden. Tags werden vom Browser interpretiert und bestimmen zusammen mit CSS, wie Webinhalte angezeigt werden und wie sich Teile des Inhalts verhalten.

Manchmal reicht die Verwendung nur eines HTML-Tags nicht aus, um die erforderliche Funktionalität einer Webanwendung zu erfüllen. Normalerweise wird dies durch die Verwendung mehrerer HTML-Tags zusammen mit JavaScript und CSS gelöst, aber diese Lösung ist nicht so elegant.

Eine elegantere Lösung ist die Verwendung eines benutzerdefinierten Tags – einer in enthaltenen Kennung, die der Browser interpretiert, um unsere beabsichtigte Funktionalität darzustellen. Wie normale HTML-Tags sollten wir in der Lage sein, benutzerdefinierte Tags mehrmals auf der Seite zu verwenden, und wir sollten auch Tag-Attribute und Unter-Tags haben können, um die Funktionalität des benutzerdefinierten Tags zu unterstützen.

Einfach ausgedrückt können benutzerdefinierte Elemente verwendet werden, um die folgenden Funktionen freizuschalten:

<li>Definieren und erstellen Sie neue HTML-Elemente <li>Erstellen Sie Elemente, die andere Elemente erweitern <li>Erstellen Sie Elemente, die benutzerdefinierte Funktionen in Ihre App integrieren <li>Verwenden Sie vorhandene DOM-Elemente und erweitern Sie deren API

In diesem Artikel lernen wir benutzerdefinierte Elemente kennen, indem wir ein benutzerdefiniertes Tag namens <codingdude-gravatar></codingdude-gravatar> erstellen. Dieses benutzerdefinierte Etikett zeigt das Gravatar-Bild für eine bestimmte E-Mail-Adresse an.

Die customElements API in modernen Browsern macht es einfach!

1. Projekt erstellen

Um unsere Tags zu implementieren und zu testen, müssen wir ein paar Dinge erstellen:

index.html

codingdude-gravatar.js

2.Ändern Sie index.html

Bearbeiten wir die Datei index.html und lassen ihren Inhalt so aussehen:

<!DOCTYPE html>
<html>
<head>
    <script type="text/javascript" src="codingdude-gravatar.js"></script>
</head>
<body>
    This is my Gravatar picture: 
    <codingdude-gravatar email="admin@coding-dude.com"></codingdude-gravatar>
</body>
</html>

Wenn wir index.html jetzt im Browser laden, werden die Ergebnisse nicht so beeindruckend sein, da wir den Code für das benutzerdefinierte Markup noch nicht implementiert haben.

Zu beachten ist, dass Browser sehr nachsichtig sind, sodass es vorkommen kann, dass Ihr Dokument unbekannte Tags enthält und der Browser diese ignoriert. Damit unser benutzerdefiniertes Etikett tatsächlich das Gravatar-Bild meiner E-Mail anzeigt, müssen wir zunächst verstehen, wie Gravatar funktioniert.

3.Neues Tag registrieren

Schritt 1: Wählen Sie den richtigen Namen

Um benutzerdefinierte Etiketten zu erstellen, müssen Sie window.customElements.define() verwenden.

Das Tag

customElements.define() 中的第一个参数是标记的名称。这就是我们在 HTML 文件中提到的。该名称应始终带有破折号 (-)。名称类似于 <codingdudegravatar></codingdudegravatar> ist ungültig. Dadurch kann der Parser zwischen regulären Elementen und benutzerdefinierten Tags unterscheiden.

Benutzerdefinierte Element-Tag-Namen müssen immer einen Bindestrich (-) enthalten.

第 2 步：选择正确的原型

customElements.define() 有第二个可选对象。该对象用于提及新元素的原型。默认情况下，自定义元素继承自 HTMLElement。上面的代码相当于下面的代码：

customElements.define("codingdude-gravatar", CodingDudeGravatar);

如果您希望创建扩展另一个 HTML 元素的自定义元素，则必须在 customElements.define() 中扩展本机元素。继承本机元素的自定义元素也称为“类型扩展自定义元素”。

customElements.define("codingdude-gravatar", class extends HTMLButtonElement {...});

还有一些需要注意的事情：

DOMException

4.实例化自定义元素

HTML 元素的所有标准规则都适用于自定义元素。就像标准元素一样，您可以使用 JavaScript 在 DOM 中创建自定义元素，或在 HTML 中声明它。

在 HTML 中声明自定义元素：

<codingdude-gravatar></codingdude-gravatar>

使用 JavaScript 在 DOM 中创建自定义元素：

var codingdudeGravatar = document.createElement('codingdude-gravatar');
codingdudeGravatar.addEventListener('click',function(e){});

在 HTML 中实例化类型扩展元素：

<button is="codingdude-gravatar">

使用 JavaScript 在 DOM 中创建类型扩展元素：

var codingdudeGravatar = document.createElement('button', 'codingdude-gravatar');

5.向自定义标签添加标记

在自定义标签中添加标记相当简单。首先，您需要创建一个扩展父 HTML 元素的类。在我们的例子中，我们将扩展 HTMLElement。在 HTMLElement 中，我们将使用 constructor 添加事件侦听器并调整自定义标记的 innerText 。记得调用 super() 因为这将有助于继承父类的方法和属性。永远记住，构造函数内的 this 指向创建的自定义元素。

这是我们组件外观的简单概述。

class CodingDudeGravatar extends HTMLElement {
  constructor() {
    super()
    this.addEventListener('click', e => {
        alert('You Clicked Me!')
    });
    this.innerText="Hello There!"
  }
}
window.customElements.define('codingdude-gravatar', CodingDudeGravatar);

6.生命周期方法

在开始向自定义标记添加标记之前，您需要了解与自定义标记关联的生命周期方法。有四个生命周期回调。

回调	目的
`构造函数`	创建自定义标签元素的实例
`connectedCallback`	自定义标签元素的实例被插入到文档中
`disconnectedCallback`	自定义标签元素的实例从文档中删除
`attributeChangedCallback(attributeName, oldValue, newValue)`	添加、删除或更新了自定义标记元素中的属性

带有这些回调的自定义标记的骨架如下所示：

class CodingDudeGravatar extends HTMLElement {
    constructor() {
    super(); // always call super() first in the constructor.
    ...
    }
    connectedCallback() {
    ...
    }
    disconnectedCallback() {
    ...
    }
    attributeChangedCallback(attrName, oldVal, newVal) {
    ...
    }
}

我们已经了解了如何在自定义元素中使用 构造函数 。现在，让我们在代码中使用其他回调方法！让我们从 connectedCallback 开始。

`connectedCallback`

connectedCallback 可用于检查自定义标记中的电子邮件属性。一旦元素添加到文档中，就会进行此检查。我们将使用 getter 函数来检查 custom tag 是否具有 email 属性。

class CodingDudeGravatar extends HTMLElement {
  get email() {
    return this.hasAttribute('email');
  }
  constructor() {
    super()
    this.addEventListener('click', e => {
        alert('You Clicked Me!')
    });
    this.innerText="Hello There!"
  }
  connectedCallback(){
    if(this.email){
        var email = this.attributes.email.value;
        var gravatar = "https://www.gravatar.com/avatar"
        this.innerHTML = "<img src='"+gravatar+"'></br>"+email
    }
    else
    {
      this.innerHTML = "No Email";
    }
  }
}

当自定义标记插入 HTML 中时，您将看到如下内容：

<codingdude-gravatar></codingdude-gravatar>

创建自定义标签以扩展 HTML 功能

但是，当在自定义标签中设置 email 属性时，屏幕将如下所示：

<codingdude-gravatar email="admin@coding-dude.com"></codingdude-gravatar>

创建自定义标签以扩展 HTML 功能

`attributeChangedCallback`

浏览器将为 observedAttributes 数组中列出的所有属性调用生命周期方法 attributeChangedCallback。其背后的目标是提高自定义标签的性能。例如，如果用户决定更改样式，您不希望触发 attributeChangedCallback 。在我们的例子中，我们希望仅当电子邮件更改时才调用 attributeChangedCallback 。为了实现这一点，代码如下所示：

class CodingDudeGravatar extends HTMLElement {
  get email() {
    return this.hasAttribute('email');
  }
  constructor() {
    super()
    this.addEventListener('click', e => {
        alert('You Clicked Me!')
    });
    this.innerText="Hello There!"
  }
  connectedCallback(){
    if(this.email){
        var email = this.attributes.email.value;
       var gravatar = "http://www.gravatar.com/avatar"
            this.innerHTML = "<img src='"+gravatar+"'></br>"+email
    }
    else
    {
      this.innerHTML = "No Email";
    }
  }
  static get observedAttributes() {
    return ['email'];
  }
  attributeChangedCallback(name, oldValue, newValue) {
    if(name == 'email'){
      alert(`The ${name} changed to ${newValue}`)
    }
  }
}

根据上面的代码，每次我们更改电子邮件时都会看到一条警报。

创建自定义标签以扩展 HTML 功能

自定义元素中的回调是同步的。如果在自定义元素上调用 el.setAttribute('email','newemail') ，浏览器将立即触发 attributeChangedCallback() 。

`disconnectedCallback`

生命周期方法列表中的最后一个是 disconnectedCallback。当您从文档中删除元素时，将调用此方法。当您想要清除自定义标签造成的影响时，该方法非常有用。您可以使用 el.remove() 方法轻松删除自定义标签。

但是，您必须非常小心 disconnectedCallback() 的使用方式。如果用户选择关闭选项卡或浏览器，则永远不会触发此回调。

7.属性到属性

在任何基于 HTML 的应用程序中，开发人员使用反映在 DOM 上的属性是很常见的。例如， hidden 是可用于隐藏元素的属性，例如<div hide></div> 只会隐藏 DOM 中的元素。开发人员自然希望这些属性也适用于自定义标签。

由于我们从 HTMLElement 扩展，因此默认情况下这些属性将出现在自定义元素中。然而，这些属性的行为是可以修改的。大多数时候，JavaScript 类中的 getter 和 setter 用于控制属性。

codingdude-gravatar[hidden] {
    opacity: 0.5;
    pointer-events: none;
}

...inside the class
{
    get hidden() {
        return this.hasAttribute('hidden');
    }
    
    set hidden(val) {
        // Reflect the value of `hidden` as an attribute.
        if (val) {
        this.setAttribute('hidden', '');
        } else {
        this.removeAttribute('hidden');
        }
    }
}

演示

本文中讨论的所有内容都可以在以下演示中进行实验。

见笔 DDev (@divyaddev) 的自定义标签在 CodePen 上。

结论

万岁！我们已经结束了关于如何创建自定义元素的文章。现在，您应该能够创建自定义元素并在 HTML 标记中使用它。一定要尝试一下！您将会惊讶地发现我们可以完成这么多工作。

这只是自定义元素工作原理的开始。这个领域还有很多东西需要探索和学习。请继续关注此空间，了解有关自定义元素及其高级概念的更多帖子。

Das obige ist der detaillierte Inhalt vonErstellen Sie benutzerdefinierte Tags, um die HTML-Funktionalität zu erweitern. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

JavaScript css html define 封装父类构造函数标识符继承 JS 对象事件 constructor dom this

Stellungnahme：

Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn

Vorheriger Artikel：HTML-TagsNächster Artikel：HTML-Tags

In Verbindung stehende Artikel

Mehr sehen