在本教學中,我將向您展示使用自訂標籤擴充 HTML 語言是多麼容易。自訂標籤可用於實現各種行為,因此它們是編寫更少程式碼並使 HTML 文件更簡單的非常方便的方法。
要進一步了解自訂標籤,請查看我關於使用 Shadow DOM 建立封裝的自訂標籤的文章。
例如,對於 HTML,您可以使用 <b></b>
標記來顯示粗體文字。如果您需要列表,則可以對每個列表項目使用 <ul></ul>
標籤及其子標籤 <li>
。標籤由瀏覽器解釋,並與 CSS 一起確定網頁內容的顯示方式以及部分內容的行為方式。
有時,只使用一個 HTML 標籤不足以滿足 Web 應用程式所需的功能。通常,這是透過使用多個 HTML 標籤以及 JavaScript 和 CSS 來解決的,但這種解決方案並不是那麼優雅。
更優雅的解決方案是使用自訂標籤 - 中包含的標識符,瀏覽器會解釋該標識符以呈現我們預期的功能。與常規 HTML 標籤一樣,我們應該能夠在頁面上多次使用自訂標籤,並且還應該能夠擁有標籤屬性和子標籤來輔助自訂標籤的功能。
簡單來說,自訂元素可用來解鎖以下功能:
在這篇文章中,我們將透過建立一個名為 <codingdude-gravatar></codingdude-gravatar>
的自訂標籤來了解自訂元素。此自訂標籤將顯示特定電子郵件地址的 Gravatar 圖片。
現代瀏覽器中的 customElements
API 讓這一切變得簡單!
為了實作和測試我們的標籤,我們需要創建一些東西:
讓我們編輯 index.html 檔案並使其內容如下所示:
<!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>
如果我們現在在瀏覽器中載入 index.html,結果不會那麼令人印象深刻,因為我們尚未實作自訂標記的程式碼。
需要注意的一件事是瀏覽器非常寬容,因此您可以在文件中包含未知標籤,瀏覽器將忽略它們。為了讓我們的自訂標籤真正顯示我的電子郵件的 Gravatar 圖片,我們必須先了解 Gravatar 的工作原理。
為了建立自訂標籤,您需要使用 window.customElements.define()
。
customElements.define()
中的第一個參數是標記的名稱。這就是我們在 HTML 文件中提到的。該名稱應始終帶有破折號 (-)。名稱類似於 <codingdudeGravatar>
的標籤無效。這使得解析器應該能夠區分常規元素和自訂標籤。
customElements.define()
有第二个可选对象。该对象用于提及新元素的原型。默认情况下,自定义元素继承自 HTMLElement
。上面的代码相当于下面的代码:
customElements.define("codingdude-gravatar", CodingDudeGravatar);
如果您希望创建扩展另一个 HTML 元素的自定义元素,则必须在 customElements.define()
中扩展本机元素。继承本机元素的自定义元素也称为“类型扩展自定义元素”。
customElements.define("codingdude-gravatar", class extends HTMLButtonElement {...});
还有一些需要注意的事情:
DOMException
。
<li>自定义元素标签不能自动关闭。
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');
在自定义标签中添加标记相当简单。首先,您需要创建一个扩展父 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);
在开始向自定义标记添加标记之前,您需要了解与自定义标记关联的生命周期方法。有四个生命周期回调。
回调 | 目的 |
---|---|
构造函数 |
创建自定义标签元素的实例 |
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>
但是,当在自定义标签中设置 email
属性时,屏幕将如下所示:
<codingdude-gravatar email="admin@coding-dude.com"></codingdude-gravatar>
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}`) } } }
根据上面的代码,每次我们更改电子邮件时都会看到一条警报。
自定义元素中的回调是同步的。如果在自定义元素上调用 el.setAttribute('email','newemail')
,浏览器将立即触发 attributeChangedCallback()
。
disconnectedCallback
生命周期方法列表中的最后一个是 disconnectedCallback
。当您从文档中删除元素时,将调用此方法。当您想要清除自定义标签造成的影响时,该方法非常有用。您可以使用 el.remove()
方法轻松删除自定义标签。
但是,您必须非常小心 disconnectedCallback()
的使用方式。如果用户选择关闭选项卡或浏览器,则永远不会触发此回调。
在任何基于 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'); } } }
本文中讨论的所有内容都可以在以下演示中进行实验。
这只是自定义元素工作原理的开始。这个领域还有很多东西需要探索和学习。请继续关注此空间,了解有关自定义元素及其高级概念的更多帖子。
以上是建立自訂標籤以擴展 HTML 功能的詳細內容。更多資訊請關注PHP中文網其他相關文章!