1. 组件的创建与引用
创建组件
在项目的根目录中,鼠标右键,创建components -> test文件夹
在新建的test文件夹上,鼠标右键,点击新建Component
键入组件的名称之后回车,会自动生成组件对应的4个文件,后缀名分别为.js, .json, .wxml, .wxss
引用组件
局部引用:组件只能在当前被引用的页面内使用,在页面的.json配置文件中引用。
// 在页面.json文件,引入组件
{
"usingComponents": {
"my-test": "/components/test/test"
}
}
// 在页面的.wxml文件中,使用组件
全局引用:组件可以在每个小程序页面中使用,在app.json配置文件中引用。
// 在app.json文件,引入组件
{
// 和pages和window平级
"usingComponents": {
"my-test1": "/components/test1/test1"
}
}
// 在页面的.wxml文件中,使用组件
全局引用和局部引用使用场景 根据组件的使用频率和范围,来选择合适的引用方式:
如果在多个页面中经常被用到,建议进行全局引用
如果在特定的页面被用到,建议进行局部引用
组件和页面的区别:.js 和 .json 文件有明显的不同。
组件的.json文件中需要证明“component”: true属性
组件的.js文件中调用的是Component( )函数
组件的事件处理函数需要定义到methods节点中
2. 自定义组件-样式
组件样式隔离 默认情况下,自定义组件的样式只对当前组件生效,不会影响到组件之外的UI结构。 如图所示:
组件A的样式不会影响组件C的样式
组件A的样式不会影响小程序页面的样式
小程序页面的样式不会影响组件A和C的样式 好处:防止外界的样式影响组件内部的样式;防止组件的样式破坏外界的样式。
组件样式隔离的注意点
app.wxss中的全局样式对组件无效。
只有class选择器有样式隔离效果,id选择器、属性选择器、标签选择器不受样式隔离的影响。在组件和引用组件的页面中,建议使用class选择器,不要使用标签、id、属性选择器。
修改组件的样式隔离选项:在组件的.js文件,或者组件的 .json 文件,使用 styleIsolation
// 在组件的 .js 文件中新增如下配置
Component({
options: {
styleIsolation: 'isolated'
}
})
// 在组件的 .json 文件新增如下配置
{
"styleIsolation": "isolated"
}
styleIsolation的可选值
可选值
默认值
描述
isolated
是
启用样式隔离,在自定义组件内外,使用class指定的样式将不会相互影响
apply-shared
否
页面WXSS样式将影响自定义组件,自定义组件的WXSS中指定的样式不会影响页面
shared
否
页面WXSS样式将影响自定义组件,自定义组件WXSS中的指定样式也影响页面和其他设置apply-shared或shared的自定义组件
3. 自定义组件-数据、方法和属性
data数据 在小程序组件中,用于组件模板渲染的私有数据,需要定义到data节点中,示例如下:
// component/test/test.js
Component({
/**
* 组件的初始数据
*/
data: {
count: 0
},
})
methods方法(_开头自定义方法,其余事件处理函数) 在小程序组件中,事件处理函数和自定义方法,需要定义到methods节点中,示例如下:
count值是: {{count}}
点我count+1
methods: {
// 点击事件处理函数
addCount() {
this.setData({
count: this.data.count + 1
});
this._showCount(); // 调用_showCount()方法
},
_showCount() {
wx.showToast({
title: '显示count值:' + this.data.count,
icon: "none"
})
}
}
properties 属性 在小程序组件中,properties是组件的对外属性,用来接收外界传递到组件中的数据,示例如下:
Component({
properties: {
max: { // 完整定义属性的方式,当需要指定属性默认值时 建议使用
type: Number, // 属性值的数据类型
value: 10 // 属性默认值
},
max: Number // 简化定义属性的方式,不需要指定属性默认值时 可以使用
}
})
data 和 properties 的区别 data和properties的用法相同,都是可读可写的。
data更倾向于存储组件的私有数据
properties更倾向于存储外界传递到组件中的数据
showInfo() {
console.log(this.data);
console.log(this.properties);
console.log(this.data===this.properties); // true
}
使用setData修改properties的值 properties属性的值也可以用于页面渲染,可以使用setData修改属性的值
methods: {
// 点击事件处理函数
addCount() {
this.setData({
count: this.data.count + 1,
max: this.properties.max + 1
});
}
}
4. 自定义组件-数据监听器
什么是数据监听器 数据监听器用于监听和响应任何属性和数据自动的变化,从而执行特定的操作。它的作用类似于vue中的watch侦听器。在小程序中,基本语法格式如下:
Component({
observers: {
'字段A,字段B': function(字段A的新值,字段B的新值){
}
}
})
数据监听器的基本用法
n1 的值:{{n1}}
n2 的值:{{n2}}
sum 的值:{{n1}} + {{n2}} = {{sum}}
点我 n1 + 1
点我 n2 + 1
// components/test2/test2.js
Component({
/**
* 组件的初始数据
*/
data: {
sum: 0,
n1: 0,
n2: 0
},
/**
* 组件的方法列表
*/
methods: {
addN1() {
this.setData({
n1: this.data.n1 + 1
});
},
addN2() {
this.setData({
n2: this.data.n2 + 1
})
}
},
// 数据监听器
observers: {
'n1, n2': function(n1, n2) {
this.setData({
sum: n1 + n2
})
}
}
})
监听对象属性的变化:支持监听对象中单个或多个属性的变化,语法如下:
Component({
observers: {
'对象.属性A, 对象.属性B': function(属性A的新值,属性B的新值) {
// 触发此监听器的3种情况:
// 为属性A赋值:使用setData设置 this.data.对象.属性A 时触发
// 为属性B赋值:使用setData设置 this.data.对象.属性B 时触发
// 直接为对象赋值:使用setData设置 this.data.对象 时触发
}
}
})
监听对象中所有属性的变化 如果某个对象中需要被监听的属性太多,可以使用通配符**来监听对象中所有属性的变化,示例代码如下:
observers: {
'rgb.**': function(obj) {
this.setData({
fullColor: `${obj.r}, ${obj.g}, ${obj.b}`
})
}
}
5. 自定义组件-纯数据字段
什么是纯数据字段 不用于页面渲染的data字段,是纯数据字段。 应用场景:某些data中的字段不会展示在界面上,也不会传递给其他组件,仅仅在当前组件内部使用。带有这种特性的data字段适合被设置为纯数据字段。 好处:纯数据字段有助于提升页面更新的性能
使用规则 在Component的options节点中,指定pureDataPattern为一个正则表达式,字段名符合这个正则表达式的字段将成为纯数据字段。示例如下:
Component({
options: {
// 指定_开头的为纯数据字段
pureDataPattern: /^_/
},
data: {
a: true, // 普通数据字段
_b: true // 纯数据字段
}
})
使用纯数据字段改造监听器案例:因为rgb 不会渲染在页面,因此改为纯数据字段
// components/test3/test3.js
Component({
options: {
pureDataPattern: /^_/
},
/**
* 组件的属性列表
*/
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,b,g){
// this.setData({
// fullColor: `${r},${g},${b}`
// })
// }
'_rgb.**': function(obj) {
this.setData({
fullColor: `${obj.r}, ${obj.g}, ${obj.b}`
})
}
}
})
6. 自定义组件-组件的生命周期函数
小程序组件可用的全部生命周期函数如下表:
生命周期函数
参数
描述说明
created
无
在组件实例刚刚被创建时执行
attached
无
在组件实例进入页面节点树时执行,此时还未被渲染
ready
无
在组件在视图层布局完成后执行,被渲染完成后
moved
无
在组件实例被移动到节点树另一个位置时执行
detached
无
在组件实例被从页面节点树移除时执行
error
object error
每当组件方法抛出错误时执行
组件主要的生命周期函数 在小程序组件,最重要的生命周期函数有3个,分别是created、attached、detached。各自的特点如下:
组件实例刚被创建好,created生命周期函数被触发。
此时不能调用setData
通常在这个生命周期函数中,只应该用于给组件的this添加一些自定义的属性字段
组件完全初始化完毕、进入页面节点树之后 ,attached生命周期函数会被触发。
此时,this.data已经被初始化完毕
绝大多数初始化的工作可以在这个时机进行(例如发请求获取初始数据)
组件离开页面节点树,被销毁,触发detached生命周期函数。
退出一个页面时,会触发页面内每个自定义组件的detached生命周期函数
此时,做一些清理性质的工作
lifetimes节点 在小程序组件中,生命周期函数可以直接定义在Component构造器的第一级参数中,也可以在lifetimes字段内进行声明(推荐,优先级最高),新旧两种同时存在,以新的为先 。示例代码如下:
Component({
lifetimes: {
attached() { // 组件实例进入页面节点树时执行
},
detached() { // 组件实例被从页面节点树移除时执行
}
},
// 旧版定义
attached() {},
detached() {}
})
7. 自定义组件-组件所在页面的生命周期
什么是组件所在页面的生命周期 有时候,自定义组件的行为依赖于页面状态的变化,此时需要用到组件所在页面的生命周期。 例如:每当触发页面的show生命周期函数的时候,能够重新生成一个随机的RGB颜色值。 在自定义组件中,组件所在页面的生命周期函数有如下3个,分别是:
生命周期函数
参数
描述
show
无
组件所在的页面被展示时执行
hide
无
组件所在的页面被隐藏时执行
resize
object size
组件所在的页面尺寸变化时执行
pageLifetimes 节点 组件所在页面的生命周期函数,需要定义在pageLifetimes节点中, ,示例代码如下:
// 组件的JS文件
Component({
pageLifetimes: {
show: function(){}, // 页面被展示
hide: function(){}, // 页面被隐藏
resize: function(){} // 页面尺寸变化
}
})
生成随机的RGB颜色值
// components/test3/test3.js
Component({
options: {
pureDataPattern: /^_/
},
data: {
_rgb: {
r: 0,
g: 0,
b: 0
},
fullColor: '0,0,0'
},
/**
* 组件的方法列表
*/
methods: {
// 生成随机颜色的方法
_randomColor() {
this.setData({
_rgb: {
r: Math.floor(Math.random() * 256),
g: Math.floor(Math.random() * 256),
b: Math.floor(Math.random() * 256)
}
})
},
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,b,g){
// this.setData({
// fullColor: `${r},${g},${b}`
// })
// }
'_rgb.**': function(obj) {
this.setData({
fullColor: `${obj.r}, ${obj.g}, ${obj.b}`
})
}
},
lifetimes: {
created() {
console.log('created__');
},
attached() {
console.log('attached__');
},
},
pageLifetimes:{
show: function() {
console.log('show');
this._randomColor() ; // 当组件所在的页面被展示,调用生成随机颜色的方法
},
}
})
8. 自定义组件-插槽
什么是插槽 在自定义组件的WXML结构中,可以提供一个
节点(插槽),用于承载组件使用者提供的wxml结构。 <
单个插槽 在小程序中,默认每个自定义组件中只允许使用一个
进行占位,这种个数上的限制叫做单个插槽。
// 组件封装者
这里是组件的内部节点
// 对于不确定的内容,使用进行占位,具体的内容由组件的使用者决定
// 组件使用者
// 这部分内容被放置在组件位置上
这里是插入到组件slot中的内容
启用多个插槽 需要使用多个
插槽时,可以在组件的.js文件中,通过如下方式启用:
Component({
options: {
multipleSlots: true // 在组件定义时的选项中启用多slot组件
}
})
定义多个插槽 可以在组件的.wxml中使用多个
标签,以不同的name来区分不同的插槽。示例如下:
// 组件模板
// name为before的第一个slot插槽
这是一段固定的文本内容
// name为after的第二个slot插槽
这里是插入到组件slot name="before"中的内容
这里是插入到组件slot name="after"中的内容
9. 自定义组件-父子组件之间的通信
父子组件之间通信的3种方式
属性绑定:用于父组件向子组件的指定属性设置数据,仅能设置JSON兼容的数据
事件绑定:用于子组件向父组件传递数据,可以传递任意数据
获取组件实例:父组件可以通过this.selectComponent( )获取子组件实例对象,可以直接访问子组件的任意数据和方法
属性绑定 属性绑定用于实现父向子传值,而且只能传递普通类型的数据,无法将方法传递给子组件。父组件的示例代码如下:
// 父组件的data节点
data: {
count: 0
}
// 父组件的wxml结构
父组件中,count值为:{{count}}
子组件在properties节点中声明对应的属性并使用。示例代码如下:
properties: {
count: Number
}
子组件中,count值为:{{count}}
事件绑定 事件绑定用于实现子向父传值,可以传递任何类型的数据。使用步骤如下:
在父组件的.js文件中,定义一个函数,这个函数即将通过自定义事件的形式,传递给子组件。函数syncCount
在父组件的wxml文件中,通过自定义事件的形式,将步骤1中定义的函数引用,传递给子组件。bind:sync=“syncCount”
在子组件的js文件中,通过调用this.triggerEvent(‘自定义事件名称’,{参数对象}),将数据发送到父组件。this.triggerEvent(‘sync’, {value: count})
在父组件的js文件中,通过e.detail获取到子组件传递过来的数据。在syncCount函数中,通过e.detail.value 可以获得传递的参数 {value:count}
获取组件实例 可以在父组件里调用this.selectComponent(“id或class选择器”),获取子组件的实例对象,从而直接访问子组件的任意数据和方法。调用时需要传入一个选择器,例如:this.selectComponent(“.my-component”)
获取子组件实例
getChild() {
const child=this.selectComponent('.customA') // 也可以传递id选择器,#cA
child.setData({count: child.properties.count + 1}) // 调用子组件的setData方法
child.addCount() // 调用子组件的addCount方法
}
10. 自定义组件-behaviors
什么是behaviors behaviors是小程序中,用于实现组件间代码共享的特性,类似于Vue.js中的“mixins”。
behaviors的工作方式 每个behaviors可以包含一组属性、数据、生命周期函数和方法。组件引用它时,它的属性、数据和方法会被合并到组件中。 每个组件可以引用多个behavior,behavior也可以引用其它behavior。
创建behavior 调用Behavior(obj)方法 即可创建一个共享的behavior实例对象,供所有的组件使用:
// 1. 调用Behavior()方法,创建实例对象
// 2. 使用module.exports将behavior实例对象共享出来
module.exports = Behavior({
properties: {},
data: {username: 'zs'},
methods: {}
})
导入并使用behavior 在组件中,使用require()方法导入需要的behavior,挂载后即可访问behavior中的数据或方法,示例代码如下:
// 1. 使用require()导入需要的自定义behavior模块
const myBehavior = require("../../behaviors/my-behavior");
Component({
// 2. 将导入的behavior实例对象,挂载到behavior实例对象,挂载到behaviors数组节点中,即可生效
behaviors: [myBehavior],
})
behavior中所有可用的节点’
可用的节点
类型
是否必填
描述
properties
Object Map
否
同组件的属性
data
Object
否
同组件的数据
methods
Object
否
同自定义组件的方法
behaviors
String Array
否
引入其他的behavior
created
Function
否
生命周期函数
attached
Function
否
生命周期函数
ready
Function
否
生命周期函数
moved
Function
否
生命周期函数
detached
Function
否
生命周期函数
同名字段的覆盖和组合规则 组件和它引用的behavior中可以包含同名的字段,可以参考以下3种同名时的处理规则:
同名的数据字段
同名的属性或方法
同名的生命周期函数