使用Web Component定義自己的專屬網頁組件

来源:https://www.cnblogs.com/onecainiao/p/18356198
-Advertisement-
Play Games

什麼是Web Component Web Component是一套Web瀏覽器的技術和規範,能夠讓開發者定製自己的HTML元素 來自MDN的描述: Web Component 是一套不同的技術,允許你創建可重用的定製元素(它們的功能封裝在你的代碼之外)並且在你的 web 應用中使用它們。 Web C ...


什麼是Web Component

Web Component是一套Web瀏覽器的技術和規範,能夠讓開發者定製自己的HTML元素

來自MDN的描述:

Web Component 是一套不同的技術,允許你創建可重用的定製元素(它們的功能封裝在你的代碼之外)並且在你的 web 應用中使用它們。

Web Component由三項技術組成:

  • Custom element(自定義元素):創建一個自定義元素,並自定義其行為。

  • Shadow DOM(影子 DOM):將若幹元素封裝成獨立的DOM,並且與主文檔DOM分開呈現,互不影響。

  • HTML template(HTML 模板):用於定義可重用的HTML,在HTML中使用類似於前端框架(如Vue)中的模板,一次定義可重用代碼,涉及到兩個HTML標簽:<template> 和 <slot>

廢話不多說,讓我們以一個自定義一個GitHub標簽快速入門

快速入門

聲明式地創建HTML模板

和往常我們書寫HTML類似,唯一不同點便是以<template>包裹:

<template id="template_github_icon">
	<a href="https://github.com/martixjohn" style="display: block; width: 100%; height: 100%" target="_blank">
		<svg style="width: 100%; height: 100%"  aria-hidden="true" viewBox="0 0 24 24" version="1.1" width="32" height="32">
			<path fill="currentColor"
					d="M12.5.75C6.146.75 1 5.896 1 12.25c0 5.089 3.292 9.387 7.863 10.91.575.101.79-.244.79-.546 0-.273-.014-1.178-.014-2.142-2.889.532-3.636-.704-3.866-1.35-.13-.331-.69-1.352-1.18-1.625-.402-.216-.977-.748-.014-.762.906-.014 1.553.834 1.769 1.179 1.035 1.74 2.688 1.25 3.349.948.1-.747.402-1.25.733-1.538-2.559-.287-5.232-1.279-5.232-5.678 0-1.25.445-2.285 1.178-3.09-.115-.288-.517-1.467.115-3.048 0 0 .963-.302 3.163 1.179.92-.259 1.897-.388 2.875-.388.977 0 1.955.13 2.875.388 2.2-1.495 3.162-1.179 3.162-1.179.633 1.581.23 2.76.115 3.048.733.805 1.179 1.825 1.179 3.09 0 4.413-2.688 5.39-5.247 5.678.417.36.776 1.05.776 2.128 0 1.538-.014 2.774-.014 3.162 0 .302.216.662.79.547C20.709 21.637 24 17.324 24 12.25 24 5.896 18.854.75 12.5.75Z">
			</path>
		</svg>
	</a>
	<style>
		a {
			display: block;
		}
		a > svg {
			color: #333;
			transition: all .3s;
		}
		a:hover > svg{
			color: #000;
			filter: drop-shadow(5px 5px 10px rgba(0,0,0,0.2));
		}
	</style>
</template>

這裡實質上是一個超鏈接包裹了一個SVG圖形,圖形是我們的GitHub圖標。

你也許發現了:

  • template標簽含有id,這是為了後續使用JavaScript去引用它並定義元素。

  • 這裡創建了一個style標簽並編寫了CSS樣式,甚至直接使用元素選擇器而沒有以一個className或者id去應用樣式,有人會問這樣會不會導致和頁面衝突。

    答案是不會,這裡的樣式局限於這個模板內部,和外部DOM是隔離的。

使用JavaScript API定義和註冊我們的元素

