自定义组件
- 组件的创建与引用
-
组件的创建
①在项目的根目录中,鼠标右键,创建components-> test文件夹
②在新建的components -> test 文件夹上,鼠标右键,点击“新建Component”
③键入组件的名称之后回车,会自动生成组件对应的4 个文件,后缀名分别为.js,.json,.wxml 和.wxss
-
引用组件
组件的引用方式分为“局部引用”和“全局引用”局部引用:组件只能在当前被引用的页面内使用
// 在页面的.json文件中,引入组件 { "usingComponents":{ "my-test1":"/components/test1/test1" } }
//在页面的.wxml文件中,使用组件 <my-test1></my-test1>
全局引用:组件可以在每个小程序页面中使用
在app.json 全局配置文件中引用组件的方式,叫做“全局引用”"usingComponents": { "my-test2": "/components/test2/test2", }
//在页面的.wxml文件中,使用组件 <my-test2></my-test2>
-
组件和页面的区别
从表面来看,组件和页面都是由.js、.json、.wxml 和.wxss 这四个文件组成的。但是,组件和页面的.js 与.json 文件有明显的不同:
组件的.json 文件中需要声明"component": true 属性
组件的.js 文件中调用的是Component() 函数
组件的事件处理函数需要定义到methods节点中
- 样式
1.组件样式隔离
默认情况下,自定义组件的样式只对当前组件生效,不会影响到组件之外的UI 结构。
组件A 的样式不会影响组件C 的样式
组件A 的样式不会影响小程序页面的样式
小程序页面的样式不会影响组件A 和C 的样式
2.组件样式隔离的注意点
app.wxss 中的全局样式对组件无效
只有class 选择器会有样式隔离效果,id 选择器、属性选择器、标签选择器不受样式隔离的影响
3.修改组件的样式隔离选项
默认情况下,自定义组件的样式隔离特性能够防止组件内外样式互相干扰的问题。但有时,我们希望在外界能够控制组件内部的样式,此时,可以通过styleIsolation修改组件的样式隔离选项,用法如下:
// 在组件的.js文件中新增如下配置
Component({
options: {
styleIsolation: 'isolated'
},
})
//或在组件的.json文件中新增如下配置
{
“styleIsolation”:"isolated"
}
styleIsolation的可选值
- 数据、方法和属性
1.data数据
在小程序组件中,用于组件模板渲染的私有数据,需要定义到data 节点中,示例如下:
Component({
data{
count:0
}
})
2.methods 方法
在小程序组件中,事件处理函数和自定义方法需要定义到methods 节点中,示例代码如下
Component({
methods:{ // 组件的方法列表
addCount(){
this.setData({count:this.data.count+1})
this._showCount() // 通过this直接调用自定义方法
},
_showCount(){
wx.showToast({
title: 'count值为'+ this.data.count,
icon:'none'
})
}
}
})
3.properties 属性
在小程序组件中,properties 是组件的对外属性,用来接收外界传递到组件中的数据
Component({
properties:{
max:{ //完整定义属性的方式,指定属性的默认值
type:Number,
value:10
}
max:Number //简化定义属性的方式
}
})
<my-test1 max="10"></my-test1>
4.data 和properties 的区别
在小程序的组件中,properties 属性和data 数据的用法相同,它们都是可读可写的,只不过:
data 更倾向于存储组件的私有数据
properties 更倾向于存储外界传递到组件中的数据
5.使用setData 修改properties 的值
由于data 数据和properties 属性在本质上没有任何区别,因此properties 属性的值也可以用于页面渲染,或使用setData 为properties 中的属性重新赋值,示例代码如下
// 在组件的 .wxml 文件中使用properities属性的值
<view> max属性的值为: {{max}} </view>
Component({
properities:{max: Number}, // 定义属性
methods:{
addCount(){
this.setData({max:this.properties.max+1})// 使用setData修改属性的值
}
}
})
- 数据监听器
1.什么是数据监听器
数据监听器用于监听和响应任何属性和数据字段的变化,从而执行特定的操作。它的作用类似于vue 中的watch侦听器。在小程序组件中,数据监听器的基本语法格式如下
Component({
observers:{
'字段A, 字段B':function(字段A的新值, 字段B的新值){
}
}
})
2.数据监听器的基本用法
组件的UI 结构如下:
<!--components/test2/test2.wxml-->
<view>{{n1}} + {{n2}} = {{sum}}</view>
<button bindtap="addN1">n1+1</button>
<button bindtap="addN2">n2+1</button>
/**
* 组件的初始数据
*/
data: {
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
})
}
}
3.监听对象属性的变化
数据监听器支持监听对象中单个或多个属性的变化,示例语法如下:
Components({
observers:{
'对象.属性A, 对象.属性B': function(属性A的新值,属性B的新值){
//触发监听器的三种情况:
// 为属性A赋值:使用setData 设置this.data.对象.属性A时触发
// 直接为对象赋值:使用setData 设置this.data.对象时触发
}
}
})
- 数据监听器-案例
1,初始数据定义
2,渲染UI结构/** * 组件的初始数据 */ data: { rgb: { r: 0, g: 0, b: 0 }, fullColor: '0, 0, 0' },
<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>
.colorBox { line-height: 200rpx; font-size: 24rpx; color: white; text-shadow: 0rpx 0rpx 2rpx black; text-align: center; }
3, 定义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
})
},
}
4.监听对象中指定属性的变化
observers: {
'rgb.r, rgb.g, rgb.b': function (r, g, b) {
this.setData({
fullColor: `${r}, ${g}, ${b}`
})
},
5.监听对象中所有属性的变化
如果某个对象中需要被监听的属性太多,为了方便,可以使用通配符** 来监听对象中所有属性的变化,示例代码如下:
observers: {
'rgb.**': function (obj) {
this.setData({
fullColor: `${obj.r}, ${obj.g}, ${obj.b}`
})
}
},
- 纯数据字段
1.概念
纯数据字段指的是那些不用于界面渲染的data 字段。
应用场景:例如有些情况下,某些data 中的字段既不会展示在界面上,也不会传递给其他组件,仅仅在当前组件内部使用。带有这种特性的data 字段适合被设置为纯数据字段。
好处:纯数据字段有助于提升页面更新的性能
2.使用规则
在Component 构造器的options 节点中,指定pureDataPattern为一个正则表达式,字段名符合这个正则表达式的字段将成为纯数据字段,示例代码如下:
options: {
pureDataPattern: /^_/
},
data:{
a: true,// 普通数据字段
_b: true,// 纯数据字段
}
- 组件的生命周期
1.组件的全部生命周期
2.组件主要的生命周期函数在小程序组件中,最重要的生命周期函数有3 个,分别是created、attached、detached。它们各自的特点如下:
①组件实例刚被创建好的时候,created 生命周期函数会被触发
此时还不能调用setData
通常在这个生命周期函数中,只应该用于给组件的this 添加一些自定义的属性字段
②在组件完全初始化完毕、进入页面节点树后,attached 生命周期函数会被触发
此时,this.data已被初始化完毕
这个生命周期很有用,绝大多数初始化的工作可以在这个时机进行(例如发请求获取初始数据)
③在组件离开页面节点树后,detached 生命周期函数会被触发
退出一个页面时,会触发页面内每个自定义组件的detached 生命周期函数
此时适合做一些清理性质的工作
3.lifetimes节点
在小程序组件中,生命周期函数可以直接定义在Component 构造器的第一级参数中,可以在lifetimes字段内进行声明(这是推荐的方式,其优先级最高)。示例代码如下:
// 旧式的定义
created() {
console.log('created')
},
attached() {
console.log('attached')
},
// 推荐用法
lifetimes: {
created() {
console.log('created ~~~~~')
},
attached() {
console.log('attached ~~~~~')
},
},
- 组件所在页面的生命周期
1.什么是组件所在页面的生命周期
有时,自定义组件的行为依赖于页面状态的变化,此时就需要用到组件所在页面的生命周期。例如:每当触发页面的show 生命周期函数的时候,我们希望能够重新生成一个随机的RGB 颜色值。在自定义组件中,组件所在页面的生命周期函数有如下3 个,分别是:
2.pageLifetimes节点pageLifetimes: { show() { console.log('show') this._randomColor() }, hide() { console.log('hide') }, resize() { console.log('resize') } }
3.生成随机的RGB值
methods: {
_randomColor() {
this.setData({
_rgb: {
r: Math.floor(Math.random() * 256),
g: Math.floor(Math.random() * 256),
b: Math.floor(Math.random() * 256)
}
})
}
}
pageLifetimes:{
//组件所在的页面被展示时,立即调用_randomColor 生成随机的颜色值
show:function(){
this._randomColor()
}
}
- 插槽
1.什么是插槽
在自定义组件的wxml 结构中,可以提供一个<slot> 节点(插槽),用于承载组件使用者提供的wxml结构。
2.单个插槽
在小程序中,默认每个自定义组件中只允许使用一个<slot> 进行占位,这种个数上的限制叫做单个插槽
<view class="wrapper">
<view>这里是组件的内部节点</view>
<slot></slot>
</view>
<componene-tag-name>
<view>这里是插入到组件slot中的内容 </view>
</component-tag-name>
3.启用多个插槽
在小程序的自定义组件中,需要使用多 插槽时,可以在组件的.js 文件中,通过如下方式进行启用。示例代码如下:
Components({
options:{
multipleSlots:true // 在组件定义时的选项中启用多个slot支持
},
})
4.定义多个插槽
<view>
<slot name="before"></slot>
<view>这里是组件的内部结构</view>
<slot name="after"></slot>
</view>
- 父子组件之间的通信
1.父子组件之间通信的3 种方式
①属性绑定
用于父组件向子组件的指定属性设置数据,仅能设置JSON 兼容的数据
②事件绑定
用于子组件向父组件传递数据,可以传递任意数据
③获取组件实例
父组件还可以通过this.selectComponent() 获取子组件实例对象
这样就可以直接访问子组件的任意数据和方法
2.属性绑定
属性绑定用于实现父向子传值,而且只能传递普通类型的数据,无法将方法传递给子组件。父组件的示例代码如下:
// 父组件的data节点
data:{
count: 0
}
//父组件的 wxml结构
<my-test3 count="{{count}}"></my-test3>
<view>~~~</view>
<view> 父组件中,count的值为:{{count}}</view>
子组件在properties节点中声明对应的属性并使用。示例代码如下:
//子组件的properies节点
properties:{
count: Number
}
// 子组件的wxml结构
<text> 子结构中,count值为:{{count}}</text>
3.事件绑定
事件绑定用于实现子向父传值,可以传递任何类型的数据。使用步骤如下:
①在父组件的js 中,定义一个函数,这个函数即将通过自定义事件的形式,传递给子组件
// 在父组件中定义syncCount方法,这个方法将会传递给子组件,供子组件进行调用。
syncCount(){
console.log('syncCount')
}
②在父组件的wxml 中,通过自定义事件的形式,将步骤1 中定义的函数引用,传递给子组件
<!--使用bind:自定义事件名称(推荐:结构清晰)-->
<my-test3 count="{{count}}" bind:sync="syncCount"></my-test3>
<!--或在bind 后面直接写上自定义事件的名称-->
<my-test3 count="{{count}}" bindsync="syncCount"></my-test3>
③在子组件的js 中,通过调用this.triggerEvent(‘自定义事件名称’, { /* 参数对象*/ }),将数据发送到父组件
// 子组件的wxml结构
<text>子组件中,count的值为:{{count}}</text>
<button type="primary" bindtap="addCount">+1</button>
// 子组件的js代码
methods: {
addCount() {
this.setData({
count: this.properties.count + 1
})
// 触发自定义事件,将数值同步给父组件
this.triggerEvent('sync', { value: this.properties.count })
}
}
④在父组件的js 中,通过e.detail 获取到子组件传递过来的数据
syncCount(e){
this.setData({
count:e.detail.value
})
}
4.获取组件实例
可在父组件里调用this.selectComponent(“id或class选择器”) ,获取子组件的实例对象,从而直接访问子组件的任意数据和方法。调用时需要传入一个选择器,例如this.selectComponent(".my-component")
<my-test3 count="{{count}}" bind:sync="syncCount" class="customA" id="cA"></my-test3>
<button bindtap="getChild">获取子组件的实例</button>
getChild(){ // 按钮的tap事件处理函数
const child=this.selectComponent('.customA')
child.setData({count:child.properties.count+1})
child.addCount()
}
- behaviors
1.什么是behaviors
behaviors 是小程序中,用于实现组件间代码共享的特性,类似于Vue.js 中的“mixins”
2.behaviors 的工作方式
每个behavior 可以包含一组属性、数据、生命周期函数和方法。组件引用它时,它的属性、数据和方法会被合并到组件中。每个组件可以引用多个behavior,behavior 也可以引用其它behavior
3.创建behavior
调用Behavior(Object object)方法即可创建一个共享的behavior实例对象,供所有的组件使用:
// 调用behavior()方法,,将behavior实例对象共享出去
// 并使用module.export将behavior实例对象共享出去
module.exports=Behavior({
properties:{};
data:{username:'zs'},
methods:{},
})
4.导入并使用behavior在组件中,使用require() 方法导入需要的behavior,挂载后即可访问behavior 中的数据或方法,示例代码如下:
// 使用require()导入需要定义的behavior模块
const myBehavior = require('../../behaviors/my-behavior')
Component({
//将导入的behavior实例对象,挂载到behavior数组节点中,即可生效。
behaviors: [myBehavior],
})