web组件标准 web components

组件的概念

组件,是数据和方法的一个封装,其定义了一个可重用的软件元素的功能,展示和使用,通常表现为一个或一组可重用的元素。

组件的特性

可拓展性:既然组件是针对某一特定功能或需求开发的,那它就必须易于开发和拓展;
封装性:组件作为一个独立整体供使用,应该是对内修改,对外封闭,只供使用,而不对使用环境产生副作用;
易用性:组件的目的是产生可重用的独立部件,那就必须提供一种简单快捷的方式供使用。

Web Components特征

Web Components将一系列特性加入HTMLDOM规范,使得开发者可以自由创建在web应用或文档可重用的元素或部件,其由四部分组成:

HTML模板(HTML Templates):HTML内的DOM模板,在<template>元素内声明。

影子DOM(Shadow DOM):组合对DOM和样式的封装;

HTML导入(HTML Imports):定义在文档中导入其他HTML文档的方式;

自定义元素(Custom Elements):定义新HTML元素的一系列API;

HTML模板

<body>
    <hello-button>hello</hello-button>
</body>
<script>
(function() {
  var HelloButtonPrototype = Object.create(HTMLElement.prototype);
  HelloButtonPrototype.who = function() {
      alert('Hello!');
  }
  HelloButtonPrototype.createdCallback = function() {
      this.addEventListener('click', function(e) {
          HelloButtonPrototype.who();
      });
  }
  document.registerElement('hello-button', {prototype: HelloButtonPrototype});
})();
</script>

影子DOM(Shadow DOM)

DOM,即文档对象模型,是HTML文档的一个结构表示,以树形结构表示一个文档,文档中元素间关系按照父子,兄弟关系排列;DOM规范提供一系列API支持我们操作文档节点,即通常所说的DOM API。

前面提到Web Components指封装DOM和样式,以组件的形式在文档中使用,而不同于JavaScript中函数会形成一个单独作用域,文档DOM树的层次结构中是不存在局部作用域概念的,也就是说文档内所有定义的样式都对整个文档产生影响,文档中的样式也会影响组件内的声明样式,而不限定于元素所处位置,这样显然极大阻碍了组件的独立性和可重用性,是必须要解决的问题,不过不用担心,这都已经解决了,解决方案就是下文介绍的attachShadow()方法。

影子DOM API提供了attachShadow()方法,创建一个影子DOM,支持将封装的内容或组件作为一个独立DOM子树附加进一个HTML文档,组件内与外部隔离,样式互不影响,这也印证了组件开发的封装性需求。

创建

要创建一个影子DOM,很简单,使用attachShadow()方法即可,而需要注意的是所有影子DOM必须和一个文档中存在的元素(HTML内置元素或自定义元素)绑定,才能使用:

    var frag = document.createElement('div');
    var shadowRoot = frag.attachShadow({mode: 'open'});
    // open 可以通过javascript来获取shandow DOM 例如
    // close的话,就是不可以在外部获取到shadow Dom 了,访问shadowRoot就会返回null
    shadowRoot.innerHTML = '<p>Shadow DOM Content</p>';
    
    // class写法
    class SlotTest extends HTMLElement {
      constructor() {
        super();
        this.attachShadow({mode: 'open'});
      }
      connectedCallback() {
    
      }
    }
    
    customElements.define('slot-test', SlotTest);

影子树(SHADOW TREE)与影子主体(SHADOW HOST)

上文使用attachShadow()方法创建的元素就是一个影子DOM,而其子内容就构成一棵影子树(shadow tree),而和影子DOM绑定,也就是包含该树的文档内元素通常称为影子主体(shadow host)。

template 槽位(SLOT)

    <div class="menus">
        <h2>Menus</h2>
        <slot></slot>
    </div>

使用:

    <slot-test>
        <ul>
            <li>home</li>
            <li>order</li>
            <li>about</li>
        </ul>
    </slot-test>

