這篇文章主要為大家展示了“vue組件庫的示例分析”，內(nèi)容簡而易懂，條理清晰，希望能夠幫助大家解決疑惑，下面讓小編帶領大家一起研究并學習一下“vue組件庫的示例分析”這篇文章吧。
網(wǎng)站建設哪家好，找創(chuàng)新互聯(lián)！專注于網(wǎng)頁設計、網(wǎng)站建設、微信開發(fā)、小程序開發(fā)、集團企業(yè)網(wǎng)站建設等服務項目。為回饋新老客戶創(chuàng)新互聯(lián)還提供了東方免費建站歡迎大家使用！
完整項目目錄結構
git clone到本地安裝依賴后，執(zhí)行npm run serve進行本地組件庫開發(fā)，npm run docs:dev進行組件庫官網(wǎng)開發(fā)。一般在src/demo.vue進行單個組件測試通過后，再引入到.vuepress/components中放入組件庫官網(wǎng)。
├─docs // vuepress開發(fā)目錄
│ ├─.vuepress
│ │ ├─components // 在markdown中可以使用的vue組件
│ │ ├─dist // vuepress打包目錄
│ │ │ ├─assets
│ │ │ │ ├─css
│ │ │ │ ├─img
│ │ │ │ └─js
│ │ │ ├─components
│ │ │ │ ├─basic
│ │ │ │ ├─form
│ │ │ │ ├─navigation
│ │ │ │ ├─notice
│ │ │ │ └─other
│ │ │ └─guide
│ │ │
│ │ ├─config.js // vurepess配置修改入口,包括左邊sidebar,右上方nav導航菜單,favicon等
│ │ ├─style.style // 覆蓋vuerpress默認主題樣式
│ │ └─public //公共資源入口，如favicon
│ ├─static
│ │ ├─img
│ │ └─js
│ └─views // vuepress視圖文件，格式是markdown
│ ├─components
│ │ ├─basic
│ │ ├─form
│ │ ├─navigation
│ │ ├─notice
│ │ └─other
│ ├─design
│ │ └─color
│ └─guide
├─src // 組件庫源碼目錄
│ ├─button
│ ├─cascader
│ ├─collapse
│ ├─container
│ ├─datepicker
│ ├─form
│ ├─icon
│ ├─layout
│ ├─notice
│ ├─plugins
│ ├─slide
│ ├─tab
│ ├─step
│ ├─sticky
│ └─index.js // 組件庫源碼組件入口文件,執(zhí)行npm run build的目標文件
├─package.json // 與npm發(fā)布相關，記錄版本號，包入口文件地址
學習組件庫制作會收獲
學習組件封裝技能，良好的接口設計, 掌握組件設計套路
夯實js/css基礎
深入對vue的理解
制作流程
組件設計/開發(fā)
發(fā)布npm
制作官網(wǎng)展示
組件設計/開發(fā)
頻繁涉及到的vue api包括
$children ： 獲取當前組件子組件。
$parent： 獲取當前組件父組件。
$options: 用于當前 Vue 實例的初始化選項, 可以用此選項獲得組件的name。
$refs： 一個對象，持有注冊過 ref 特性 的所有 DOM 元素和組件實例。
$el: Vue 實例使用的根 DOM 元素。
provide & inject ：這對選項需要一起使用，允許一個祖先組件向其所有子孫后代注入一個依賴,注意不是響應式的。注入的對象可以是個vue實例的eventBus。
$on： 組件監(jiān)聽自定義事件。
$emit： 組件觸發(fā)自定義事件。
.sync：語法糖，單向數(shù)據(jù)流中，父組件監(jiān)聽到子組件修改props的意圖后父組件修改傳入的props，用了.sync不需要顯式在父組件監(jiān)聽組件內(nèi)部觸發(fā)的自定義事件去修改值, 父組件只要寫:x.sync="bindValue", 注意此時子組件觸發(fā)的事件必須是"update:x"此語法糖才生效。
updated 生命周期鉤子函數(shù)，由于數(shù)據(jù)更改導致的虛擬 DOM 重新渲染和打補丁，在這之后會調(diào)用該鉤子, 在父子組件通信可能用到。
beforeDestoryed/ destory 生命周期鉤子函數(shù)，destory后組件的所有的事件監(jiān)聽器會被移除。注意:如果是自己在組件內(nèi)部對dom增加了事件監(jiān)聽，組件銷毀的時候需要自己手動接觸自己另外添加上去的監(jiān)聽程序。而且組件銷毀，dom元素還被保留在頁面，需要手動清除，可以調(diào)用原生js api, node.remove()清除dom節(jié)點。
原生js api包括：
target.addEventListener(type, listener[, useCapture])/removeEventListener 由于這是 DOM2 規(guī)范的基本內(nèi)容，幾乎所有瀏覽器都支持這個，而且不需要特殊的跨瀏覽器兼容代碼。
Node.contains()返回的是一個布爾值，來表示傳入的節(jié)點是否為該節(jié)點的后代節(jié)點。多用于事件監(jiān)聽判斷是否點擊了目標區(qū)域。
window.scrollY 獲取文檔垂直方向的滾動距離。
Element.getBoundingClientRect() 返回元素的大小及其相對于視口的位置，返回一個對象，包括width/height/left/right/top/bottom。多用于計算定位。
技術點總結
組件設計的思想包括單數(shù)據(jù)流/ eventBus事件中心，核心是組件通信。
單數(shù)據(jù)流: 數(shù)據(jù)的改變是單向的，即通過props的方式，只能讓父組件來修改數(shù)據(jù)，子組件不能主動修改props。這樣的例子如在collapse/tab/slide組件中，讓父組件來控制選中的值。單向數(shù)據(jù)流的思想讓數(shù)據(jù)修改更好設計，邏輯更加清晰。
vue插件開發(fā)：什么時候用插件開發(fā)?當組件不是顯式在代碼中被調(diào)用，不是直接寫在template中，而是通過調(diào)用Vue原型鏈上的方法被掛載到文檔中。
比如modal模態(tài)框/toast彈窗。插件設計的基本思路是暴露一個install方法，這個方法中在vue原型鏈上增加一個自定義的方法X， X中引入組件a，通過Vue.extend(a)獲得組件構造器Constructor, 在通過new Constructor({propsData})獲得組件實例vm, 再掛載組件實例到文檔中。
重慶分公司
重慶分公司
import modal from '../notice/modal'
export default {
install (vue, options) {
const Construtor = vue.extend(modal)
let modalVm // 保證全局只有一個modal實例
let lastOption
vue.prototype.$modal = (options) => {
if (lastOption !== JSON.stringify(options)) { //! modalVm
modalVm = new Construtor({ propsData: options })
modalVm.$mount()
document.body.append(modalVm.$el)
}
lastOption = JSON.stringify(options)
modalVm.isVisible = true
}
}
}eventBus：什么時候用eventBus?當狀態(tài)的變化需要多個子組件被通知。如tab組件中，當選中的值發(fā)生變化，tab-head需要感知變化讓提示的短線做個動畫滑到選中的標簽下，tab-item需要感知變化讓文字變成選中樣式，tab-pane需要感知變化讓選中的面板出現(xiàn)。
遞歸：在級聯(lián)組件的設計中用到。類似函數(shù)fn中用setTimout(fn,millseconds)調(diào)用自己實現(xiàn)setInterval的遞歸效果。組件只要內(nèi)部提供name屬性，就可以遞歸地調(diào)用自身。允許組件模板遞歸地調(diào)用自身。通過提供 name 選項，便于調(diào)試，在控制臺可以看到可以獲得更有語義信息的組件標簽。
媒體查詢 &flex布局：響應式布局的原理是媒體查詢和百分比布局，介于某個尺寸的時候某個類名生效;跟布局相關的大部分用到flex,非常好用。詳細看阮一峰老師教程
| 組件類型 | 組件 | 單數(shù)據(jù)流 | vue插件開發(fā) | eventBus | 原生js操作dom & 事件 | 遞歸 | 媒體查詢&flex布局 |
|---|---|---|---|---|---|---|---|
| 基礎 | button按鈕 | - | - | - | - | - | - |
| 基礎 | icon圖標 | - | - | - | - | - | - |
| 基礎 | grid網(wǎng)格 | - | - | - | - | - | yes |
| 基礎 | layout布局 | - | - | - | - | - | yes |
| 表單 | input輸入框 | - | - | - | - | - | - |
| 表單 | cascader級聯(lián)選擇器 | yes | - | - | - | yes | - |
| 表單 | form表單 | - | - | - | - | - | - |
| 表單 | datepicker日期選擇器 | - | - | - | yes | - | - |
| 導航 | tab標簽頁 | - | - | yes | - | - | - |
| 導航 | step步驟調(diào) | - | - | - | - | - | - |
| 通知 | toast提示 | - | yes | - | yes | - | - |
| 通知 | popover彈出框 | - | - | - | yes | - | - |
| 通知 | modal模態(tài)框 | - | yes | - | yes | - | - |
| 其他 | collapse折疊面板 | yes | - | yes | - | - | - |
| 其他 | slide輪播圖 | yes | - | - | - | - | - |
| 其他 | sticky粘滯 | - | - | - | - | - | - |
組件設計三要素
props：可以參考餓了么或者antd, 需要從用戶的角度考慮怎么使用方便和擴展性好，一般需要校驗類型和有效值，設置默認值。
slot：插槽內(nèi)容分發(fā)，使用作用域插槽讓slot也可以獲得組件內(nèi)部方法，讓用戶自定義的內(nèi)容頁能調(diào)用組件內(nèi)部方法，比如popover彈出框中用戶想自己加個按鈕手動調(diào)用關閉。
event: 組件事件。從用戶角度考慮，比如datepicker組件中用戶想在日期面板被打開或這關閉的時候進行操作。這種一般用在交互類UI組件。
舉個例子
復雜組件datepicker開發(fā)思路
1、在原有的popover組件上開發(fā)
點擊一個元素A(輸入框)后可以彈出元素B（日期面板）
2、生成日期面板
生成7*6=42個日期，6行是為了確保一個月都能在面板上完整顯示。這里計算最方便的做法是用時間戳，計算出這個月第一天時間戳和這一天周幾，就可以一次性計算出這42個日期。不用算上個月下個月分三段算，這樣的問題是還要考慮邊界情況，如剛好出現(xiàn)上一年下一年等，麻煩容易出bug。這42個日期我們在computed用visibleDays表示。
visibleDays () {
let { year, month } = this.display
let defaultObj = new Date(year, month, 28)
var curMonthFirstDay = helper.getMonthFirstDay(defaultObj)
var curMonthFirstDayDay = helper.getDay(curMonthFirstDay) === 0 ? 7 : helper.getDay(curMonthFirstDay)
let x = curMonthFirstDayDay - 1 // 前面需要補多少位
var arr = []
for (let i = 0; i < 42; i++) {
arr.push(new Date(curMonthFirstDay.getTime() + (-x + i) * 3600 * 24 * 1000))
}
return arr
},3、props接受value, 類型是date
日期面板上的日期渲染的時候加上一個計算的class, 分別加上'today','selected-date','available','prev-month','next-month'，進行樣式上的區(qū)分
4、實現(xiàn)選中日期
告訴父組件修改數(shù)據(jù)意圖讓父組件修改傳入的props，對應使用我們組件的時候使用, 這里的基礎知識是組件上的v-model是個語法糖，v-model="x"會被解析成:value="a" @input="a=$event"。同時面板上輸入框顯示的數(shù)據(jù)也要跟著變化，所以這里用計算屬性，如在computed中用formattedValue表示。
formattedValue: {
return this.value instanceof Date ? helper.getFormatDate(this.value) : ''
}5、實現(xiàn)點擊上一年/月，下一年/月
我們需要知道當前展示的是哪一年哪一個月，這個數(shù)據(jù)是組件內(nèi)部維護的，所以在data申明一個display對象
display: {
year: (this.value && this.value.getFullYear()) || new Date().getFullYear(),
month: (this.value && this.value.getMonth()) || new Date().getMonth()
}點擊的時候即修改display對象的year/month，因為visibleDays也是計算屬性，依賴display對象，所以點擊上一年/月，下一年/月，渲染的日期也跟著變。
6、實現(xiàn)選擇年
年面板的制作，生成12個年，點擊第1（12）個年渲染出上（下）12個年。這里只需要給渲染出來的年的第一個和最后一個dom元素綁定事件，事件監(jiān)聽程序傳入當前點擊的元素的值，即可計算出上或下一個12年。
同理點擊年的時候用$emit通知父組件修改value
7、實現(xiàn)選擇月
直接寫死12個月份，同理點擊月的時候用$emit通知父組件修改value
8、增加住面板上【今天】和【清空】的按鈕
點擊的時候用$emit通知父組件修改value，new Date()和''
9、細節(jié)處理
用戶選中完日期后要關閉面板
用戶選了年后點擊周圍空白區(qū)域日期面板關閉，第二次點擊進來應該默認展示日面板
10、用戶可以修改輸入框里面的值，需要判斷有效性
有效的話$emit通知父組件改值，無效的話當失去焦點的時候變回原來的值，這里需要用原生js去給input修改value。注意這里直接改formattedValue的話無效，雖然輸入框的值綁定了:value="formattedValue",但是因為formattedValue是計算屬性，依賴于this.value，在用戶輸入無效值的情況下this.value不會改變，因此界面不會被更新，所以需要手動改value的值。
setValueManually ($event) {
if (!helper.isValidDate($event)) {
this.$refs.inputWrapper.$refs.input.value = this.isDate(this.value) ? helper.getFormatDate(this.value) : ''
return
}
this.$emit('input', new Date($event))
}11、完善
給彈出日期面板和關閉日期面板增加組件自定義事件, 即調(diào)用$emit觸發(fā)'showDatepicker'和'closeDatepicker'事件。
發(fā)布npm
1、使用vue cli3 的庫模式打包代碼，修改package.json 中的"build": "vue-cli-service build --target lib --name sakura src/index.js"，打包后輸出umd構建版本, 參考vue cli。
什么是umd? 統(tǒng)一模塊定義，可以兼容common.js(node端規(guī)范)/ AMD(瀏覽器端規(guī)范)/ ES6(node端不完全支持)等多種模塊化方案，確保代碼在各種環(huán)境下能被運行。
File Size Gzipped dist/sakura.umd.min.js 13.28 kb 8.42 kb dist/sakura.umd.js 20.95 kb 10.22 kb dist/sakura.common.js 20.57 kb 10.09 kb dist/sakura.css 0.33 kb 0.23 kb
2、在package.json指明模塊入口"main":"dist/sakura.umd.min.js"
"name": "heian-sakura-ui", "version": "0.0.6", "private": false, "main":"dist/sakura.umd.min.js", "description": "an UI framework based on Vue.js",
3、在npm 上注冊一個用戶
4、在命令行輸入，注意每次發(fā)布都要修改package.json中的 "version": "0.0.x"，"private"必須設置成false才能發(fā)布
npm adduser // 提示輸入注冊的用戶名 npm publish
官網(wǎng)制作
使用vue press
1、在原有項目中使用
# 安裝依賴 npm install -D vuepress # 創(chuàng)建一個 docs 目錄 mkdir docs
在package.json中進行腳本配置
{
"scripts": {
"docs:dev": "vuepress dev docs",
"docs:build": "vuepress build docs"
}
}然后運行npm run docs:dev即可訪問
2、簡單配置
在docs/.vuepress下新建文件config.js
module.exports = {
base:'/sakura-ui/',
title: 'Sakura UI',
description: 'Inspiration from heian sakura',
head: [
['link', { rel: 'icon', href: '/favicon.ico' }]
],
themeConfig: {
nav: [
{ text: 'Home', link: '/' },
{ text: 'Github', link: 'https://github.com/Firenzia/sakura-ui/' },
],
sidebar: [
{
title: '開發(fā)指南',
collapsable: true,
children: [
'views/guide/install.md',
'views/guide/get-started.md'
]
},
{
title: '設計',
collapsable: true,
children: [
'views/design/color/',
]
},
{
title: '組件',
collapsable: true,
children: [
'views/components/basic/',
'views/components/form/',
'views/components/navigation/',
'views/components/notice/',
'views/components/other/'
]
},
]
}
}3、使用vue組件
官網(wǎng)中提到，所有在 .vuepress/components 中找到的 *.vue 文件將會自動地被注冊為全局的異步組件，可以在markdown中引用, vue文件中的代碼高亮我用的是vue-highlightjs 查看這里
4、編寫文檔
由于所有的頁面在生成靜態(tài) HTML 時都需要通過 Node.js 服務端渲染，對于SSR 不怎么友好的組件（比如包含了自定義指令），你可以將它們包裹在內(nèi)置的 ClientOnly 組件中，而且注意因為是ssr,組件內(nèi)部beforeCreate, created生命周期鉤子函數(shù)訪問不到瀏覽器 / DOM 的 API，只能在beforeMount和mounted中調(diào)用。
