VUE SYNC 用法：PROPS 雙向通信基礎
標簽： 前端開發經驗匯總
背景
vue-admin-element 是一個比較流行的開源項目，里面有對 el-pagination 組件的二次封裝，pagination，本文將整理這個組件封裝時 sync 的應用。
分頁插件
Element-UI 提供的分頁組件是 el-pagination ，它的功能還算強大，跟分頁有關的主要屬性整理如下：
封裝代碼
封裝 el-pagination 的兩個事件為統一的函數，觸發父組件接收最新的 pageSize 和 currentPage 參數，並更新父組件的列表。開源項目中的封裝過程如下：
<template>
<div :class="{'hidden':hidden}" class="pagination-container">
<el-pagination
:background="background"
:current-page.sync="currentPage"
:page-size.sync="pageSize"
:layout="layout"
:page-sizes="pageSizes"
:total="total"
v-bind="$attrs"
@size-change="handleSizeChange"
@current-change="handleCurrentChange"
/>
</div>
</template>
<script>
import { scrollTo } from '@/utils/scroll-to'
export default {
name: 'Pagination',
props: {
total: {
required: true,
type: Number
},
page: {
type: Number,
default: 1
},
limit: {
type: Number,
default: 20
},
pageSizes: {
type: Array,
default() {
return [10, 20, 30, 50]
}
},
layout: {
type: String,
default: 'total, sizes, prev, pager, next, jumper'
},
background: {
type: Boolean,
default: true
},
autoScroll: {
type: Boolean,
default: true
},
hidden: {
type: Boolean,
default: false
}
},
computed: {
currentPage: {
get() {
return this.page
},
set(val) {
this.$emit('update:page', val)
}
},
pageSize: {
get() {
return this.limit
},
set(val) {
this.$emit('update:limit', val)
}
}
},
methods: {
handleSizeChange(val) {
this.$emit('pagination', { page: this.currentPage, limit: val })
if (this.autoScroll) {
scrollTo(0, 800)
}
},
handleCurrentChange(val) {
this.$emit('pagination', { page: val, limit: this.pageSize })
if (this.autoScroll) {
scrollTo(0, 800)
}
}
}
}
</script>
<style scoped>
.pagination-container {
background: #fff;
padding: 32px 16px;
}
.pagination-container.hidden {
display: none;
}
</style>
核心代碼是 currentPage 和 pageSize 這兩個計算屬性：
this.$emit('update:limit', val) 封裝后的組件參數包括 el-pagination 自身的參數，加上一個 pagination 事件。
組件引用
<pagination v-show="total>0" :total="total" :page.sync="listQuery.page" :limit.sync="listQuery.limit" @pagination="getList" />
父組件需要提供一個監聽事件 @pagination ，它的函數定義接收一個 JSON 對象，由 pagination 組件觸發，對父組件列表數據的刷新。
原理：父組件傳遞的 page 和 limit 用 sync 修飾，在子組件通過this.$emit('update:page', val) 完成雙向綁定數據的更新。
VUE SYNC 基礎知識
父組件向子組件傳遞數據的方式有多種，props 是其中的一種，但是它的局限在於數據只能單向傳遞，子組件不能直接修改 prop 屬性，但是碰到子組件需要修改父組件的情況怎么辦呢？
Vue 提供了一種語法糖，就是 sync ，它是一種優雅的觸發父組件傳遞的 prop 的方式。
父組件中並沒有定義過 update 事件，但是卻可以完成 prop 屬性 page 的修改，這就是 sync 語法糖的作用。
vue 中的.sync語法糖
提到父子組件相互通信，可能大家的第一反應是$emit,最近在學着封裝組件，以前都是用的別人封裝好的UI組件，對vue
中的.sync這個修飾符有很大的忽略，后來發現這個修飾符很nice，官方對她的描述是：可以對一個prop進行雙向綁定，當一
個子組件改變了一個帶.sync的prop的值時，這個變化也回同步到父組件所綁定的值。
但是這個屬性在vue2.0的時候溢出了，在vue2.3.0的版本中作為一個語法糖被引入，會被擴展成為一個自動更新父組件屬
性的v-on監聽器。