使用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 8、WPF、Prism.DryIoc、MVVM設計模式、Blazor以及MySQL資料庫構建的企業級工作流系統的WPF客戶端框架-AIStudio.Wpf.AClient 6.0。 項目介紹 框架採用了 Prism 框架來實現 MVVM 模式,不僅簡化了 MVVM 的典型 ...
  • 先看一下效果吧: 我們直接通過改造一下原版的TreeView來實現上面這個效果 我們先創建一個普通的TreeView 代碼很簡單: <TreeView> <TreeViewItem Header="人事部"/> <TreeViewItem Header="技術部"> <TreeViewItem He ...
  • 1. 生成式 AI 簡介 https://imp.i384100.net/LXYmq3 2. Python 語言 https://imp.i384100.net/5gmXXo 3. 統計和 R https://youtu.be/ANMuuq502rE?si=hw9GT6JVzMhRvBbF 4. 數 ...
  • 本文為大家介紹下.NET解壓/壓縮zip文件。雖然解壓縮不是啥核心技術,但壓縮性能以及進度處理還是需要關註下,針對使用較多的zip開源組件驗證,給大家提供個技術選型參考 之前在《.NET WebSocket高併發通信阻塞問題 - 唐宋元明清2188 - 博客園 (cnblogs.com)》講過,團隊 ...
  • 之前寫過兩篇關於Roslyn源生成器生成源代碼的用例,今天使用Roslyn的代碼修複器CodeFixProvider實現一個cs文件頭部註釋的功能, 代碼修複器會同時涉及到CodeFixProvider和DiagnosticAnalyzer, 實現FileHeaderAnalyzer 首先我們知道修 ...
  • 在軟體行業,經常會聽到一句話“文不如表,表不如圖”說明瞭圖形在軟體應用中的重要性。同樣在WPF開發中,為了程式美觀或者業務需要,經常會用到各種個樣的圖形。今天以一些簡單的小例子,簡述WPF開發中幾何圖形(Geometry)相關內容,僅供學習分享使用,如有不足之處,還請指正。 ...
  • 在 C# 中使用 RabbitMQ 通過簡訊發送重置後的密碼到用戶的手機號上,你可以按照以下步驟進行 1.安裝 RabbitMQ 客戶端庫 首先,確保你已經安裝了 RabbitMQ 客戶端庫。你可以通過 NuGet 包管理器來安裝: dotnet add package RabbitMQ.Clien ...
  • 1.下載 Protocol Buffers 編譯器(protoc) 前往 Protocol Buffers GitHub Releases 頁面。在 "Assets" 下找到適合您系統的壓縮文件,通常為 protoc-{version}-win32.zip 或 protoc-{version}-wi ...
  • 簡介 在現代微服務架構中,服務發現(Service Discovery)是一項關鍵功能。它允許微服務動態地找到彼此,而無需依賴硬編碼的地址。以前如果你搜 .NET Service Discovery,大概率會搜到一大堆 Eureka,Consul 等的文章。現在微軟為我們帶來了一個官方的包:Micr ...
  • ZY樹洞 前言 ZY樹洞是一個基於.NET Core開發的簡單的評論系統,主要用於大家分享自己心中的感悟、經驗、心得、想法等。 好了,不賣關子了,這個項目其實是上班無聊的時候寫的,為什麼要寫這個項目呢?因為我單純的想吐槽一下工作中的不滿而已。 項目介紹 項目很簡單,主要功能就是提供一個簡單的評論系統 ...