一、自定义组件
- 在项目的根目录中,创建components 文件夹。
- 在新建的 components 文件夹上,鼠标右键,点击“新建 Component”。
- 新建 Component的会自动生成组件对应的4个文件,后缀名分别为js,json,.wxml和.wxss。
1.1、引用组件
组件的引用方式分为“局部引用”和“全局引用,顾名思义:
- 局部引用:组件只能在当前被引用的页面内使用。
- 全局引用:组件可以在每个小程序页面中使用。
在页面的 .json 配置文件中引用组件的方式,叫做“局部引用”。
//在页面的 .json 文件中,引入组件
"usingComponents": {
"component-test":"/components/test1/test1"
},
//在页面的 .wxml 文件中,使用组件
<component-test></component-test>
在 app.json 全局配置文件中引用组件的方式,叫做“全局引用”。
"usingComponents": {
"component-test":"/components/test1/test1"
},
"pages": [
"pages/home/home",
"pages/message/message",
"pages/contact/contact",
"pages/info/info"
],
//在页面的 .wxml 文件中,使用组件
<component-test></component-test>
根据组件的使用频率和范围,来选择合适的引用方式:。如果某组件在多个页面中经常被用到,建议进行“全局引用”如果某组件只在特定的页面中被用到,建议进行“局部引用。
组件和页面的区别,从表面来看,组件和页面都是由js、json、.wxml和.wxss这四个文件组成的。但是,组件和页面的 js与.json 文件有明显的不同:
- 组件的 .json 文件中需要声明"component":true 属性。
- 组件的 .js 文件中调用的是 Component()函数。
- 组件的事件处理函数需要定义到 methods 节点中。
1.2、组件样式隔离
默认情况下,自定义组件的样式只对当前组件生效,不会影响到组件之外的。UI结构,如图所示:
- 组件 A的样式不会影响组件C的样式。
- 组件 A 的样式不会影响小程序页面的样式。
- 小程序页面的样式不会影响组件 A和C的样式。
好处:
防止外界的样式影响组件内部的样式。
防止组件的样式破坏外界的样式。
1.2.1、组件样式隔离的注意点
- app.wxss 中的全局样式对组件无效
- 只有 class 选择器会有样式隔离效果,id 选择器、属性选择器、标签选择器不受样式隔离的影响。
建议:在组件和引用组件的页面中建议使用 class 选择器,不要使用id、属性、标签选择器!
1.2.2、修改组件的样式隔离选项
默认情况下,自定义组件的样式隔离特性能够防止组件内外样式互相干扰的问题。但有时,我们希望在外界能够控制组件内部的样式,此时,可以通过 stylelsolation 修改组件的样式隔离选项,用法如下:
//在组件的js文件中增加如下配置
Component({
options:{
styleIsolation:"apply-shared"
},
// 或在组件的 .ison 文件中新增如下配置
{
"stylelsolation":"apply-shared"
}
styleIsolation的可选值如下:
1.3、组件数据、方法和属性
- 在小程序组件中,用于组件模板渲染的私有数据需要定义到 data 节点中,示例如下:
/**
* 组件的初始数据
*/
data: {
count:0,
},
- 在小程序组件中,事件处理函数和自定义方法需要定义到 methods 节点中,示例代码如下:
/**
* 组件的方法列表
*/
methods: { // 组件的方法列表【包含事件处理函数和自定义方法】
addCount(){//事件处理函数
this.setData({count:this.data.count+1})
this._showCount() // 通过 this 直接调用自定义方法
},
_showCount(){
wx.showToast({
title:'count值为:'+this.data.count,
icon:'none'
})
}
},
- properties 属性
在小程序组件中,properties 是组件的对外属性,用来接收外界传递到组件中的数据,,示例代码如下:
/**
* 组件的属性列表
*/
properties:{
max: {
//完整定义属性的方式【当需要指定属性默认值时,建议使用此方式】
type:Number, //属性值的数据类型
value: 10 // 属性默认值
}
//简化定义属性的方式【不需指定属性默认值时,可以使用简化方式】
// max:Number
},
<component-test max = "10"></component-test>
js文件中获取该属性 this.properties.max
data和 properties 的区别
在小程序的组件中,properties 属性和 data 数据的用法相同,它们都是可读可写的,只不过:data 更倾向于存储组件的私有数据。properties 更倾向于存储外界传递到组件中的数据。使用 setData 修改 properties 的值
由于 data 数据和 properties 属性在本质上没有任何区别,因此 properties 属性的值也可以用于页面渲染或使用 setData 为 properties 中的属性重新赋值,示例代码如下:
<view>max属性的值{{max}}</view>
this.setData({max:this.properties.max+1})
1.4、数据监听器
- 数据监听器用于监听和响应任何属性和数据字段的变化,从而执行特定的操作。它的作用类似于 vue 中的watch 侦听器。在小程序组件中,数据监听器的基本语法格式如下:
Component({
observers:{"字段A,字段B':function(字段A的新值,字段B的新值){
// do something
}
})
- 数据监听器基本用法
<view>num1与num2和为:{{sum}}</view>
<button bind:tap="addNum1">num1</button>
<button bind:tap="addNum2">num2</button>
<view>num1值为:{{num1}}</view>
<view>num2值为:{{num2}}</view>
组件js内容如下:
/**
* 组件的初始数据
*/
data: {
num1:0,
num2:0,
sum:0
},
/**
* 组件的方法列表
*/
methods: {
addNum1(){this.setData({num1:this.data.num1+1})},
addNum2(){this.setData({num2:this.data.num2+1})}
},
observers:{ //数据监听节点
'num1,num2':function(num1,num2){ //监听num1与num2数据变化
this.setData({sum:num1+num2}) //自动计算sum值
}
}
- 监听对象属性的变化
数据监听器支持监听对象中单个或多个属性的变化,示例语法如下:
Component({
observers:{
'对象.属性A,对象.属性B': function(属性A的新值,属性B的新值){
//触发此监听器的 3 种情况:
//【为属性A赋值】使用 setData 设置 this.data.对象.属性A 时触发//【为属性B赋值】使用 setData 设置 this.data.对象.属性B 时触发
//【直接为对象赋值】使用 setData 设置 this.data.对象 时触发
// do something...
}
}
})
如果某个对象中需要被监听的属性太多,为了方便,可以使用通配符 **来监听对象中所有属性的变化,示例代码如下:
observers:{
// 使用通配符 ** 完成监听对象上所有属性的变化
'rgb.**': function(obj){
this.setData({
fullColor:`${obj.r}, ${obj.g},${obj.b}
})
}
}
纯数据字段
概念:纯数据字段指的是那些不用于界面渲染的 data 字段。
应用场景:例如有些情况下,某些 data 中的字段既不会展示在界面上,也不会传递给其他组件,仅仅在当前组件内部使用。带有这种特性的 data 字段适合被设置为纯数据字段。
好处:纯数据字段有助于提升页面更新的性能。使用规则
在 Component 构造器的 options 节点中,指定 pureDataPattern 为一个正则表达式,字段名符合这个正则表达式的字段将成为纯数据字段,示例代码如下:
Component({
options:{
//指定所有以_开头的字段为纯数据字段
pureDataPattern:/^_/
},
data:{
a:1, //普通数据字段
_b:2 //纯数据字段
}
})
1.5、组件的生命周期
-
小程序组件可用的全部生命周期如下表所示:
在小程序组件中,最重要的生命周期函数有3个,分别是created、attached、detached。它们各自的特点如下:
- 组件实例刚被创建好的时候,created 生命周期函数会被触发。
此时还不能调用 setData
通常在这个生命周期函数中,只应该用于给组件的 this 添加一些自定义的属性字段 - 在组件完全初始化完毕、进入页面节点树后,attached生命周期函数会被触发。
此时,this.data 已被初始化完毕
这个生命周期很有用,绝大多数初始化的工作可以在这个时机进行(例如发请求获取初始数据) - 在组件离开页面节点树后,detached 生命周期函数会被触发。
退出一个页面时,会触发页面内每个自定义组件的 detached 生命周期函数
此时适合做一些清理性质的工作 - lifetimes 节点
在小程序组件中,生命周期函数可以直接定义在Component构造器的第一级参数中,可以在 lifetimes 字段内进行声明(这是推荐的方式,其优先级最高)。示例代码如下:
Component({
// 推荐用法
lifetimes:{
attached(){},//在组件实例进入页面节点树时执行
detached(){},//在组件实例被从页面节点树移除时执行
},
// 以下是旧式的定义方式
attached(){},//在组件实例进入页面节点树时执行
detached(){},//在组件实例被从页面节点树移除时执行
})
1.6、组件所在页面的生命周期
-
有时自定义组件的行为依赖于页面状态的变化,此时就需要用到组件所在页面的生命周期。
在自定义组件中,组件所在页面的生命周期函数有如下3个,分别是:
- pageLifetimes 节点
组件所在页面的生命周期函数,需要定义在 pageLifetimes 节点中,示例代码如下:
Component({
pageLifetimes:{
show:function(){},//页面被展示
hide:function(){},// 页面被隐藏
resize:function(size){}// 页面尺寸变化
}
})
1.7、插槽
在自定义组件的 wxml结构中,可以提供一个<slot>节点(插槽),用于承载组件使用者提供的 wxml结构。
- 单个插槽
在小程序中,默认每个自定义组件中只允许使用一个<slot>进行占位,这种个数上的限制叫做单个插槽。
<!--组件的封装者:-->
<view class="wrapper">
<view>这里是组件的内部节点</view>
<!--对于不确定的内容,可以使用<slot>进行占位,具体的内容由组件的使用者决定-->
<slot></slot>
</view>
<!-- 组件的使用者-->
<component-tag-name>
<!--这部分内容将被放置在组件<slot>的位置上 -->
<view>>这里是插入到组件slot中的内容</view>
</component-tag-name>
- 多个插槽
在小程序的自定义组件中,需要使用多<slot>插槽时,可以在组件的 .js 文件中,通过如下方式进行启用。示例代码如下:
Component({
//在组件定义时的选项中启用多 slot 支持
options:{
multipleSlots:true
},
/**
* 组件的属性列表
*/
properties: {
},
- 定义多个插槽
可以在组件的 .wxml中使用多个<slot>标签,以不同的 name 来区分不同的插槽。示例代码如下:
<!--组件模板-->
<view class="wrapper">
<!--name 为 before 的第一个 slot 插槽 -->
<slot name="before"></slot>
<view>这是一段固定的文本内容</view>
<!--name 为 after 的第二个 slot 插槽 -->
<slot name="after"></slot>
</view>
- 使用多个插槽
在使用带有多个插槽的自定义组件时,需要用 slot 属性来将节点插入到不同的<slot>中。示例代码如下:
<!--引用组件的页面模板-->
<component-tag-name>
<!--这部分内容将被放置在组件<slot name="before">的位置上 -->
<view slot="before">这里是插入到组件slot name="before"中的内容</view>
<!--这部分内容将被放置在组件<slot name="after">的位置上 -->
<view slot="after">这里是插入到组件slot name="after"中的内容</view>
</component-tag-name>
1.8、父子组件之间的通信
父子组件之间通信的 3 种方式::
- 属性绑定
属性绑定用于实现父向子传值,而且只能传递普通类型的数据,无法将方法传递给子组件。父组件的示例代码如下:
// 父组件的 data 节点
data: {
count:0
}
//父组件的 wxml 结构
<my-test3 count="{{count}}"></my-test3>
<view>---</view>
<view>父组件中,count值为:{{count}}</view>
子组件在 properties 节点中声明对应的属性并使用。示例代码如下:
//子组件的 properties 节点
properties:{
count: Number
}
//子组件的 wxml 结构
<text>子组件中,count值为:{{count}}</text>
- 事件绑定
用于子组件向父组件传递数据,可以传递任意数据。使用步骤如下:
1、在父组件的js 中,定义一个函数,这个函数即将通过自定义事件的形式,传递给子组件。
// 在父组件中定义 addCount 方法
//将来,这个方法会被传递给子组件,供子组件进行调用
addCount(e){
console.log(e.detail.value)
},
2、在父组件的 wxml中,通过自定义事件的形式,将步骤1中定义的函数引用,传递给子组件。
<component-test4 count = "4" bind:add="addCount">
<view>这是插槽内容</view>
</component-test4>
3、在子组件的js 中,通过调用 this.triggerEvent(自定义事件名称',{/参数对象/}),将数据发送到父组件。
methods: {
addCount(){
this.setData({
count:this.properties.count+1
}),
this.triggerEvent('add',{value:this.properties.count})
},
}
})
4、在父组件的 is 中,通过 e.detail 获取到子组件传递过来的数据。
addCount(e){
console.log(e.detail.value)
},
获取组件实例
父组件还可以通过 this.selectcomponent()获取子组件实例对象这样就可以直接访问子组件的任意数据和方法。可在父组件里调用 this.selectComponent("id或class选择器"),获取子组件的实例对象,从而直接访问子组件的任意数据和方法。调用时需要传入一个选择器,例如 this.selectcomponent(".my-component")。
<component-test4 bind:add="addCount" class="my_component" id = "my_component">
<view>这是插槽内容</view>
</component-test4>
<button bind:tap="getMyComponent">获取组件实例</button>
getMyComponent(){
const child = this.selectComponent(".my_component")
child.setData({count:child.properties.count+1})
child.addCount()
},
1.9、 behaviors
behaviors 是小程序中,用于实现组件间代码共享的特性,类似于 Vue.js 中的“mixins'。
behaviors 的工作方式
每个 behavior 可以包含一组属性、数据、生命周期函数和方法。组件引用它时,它的属性、数据和方法会被合并到组件中。
每个组件可以引用多个 behavior,behavior也可以引用其它 behavior。创建 behavior
调用 Behavior(0bject object)方法即可创建一个共享的 behavior 实例对象,供所有的组件使用:
module.exports = Behavior({
data:{
username:"tx"
},
properties:{},
methods:{}
})
- 导入并使用 behavior
在组件中,使用require()方法导入需要的 behavior,挂载后即可访问 behavior 中的数据或方法,示例代码如下:
const myBehavior = require('../../behavior/my_behavior')
Component({
behavior:['myBehavior'],
//在组件定义时的选项中启用多 slot 支持
options:{
multipleSlots:true
},
<view>在behavior中定义的数据是:{{username}}</view>
-
behavior 中所有可用的节点
- 同名字段的覆盖和组合规则*
组件和它引用的 behavior 中可以包含同名的字段,此时可以参考如下3种同名时的处理规则:
同名的数据字段(data)
同名的属性(properties)或方法(methods)
同名的生命周期函数
参考小程序官方文档。