web component学习笔记

参考链接:https://www.robinwieruch.de/web-components-tutorial

http://www.ruanyifeng.com/blog/2019/08/web_components.html

https://mp.weixin.qq.com/s/KsPpmBrLsu0HjYWuzyAdgQ

https://segmentfault.com/a/1190000019115050

前置知识:

  • appendChild() 方法可向节点的子节点列表的末尾添加新的子节点。
    xxx.appendChild(node)
    node指的是你要添加的节点对象。

为什么要使用web components

现在很多人都使用框架进行开发,例如Vue,Angluar,React,组件化开发已经成为大家的日常,但是,有没有想过,如果不需要框架就能实现可复用的前端组件,或者说在不同的框架之间使用同一套组件,那是不是会掀起一阵新的浪潮?

web components就是这样的一套功能组件,只需要HTML,CSS和JavaScript就能创建能运行在任何浏览器上的可复用组件了。

开始动手搭建我们的web components吧

我们的目标是做一个像这个一样的小组件!!!冲鸭!


image.png
定义一个类

构造函数必须是一个ES6的类,

class HelloWorld extends HTMLElement {
  constructor() {
    // 必须首先调用 super 方法
    super();

    // 元素的功能代码写在这里

    ...
  }
}

注册一个 custom emelent

使用customElements.define来注册一个 custom emelent,这个方法接受三个参数:

  1. 所创建的元素名称的符合,不能为单个单词,中间必须要用短横线连接,方便与原生的HTML元素区别开来。
  2. 用于定义元素行为的类
  3. 可选参数,一个包含extends 属性的配置对象,是可选参数。它指定了所创建的元素继承自哪个内置元素,可以继承任何内置元素。

看下实例:

customElements.define('hello-world', HelloWorld, { extends: 'p' });

这个元素叫做 hello-world,它的类对象是 HelloWorld, 继承自自<p>元素。

template标签

Web Components API 提供了<template>标签,可以在它里面使用 HTML 定义 DOM。

<template id="helloWorldTemplate">
  <div class="container">
    <p class="title">2019前端面试技巧</p>
    <p class="text">掌握最新面试技巧,面试题,让你在前端面试中脱颖而出。</p>
    <a class="detail">查看详情</p>
  </div>
</template>

这个时候,我们要重新修改一下我们的HelloWorld类,使我们的这个类加载这个template。

class HelloWorld extends HTMLElement {
  constructor() {
    // 必须首先调用 super 方法
    super();

    var templateElem = document.getElementById('helloWorldTemplate')
    var content = templateElem.content.cloneNode(true)
    this.appendChild(content);
  }
}

添加样式

给自定义元素添加元素,将样式写在<template>里面,让样式只对自定义元素生效,不影响外部。

例子中的样式代码如下:

<style>
  .container {
    background-image: url(http://img.mukewang.com/595228110001155208000480.jpg);
    background-size: 100%;
    float: left;
    width: 475px;
    height: 124px;
    border-radius: 6px;
    color: #fff;
    margin: 0 10px 36px 20px;
    box-sizing: border-box;
    padding: 24px 32px 0;
  }
  .detail {
    margin-top: 8px;
    font-size: 12px;
    font-weight: 200;
    color: rgba(240, 20, 20, 0.6);
    line-height: 16px;
  }
  .title {
    font-size: 20px;
    line-height: 24px;
    margin: 2px;
    color: rgba(255, 255, 255, 0.8);
    overflow: hidden;
    text-overflow: ellipsis;
    white-space: nowrap;
  }
  .text {
    font-size: 12px;
    line-height: 24px;
    color: rgba(255, 255, 255, 0.6);
    font-weight: 200;
    margin-top: 5px;
    overflow: hidden;
    text-overflow: ellipsis;
    white-space: nowrap;
  }
</style>

抽离参数

我们的自定义元素可能多次出现,所以像上面将他写死就与我们当初组件化的初衷相背离了,我们应该将参数抽离出来,像下面这样:

<hello-world
  title="2019前端面试技巧"
  text="掌握最新面试技巧,面试题,让你在前端面试中脱颖而出。"
  img="url(http://img.mukewang.com/595228110001155208000480.jpg)"
></hello-world>

相对应的,应该在HelloWorld类中对参数进行处理

class HelloWorld extends HTMLElement {
  constructor() {
    // 必须首先调用 super 方法
      super();

      var templateElem = document.getElementById('helloWorldTemplate')
      var content = templateElem.content.cloneNode(true)
      content.querySelector(
        '.container'
      ).style.backgroundImage = this.getAttribute('img')
      content.querySelector(
        '.container>.title'
      ).innerText = this.getAttribute('title')
      content.querySelector(
        '.container>.text'
      ).innerText = this.getAttribute('text')
      this.appendChild(content);
  }
}

此时,template的内容也相对应的修改为:

<template id="helloWorldTemplate">
  <style>...</style>
  <div class="container">
    <p class="title"></p>
    <p class="text"></p>
    <a class="detail">查看详情</p>
  </div>
</template>

在style中,将样式删掉background-image这个属性
即将大功告成,再来研究研究shadow DOM,将这一部分的DOM和外面的DOM隔绝起来吧!

Shadow DOM

使用attachShadow()方法开启 Shadow DOM,attachShadow的参数为mode。
mode: 一个指定Shadow DOM封装模式的字符串,可以是下列项目之一:
open 指定为开放的封装模式,则我们可以通过挂载时使用的真实元素获取到shadow-DOM。
closed 指定为关闭的封装模式,不允许外部访问。

  class HelloWorld extends HTMLElement {
    constructor() {
      super()
      var shadow = this.attachShadow({ mode: 'open' })
      var templateElem = document.getElementById('helloWorldTemplate')
      var content = templateElem.content.cloneNode(true)
      shadow.appendChild(content)
    }
  }

https://github.com/LemonTency/jichengHomework/blob/master/0211%E7%AC%AC%E4%B8%89%E5%91%A8%E5%89%8D%E7%AB%AF%E9%9B%86%E6%88%90/demo.html

组件化

在我们的实际开发过程中,可以将对应的JS代码和<template>放在同一个文件中,成为独立的组件文件。网页只要加载这个脚本,就能使用对应的组件。
具体示例可以参照:
https://github.com/LemonTency/jichengHomework/tree/master/0211%E7%AC%AC%E4%B8%89%E5%91%A8%E5%89%8D%E7%AB%AF%E9%9B%86%E6%88%90/web-components-starter-kit-master

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

推荐阅读更多精彩内容