自定义组件
创建组件
- 在项目的根目录中,鼠标右键,创建components -> test 文件夹
- 在新建的components -> test 文件夹上,鼠标右键,点击 “
新建Component
" - 键入组件的名称之后回车,会自动生成组件对应的4个文件,后缀名分别为
.js
,.json
,.wxml
和.wxss
引用组件
组件的引用方式分为”局部引用“和全局引用”,顾名思义:
- 局部引用 : 组件只能在当前被引用的界面内使用
- 全局引用: 组件可以在每个小程序页面中使用
局部引用组件
在页面的.json
配置文件中引用组件的方式,叫做“局部引用”。
.json
{
"usingComponents": {
"my-test": "/components/test/test"
}
}
.wxml
以标签的形式进行引用
<my-test> </my-test>
全局引用组件
在app.json
全局配置文件中引用组件的方式,叫做“全局引用”。
使用方式同局部引用一样,可以通过标签的形式进行引用
组件与页面的区别
- 组件的
.json
文件中 需要声明"component":true
属性 - 组件的
.js
文件中调用的是Component()
函数 - 组件的事件处理函数需要定义到
methods
节点中
自定义组件 - 样式
- 组件样式隔离
默认情况下,自定义组件的样式只对当前组件生效,不会影响到组件之外的UI结构 - 组件样式隔离的注意点
- app.wxss 中的全局样式对组件无效
- 只有class 选择器会有样式隔离效果,id 选择器、属性选择器、标签选择器不受样式隔离的影响
建议:在组件和引用组件的页面中建议使用class选择器,不要使用id 、属性、标签选择器!
- 修改组件的样式隔离选项
默认情况下,自定义组件的样式隔离特性能够防止组件内外样式互相干扰的问题,
但有时,我们希望在外界能够控制组件内部的样式,此时,可以通过styleIsoation
修改组件的样式隔离选项,用法如下:
a. 在组件的.js
文件中
// components/test/test.js
Component({
options:{
styleIsolation: 'isolated'
},
b. 在组件的.json文件中声明一个节点
"styleIsolation": "isolated",
styleIsolation
的可选值
可选值 | 默认值 | 描述 |
---|---|---|
isolated | 是 | 表示启用样式隔离,在自定义组件内外,使用class指定的样式将不会相互影响 |
apply-shared | 否 | 表示页面wxss 样式将影响到自定义组件,但自定义组件wxss 中指定的样式不会影响页面 |
shared | 否 | 表示页面wxss 样式将影响到自定义组件,自定义组件wxss 中指定的样式也会影响页面和其他设置了apply-shared 或 shared 的自定义组件 |
自定义组件 - 数据、方法和属性
- data数据
在小程序组件中,用于组件模板渲染的私有数据,需要定义到data节点中 - methods方法
在小程序组件中,事件处理函数和自定义方法需要定义到methods节点中
/**
* 组件的方法列表
*/
methods: {
//点击事件处理函数
addCount(){
this.setData({
count: this.data.count + 1
})
this._showCont()
},
//自定义方法,建议以_开头,便于区分
_showCont(){
wx.showToast({
title: 'count是'+ this.data.count,
icon:'none'
})
}
}
- properties属性
在小程序组件中,properties是组件的对外属性,用来接收外界传递到组件中的数据
/**
* 组件的属性列表
*/
properties: {
//第一种方式 简化的方式 无法指定默认值,只有属性名和属性类型
max:Number,
//第二种方式 完整的定义方式
min:{
type:Number,
value: 0
}
},
- data和properties的区别
在小程序组件中,properties属性和data数据的用法相同,它们都是可读可写的,只不过:
- data更倾向于存储组件的私有数据
- properties更倾向于存储外界传递到组件中的数据
- 使用setData修改properties的值
由于data数据和properties属性在本质上没有任何区别,因此properties属性的值也可以用于页面渲染,或使用setData为properties中的属性重新赋值
自定义组件 - 数据监听器
概述
数据监听器用于监听和响应任何属性和数据字段的变化,从而执行特定的操作。它的作用类似于vue中的watch侦听器。
基本语法
// components/test2/test2.js
Component({
/**
* 组件的属性列表
*/
properties: {
},
/**
* 组件的初始数据
*/
data: {
n1:0,
n2:0,
sum:0
},
/**
* 组件的方法列表
*/
methods: {
addNum1(){
this.setData({ n1: this.data.n1 + 1})
},
addNum2(){
this.setData({
n2: this.data.n2 + 1
})
}
},
observers:{
'n1,n2':function (newN1,newN2) { // '旧值1,旧值2':function (新值1,新值2)
//监听n1和n2,设置对应事件变化
this.setData({
sum: newN1 + newN2
})
}
}
})
监听对象属性的变化
数据监听器支持监听对象中单个或多个属性的变化
observers:{
'对象.属性1,对象.属性2':function (属性1的新值,属性2的新值) {
//触发监听器的三种情况:
//1.为属性1赋值,2.为属性2赋值,3.直接为对象赋值
}
}
数据监听器案例
实现效果
组件.js 文件
// components/test3/test3.js
Component({
/**
* 组件的属性列表
*/
properties: {
},
/**
* 组件的初始数据
*/
data: {
rgb: {
r: 0,
g: 0,
b: 0
},
fullColor: '0,0,0'
},
/**
* 组件的方法列表
*/
methods: {
changeR(){
this.setData({
"rgb.r": this.data.rgb.r +5 > 255 ? 255 : this.data.rgb.r+5
})
},
changeG(){
this.setData({
"rgb.g": this.data.rgb.g +5 > 255 ? 255 : this.data.rgb.g+5
})
},
changeB(){
this.setData({
"rgb.b": this.data.rgb.b +5 > 255 ? 255 : this.data.rgb.b+5
})
}
},
observers:{
// 'rgb.r,rgb.g,rgb.b':function(r,g,b){
// this.setData({
// fullColor: `${r},${g},${b}`//模板字符串,注意不是单引号
// })
// }
//使用通配符**监听对象所有属性变化
'rgb.**':function(obj){
this.setData({
fullColor: `${obj.r},${obj.g},${obj.b}`//模板字符串,注意不是单引号
})
}
}
})
组件.wxml文件
<!--components/test3/test3.wxml-->
<view style="background-color: rgb({{fullColor}});" class="colorBox">颜色值:{{fullColor}}</view>
<button size="mini" bindtap="changeR" type="default">R</button>
<button size="mini" bindtap="changeG" type="primary">G</button>
<button size="mini" bindtap="changeB" type="warn">B</button>
组件.wxss文件
/* components/test3/test3.wxss */
.colorBox{
line-height: 200rpx;
font-size: 24rpx;
color: white;
text-shadow:0rpx 0rpx 2rpx black;
text-align:center;
}
最后是在页面或全局.json文件中引用这个组件
"usingComponents": {
"my-test3": "/components/test3/test3"
}
对应界面通过标签的方式使用
<my-test3> </my-test3>
自定义组件 - 纯数据字段
概念
纯数据字段指的是那些不用于界面渲染的data字段
好处
纯数据字段有助于提升页面更新的性能
使用规则
在Component构造器的options节点中,指定pureDataPattern 为一个正则表达式,字段名符合这个正则表达式的字段将成为纯数据字段,示例代码如下:
// components/test4/test4.js
Component({
options:{
//指定所有_开头的数据字段为纯数据字段
pureDataPattern: /^_/
},
/**
* 组件的初始数据
*/
data: {
a:true, // 普通数据字段
_b:true // 纯数据字段
},
})
自定义组件 - 组件的生命周期
组件全部的生命周期
生命周期函数 | 参数 | 描述说明 |
---|---|---|
created | 无 | 在组件实例刚刚被创建时执行 |
attached | 无 | 在组件实例进入页面节点树时执行 |
ready | 无 | 在组件在视图层布局完成后执行 |
moved | 无 | 在组件实例被移动到节点树另一个位置时执行 |
detached | 无 | 在组件实例被从页面节点树移除时执行 |
error | Object Error | 每当组件方法抛出错误时执行 |
组件主要的生命周期
在小程序中,最重要的生命周期函数有3个,分别时created、attached、detached
。它们各自的特点如下:
- 组件实例刚被创建好的时候,created 生命周期函数会被触发
- 此时还不能调用
setData
- 通常在这个生命周期函数中,只应该用于给组件的this添加一些自定义的属性字段
- 在组件完全初始化完毕、进入页面节点树,
attached
生命周期函数会被触发
- 此时,
this.data
已被初始化完毕 - 这个生命周期很有用,绝大多数初始化的工作可以在这个时机进行(例如发请求获取初始数据)
- 在组件离开页面节点树后,
detached
生命周期函数会被触发
- 退出一个页面时,会触发页面内每个自定义组件的
datached
生命周期函数 - 此时适合做一些清理性质的工作
lifetimes节点
在小程序组件中,生命周期函数可以直接定义在Component构造器的第一级参数中,可以在lifetimes字段内进行声明(这是推荐的方式,其优先级最高)。示例代码如下:
lifetimes:{
attached(){},
detached(){}
}
旧的方式是直接定义在构造器的第一级参数中(不推荐)
组件所在页面的生命周期
有时,自定义组件的行为依赖于页面状态的变化
,此时就需要用到组件所在页面的生命周期
在自定义组件中,组件所在页面的生命周期函数有如下3个,分别是:
生命周期函数 | 参数 | 描述说明 |
---|---|---|
show | 无 | 组件所在的页面被展示时执行 |
hide | 无 | 组件所在页面被隐藏时执行 |
resize | Object Size | 组件所在页面尺寸变化时执行 |
pageLifetimes
节点
组件所在页面的生命周期函数,需要定义在pageLifetimes
节点中
// components/test3/test3.js
Component({
/**
* 组件的初始数据
*/
data: {
},
"pageLifetimes":{
show(){
},
hide(){
}
}
})
自定义组件 - 插槽
概述
在自定义组件的wxml结构中,可以提供一个<slot>
节点(插槽),用于承载组件使用者提供的wxml结构
单个插槽
在小程序中,默认每个自定义组件中允许使用一个<slot>
进行占位,这种个数上的限制叫做单个插槽
<!--components/test4/test4.wxml-->
<view>这是组件test4的内部结构</view>
<slot></slot>
slot的填充内容由使用其的页面进行填充
<!--pages/page1/page1.wxml-->
<text>pages/page1/page1.wxml</text>
<my-test4>
<view>通过插槽进行添加的view</view>
</my-test4>
启用多个插槽
在小程序的自定义组件中,需要使用多<slot>
插槽时,可以在组件的.js
文件中,通过如下方式进行启用
// components/test4/test4.js
Component({
/**
* 组件的初始数据
*/
data: {
},
options:{
multipleSlots:true
}
})
做了上述代码的操作就可以在组件中定义多个<slot>
标签,并通过使用的界面去为其填充内容,可以通过name属性来区分slot插槽如:
<!--components/test4/test4.wxml-->
<slot name = "before"></slot>
<view>这是组件test4的内部结构</view>
<slot name = "after"></slot>
<!--components/test4/test4.wxml-->
<slot name = "before"></slot>
<view>这是组件test4的内部结构</view>
<slot name = "after"></slot>
自定义组件 - 父子组件之间的通信
父子组件之间通信的3种方式
- 属性绑定
- 用于父组件向子组件的指定属性设置数据,仅能设置
JSON
兼容的数据
- 事件绑定
- 用于子组件向父组件中传递数据,可以传递任意数据
- 获取组件实例
- 父组件还可以通过
this.selectComponent()
获取子组件实例对象 - 这样就可以直接访问子组件的任意数据和方法
1. 属性绑定
属性绑定用于实现父向子传值,而且只能传递普通类型的数据,无法将方法传递给子组件。父组件的示例代码如下:
// pages/page1/page1.js
Page({
/**
* 页面的初始数据
*/
data: {
count: 0
},
<!--pages/page1/page1.wxml-->
<my-test5 count="{{count}}"></my-test5>
<view>~~~~~~~~~~~</view>
<view>父组件中count的值为{{count}}</view>
// components/test5/test5.js
Component({
/**
* 组件的属性列表
*/
properties: {
count:Number
}
<!--components/test5/test5.wxml-->
<view>components/test5/test5.wxml</view>
<view>子组件的count={{count}}</view>
2. 事件绑定
事件绑定用于实现子向父传值,可以传递任何类型的数据。使用步骤如下:
- 在父组件的
js
中,定义一个函数,这个函数即将通过自定义事件的形式,传递给子组
syncCount(e){
console.log('syncCount');
this.setData({
count: e.detail.value
})
},
- 在父组件的
wxml
中,通过自定义事件的形式,将步骤1中定义的函数引用,传递给子组件
<my-test5 count="{{count}}" bind:sync="syncCount"></my-test5>
-
在子组件的
js
中,通过第哦啊用this.triggerEvent('自定义事件名称',{/*参数对象*/})
,将数据发送到父组件 -
在父组件的
js
中,通过e.detail
获取到子组件传递过来的数据
methods: {
addCount(){
this.setData({
count: this.properties.count+1
})
//触发自定义事件
this.triggerEvent('sync',{value:this.properties.count})
}
}
4. 获取组件实例
可在父组件里调用this.selectComponent("id或class选择器")
,获取子组件的实例对象,从而直接访问子组件的任意数据和方法。调用时需要传入一个选择器,例如 this.selectComponent(".my-component")
。
getChild(){
const child= this.selectComponent(".customA")
console.log(child);
//通过child去调用子组件的属性或事件
child.addCount()
},
<!--pages/page1/page1.wxml-->
<my-test5 count="{{count}}" bind:sync="syncCount" class="customA" id="CA"></my-test5>
<view>~~~~~~~~~~~</view>
<view>父组件中count的值为{{count}}</view>
<button bindtap="getChild">获取子组件的实例对象</button>
自定义组件 - behaviors
概述
behaviors是小程序中,用于实现组件间代码共享的特性
behaviors的工作方式
- 每个behaviors可以包含一组属性、数据、生命周期函数和方法。组件引用它时,它的属性、数据、和方法会被合并到组件中。
- 每个组件中可以引用多个behavior,behavior也可以引用其它behavior
创建behaviors
调用Behavior(Object object)方法即可创建一个共享的behavior实例对象,供所有组件使用:
module.exports =Behavior({
data:{
username: 'zs'
},
properties:{
},
methods:{
}
})
导入并使用behavior
在组件中,使用require()方法导入需要的behavior,挂载后即可访问behavior中的数据或方法,示例代码如下:
// components/test5/test5.js
const myBehavior = require('../../behaviors/my-behavior')
Component({
behaviors:[myBehavior],
/**
* 组件的属性列表
*/
properties: {
},
直接在组件的wxml中通过{{}}直接拿到属性username
<!--components/test5/test5.wxml-->
<view>components/test5/test5.wxml</view>
<view>子组件的count={{count}}</view>
<button bindtap="addCount">+1</button>
<view>在behaviors中定义的username是{{username}}</view>
behavior中所有可用的节点
可用的节点 | 类型 | 是否必填 | 描述 |
---|---|---|---|
properties | Object Map | 否 | 同组件的属性 |
data | Object | 否 | 同组件的数据 |
methods | Object | 否 | 同自定义组件的方法 |
behaviors | String Arrary | 否 | 引用其它的behavior |
created | Function | 否 | 生命周期函数 |
attached | Function | 否 | 生命周期函数 |
ready | Function | 否 | 生命周期函数 |
moved | Function | 否 | 生命周期函数 |
detached | Function | 否 | 生命周期函数 |
同名字段的覆盖和组合规则
组件和它引用的behavior中可以包含同名的字段,此时可以参考如下3种同名时的处理规则:
- 同名的数据字段(data)
- 同名的属性(properties)或方法(methods)
- 同名的生命周期函数
详细看微信开发者文档