自定义组件
1、组件的创建与引用
1.1、创建组件
- 在项目的根目录中,鼠标右键,创建 components -> test 文件夹。
- 在新建的 components -> test 文件夹上,鼠标右键,点击“新建 Component”。
- 键入组件的名称之后回车,会自动生成组件对应的 4 个文件,后缀名分别为 .js,.json, .wxml 和 .wxss。
注意:为了保证目录结构的清晰,建议把不同的组件,存放到单独目录中,例如:
1.2、引用组件
组件的引用方式分为“局部引用”和“全局引用”,顾名思义:
- 局部引用:组件只能在当前被引用的页面内使用。
- 全局引用:组件可以在每个小程序页面中使用。
1.3、局部引用组件
在页面的 .json 配置文件中引用组件的方式,叫做“局部引用”。
示例代码如下:
- 引入组件
{
"usingComponents": {
"my-test": "/components/test/test"
}
}
- 使用组件
<view>使用组件</view>
<!-- 使用组件 -->
<my-test></my-test>
1.4、全局引用组件
在 app.json 全局配置文件中引用组件的方式,叫做“全局引用”。
示例代码如下:
- app.json引入组件
- 首页使用组件
- 消息也使用组件
1.5、全局引用 VS 局部引用
根据组件的使用频率和范围,来选择合适的引用方式:
- 如果某组件在多个页面中经常被用到,建议进行“全局引用”
- 如果某组件只在特定的页面中被用到,建议进行“局部引用”
1.6、组件和页面的区别
从表面来看,组件和页面都是由 .js、.json、.wxml 和 .wxss 这四个文件组成的。但是,组件和页面的 .js 与.json 文件有明显的不同:
- 组件的 .json 文件中需要声明 “component”: true 属性。
- 组件的 .js 文件中调用的是 Component() 函数。
- 组件的事件处理函数需要定义到 methods 节点中。
2、样式
2.1、组件样式隔离
默认情况下,自定义组件的样式只对当前组件生效,不会影响到组件之外的UI 结构,如图所示:
- 组件 A 的样式不会影响组件 C 的样式
- 组件 A 的样式不会影响小程序页面的样式
- 小程序页面的样式不会影响组件 A 和 C 的样式
好处:
- 防止外界的样式影响组件内部的样式
- 防止组件的样式破坏外界的样式
2.2、组件样式隔离的注意点
- app.wxss 中的全局样式对组件无效。
- 只有 class 选择器会有样式隔离效果,id 选择器、属性选择器、标签选择器不受样式隔离的影响。
建议:在组件和引用组件的页面中建议使用 class 选择器,不要使用 id、属性、标签选择器!
- 组件设置样式,颜色改为红色
- 组件使用class属性
- 首页使用属性
- 效果
2.3、修改组件的样式隔离选项
默认情况下,自定义组件的样式隔离特性能够防止组件内外样式互相干扰的问题。但有时,我们希望在外界能够控制组件内部的样式,此时,可以通过 styleIsolation 修改组件的样式隔离选项,用法如下:
- js设置
options: {
styleIsolation: 'shared'
},
- json文件设置
"styleIsolation": "shared"
2.4、styleIsolation 的可选值
3、数据、方法、属性
3.1、data 数据
在小程序组件中,用于组件模板渲染的私有数据,需要定义到 data 节点中,示例如下:
Component({
/**
* 组件的初始数据
*/
data: {
count: 0
},
})
3.2、methods 方法
在小程序组件中,事件处理函数和自定义方法需要定义到 methods 节点中,示例代码如下:
- wxml代码
<view>count:{{count}}</view>
<button bindtap="addCount">+1</button>
- js代码
/**
* 组件的方法列表
*/
methods: {
addCount(){
this.setData({
count: this.data.count + 1
}),
this._showCount()
},
_showCount(){ //自定义方法
wx.showToast({
title: 'count的值为:' + this.data.count,
icon: 'none'
})
}
}
- 效果
3.3、properties 属性
在小程序组件中,properties 是组件的对外属性,用来接收外界传递到组件中的数据,示例代码如下:
/**
* 组件的属性列表
*/
properties: {
// 定义完整属性,设置默认值
max:{
// 属性类型
type: Number,
// 默认值
value: 10
},
// 简化的方式,不需要默认值
// max: Number
},
- 修改默认值
<!-- 使用组件 -->
<my-test max="9">{{max}}</my-test>
3.4、data 和 properties 的区别
在小程序的组件中,properties 属性和 data 数据的用法相同,它们都是可读可写的,只不过:
- data 更倾向于存储组件的私有数据。
- properties 更倾向于存储外界传递到组件中的数据。
组件的wxml
<button bindtap="showInfo">showInfo</button>
组件的js
/**
* 组件的方法列表
*/
methods: {
showInfo(){
console.log(this.data);
console.log(this.properties);
console.log(this.data == this.properties);
}
}
3.5、使用 setData 修改 properties 的值
由于 data 数据和 properties 属性在本质上没有任何区别,因此 properties 属性的值也可以用于页面渲染,或使用 setData 为 properties 中的属性重新赋值,示例代码如下:
<view>max的值:{{max}}</view>
methods: {
addCount(){
this.setData({
count: this.data.count + 1,
// 修改max的值
max: this.properties.max + 1
}),
this._showCount()
},
}
4、数据监听器
4.1、什么是数据监听器
数据监听器用于监听和响应任何属性和数据字段的变化,从而执行特定的操作。它的作用类似于 vue 中的watch 侦听器。在小程序组件中,数据监听器的基本语法格式如下:
Component({
'字段A,字段B':function(字段A的新值,字段B的新值){
//执行操作
}
})
4.2、数据监听器的基本用法
监听两个变量,当变量变化时,进行计算
- wxml代码
<view>{{n1}} + {{n2}} = {{sum}}</view>
<button bindtap="fun1">N1 + 1</button>
<button bindtap="fun2">N2 + 2</button>
- js代码
* 组件的初始数据
*/
data: {
n1: 0,
n2: 0,
sum: 0
},
/**
* 组件的方法列表
*/
methods: {
fun1(){
this.setData({
n1: this.data.n1 + 1
})
},
fun2(){
this.setData({
n2: this.data.n2 + 1
})
}
},
//监听
observers:{
'n1,n2':function(newN1,newN2){
this.setData({
sum: newN1 + newN2
})
}
}
- 效果
4.3、监听对象属性的变化
数据监听器支持监听对象中单个或多个属性的变化,示例语法如下:
Component({
'对象.属性A,对象.属性B':function(属性A的新值,属性B的新值){
//执行操作
}
})
4.4、数据监听案例
更改颜色数据,并显示对应的颜色
- 定义初始数据
/**
* 组件的初始数据
*/
data: {
// rgb对应的颜色值
rgb: {
r: 0,
g: 0,
b: 0
},
// rgb对象对应的三个属性
fullColor: '0,0,0'
},
- wxml代码
<view style="background-color: rgb({{fullColor}});" class="colorBox">颜色值:{{fullColor}}</view>
<button size="mini" type="default" bindtap="changeR">R</button>
<button size="mini" type="primary" bindtap="changeG">G</button>
<button size="mini" type="warn" bindtap="changeB">B</button>
- wxss代码
.colorBox{
line-height: 200rpx;
font-size: 28rpx;
color: white;
text-shadow: 0rpx 0rpx 2rpx black;
text-align: center;
}
- 当前效果
- 定义 button 的事件处理函数
/**
* 组件的方法列表
*/
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
})
}
}
- 监听对象中指定属性的变化
Component({
observers:{
'rgb.r,rgb.g,rgb.b':function(R,G,B){
this.setData({
fullColor: `${R},${G},${B}`
})
}
}
})
- 点击三个按钮,颜色值改变,监听的颜色也改变
- 监听对象中所有属性的变化
如果某个对象中需要被监听的属性太多,为了方便,可以使用通配符 ** 来监听对象中所有属性的变化,示例代码如下:
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}`
})
}
}
5、纯数据字段
5.1、什么是纯数据字段
概念:纯数据字段指的是那些不用于界面渲染的 data 字段。
应用场景:例如有些情况下,某些 data 中的字段既不会展示在界面上,也不会传递给其他组件,仅仅在当前组件内部使用。带有这种特性的 data 字段适合被设置为纯数据字段。
好处:纯数据字段有助于提升页面更新的性能。
5.2、使用规则
在 Component 构造器的 options 节点中,指定 pureDataPattern 为一个正则表达式,字段名符合这个正则表达式的字段将成为纯数据字段,示例代码如下:
Component({
options:{
// 指定所以以_开头的字段为纯数据字段
pureDataPattern: /^_/
},
data: {
//纯数据字段
_a: 'abs',
//普通字段
b: 'ccc'
}
})
5.3、使用纯数据字段改造数据监听器案例
/**
* 组件的初始数据
*/
data: {
// rgb对应的颜色值
_rgb: {
r: 0,
g: 0,
b: 0
},
// rgb对象对应的三个属性
fullColor: '0,0,0'
},
6、组件的生命周期
6.1、组件全部的生命周期函数
小程序组件可用的全部生命周期如下表所示:
6.2、组件主要的生命周期函数
在小程序组件中,最重要的生命周期函数有 3 个,分别是 created、attached、detached。它们各自的特点如下:
- 组件实例刚被创建好的时候,created 生命周期函数会被触发
- 此时还不能调用 setData。
- 通常在这个生命周期函数中,只应该用于给组件的 this 添加一些自定义的属性字段。
- 在组件完全初始化完毕、进入页面节点树后, attached 生命周期函数会被触发
- 此时, this.data 已被初始化完毕。
- 这个生命周期很有用,绝大多数初始化的工作可以在这个时机进行(例如发请求获取初始数据)。
- 在组件离开页面节点树后, detached 生命周期函数会被触发
- 退出一个页面时,会触发页面内每个自定义组件的 detached 生命周期函数。
- 此时适合做一些清理性质的工作。
6.3、lifetimes 节点
在小程序组件中,生命周期函数可以直接定义在 Component 构造器的第一级参数中,可以在 lifetimes 字段内进行声明(这是推荐的方式,其优先级最高)。
示例代码如下:
Component({
lifetimes:{
created(){
console.log('xxxxxxx');
},
attached(){
console.log('aaaaaaaaaaa');
}
}
})
7、组件所在页面的生命周期
7.1、什么是组件所在页面的生命周期
有时,自定义组件的行为依赖于页面状态的变化,此时就需要用到组件所在页面的生命周期。
例如:每当触发页面的 show 生命周期函数的时候,我们希望能够重新生成一个随机的 RGB 颜色值。
在自定义组件中,组件所在页面的生命周期函数有如下 3 个,分别是:
7.2、pageLifetimes 节点
组件所在页面的生命周期函数,需要定义在 pageLifetimes 节点中,示例代码如下:
Component({
pageLifetimes:{
// 页面被显示
show(){
console.log("显示中...");
},
//页面被隐藏
hide(){
console.log("隐藏了...");
},
// 页面尺寸变化
resize(size){
}
},
})
- 首页使用组件,显示时
- 切换到其他页面时,隐藏
7.3、生成随机的 RGB 颜色值
/**
* 组件的方法列表
*/
methods: {
// 自定义随机生产颜色值的函数
_randomCOlor(){
this.setData({
_rgb:{
r: Math.floor(Math.random() * 255),
g: Math.floor(Math.random() * 255),
b: Math.floor(Math.random() * 255)
}
})
}
}
pageLifetimes:{
// 页面被显示
show(){
console.log("显示中...");
// 显示时,随机生成颜色值
this._randomCOlor();
},
}
- 每次切换到首页时,随机生成颜色的效果
8、插槽
8.1、什么是插槽
在自定义组件的 wxml 结构中,可以提供一个 节点(插槽),用于承载组件使用者提供的 wxml 结构。
8.2、单个插槽
在小程序中,默认每个自定义组件中只允许使用一个 进行占位,这种个数上的限制叫做单个插槽。
- 组件使用插槽占个位
<!--components/test4/test4.wxml-->
<text>components/test4/test4.wxml</text>
<view>
<view>这里是组件的内部结构</view>
<slot></slot>
</view>
- 页面通过插槽填充
<my-test4>
<view>通过插槽填充的内容</view>
</my-test4>
8.3、启用多个插槽
在小程序的自定义组件中,需要使用多 插槽时,可以在组件的 .js 文件中,通过如下方式进行启用。
示例代码如下:
- 开启多slot支持
Component({
options:{
// 启用多slot支持
multipleSlots: true
},
})
- 定义多个插槽
可以在组件的 .wxml 中使用多个 标签,以不同的 name 来区分不同的插槽。
示例代码如下
<view>
<view>这里是组件的内部结构</view>
<slot name="s1"></slot>
<view>多个slot</view>
<slot name="s2"></slot>
</view>
- 使用多个插槽
在使用带有多个插槽的自定义组件时,需要用 slot 属性来将节点插入到不同的 中。
示例代码如下:
<my-test4>
<!-- <view>通过插槽填充的内容</view> -->
<view slot="s1">使用slot1</view>
</my-test4>
9、父子组件之间的通信
9.1、父子组件之间通信的 3 种方式
- 属性绑定
- 用于父组件向子组件的指定属性设置数据,仅能设置 JSON 兼容的数据。
- 事件绑定
- 用于子组件向父组件传递数据,可以传递任意数据。
- 获取组件实例
- 父组件还可以通过 this.selectComponent() 获取子组件实例对象。
- 这样就可以直接访问子组件的任意数据和方法。
9.2、属性绑定
属性绑定用于实现父向子传值,而且只能传递普通类型的数据,无法将方法传递给子组件。
父组件的示例代码如下:
- 父组件定义变量
/**
* 页面的初始数据
*/
data: {
count: 0
},
- 引入子组件
<view>父组件的count:{{count}}</view>
<view>引入子组件</view>
<my-test5></my-test5>
- 子组件使用父组件的变量
/**
* 组件的属性列表
*/
properties: {
count: Number
},
<text>子组件,count的值:{{count}}</text>
- 效果
- 测试对子组件的count进行+1
<button bindtap="addCount">+1</button>
/**
* 组件的方法列表
*/
methods: {
addCount(){
this.setData({
count: this.properties.count + 1
})
}
}
- 结果,子组件改变,父组件不变
9.3、事件绑定
事件绑定用于实现子向父传值,可以传递任何类型的数据。
使用步骤如下:
- 在父组件的 js 中,定义一个函数,这个函数即将通过自定义事件的形式,传递给子组件。
- 在父组件的 wxml 中,通过自定义事件的形式,将步骤 1 中定义的函数引用,传递给子组件。
- 在子组件的 js 中,通过调用 this.triggerEvent(‘自定义事件名称’, { /* 参数对象 */ }) ,将数据发送到父组件。
- 在父组件的 js 中,通过 e.detail 获取到子组件传递过来的数据。
- 步骤1:在父组件的 js 中,定义一个函数,这个函数即将通过自定义事件的形式,传递给子组件。
syncCount(){
console.log("执行l...");
},
- 步骤2:在父组件的 wxml 中,通过自定义事件的形式,将步骤 1 中定义的函数引用,传递给子组件。
<my-test5 bind:sync="syncCount"></my-test5>
- 步骤3:在子组件的 js 中,通过调用 this.triggerEvent(‘自定义事件名称’, { /* 参数对象 */ }) ,将数据发送到父组件。
/**
* 组件的方法列表
*/
methods: {
addCount(){
this.setData({
count: this.properties.count + 1
}),
// 绑定自定义事件的名称和参数
this.triggerEvent('sync',{value:this.properties.count})
}
}
- 步骤4:在父组件的 js 中,通过 e.detail 获取到子组件传递过来的数据。
syncCount(e){
// console.log("执行l...");
this.setData({
count: e.detail.value
})
},
- 效果,子组件改变后传递给父组件进行同步。
9.4、获取组件实例
可在父组件里调用 this.selectComponent(“id或class选择器”) ,获取子组件的实例对象,从而直接访问子组件的任意数据和方法。调用时需要传入一个选择器,例如 this.selectComponent(“.my-component”)。
- 对引入的子组件使用ID或class选择器进行标识,使用按钮进行自增功能
<my-test5 bind:sync="syncCount" class="test5"></my-test5>
<button type="primary" bindtap="getTest5">获取子组件实例</button>
- 点击按钮方法,获取子组件,对子组件数据进行操作
// 通过调用子组件方法进行+1
getTest5(){
// 通过class选择器获取子组件
const child = this.selectComponent('.test5');
// 通过属性进行+1
child.setData({
count: child.properties.count + 1
})
// 或者直接调用自增方法
// child.addCount()
},
- 效果
10、behaviors
10.1、什么是 behaviors
behaviors 是小程序中,用于实现组件间代码共享的特性,类似于 Vue.js 中的 “mixins”。
10.2、behaviors 的工作方式
每个 behavior 可以包含一组属性、数据、生命周期函数和方法。组件引用它时,它的属性、数据和方法会被合并到组件中。
每个组件可以引用多个 behavior,behavior 也可以引用其它 behavior。
10.3、创建 behavior
调用 Behavior(Object object) 方法即可创建一个共享的 behavior 实例对象,供所有的组件使用:
module.exports = Behavior({
//属性节点
properties: {},
//私有数据
data:{
username: 'zs'
},
// 事件函数
methods:{}
})
10.4、导入并使用 behavior
在组件中,使用 require() 方法导入需要的 behavior,挂载后即可访问 behavior 中的数据或方法,示例代码如下:
const myBehavior = require("../../behaviors/my-behavior");
Component({
// 将导入behavior挂载到数组中
behaviors: [myBehavior],
})
- 效果
10.5、behavior 中所有可用的节点
10.6、同名字段的覆盖和组合规则*
组件和它引用的 behavior 中可以包含同名的字段,此时可以参考如下 3 种同名时的处理规则:
- 同名的数据字段 (data)。
- 同名的属性 (properties) 或方法 (methods)。
- 同名的生命周期函数。
关于详细的覆盖和组合规则,大家可以参考微信小程序官方文档给出的说明:
https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/behaviors.html
结束!!!!!!
有两种事情是无限的,一个是宇宙,一个是人类的愚蠢与邪恶。