// customElements.define()
customElements.define(
	// 元素名,必須是Kebab case命名
	// 目的是在頁面中以<github-icon />去引用
	"github-icon",
	// 定義類,需要繼承自HTMLElement
	class extends HTMLElement {
		// 構造器
		constructor() {
			// 必須調用父級構造
			super();

			// 獲取上一步定義的template模板
			const template = document.getElementById("template_github_icon");
			// 獲取模板內容
			const templateContent = template.content;

			// 獲取本元素的影子DOM樹根,mode為true表示以後可以通過JavaScript直接外部訪問根節點
			const shadowRoot = this.attachShadow({ mode: "open" });

			// 將template的內容克隆並附加到shadowRoot,
			shadowRoot.appendChild(
				// true表示深拷貝
				templateContent.cloneNode(true)
			);
		}
	}
);

實際上在第一步你可以不以HTML創建“模板”,而是在類的構造器中以JS自定義元素的創建過程

使用自定義元素

HTML頁面上使用

和普通元素使用方式完全相同,你甚至還可以為其添加屬性(attribute)

<github-icon style="width: 40px; height: 40px;"></github-icon>

JavaScript內創建

也和普通元素的創建方式相同

const element = document.createElement('github-icon');
// element.xxx=xxx

總結

以上演示瞭如何自定義元素,併在頁面中使用他們。

Web Component的靈活和強大不止於此,你甚至還可以:

  • 使用類似於Vue中的插槽slot以替換部分不相同的代碼

  • 以現有的元素為母版去擴展

  • 自定義生命周期函數

  • 響應屬性變化

  • ...

如果你仔細發現的話,本博客頁面使用的GitHub圖標正是一個自定義元素

參考

感謝你的閱讀,覺得不錯麻煩幫忙點個小小的推薦吧

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 本文介紹了記憶體管理的基礎知識,重點分析了棧區與堆區的區別,並詳細討論了V8引擎的記憶體管理機制,包括垃圾回收策略和優化技術。文章通過實例代碼展示了堆區和棧區的記憶體變化,並探討了v8如何通過並行、增量和併發技術優化垃圾回收性能。 ...
  • 本文主要內容: screenX 和 screenY, clientX 和 clientY / x 和 y pageX 和 pageY layerX 和 layerY 在處理滑鼠事件(MouseEvent)時,瞭解不同的坐標系是非常重要的。常見的坐標系包括屏幕坐標(screen)、客戶端坐標(clie ...
  • 一、載入問題 用高德地圖做了個進京證路線規劃的功能,官網也是有 React 代碼示例。但是吧,這個Demo有問題,地圖是能載入成功,但是其他功能再用 map 這個變數肯定不行,果不其然是null,處理也簡單,把公共變數都管理起來就行了。 const [map, setMap] = useState( ...
  • title: 使用 onBeforeRouteUpdate 組合式函數提升應用的用戶體驗 date: 2024/8/15 updated: 2024/8/15 author: cmdragon excerpt: 摘要:本文介紹如何在Nuxt 3開發中使用onBeforeRouteUpdate組合式函 ...
  • 歐陽堅持每周更新一篇高質量文章半年後的收益:收入1380.27元、電子書一本、微信技術群418人、微信好友459人、文章38篇 ...
  • 本文比較了NPM、Yarn 和 pnpm 三種包管理工具的特點,重點分析了它們在安裝速度、依賴管理、磁碟空間使用、依賴衝突處理等方面的差異,重點介紹了pnpm的依賴組織結構。 ...
  • 前言 在現代 Web 開發中,WebAssembly (WASM) 已成為一種強大的工具。它使得開發者可以在瀏覽器中運行高性能的代碼,跨越傳統的 JavaScript 性能限制。Rust 語言因其高效性和記憶體安全性,成為了編寫 WASM 模塊的熱門選擇。本文將介紹如何將 Rust 代碼編譯為 Web ...
  • title: 使用 onBeforeRouteLeave 組合式函數提升應用的用戶體驗 date: 2024/8/14 updated: 2024/8/14 author: cmdragon excerpt: 摘要:本文介紹了在Nuxtjs中使用onBeforeRouteLeave組合式函數來提升應 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...