微信小程序中的組件
前言
之前做小程序開發(fā)的時候暇检,對于開發(fā)來說比較頭疼的莫過于自定義組件了晤硕,當(dāng)時官方對這方面的文檔也只是寥寥幾句,一筆帶過而已潮酒,所以寫起來真的是非常非常痛苦!邪蛔!
好在微信小程序的庫從 1.6.3 開始急黎,官方對于自定義組件這一塊有了比較大的變動,首先比較明顯的感覺就是文檔比以前全多了侧到,有木有2獭(小程序文檔),現(xiàn)在小程序支持簡潔的組件化編程匠抗,可以將頁面內(nèi)的功能模塊抽象成自定義組件故源,以便在不同的頁面中復(fù)用,提高自己代碼的可讀性汞贸,降低自己維護代碼的成本绳军!
本篇文章就是手把手教你實現(xiàn)小程序中自定義組件,坐穩(wěn)啦~
具體實現(xiàn)
要做自定義組件矢腻,我們先定一個小目標(biāo)门驾,比如說我們在小程序中實現(xiàn)一下 WEUI 中的彈窗組件,基本效果圖如下多柑。
Step1
我們初始化一個小程序(本示例基礎(chǔ)版本庫為 1.7 )奶是,刪掉里面的示例代碼,并新建一個 components
文件夾竣灌,用于存放我們以后開發(fā)中的所用組件诫隅,今天我們的目的是實現(xiàn)一個 彈框 組件,因此帐偎,我們在 components
組件中新建一個 Dialog
文件夾來存放我們的彈窗組件逐纬,在 Dialog
下右擊新建 Component
并命名為 dialog
后,會生成對應(yīng)的 json wxml wxss js
4個文件削樊,也就是一個自定義組件的組成部分豁生,此時你的項目結(jié)構(gòu)應(yīng)該如下圖所示:
Step2
組件初始化工作準(zhǔn)備完成兔毒,接下來就是組件的相關(guān)配置,首先我們需要聲明自定義組件甸箱,也就是將 dialog.json
中 component
字段設(shè)為 true
:
{
"component": true, // 自定義組件聲明
"usingComponents": {} // 可選項育叁,用于引用別的組件
}
其次,我們需要在 dialog.wxml
文件中編寫彈窗組件模版芍殖,在 dialog.wxss
文件中加入彈窗組件樣式豪嗽,它們的寫法與頁面的寫法類似,我就不贅述豌骏,直接貼代碼啦~
dialog.wxml
文件如下:
<!--components/Dialog/dialog.wxml-->
<view class='wx_dialog_container' hidden="{{!isShow}}">
<view class='wx-mask'></view>
<view class='wx-dialog'>
<view class='wx-dialog-title'>{{ title }}</view>
<view class='wx-dialog-content'>{{ content }}</view>
<view class='wx-dialog-footer'>
<view class='wx-dialog-btn' catchtap='_cancelEvent'>{{ cancelText }}</view>
<view class='wx-dialog-btn' catchtap='_confirmEvent'>{{ confirmText }}</view>
</view>
</view>
</view>
dialog.wxss
文件如下:
/* components/Dialog/dialog.wxss */
.wx-mask{
position: fixed;
z-index: 1000;
top: 0;
right: 0;
left: 0;
bottom: 0;
background: rgba(0, 0, 0, 0.3);
}
.wx-dialog{
position: fixed;
z-index: 5000;
width: 80%;
max-width: 600rpx;
top: 50%;
left: 50%;
-webkit-transform: translate(-50%, -50%);
transform: translate(-50%, -50%);
background-color: #FFFFFF;
text-align: center;
border-radius: 3px;
overflow: hidden;
}
.wx-dialog-title{
font-size: 18px;
padding: 15px 15px 5px;
}
.wx-dialog-content{
padding: 15px 15px 5px;
min-height: 40px;
font-size: 16px;
line-height: 1.3;
word-wrap: break-word;
word-break: break-all;
color: #999999;
}
.wx-dialog-footer{
display: flex;
align-items: center;
position: relative;
line-height: 45px;
font-size: 17px;
}
.wx-dialog-footer::before{
content: '';
position: absolute;
left: 0;
top: 0;
right: 0;
height: 1px;
border-top: 1px solid #D5D5D6;
color: #D5D5D6;
-webkit-transform-origin: 0 0;
transform-origin: 0 0;
-webkit-transform: scaleY(0.5);
transform: scaleY(0.5);
}
.wx-dialog-btn{
display: block;
-webkit-flex: 1;
flex: 1;
-webkit-tap-highlight-color: rgba(0, 0, 0, 0);
position: relative;
}
.wx-dialog-footer .wx-dialog-btn:nth-of-type(1){
color: #353535;
}
.wx-dialog-footer .wx-dialog-btn:nth-of-type(2){
color: #3CC51F;
}
.wx-dialog-footer .wx-dialog-btn:nth-of-type(2):after{
content: " ";
position: absolute;
left: 0;
top: 0;
width: 1px;
bottom: 0;
border-left: 1px solid #D5D5D6;
color: #D5D5D6;
-webkit-transform-origin: 0 0;
transform-origin: 0 0;
-webkit-transform: scaleX(0.5);
transform: scaleX(0.5);
}
step3
組件的結(jié)構(gòu)和樣式都有了龟梦,還缺少什么呢,沒錯窃躲,還缺 js
计贰, 眼睛比較犀利的同學(xué),可能已經(jīng)發(fā)現(xiàn)了我們在 dialog.wxml
文件中的會有一些比如 {{ isShow }}
蒂窒、{{ title }}
這樣的模版變量躁倒,還定義了 _cancelEvent
和 _confirmEvent
兩個方法,其具體實現(xiàn)就是在 dialog.js
中洒琢。
dialog.js
是自定義組件的構(gòu)造器秧秉,是使用小程序中 Component
構(gòu)造器生成的,調(diào)用 Component
構(gòu)造器時可以用來指定自定義組件的屬性衰抑、數(shù)據(jù)象迎、方法等,具體的細(xì)節(jié)可以參考一下官方的文檔
下面我通過代碼注釋解釋一下構(gòu)造器中的一些屬性的使用:
// components/Dialog/dialog.js
Component({
options: {
multipleSlots: true // 在組件定義時的選項中啟用多slot支持
},
/**
* 組件的屬性列表
* 用于組件自定義設(shè)置
*/
properties: {
// 彈窗標(biāo)題
title: { // 屬性名
type: String, // 類型(必填)停士,目前接受的類型包括:String, Number, Boolean, Object, Array, null(表示任意類型)
value: '標(biāo)題' // 屬性初始值(可選)挖帘,如果未指定則會根據(jù)類型選擇一個
},
// 彈窗內(nèi)容
content :{
type : String ,
value : '彈窗內(nèi)容'
},
// 彈窗取消按鈕文字
cancelText :{
type : String ,
value : '取消'
},
// 彈窗確認(rèn)按鈕文字
confirmText :{
type : String ,
value : '確定'
}
},
/**
* 私有數(shù)據(jù),組件的初始數(shù)據(jù)
* 可用于模版渲染
*/
data: {
// 彈窗顯示控制
isShow:false
},
/**
* 組件的方法列表
* 更新屬性和數(shù)據(jù)的方法與更新頁面數(shù)據(jù)的方法類似
*/
methods: {
/*
* 公有方法
*/
//隱藏彈框
hideDialog(){
this.setData({
isShow: !this.data.isShow
})
},
//展示彈框
showDialog(){
this.setData({
isShow: !this.data.isShow
})
},
/*
* 內(nèi)部私有方法建議以下劃線開頭
* triggerEvent 用于觸發(fā)事件
*/
_cancelEvent(){
//觸發(fā)取消回調(diào)
this.triggerEvent("cancelEvent")
},
_confirmEvent(){
//觸發(fā)成功回調(diào)
this.triggerEvent("confirmEvent");
}
}
})
step4
截至目前為止完丽,你應(yīng)該完成了一個自定義彈窗組件的大部分恋技,可是你保存后并沒有發(fā)現(xiàn)任何變化,因為我們還需要在 index.wxml
文件中引入它逻族!
首先需要在 index.json
中引入組件:
{
"usingComponents": {
"dialog": "/components/Dialog/dialog"
}
}
然后我們在 index.wxml
中引入它蜻底,并增加我們自定義的一些值,如下
<!--index.wxml-->
<view class="container">
<dialog id='dialog'
title='我是標(biāo)題'
content='恭喜你聘鳞,學(xué)會了小程序組件'
cancelText='知道了'
confirm='謝謝你'
bind:cancelEvent="_cancelEvent"
bind:confirmEvent="_confirmEvent">
</dialog>
<button type="primary" bindtap="showDialog"> ClickMe! </button>
</view>
嗯哪薄辅,還差最后一步,index.js
配置抠璃,沒錯站楚,這個也很簡單,我就復(fù)制粘貼了
//index.js
//獲取應(yīng)用實例
const app = getApp()
Page({
/**
* 生命周期函數(shù)--監(jiān)聽頁面初次渲染完成
*/
onReady: function () {
//獲得dialog組件
this.dialog = this.selectComponent("#dialog");
},
showDialog(){
this.dialog.showDialog();
},
//取消事件
_cancelEvent(){
console.log('你點擊了取消');
this.dialog.hideDialog();
},
//確認(rèn)事件
_confirmEvent(){
console.log('你點擊了確定');
this.dialog.hideDialog();
}
})
到此搏嗡!大功告成窿春!
step5
讓我們測試一下試試看:
點擊按鈕之后呢拉一,會出現(xiàn)如下效果:
點擊取消或者確定按鈕的話,我們在事件中設(shè)置了彈窗會關(guān)閉旧乞,并會打印出相應(yīng)的信息蔚润,具體點擊完應(yīng)該怎么做,就看你們自己發(fā)揮了尺栖,我只能幫你到這里了~
總結(jié)
現(xiàn)在嫡纠,你已經(jīng)基本掌握了小程序中的自定義組件開發(fā)技巧,怎么樣延赌,是不是很棒除盏,應(yīng)該給自己點個贊,打個call皮胡。
總體來說痴颊,小程序推出自定義組件后,感覺方便了很多屡贺,還沒有 get 的小伙伴們蠢棱,趕緊學(xué)習(xí)學(xué)習(xí),以后多用組件化開發(fā)甩栈,就不會那么難受了泻仙,加油哦~
具體代碼,我已經(jīng)托管到 github 上了量没,歡迎 issue
~