渲染结果:

    <div class="menus">
        <h2>Menus</h2>
        <ul>
            <li>Home</li>
            <li>order</li>
            <li>about</li>
        </ul>
    </div>

命名槽

    <div class="menus">
        <h2>Menus</h2>
        <slot name="menu"></slot>
    </div>
    <slot-test>
        <ul>
            <li>home</li>
            <li>order</li>
            <li>about</li>
        </ul>
         <ul slot="menu">
            <li>menu home</li>
            <li>menu order</li>
            <li>menu about</li>
        </ul>
    </slot-test>

渲染结果

    <div class="menus">
        <h2>Menus</h2>
        <ul>
            <li>menu home</li>
            <li>menu order</li>
            <li>menu about</li>
        </ul>
    </div>

样式

Web Components定义的组件内的样式与外部环境的样式是互不影响的,那么如何为组件设置样式呢,依然使用<style>标签:

    class SlotTest extends HTMLElement {
      constructor() {
        super();
        this.attachShadow({mode: 'open'});
        this.shadowRoot.innerHTML = `
          <style>
            div h2 {
              color: red;
            }
          </style>
          <div>
            <h2>Menus</h2>
            <slot></slot>
          </div>
        `
      }
      connectedCallback() {
    
      }
    }
    customElements.define('slot-test', SlotTest);

HTML引入(HTML Imports)

    <link rel="import" href="components.html">

自定义元素(Custom Elements)

自定义元素支持开发者定义一类新HTML元素,声明其行为和样式,自定义元素分两类:

自定义标签元素(Autonomous custom elements):完全独立于原始HTML元素标签的新标签元素,其所有行为需要开发者定义;

自定义内置元素(Customized built-in):基于HTML原始元素标签的自定义元素,以便于使用原始元素的特性,开发者只需要定义拓展行为;

创建自定义标签元素

为了创建一个自定义标签元素,我们需要继承HTMLELement类, 如在很多页面我们经常会有一键回到页面顶部功能,我们创建一个返回顶部的组件:

    class GoTop extends HTMLElement {
      constructor() {
        super();
        this.addClick()
      }
      addClick() {
        this.addEventListener('click',function(e) {
          console.log(999);
          (function smoothscroll(){
            var currentScroll = document.documentElement.scrollTop || document.body.scrollTop;
            if (currentScroll > 0) {
                 window.requestAnimationFrame(smoothscroll);
                 window.scrollTo (0,currentScroll - (currentScroll/5));
            }
          })();
        })
      }
      connectedCallback() {
        // 首次被插入文档DOM时,被调用
        console.log(88888)
        console.log(this.getAttribute('data-name'))
      }
      disconnectedCallback() {
        // 文档DOM中删除时,被调用
      }
      adoptedCallback() {
        // 被移动到新的文档时,被调用
      }
      attributesChangedCallback() {
        // 元素的属性被增删改时执行
      }
    }
    console.log(HTMLElement.prototype)
    customElements.define('go-top', GoTop);

生命周期函数github example:
https://github.com/mdn/web-components-examples/tree/master/life-cycle-callbacks

在需要使用该组件的页面只需像使用正常HTML元素一样:

    <go-top>Top</go-top>

该元素的一切样式,行为,事件监听,默认行为均需要开发者自行定义

    //带图片及link的组件
    class ImgLink extends HTMLElement {
      constructor() {
        super();
      }
      connectedCallback() {
        let src = this.getAttribute('src');
        let height = this.getAttribute('height') || '100';
        let width = this.getAttribute('width') || '100';
        // Create a shadow root
        let shadow = this.attachShadow({mode: 'open'});
        // create img
        let img = document.createElement('img');
        img.src = src;
        img.width = width; 
        img.height = height; 
        shadow.appendChild(img)
        // create a
        let link = document.createElement('a');
        link.href = this.getAttribute('url');
        link.innerText = this.getAttribute('name')
        shadow.appendChild(link)
      }
    }
    
    customElements.define('img-link', ImgLink);
    

使用

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

推荐阅读更多精彩内容