1. 自定义组件 - 组件的创建与引用
1. 1 创建组件
① 在项目的根目录中,鼠标右键,创建 components -> test 文件夹
② 在新建的 components -> test 文件夹上,鼠标右键,点击“新建Component”
③ 键入组件的名称之后回车,会自动生成组件对应的 4 个文件,后缀名分别为 .js,.json, .wxml 和 .wxss
注意:为了保证目录结构的清晰,建议把不同的组件,存放到单独目录中
1.2 引用组件
组件的引用方式分为“局部引用”和“全局引用”,顾名思义:
⚫ 局部引用:组件只能在当前被引用的页面内使用
// 在页面的 .json 配置文件中引用组件的方式,叫做“局部引用”。示例代码如下
{
"usingComponents": {
"my-test":"/components/test/test"
},
"onReachBottomDistance": 150
}
// html
<text>pages/hone/home.wxml</text>
<view></view>
<my-test></my-test>
⚫ 全局引用:组件可以在每个小程序页面中使用
// 在 app.json 全局配置文件中引用组件的方式,叫做“全局引用”。示例代码如下:
"style": "v2",
"sitemapLocation": "sitemap.json",
"usingComponents": {
"my-test2":"/components/test2/test2"
}
// html wxml
<my-test2></my-test2>
1.3 组件和页面的区别
从表面来看,组件和页面都是由 .js、.json、.wxml 和 .wxss 这四个文件组成的。但是,组件和页面的.js 与
.json 文件有明显的不同:
⚫ 组件的 .json 文件中需要声明 "component": true 属性
⚫ 组件的 .js 文件中调用的是 Component() 函数
⚫ 组件的事件处理函数需要定义到 methods 节点中
1.4 组件样式隔离的注意点
⚫ app.wxss 中的全局样式对组件无效
⚫ 只有 class 选择器会有样式隔离效果,id 选择器、属性选择器、标签选择器不受样式隔离的影响
建议:在组件和引用组件的页面中建议使用 class 选择器,不要使用 id、属性、标签选择器!
2. 修改组件的样式隔离选项
默认情况下,自定义组件的样式隔离特性能够防止组件内外样式互相干扰的问题。但有时,我们希望在外界能
够控制组件内部的样式,此时,可以通过 styleIsolation 修改组件的样式隔离选项,用法如下:
可选值 默认值 描述
isolated 是 表示启用样式隔离,在自定义组件内外,使用 class 指定的样式将不会相互影响
apply-shared 否 表示页面 wxss 样式将影响到自定义组件,但自定义组件 wxss 中指定的样式不会影响页面
shared 否
表示页面 wxss 样式将影响到自定义组件,自定义组件 wxss 中指定的样式也会影响页面和其
他设置了 apply-shared 或 shared 的自定义组件
// 在组件的 .js 文件中新增如下配置
Component({
// styleIsolation 的可选值
options: {
styleIsolation:'apply-shared'
},
})
// 或在组件的 .json 文件中新增如下配置
{
styleIsolation:'apply-shared'
}
3.事件处理函数和自定义方法需要定义到 methods 节点中
<!-- 在组件内部定义方法 -->
<view>count的值{{count}}</view>
<button bindtap="addCount">+1</button>
// 在小程序组件中,事件处理函数和自定义方法需要定义到 methods 节点中
Component({
// styleIsolation 的可选值控制组建内部样式与页面样式的互相影响
options: {
styleIsolation:'shared'
},
// 组件的属性列表
properties: {
max: {
type:Number, // 属性值的数据类型可以是str bloon 等
value:10 //定义属性默认值,可以省略
}
},
// 组件的初始数据
data: {
count:0
},
// 组件的方法列表
methods: {
// 事件处理函数
addCount() {
// >9 跳出
if(this.data.count >= this.properties.max) return
this.setData({ count: this.data.count + 1})
this._showCount()
},
// 自定义方法建议以下划线开头区分事件处理函数
_showCount() {
wx.showToast({
title: 'count是: ' + this.data.count,
icon:'none'
})
}
}
})
4. properties 属性用来接收外界传递到组件中的数据
Component({
// 组件的属性列表
properties: {
max: {
type:Number, // 属性值的数据类型可以是str bloon 等
value:10 //定义属性默认值,可以省略
}
},
})
<my-test max="9"></my-test>
5. data 和 properties 的区别
在小程序的组件中,properties 属性和 data 数据的用法相同,它们都是可读可写的,只不过:
⚫ data 更倾向于存储组件的私有数据
⚫ properties 更倾向于存储外界传递到组件中的数据
showInfo() {
console.log(this.data)
console.log(this.properties)
console.log(this.data === this.properties) //输出true
}
<button bindtap="showInfo">showInfo</button>
6.使用 setData 修改 properties 的值
<button bindtap="addCount">+1</button>
<!-- 修改properties里面的值 -->
<view>max属性值是:{{max}}</view>
Component({
// 组件的属性列表
properties: {
max: {
type:Number, // 属性值的数据类型可以是str bloon 等
value:10 //定义属性默认值,可以省略
}
},
data: {
count:0
},
methods: {
// 事件处理函数
addCount() {
if(this.data.count >= this.properties.max) return
this.setData(
{
count: this.data.count + 1,
max: this.properties.max + 1
})
},
}
})
7.数据监听器
监听和响应任何属性和数据字段的变化,从而执行特定的操作
<!-- 数据监听器 -->
<view>{{n1}} + {{n2}} = {{sum}}</view>
<button size="mini" bindtap="addN1">n1自增</button>
<button size="mini" bindtap="addN2">n2自增</button>
data: { count:0, n1:0, n2:0, sum:0},
methods: {
// 事件处理函数
addN1() { this.setData({ n1: this.data.n1 + 1})},
addN2() { this.setData({ n2: this.data.n2 + 1})},
},
observers: {
'n1, n2':function(newn1,newn2) {
this.setData({
sum : newn1 + newn2
})
}
}
8.数据监听器的案例
<!--components/text3/text3.wxml-->
<text>components/text3/text3.wxml</text>
<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
.colorBox {
line-height: 200rpx;
font-size: 24rpx;
color: white;
text-shadow: 0rpx 0rpx 2rpx black;
text-align: center;
margin-bottom: 20rpx;
}
// js
// components/text3/text3.js
Component({
/**
* 组件的属性列表
*/
properties: {
},
// 纯数据字段,只用做业务逻辑处理
options: {
// 指定所有 — 开头的数据字段为纯数据字段
pureDataPattern:/^_/
},
/**
* 组件的初始数据
*/
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 + 20 > 255 ? 255 : this.data._rgb.g +20
})
},
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.**监听对象上所有的属性
'_rgb.**' : function(obj) {
this.setData({
fullColor: `${obj.r}, ${obj.g}, ${obj.b}`
})
}
}
})
9.组件的生命周期
9.1 组件全部的生命周期函数
小程序组件可用的全部生命周期如下表所示:
生命周期函数 参数 描述说明
created 无 在组件实例刚刚被创建时执行
attached 无 在组件实例进入页面节点树时执行
ready 无 在组件在视图层布局完成后执行
moved 无 在组件实例被移动到节点树另一个位置时执行
detached 无 在组件实例被从页面节点树移除时执行
error Object Error 每当组件方法抛出错误时执行
2. 组件主要的生命周期函数
在小程序组件中,最重要的生命周期函数有 3 个,分别是 created、attached、detached。它们各自的特点
如下:
① 组件实例刚被创建好的时候,created 生命周期函数会被触发
⚫ 此时还不能调用 setData
⚫ 通常在这个生命周期函数中,只应该用于给组件的this 添加一些自定义的属性字段
② 在组件完全初始化完毕、进入页面节点树后, attached 生命周期函数会被触发
⚫ 此时, this.data 已被初始化完毕
⚫ 这个生命周期很有用,绝大多数初始化的工作可以在这个时机进行(例如发请求获取初始数据)
③ 在组件离开页面节点树后, detached 生命周期函数会被触发
⚫ 退出一个页面时,会触发页面内每个自定义组件的detached 生命周期函数
⚫ 此时适合做一些清理性质的工作
Component({
methods:{},
// 生命周期函数
lifetimes: {
created(){ console.log('created') },
attached() { console.log('attached') }
},
})
10.组件所在页面的生命周期
有时,自定义组件的行为依赖于页面状态的变化,此时就需要用到组件所在页面的生命周期。
例如:每当触发页面的show 生命周期函数的时候,我们希望能够重新生成一个随机的 RGB 颜色值。
在自定义组件中,组件所在页面的生命周期函数有如下 3 个,分别是:
生命周期函数 参数 描述
show 无 组件所在的页面被展示时执行
hide 无 组件所在的页面被隐藏时执行
resize Object Size 组件所在的页面尺寸变化时执行
Component({
methods:{},
// 组件所在页面的生命周期函数
pageLifetimes: {
show() { console.log('show') },
hide() { console.log('hide') },
resize() { console.log('resize') }
}
})
11.生成随机的 RGB 颜色值
Component({
methods:{
// 生成随机 RGB 演的的方法 非事件处理函数以 —— 开头
_randomColor() {
this.setData({
// 为data 里面的 _rgb 重新赋值
_rgb: {
// Math.floor(Math.random() * 256) 生成0-256之间的随机数
r: Math.floor(Math.random() * 256),
g: Math.floor(Math.random() * 256),
b: Math.floor(Math.random() * 256)
}
})
}
},
// 组件所在页面的生命周期函数
pageLifetimes: {
show() { this._randomColor() },
hide() { console.log('hide') },
resize() { console.log('resize') }
},
12.插槽
在自定义组件的 wxml 结构中,可以提供一个 <slot> 节点(插槽),用于承载组件使用者提供的 wxml 结构。
<!-- 组件的封装 -->
<view class="wrapper">
<view>这里是组件的内部结构</view>
<!-- 不确定放什么内容 由使用者进行填充 -->
<slot></slot>
</view>
<!-- slot 插槽组件的使用者 -->
<my-test4>
<view>这是通过插槽填充的的内容</view>
</my-test4>
启用多个插槽
在小程序的自定义组件中,需要使用多 <slot> 插槽时,可以在组件的 .js 文件中,通过如下方式进行启用。
示例代码如下:
<!-- slot 多个插槽组件的使用者 -->
<my-test4>
<view slot="before">1</view>
<view slot="after">2</view>
</my-test4>
Component({
// 组件的属性列表
properties: { },
options:{
multipleSlots:true // 在组件定义的时候启用 多个 slot
},
data: { },
methods: { }
})
13. 父子组件之间的通信
13.1 父子组件之间通信的 3 种方式
① 属性绑定
⚫ 用于父组件向子组件的指定属性设置数据,仅能设置 JSON 兼容的数据
② 事件绑定
⚫ 用于子组件向父组件传递数据,可以传递任意数据
③ 获取组件实例
⚫ 父组件还可以通过 this.selectComponent() 获取子组件实例对象
⚫ 这样就可以直接访问子组件的任意数据和方法
13.2 属性绑定
属性绑定用于实现父向子传值,而且只能传递普通类型的数据,无法将方法传递给子组件。父组件的示例代码
如下:
<!-- 父子组件之间的通信 -->
<my-test5 count="{{count}}"></my-test5>
<view>------------------</view>
<view>父组件中的count值是: {{count}}</view>
// 父组件中的 data 节点
Page({
data: {
count:0
},
})
13.3 子组件在 properties 节点中声明对应的属性并使用。示例代码如下:
// 子组件在 properties 节点中声明对应的属性并使用
Component({
properties: {
count:Number
},
data: {
},
methods: {
}
})
// 子组件中 wxml 结构
<view>子组件中count值是: {{count}}</view>
13.4 实现子组件 +1
Component({
properties: {
count:Number
},
data: {
},
methods: {
addCount() {
this.setData({
count: this.properties.count + 1
})
}
}
})
// wxml 页面结构
<view>子组件中count值是: {{count}}</view>
<button bindtap="addCount">+1</button>
14. 父子组件之间的通信 —— 事件绑定
事件绑定用于实现子向父传值,可以传递任何类型的数据。使用步骤如下:
① 在父组件的 js 中,定义一个函数,这个函数即将通过自定义事件的形式,传递给子组件
② 在父组件的 wxml 中,通过自定义事件的形式,将步骤1 中定义的函数引用,传递给子组件
③ 在子组件的 js 中,通过调用 this.triggerEvent('自定义事件名称', { /* 参数对象 */ }) ,将数据发送到父组件
④ 在父组件的 js 中,通过 e.detail 获取到子组件传递过来的数据
// 1.在父组件中定义方法 syncCount
Page({
// 父组件中的 data 节点
data: {
count:0
},
// 1.在父组件中定义方法
syncCount(e) {
console.log('syncCount')
console.log(e);
console.log(e.detail.value);
this.setData({
count: e.detail.value
})
}
})
// 2.在父组件的 wxml 中,通过自定义事件的形式,将步骤 1 中定义的函数引用,传递给子组件。
<!-- 绑定 sync 事件 实现子 向 父亲 传值 -->
<my-test5 count="{{count}}" bind:sync="syncCount"></my-test5>
<view>------------------</view>
<view>父组件中的count值是: {{count}}</view>
// 3. 在子组件的 js 中,通过调用 this.triggerEvent(‘自定义事件名称’, { /* 参数对象 */ }) ,将数据发送到父组件
Component({
properties: {
count:Number
},
data: { },
methods: {
addCount() {
this.setData({
count: this.properties.count + 1
})
// 触发自定义事件, 将数值同步给父组件
// 'sync',{ value: this.properties.count } 事件名称 和参数值
this.triggerEvent('sync',{ value: this.properties.count })
}
}
})
15.获取组件实例
在父组件里调用 this.selectComponent("id或class选择器") ,获取子组件的实例对象,从而直接访问子组
件的任意数据和方法。调用时需要传入一个选择器,例如 this.selectComponent(".my-component")
// wxml 结构
<!-- 获取组件实例 class id 都行 -->
<my-test5 count="{{count}}" bind:sync="syncCount" class="customA" id="cA"></my-test5>
<button bindtap="getChild">获取子组件实例</button>
// 方法
// getChild 获取子组件实例
getChild() {
// 切记只能使用 class 类选择器 或者 id 选择器
const child = this.selectComponent('.customA') //也可以传递 id #cA
// child.setData({ COUNT: child.properties.count + 1}) // 调用子组件 setData方法
child.addCount() //调动子组件的addCount()方法
},
16. behaviors 用于实现组件间代码共享的特性,类似于 Vue.js 中的 “mixins”
每个 behavior 可以包含一组属性、数据、生命周期函数和方法。组件引用它时,它的属性、数据和方法会被
合并到组件中。
每个组件可以引用多个behavior,behavior 也可以引用其它 behavior。
16.1 创建 behavior
// 调用 Behavior() 方法 创建实例对象
// 使用 module.exports 将 Behavior共享出去
module.exports = Behavior ({
// 私有数据节点
data:{username:'zs'},
// 属性节点
properties:{},
// 事件处理函数和自定义方法节点
methods:{}
})
16.2 导入并使用 behavior
在组件中,使用 require() 方法导入需要的 behavior,挂载后即可访问 behavior 中的数据或方法,示例代码
如下:
// 在 .js 文件中 使用 require() 方法导入需要的 behavior
const myBbehavior = require('../../behaviors/my-behavior')
Component({
// 将导入的 behavior 实例对象 挂在到 behavior 节点中,即可生效
behaviors: [ myBehavior ],
properties: {
count:Number
},
data: {
},
})
// wxml 结构
<view>在Behavior中定义的用户名是: {{username}}</view>
16.3 behavior 中所有可用的节点
可用的节点 类型 是否必填 描述
properties Object Map 否 同组件的属性
data Object 否 同组件的数据
methods Object 否 同自定义组件的方法
behaviors String Array 否 引入其它的 behavior
created Function 否 生命周期函数
attached Function 否 生命周期函数
ready Function 否 生命周期函数
moved Function 否 生命周期函数
detached Function 否 生命周期函数
17 总结 - 组件
① 能够创建并引用组件
⚫ 全局引用、局部引用、usingComponents
"usingComponents": {
"my-test2":"/components/test2/test2",
"my-text3":"/components/text3/text3",
"my-test4":"/components/test4/test4",
"my-test5":"/components/test5/test5"
}
② 能够知道如何修改组件的样式隔离选项
⚫ options -> styleIsolation( isolated, apply-shared, shared)
③ 能够知道如何定义和使用数据监听器
⚫ observers
④ 能够知道如何定义和使用纯数据字段
⚫ options -> pureDataPattern
⑤ 能够知道实现组件父子通信有哪3种方式
⚫ 属性绑定、事件绑定、this.selectComponent(' id或class选择器')
⑥ 能够知道如何定义和使用behaviors
⚫ 调用 Behavior() 构造器方法