使用Vue寫一個datepicker的示例
前言
寫插件是很有意思,也很鍛煉人,因為這個過程中能發(fā)現(xiàn)許多的細節(jié)問題。在前端發(fā)展的過程中,jQuery無疑是一個重要的里程碑,圍繞著這個優(yōu)秀項目也出現(xiàn)了很多優(yōu)秀的插件可以直接使用,大大節(jié)省了開發(fā)者們的時間。jQuery最重要的作用是跨瀏覽器,而現(xiàn)在瀏覽器市場雖不完美,但已遠沒有從前那么慘,數(shù)據驅動視圖的思想倍受歡迎,大家開始使用前端框架取代jQuery,我個人比較喜歡Vue.js,所以想試著用Vue.js寫一個組件出來。
為了發(fā)布到npm上,所以給項目地址改名字了,但是內部代碼沒有改,使用方法比之前方便。
GitHub地址: Here
功能&期望
這個datepicker目前僅實現(xiàn)了一些常用的功能:
- 選擇時間(這話說得有點多余)
- 最大/最小時間限制
- 中/英文切換(其實也就星期和月份需要切換)
- 可以以.vue形式使用,也可在瀏覽器環(huán)境中直接使用
- 沒了。。。
目錄結構
萬事的第一步依然是創(chuàng)建項目,只是單一組件,結構并不復雜,Datepicker.vue是最重要的組件文件,dist是webpack的輸出文件夾,index.js是webpack打包的入口文件,最后是webpack的配置文件,用來對我們的庫文件進行打包用的。因此項目結構就是這樣:
. ├── Datepicker.vue ├── LICENSE ├── README.md ├── dist │ └── vue-datepicker.js ├── index.js ├── package.json └── webpack.config.js
從Datepicker.vue入手
以.vue的方式寫Vue組件是一種特殊寫法,每個Vue文件包括template, script, style三部分,template最好不要成為片段實例,所以最外層先套一層div,當做整個組件的根元素。一個datepicker一般由兩部分組成,一個用來顯示日期的input框,一個用來選擇日期的panel,因為我發(fā)現(xiàn)input在移動端會自動喚起鍵盤,所以沒有使用input,直接用了div模擬,通過點擊事件決定panel的顯隱。value是最終的結果,需要和父組件通信,所以將value寫成了prop,在父組件中使用value.sync="xxx",datepicker的value就和父組件的xxx雙向綁定了。
<template> <div class="date-picker"> <div class="input" v-text="value" @click="panelState = !panelState"> </div> <div class="date-panel" v-show="panelState"> </div> </template> <scrip> export default { data () { return { panelState: false //初始值,默認panel關閉 } }, props: { value: String } } </script>
渲染日期列表
一個月最少是28天,如果把周日排在開頭,那么最少(1號恰好是周日)需要4行,但是每個月天數(shù)30,31居多,而且1號又不一定是周日,我索性干脆按最多的情況設計了,共6行,當月日期沒填滿的地方用上個月或下個月的日期補齊,這樣就方便計算了,而且切換月份時候panel高度不會變化。日期列表的數(shù)組需要動態(tài)計算,Vue提供了computed這個屬性,所以直接將日期列表dateList寫成計算屬性。我的方法是將日期列表固定為長度為42的數(shù)組,然后將本月,上個月,下個月的日期依次填充。
computed: { dateList () { //獲取當月的天數(shù) let currentMonthLength = new Date(this.tmpMonth, this.tmpMonth + 1, 0).getDate() //先將當月的日期塞入dateList let dateList = Array.from({length: currentMonthLength}, (val, index) => { return { currentMonth: true, value: index + 1 } }) //獲取當月1號的星期是為了確定在1號前需要插多少天 let startDay = new Date(this.year, this.tmpMonth, 1).getDay() //確認上個月一共多少天 let previousMongthLength = new Date(this.year, this.tmpMonth, 0).getDate() } //在1號前插入上個月日期 for(let i = 0, len = startDay; i < len; i++){ dateList = [{previousMonth: true, value: previousMongthLength - i}].concat(dateList) } //補全剩余位置 for(let i = 0, item = 1; i < 42; i++, item++){ dateList[dateList.length] = {nextMonth: true, value: i} } return dateList }
這里用Array.from來初始化了一個數(shù)組,傳入一個Array Like,轉化成數(shù)組,在拼接字符串時候采用了arr[arr.length]和[{}].concat(arr)這種方式,因為在JsTips上學到這樣做性能更好,文章的最后會貼出相關鏈接。
這樣,日期列表就構建好了,在template中使用v-for循環(huán)渲染出來
<ul class="date-list"> <li v-for="item in dateList" v-text="item.value" :class="{preMonth: item.previousMonth, nextMonth: item.nextMonth, selected: date === item.value && month === tmpMonth && item.currentMonth, invalid: validateDate(item)}" @click="selectDate(item)"> </li> </ul>
樣式上就可以自己發(fā)揮了,怎么喜歡怎么寫。需要注意的是循環(huán)日期可能會出現(xiàn)上個月或這個月的日期,我通過previuosMonth,currentMonth和nextMonth分別做了標記,對其他功能提供判斷條件。
年份和月份的列表都是差不多的道理,年份列表的初始值我直接寫在了data里,以當前年份為第一個,為了和月份保持一致,每次顯示12個,都通過v-for渲染。
data () { return { yearList: Array.from({length: 12}, (value, index) => new Date().getFullYear() + index) } }
選擇日期功能
選擇順序是:年 -> 月 -> 日,所以我們可以通過一個狀態(tài)變量來控制panel中顯示的內容,綁定適合的函數(shù)切換顯示狀態(tài)。
<div> <div class="type-year" v-show="panelType === 'year'"> <ul class="year-list"> <li v-for="item in yearList" v-text="item" :class="{selected: item === tmpYear, invalid: validateYear(item)}" @click="selectYear(item)" > </li> </ul> </div> <div class="type-month" v-show="panelType === 'month'"> <ul class="month-list"> <li v-for="item in monthList" v-text="item | month language" :class="{selected: $index === tmpMonth && year === tmpYear, invalid: validateMonth($index)}" @click="selectMonth($index)" > </li> </ul> </div> <div class="type-date" v-show="panelType === 'date'"> <ul class="date-list"> <li v-for="item in dateList" v-text="item.value" track-by="$index" :class="{preMonth: item.previousMonth, nextMonth: item.nextMonth, selected: date === item.value && month === tmpMonth && item.currentMonth, invalid: validateDate(item)}" @click="selectDate(item)"> </li> </ul> </div> </div>
選擇日期的方法就不細說了,在selectYear,selectMonth中對年份,月份變量賦值,再分別將panelType推向下一步就實現(xiàn)了日期選擇功能。
不過在未選擇完日期之前,你可能不希望當前年月的真實值發(fā)生變化,所以在這些方法中可先將選擇的值賦給一個臨時變量,等到seletDate的時候再一次性全部賦值。
selectMonth (month) { if(this.validateMonth(month)){ return }else{ //臨時變量 this.tmpMonth = month //切換panel狀態(tài) this.panelType = 'date' } }, selectDate (date) { //validate logic above... //一次性全部賦值 this.year = tmpYear this.month = tmpMonth this.date = date.value this.value = `${this.tmpYear}-${('0' + (this.month + 1)).slice(-2)}-${('0' + this.date).slice(-2)}` //選擇完日期后,panel自動隱藏 this.panelState = false }
最大/小時間限制
最大/小值是需要從父組件傳遞下來的,因此應該使用props,另外,這個值可以是字符串,也應該可以是變量(比如同時存在兩個datepicker,第二個的日期不能比第一個大這種邏輯),所以應該使用Dynamically bind的方式傳值。
<datepicker :value.sync="start"></datepicker> <!-- 現(xiàn)在min的值會隨著start的變化而變化 --> <datepicker :value.sync="end" :min="start" ></datepicker>
增加了限制條件,對于不合法的日期,其按鈕應該變?yōu)橹没覡顟B(tài),我用了比較時間戳的方式來判斷日期是否合法,因為就算當前panel中的日期是跨年或是跨月的,通過日期構造函數(shù)創(chuàng)建時都會幫你轉換成對應的合法值,省去很多判斷的麻煩:
new Date(2015, 0, 0).getTime() === new Date(2014, 11, 31).getTime() //true new Date(2015, 12, 0).getTime() === new Date(2016, 0, 0).getTime() //true
因此驗證日期是否合法的函數(shù)是這樣的:
validateDate (date) { let mon = this.tmpMonth if(date.previousMonth){ mon -= 1 }else if(date.nextMonth){ mon += 1 } if(new Date(this.tmpYear, mon, date.value).getTime() >= new Date(this.minYear, this.minMonth - 1, this.minDate).getTime() && new Date(this.tmpYear, mon, date.value).getTime() <= new Date(this.maxYear, this.maxMonth - 1, this.maxDate).getTime()){ return false } return true }
動態(tài)計算位置
當頁面右側有足夠的空間顯示時,datepicker的panel會定位為相對于父元素left: 0的位置,如果沒有足夠的空間,則應該置于right: 0的位置,這一點可以通過Vue提供的動態(tài)樣式和樣式對象來實現(xiàn)(動態(tài)class和動態(tài)style其實只是動態(tài)props的特例),而計算位置的時刻,我放在了組件聲明周期的ready周期中,因為這時組件已經插入到DOM樹中,可以獲取style進行動態(tài)計算:
ready () { if(this.$el.parentNode.offsetWidth + this.$el.parentNode.offsetLeft - this.$el.offsetLeft <= 300){ this.coordinates = {right: '0', top: `${window.getComputedStyle(this.$el.children[0]).offsetHeight + 4}px`} }else{ this.coordinates = {left: '0', top: `${window.getComputedStyle(this.$el.children[0]).offsetHeight + 4}px`} } } <!-- template中對應的動態(tài)style --> <div :style="coordinates"></div>
為了panel的顯隱可以平滑過渡,可以使用transition做過渡動畫,這里我簡單地通過一個0.2秒的透明度過渡讓顯隱更平滑。
<div :style="this.coordinates" v-show="panelState" transition="toggle"></div> //less syntax .toggle{ &-transition{ transition: all ease .2s; } &-enter, &-leave{ opacity: 0; } }
中英文切換
這里其實也很簡單,這種多語言切換實質就是一個key根據不同的type而輸出不同的value,所以使用filter可以很容易的實現(xiàn)它!比如渲染星期的列表:
<ul class="weeks"> <li v-for="item in weekList" v-text="item | week language"></li> </ul> filters : { week (item, lang){ switch (lang) { case 'en': return {0: 'Su', 1: 'Mo', 2: 'Tu', 3: 'We', 4: 'Th', 5: 'Fr', 6: 'Sa'}[item] case 'ch': return {0: '日', 1: '一', 2: '二', 3: '三', 4: '四', 5: '五', 6: '六'}[item] default: return item } } }
多種使用方式
對于一個Vue組件,如果是使用webpack + vue-loader的.vue單文件寫法,我希望這樣使用:
//App.vue <script> import datepicker from 'path/to/datepicker.vue' export default { components: { datepicker} } </script>
如果是直接在瀏覽器中使用,那么我希望datepicker這個組件是暴露在全局下的,可以這么使用:
//index.html <html> <script src="path/to/vue.js"></script> <script src="path/to/datepicker.js"></script> <body> <div id="app"></div> <script> new Vue({ el: '#app', components: { datepicker } }) </script> </body> </html>
這里我選擇了webpack作為打包工具,使用webpack的output.library和output.linraryTarget這兩個屬性就可以把你的bundle文件作為庫文件打包。library定義了庫的名字,libraryTarget定義了你想要打包的格式,具體可以看文檔。我希望自己的庫可以通過datepicker加載到,并且打包成umd格式,因此我的webpack.config.js是這樣的:
module.exports = { entry: './index.js', output: { path: './dist', library: 'datepicker', filename: 'vue-datepicker.js', libraryTarget: 'umd' }, module: { loaders: [ {test: /\.vue$/, loaders: ['vue']}, {test: /\.js$/, exclude: /node_modules/, loaders: ['babel']} ] } }
打包完成的模塊就是一個umd格式的模塊啦,可以在瀏覽器中直接使用,也可以配合require.js等模塊加載器使用!
適配 Vue 2.x
Vue 2.0已經發(fā)布有段時間了,現(xiàn)在把之前的組件適配到Vue 2.0。遷移過程還是很順利的,核心API改動不大,可以借助vue-migration-helper來找出廢棄的API再逐步修改。這里只列舉一些我需要修改的API。
filter
2.0中的filter只能在mustache綁定中使用,如果想在指令式綁定中綁定過濾后的值,可以選擇計算屬性。我在月份和星期的顯示中使用到了過濾器來過濾語言類型,但我之前是在指令式綁定中使用的filter,所以需要如下修改,:
//修改前 <div class="month-box" @click="chType('month')" v-text="tmpMonth + 1 | month language"></div> //修改后,filter傳參的方式也變了,變成了函數(shù)調用的風格 <div class="month-box" @click="chType('month')">{{tmpMonth + 1 | month(language)}}</div>
移除$index和$key
這兩個屬性不會在v-for中被自動創(chuàng)建了,如需使用,要在v-for中自行聲明:
<li v-for="item in monthList" @click="selectMonth($index)"></li> // <li v-for="(item, index) in monthList" @click="selectMonth(index)"></li>
ready 生命周期移除
ready從生命周期鉤子中移除了,遷移方法很簡單,使用mounted和this.$nextTick來替換。
prop.sync棄用
prop的sync棄用了,遷移方案是使用自定義事件,而且Datepicker這種input類型組件,可以使用表單輸入組件的自定義事件作為替換方案。自定義組件也可以使用v-model指令了,但是必須滿足兩個條件:
- 接收一個value的prop
- 值發(fā)生變化時,觸發(fā)一個input事件,傳入新值。
所以Datepicker的使用方式也不是<datepicker value.sync="now"></datepicker>了,而是<datepicker v-model="now"></datepicker>。組件自身向父級傳值的方式也不一樣了:
//1.x版本,設置了value的值會同步到父級 this.value = `${this.tmpYear}-${('0' + (this.month + 1)).slice(-2)}-${('0' + this.date).slice(-2)}` //2.x版本,需要自己觸發(fā)input事件,將新值作為參數(shù)傳遞回去 let value = `${this.tmpYear}-${('0' + (this.month + 1)).slice(-2)}-${('0' + this.date).slice(-2)}` this.$emit('input', value)
總結
以上就是我在寫這個datepicker時的大致思路,本身也是很簡單的事情,沒有處處展開來說,寫在這里作為自己的一個總結,如果有剛開始使用Vue的同學也希望這篇文章可以在思路上幫助到你們:P,對于各位老鳥如果有什么指點的地方我也很感謝:D,那么差不多就這樣。也希望大家多多支持腳本之家。
- Vue2中Element?DatePicker組件設置默認日期及控制日期范圍
- Element-ui DatePicker顯示周數(shù)的方法示例
- element-ui 限制日期選擇的方法(datepicker)
- vue時間組件DatePicker組件的手寫示例
- ant design vue datepicker日期選擇器中文化操作
- vue中datepicker的使用教程實例代碼詳解
- vue項目中引入vue-datepicker插件的詳解
- vue2.0 datepicker使用方法
- Vue引用第三方datepicker插件無法監(jiān)聽datepicker輸入框的值的解決
- vue+element?DatePicker實現(xiàn)日期選擇器封裝
相關文章
vue-cli3使用 DllPlugin 實現(xiàn)預編譯提升構建速度
這篇文章主要介紹了vue-cli3使用 DllPlugin 實現(xiàn)預編譯提升構建速度 ,需要的朋友可以參考下2019-04-04vue實現(xiàn)圖片路徑轉二進制文件流(binary)
這篇文章主要介紹了vue實現(xiàn)圖片路徑轉二進制文件流(binary),具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2022-06-06Vue?2中實現(xiàn)CustomRef方式防抖節(jié)流
這篇文章主要為大家介紹了Vue?2中實現(xiàn)CustomRef方式防抖節(jié)流示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-02-02Ant Design Vue table中列超長顯示...并加提示語的實例
這篇文章主要介紹了Ant Design Vue table中列超長顯示...并加提示語的實例,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-10-10