使用 Vanilla JS 构建可复用 HTML 组件的推荐实践

秋明吖_7602

秋明吖_7602

2026-10-03

392人浏览

原创

使用 Vanilla JS 构建可复用 HTML 组件的推荐实践

本文介绍如何在不依赖框架的前提下,通过类封装 + 自定义 data 属性 + web components 思路,构建结构清晰、易于维护的自定义 html 对象(如图表组件),兼顾可读性、可扩展性与原生兼容性。

本文介绍如何在不依赖框架的前提下,通过类封装 + 自定义 data 属性 + web components 思路,构建结构清晰、易于维护的自定义 html 对象(如图表组件),兼顾可读性、可扩展性与原生兼容性。

在 Vanilla JS 项目中,当页面需要重复渲染多个结构相似、行为一致的 UI 单元(例如带 Canvas 图表、控制按钮和配置表单的“数据卡片”)时,简单地用 document.createElement 拼接 DOM 或写长循环极易导致代码臃肿、逻辑耦合、复用困难。此时,核心诉求是:将模板、状态与行为封装为可实例化的单元——而最佳路径并非直接跳入复杂方案,而是分阶段演进:从轻量抽象起步,逐步向标准化靠拢。

✅ 推荐方案:基于类的声明式组件(Class + data-attribute 驱动)

最实用、兼容性最好且无需构建工具的方案,是定义一个 JavaScript 类(如 Chart),通过约定的 data-* 属性识别并挂载到现有 DOM 节点上。这种方式不侵入 HTML 标准,却实现了组件化的核心价值:关注点分离、实例隔离、生命周期可控。

以下是一个典型实现:

class Chart {
  #root;
  #dataUrl;
  #chartData;

  constructor(root) {
    this.compile(root);
  }

  compile(root) {
    if (!root?.matches?.('[data-chart]')) {
      throw new ReferenceError('Root element must have [data-chart]');
    }
    this.#root = root;

    // 从 data 属性提取配置
    this.#dataUrl = root.dataset.chartDataUrl;
    this.#chartData = root.dataset.chartData ? JSON.parse(root.dataset.chartData) : null;

    // 初始化子元素(如 canvas)
    const canvas = this.#root.querySelector('canvas');
    if (canvas) {
      this.#initCanvas(canvas);
    }
  }

  #initCanvas(canvas) {
    const ctx = canvas.getContext('2d');
    ctx.clearRect(0, 0, canvas.width, canvas.height);

    // 示例:绘制占位图形(实际中替换为你的图表逻辑)
    ctx.fillStyle = '#369';
    ctx.fillRect(10, 10, 80, 40);
    ctx.font = '12px sans-serif';
    ctx.fillStyle = '#fff';
    ctx.fillText('Chart', 15, 35);
  }

  // 公共方法供外部调用(如刷新数据、重绘)
  redraw() {
    const canvas = this.#root.querySelector('canvas');
    if (canvas) this.#initCanvas(canvas);
  }

  destroy() {
    // 清理事件监听、定时器等
  }
}

// 批量初始化所有 chart 组件
function initializeCharts() {
  document.querySelectorAll('[data-chart]').forEach(el => new Chart(el));
}
initializeCharts();

对应 HTML 使用方式简洁直观:

html-deploy
html-deploy

使用 htmlcode.fun 将 HTML 内容或文件部署到网页,适用于用户要求“部署到网页”“托管此 HTML”“生成此前端...的实时链接”等场景。

下载
<article data-chart data-chart-data='[{"x":0,"y":2},{"x":1,"y":5}]' data-chart-data-url="/api/chart/123"><fieldset>
<legend>Settings</legend>
    <label><span>Enable Trendline</span><input type="checkbox"></label>
    <button type="button" onclick="this.closest('[data-chart]').__chart?.redraw()">Refresh</button>
  </fieldset>
<figure><canvas width="400" height="150"></canvas><figcaption>Sales Overview (Q1)</figcaption></figure></article>

? 关键设计思想:

  • HTML 是声明式 API:data-chart 表明“这是一个 Chart 组件”,其他 data-* 提供配置;
  • JS 是实现引擎:类负责解析配置、操作 DOM、封装逻辑;
  • 实例即上下文:每个 <article data-chart></article> 对应独立 Chart 实例,互不干扰;
  • 可扩展性强:后续可轻松添加 exportToPNG()、onDataUpdate(cb) 等方法。

⚠️ 注意事项与进阶建议

  • 避免全局污染:将 Chart 类置于模块作用域或 IIFE 中,防止命名冲突;
  • 异步数据加载需谨慎:若依赖 fetch(this.#dataUrl),应在 compile() 后异步处理,并考虑 loading 状态与错误回退;
  • 事件委托优于内联绑定:不要在 HTML 中写 onclick="...",改用 this.#root.addEventListener('click', ...) 并在类内统一管理;
  • 样式解耦推荐 CSS 自定义属性:例如 --chart-bg: #f0f0f0,便于主题切换;
  • 向 Web Components 迁移平滑:当项目成熟后,可将 Chart 类改造为 class ChartElement extends HTMLElement,并注册为 <custom-chart></custom-chart> —— 此时只需调整构造函数和 connectedCallback,大部分业务逻辑可复用。

✅ 总结

对于大多数 Vanilla JS 场景,*以 `data-属性为契约、ES6 Class 为载体的轻量组件模式,是平衡简洁性、可维护性与浏览器兼容性的最优解**。它不强制引入新标准,却已蕴含 Web Components 的设计哲学:封装、复用、自治。从今天起,把每一个

` 当作一个可实例化的对象,你的前端架构便已迈出坚实一步。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

相关文章

HTML速学教程(入门课程)
HTML速学教程(入门课程)

HTML怎么学习?HTML怎么入门?HTML在哪学?HTML怎么学才快?不用担心,这里为大家提供了HTML速学教程(入门课程),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

html js

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

4446

5

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

2023.07.04

1109

3

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

2023.07.04

4364

6

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

2023.09.01

880

4

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.04

1776

5

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

2023.09.04

3205

4

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

2023.09.12

4173

6

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2023.09.20

2680

5

java访问控制修饰符介绍
java访问控制修饰符介绍

java访问控制修饰符有四种,分别是public、protected、private、默认访问修饰符。详细介绍:1、public,public是最宽松的访问控制修饰符,被修饰的类、方法和变量可以被任何其他类访问,当一个类、方法或变量被声明为public时,它们可以在任何地方被访问,无论是同一个包中的类还是不同包中的类;2、protected修饰符等等。

2023.09.20

868

7

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
GDB 17.2 官方文档集合
GDB 17.2 官方文档集合

共0课时 | 0人学习

Bootstrap 入门安装配置
Bootstrap 入门安装配置

共0课时 | 0人学习

38+ PhpStorm 提示和技巧
38+ PhpStorm 提示和技巧

共1课时 | 219人学习