使用CLI 3 創建發布Web Components


本文翻譯自:codementor

翻譯不當之處,歡迎指正交流

Web Components是web平台的未來嗎?關於這一問題支持和反對的觀點有很多。事實上瀏覽器對Web Components的支持正在逐漸形成,並有越來越多的工具、資源和IT從業人員正在致力於創建發布自己的Web Components。

Vue.js是一個創建Web Components的很好的工具,在更新的Vue CLI 3和@vue/web-component-wrapper中甚至更加簡單。
這篇文章中,我們會討論為什么你需要創建一個Web Components並向你展示如何在僅有Vue基礎知識的情況下創建你的第一個Web Components。
Note: this article was originally posted here on the Vue.js Developers blog on 2018/05/21 [本文章原創發布地址]

 

  • 什么是Web Components

相信你已經對HTML元素(div,spans,tables等)很熟悉了,Web Components是一種定制的,可以在web app和web頁面中使用並復用的HTML元素。
例如,你可以創建一個定制的element叫做 video-player ,並且
可以提供一個可重用的video接口, 它的 UI 功能超出了標准 HTML 5 視頻元素的可用范圍。這個元素能夠為video文件和事件(如:播放play,暫停pause等)提供一個“src”屬性,允許用戶以編程方式來控制它。

<div>
<video-player src="..." onpause="..."></video-player>
</div>

這聽起來或許很像常規的Vue components做的,不同之處就在於web components是瀏覽器原生的(或者說至少會隨着規范來逐步實現)並能夠像HTML元素一樣來用。無論如何,不管你用什么工具去創建你的web components你都可以在react,angular等框架中(甚至不需要使用框架)來使用它。

function ReactComponent() { return( <h1>A Vue.js web component used in React! </h1>
    <video-player></video-player> ); }

 

  • 如何創建一個web component?

在內部,web components由瀏覽器早已熟悉的標准HTML元素構成,如divs,spans等。所以video-player在內部看起來更像這樣:

<div>
  <video src="..."></video>
  <div class="buttons">
    <button class="play-button"></button>
    <button class="pause-button"></button> ... </div> ... </div>

Web components也可以包含CSS和Javascript。使用新的瀏覽器標准像Shadow DOM這種,通過你自己定制的組件完全封裝,因此用戶不需要擔心CSS會覆蓋web component中的規則。
當然,您將用API聲明自帶的web 組件。但我們目前不需要知道,因為我們將使用的的是一個抽象層
更多深入介紹 Web Components - Introduction

 

  • 使用@vue/web-component-wrapper創建web components

通過Vue CLI3和新的@vue/web-component-wrapper庫創建web components十分方便。
@vue/web-component-wrapper庫提供了一個通過web componentAPI接入Vue組件的容器。這個容器能夠自動代理properties,attributes,events和slot。這意味着你可以僅用你現有的Vue components知識寫一個web components!
關於創建webcomponents另一個vue庫vue-custom-element
創建一個webcomponent,先確保已安裝Vue CLI3並通過任何你熟悉的環境創建一個新的項目。

$ vue create vue-web-component-project

現在創建一個新的可以作為web component來使用的Vue component.這個組件在發布前可以通過webpack來編輯,所以你可以使用任何JavaScript的特性。但這里我們只是做一些簡單的雛形來進行可行性的概念驗證:
src/components/VueWebComponent.vue

<template>
  <div>
    <h1>My Vue Web Component</h1>
    <div>{{ msg }}</div>
  </div>
</template>
<script> export default { props: ['msg'] } </script>

通過@vue/web-component-wrapper來准備一個包裹的組件以確保你的入口文件,正如: src/main.js

import Vue from 'vue';
import wrap from '@vue/web-component-wrapper';
import VueWebComponent from './components/VueWebComponent';

const CustomElement = wrap(Vue, VueWebComponent);

window.customElements.define('my-custom-element', CustomElement);

用來注冊一個組建的APIcustomElements.define()注意custom element和web component在這方面是一樣的

 

  • 用Vue CLI3構建一個web component

Vue CLI3包括了許多不錯的新特性(查看這篇文章的摘要)。CLI Service使用的是Webpack來處理多項任務包括構建你自己的項目代碼。這一點可以通過簡單的vue-cli-service build指令來完成。通過添加

--target wc來轉換,你可以創建一個依賴,完美地創建一個web component:

$ vue-cli-service build --target wc --name my-custom-element ./src/main.js

在幕后,使用webpack來處理單獨的javascript文件和所有必須的內置web components。當被包含在一個頁面內時,<my-custom-element> 這個腳本注冊了一個用@vue/web-component-wrapper包裹着目標的Vue組件

 

  • 在網頁中使用你的Vue web component

隨着你的組建的構建, 任何人都可以在一個非Vue項目中使用它使用並不需要任何Vue.js的代碼(即便你為了避免重復刻意不添加綁定而需要導入Vue庫 作為在這種情況下,where你使用多個基於Vue的web components)一旦你加載定義在頁面上的腳本時,定制的元素就起到了原生HTML元素的作用。
請注意, 包含polyfill(填充代碼)是非常必要的, 因為大多數瀏覽器本身並不支持所有web component規范。在這里,我使用webcomponents.js (v1 spec polyfills)
index.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width,initial-scale=1.0">
    <title>My Non-Vue App</title>
  </head>
  <body>
    <!--Load Vue-->
    <script src="https://unpkg.com/vue"></script>
    <!--Load the web component polyfill-->
    <script src="https://cdnjs.cloudflare.com/ajax/libs/webcomponentsjs/1.2.0/webcomponents-loader.js"></script>
    <!--Load your custom element-->
    <script src="./my-custom-element.js"></script>
    <!--Use your custom element-->
    <my-custom-element msg="Hello..."></my-custom-element>
  </body>
</html>

這段代碼是有效的,如果你想把這段代碼作為模板來引用的話,我把它們放到了這里

 

  • 發布

最后,如果你想和所有人分享你的web component,沒有比webcomponents.org更好的地方了。這個網站有一個供免費下載web component的可瀏覽收藏夾,所展示的是由Vue,Polymer,Abgular等各種框架構建的組件。

擴展閱讀
• Docs for @vue/web-component-wrapper
• Docs for Vue CLI 3 Build Targets

• Web Components - Introduction

Get the latest Vue.js articles, tutorials and cool projects in your inbox with the Vue.js Developers Newsletter

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM