Web components API: Shadow DOM、Light DOM、 Lifecycle Events 和 Custom Events

shadow DOM

组件开发者编写的 DOM。Shadow DOM 对组件来说是本地的,它定义了它的内部结构、作用域 CSS,并封装了实现细节。它还可以定义如何呈现由组件的使用者编写的 DOM。

light DOM

由组件使用者编写的 DOM。这个 DOM 存在于组件的 shadow DOM 之外。它是自定义元素的实际子元素。特别是 slot。

插槽允许组件使用者定义 html,因为不是 shadow DOM 的一部分,没有被封装,所以样式受页面的影响,并且 DOM 可以被获取到。比如下面 img 和 span 就是 light DOM:

<webc-button>
  <img src slot="icon" />
  <span> Hello </span>
</webc-button>

Lifecycle Events

一图胜千言

image.png

Constructor

创建 webc 时调用。

  1. HTMLElement 类建立原型链的地方
  2. 初始化组件必要的属性
  3. 使用 attachShadow() 方法创建 shadow DOM

其余操作,比如获取数据、渲染不建议在这里,而是在 connectedCallback 中

connectedCallback

每次 web 组件连接到 DOM 时调用。适合获取数据或添加事件监听器。

adoptedCallback

每次将 Web 组件移动到新文档时调用。这特别适用于 iFrame。

attributeChangedCallback

每次添加、更改或删除 web 组件的属性时调用。

接收三个参数:

  1. 属性名
  2. 旧值
  3. 新值
attributeChangedCallback(name, oldValue, newValue) {

}

要能够监听到属性的变化,需要 observedAttributes 方法指定要监听的属性。

static get observedAttributes() {

  return ['value', 'min', 'max'];

}

disconnectedCallback

Web 组件与文档 DOM 断开连接时调用。适合移除事件监听器,中断数据的请求等操作。

Custom Events

当我们基于用户操作执行代码时,原生事件是我们必须在 Web 上添加交互性的主要方式:例如,当用户单击某处(单击事件)时我们运行一些程序,或者当用户输入时验证值的合法性。

同样的,在开发 web 组件时,不得不需要用到事件。因为:事件是组建公共 API 的一部分,某些事件触发后的逻辑需要交给组件使用者处理。比如:

  1. 什么时候加载完数据
  2. 值更改
  3. 内部触发的事件

创建自定义事件

使用 Event 构造函数

const event = new Event('build')

ele.addEventListener('build', function (e) { ... }, false)
ele.dispatchEvent(event)

添加自定义数据

要向事件对象添加更多数据,使用 customEvent,detail 属性可用于传递自定义数据。 例如:

const event = new CustomEvent('build', { 'detail': 22 })

ele.dispatchEvent(event)

组件库建设

内部使用纯原生 API 搞了一套移动端组件库。大致罗列下一套组件库需要做哪些工作:

布局适配、主题

目前主流的组件库在适配上基本采用的方式是:设置基准值,然后使用 rem 或 vw 或者两者兼用的方式,开发时同时使用 px,打包时使用 px2rem 的插件进行处理。但是 webc 组件不同,css 被封装到了 Shadow DOM 中,无法使用 px2rem 进行修改。并且 webc 组件还要面临使用者适配方案不一致的情况。

webc 适配方案

既然 webcomponents 的组件是已经打包成了不可见的 shadow dom 了,既然通过插件改不了 css 代码,就需要一个变量和外部形成桥梁,css 变量就是低成本、便捷的选择。事实上已经有不少三方组件库采用 css 变量实现主题的自定义。

;(function (win) {
  win.rwcFn = function () {
    var oDoc = document.documentElement,
      iW = oDoc.clientWidth || win.innerWidth,
      _base = 375,
      _maxW = 1024

    iW = Math.min(iW, _maxW)

    oDoc.style.setProperty('--webc-base-font', (iW / _base).toFixed(2))
  }

  rwcFn()

  win.addEventListener('resize', rwcFn, false)
})(window)
@media (min-width: 320px) {
  :root {
    --webc-base-font: 0.8533333333333334;
  }
}

@media (min-width: 360px) {
  :root {
    --webc-base-font: 0.96;
  }
}

/*
    iphone 678x
 */

@media (min-width: 375px) {
  :root {
    --webc-base-font: 1;
  }
}

/*
    iphone 678 plus
 */
@media (min-width: 414px) {
  :root {
    --webc-base-font: 1.104;
  }
}

/*
   ipad  
 */
@media (min-width: 677px) {
  :root {
    --webc-base-font: 1.8053333333333332;
  }
}

/*
   ipad  
 */
@media (min-width: 712px) {
  :root {
    --webc-base-font: 1.8986666666666667;
  }
}

/*
   ipad  
 */
@media (min-width: 768px) {
  :root {
    --webc-base-font: 2.048;
  }
}

代码质量

eslint、prettier、husky

无障碍

无障碍

单元测试

使用 @open-wc/testing 和 @web/test-runner 做单元测试

与 Vue & React 结合

React 与 Web Components

Vue 与 Web Components

打包构建

使用 webpack

打包出一个全局 bundle,针对每个组件打包出一个单独的包,按需加载时只引入单独的文件即可。

文档建设

构建部署

stencil

纯原生开发存在不少问题,

  1. 开发效率低下;比如 html 模版和样式的编写和维护、数据更新的读取和监听、事件的触发、slot 的监听等
  2. 整体架构需要从 0 到 1 搭建
  3. 目标文件的输出
  4. 与其他框架的集成等诸多问题

stencil 是由 ionic 团队开发的用于开发 web 组件库的工具链,包括:框架集成、静态站点生成、单元测试等功能。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,088评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,715评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,361评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,099评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 60,987评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,063评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,486评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,175评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,440评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,518评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,305评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,190评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,550评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,880评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,152评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,451评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,637评论 2 335

推荐阅读更多精彩内容

  • 前言 在初涉前端之时,我就一直在好奇一个问题,为什么像: …… 等等这些标签,看起来似乎很简单,可为什么可以展现出...
    隐逸王阅读 403评论 0 0
  • 这是webkitBlog上一篇文章的翻译,原文链接。 很高兴宣布我们已经对slot-base Shadow DOM...
    IAIAE阅读 2,452评论 0 2
  • 组件化是前端工程化重要的一环,UI 和 交互(或逻辑)的复用极大的提高开发效率以及减少代码冗余。 目前开源的组件库...
    一蓑烟雨任平生_cui阅读 4,459评论 0 4
  • 前端组件化其实是个持续了很长时间的过程了,从最开始的jquery的插件开始。我们就在封装一些js,css,html...
    潘逸飞阅读 9,726评论 1 16
  • 组件的概念 组件,是数据和方法的一个封装,其定义了一个可重用的软件元素的功能,展示和使用,通常表现为一个或一组可重...
    zx_lau阅读 2,408评论 0 3