微信小程序的自定义组件

news/2024/7/8 5:00:55 标签: 微信小程序, 小程序

小程序目前已经支持组件化开发,可以将页面中的功能模块抽取成自定义组件,以便在不同的页面中重复使用;
也可以将复杂的页面拆分成多个低耦合的模块,有助于代码维护

常见组件

开发中常见的组件有两种:
1. 公共组件:将页面的功能模块抽取成自定义组件,以便在不同的页面中重复使用
2. 页面组件:将复杂的页面拆分成多个低耦合的模块,有助于代码维护

创建和注册组件

如果时公共组件,建议放在项目根目录的components文件夹中
如果时页面组件,建议放在对应页面的目录下
建议:一个组件一个文件夹
开发中常见的组件主要分为公共组件和页面组件两种,因此注册组件的方式也分为两种:
1. 全局注册:在app.json 文件中配置 usingComponents 进行注册,注册后可以再任意页面使用
2. 局部注册:在页面的json文件中配置 usingComponents  进行注册,注册后只能在当前页面使用

在 usingComponents 中进行组件注册时,需要提供 自定义组件的组件名和自定义组件文件路径
在将组件注册好以后,直接将 自定义组件的组件名当成组件标签名使用即可。
在这里插入图片描述

组件的数据以及方法

组件数据和方法需要在组件 .js 的 Component 方法中进行定义,Component 创建自定义组件
1. data: 定义组件的内部数据
2. methods:在组件中事件处理程序需要写到 methods 中才可以

组件的属性

Properties 是指组建的对外属性,主要用来接收组件使用者传递给组件内部的数据,
和 data 一同用于组件的模板渲染
// components/custom-checkbox/custom-checkbox.js
Component({
  data:{
    isChecked:false
  },
  // 组件的属性列表:组件的对外属性,主要用来接收使用
  properties:{
    // 如果需要接收传递的属性,有两种方式:全写、简写
    // label:String
    label:{
      // type 组件使用着传递的数据类型
      // 数据类型:String、Number、Boolean、Object、Array
      // 也可以设置为null,表示不限制类型
      type:String,
      value:''
    },
    position:{
      type:String,
      value:'right'
    }
  },
  /**
   * 组件的方法列表:在组件中,所有的事件处理都需要写到 methods 方法中
   */
  methods: {
    // 更新复选框的状态
    updateCheck(){
      console.log(this.properties.label)// 获取 properties 里的属性
      this.setData({
        isChecked:!this.data.isChecked,
        // 更改properties 里的属性,但是一般情况下,不建议修改,因为会造成数据流的混乱
        // 一般建议父子组件修改
        label:'在组件内部更改啦',
      })
    }
  }
})
注意事项:
设置属性类型需要使用 type 属性,属性类型是必填项,value 属性为默认值
属性类型可以为 String 、Number、Boolean、Object、Array ,也可以为null 表示不限制类型 

组件wxml的slot

在使用基础组件时,可以在组件中间些子节点,从而子节点的内容展示到页面中,自定义组件也可以接收子节点
只不过在组件模板中需要定义<slot/>节点,用于承载组件中的子节点

在这里插入图片描述
在这里插入图片描述

默认情况下,一个组件的wxml 中 只能有一个slot(默认插槽)。
需要使用多slot时,可以在组件 js 中声明启用。
Component({
  options:{
    // 启用多 slot 支持
    multipleSlots:true
  },
})
同时需要给 slot 添加 name 属性来区分不同的 slot (具名插槽)
然后给子节点内容添加 slot 属性,属性值时对应 slot 的 name 名称,从而将内容插入到 对应的 slot中

在这里插入图片描述

自定义组件样式以及注意事项

自定义组件拥有自己的 wxss 样式,组件 wxss 文件的样式,默认支队当前组件生效

编写组件样式时,需要注意一下几点:
1. app.wxss 或页面的 wxss 中使用了标签名(view)选择器(或一些其他特殊选择器)来直接指定样式
	这些选择器会影响到页面和全部组件,通常情况下这是不推荐的做法
2. 组件和应用组件的页面不能使用 id 选择器(#a)、属性选择器([a])和标签选择器,请改用class 选择器
3. 组件和引用组件的页面中使用后代选择器(.a .b)在一些极端情况下会有非预期的表现,如遇,请避免使用
4. 子元素选择器(.a>.b)只能用于view组件与其子节点之间,用于其它组件可能导致非预期的情况
5. 继承样式,如 font、color,会从组件外继承到组件内。
6. 除继承样式外,全局中的样式、组件所在页面的样式队自定义组件无效(除非更改组件样式隔离选项)

自定义组件的样式隔离

默认情况下,自定义组件的样式只受自身 wxss 的影响,但是有时候我们需要组件使用者的样式能够影响到组件
这时候就需要指定特殊的样式隔离选项, styleIsolation, 选择它支持以下取值:
1. isolated:表示启用样式隔离,在自定义组件内外,
	使用 class 指定的样式将不会互相影响(一般情况下的默认值)
	
2. apply-shared:表示页面使用者、页面的 wxss 样式能够影响到自定义组件,
	但自定义组件的样式不会影响组件使用者、页面的 wxss 样式
	
3. shared: 表示页面使用者、页面的 wxss 样式能够影响到自定义组件
	自定义组件的样式会影响组件使用者、页面的 wxss 样式
	和其它使用了 apply-share 以及 shared 属性的自定义组件
Component({
  options:{
    styleIsolation:"isolated"
  },
})

示例 修改checkbox样式
在自定义样式中,不能直接修改复选框样式 需要在当前自定义组件 .js 文件中添加以下代码
shared: 修改其它页面的样式、组件使用者的样式、以及其它使用了 share 以及 apply-share 的组件
这时候,不是想要的结果

Component({
  options:{
    styleIsolation:"shared"
  },
})

需求时:只想影响当前组件,可以添加命名空间 在 wxml中 添加class

<view>
  <checkbox class="custom-checkbox"></checkbox>
</view>

注意:
然后在当前自定义组件 wxss 样式文件中重写样式 记得添加权重

// 复选框没有选中时默认的样式
.wx-checkbox-input{
  width: 24rpx !important;
  height: 24rpx !important;
  border-radius: 50% !important;
  border: 1px solid #fda007 !important;
}

自定义组件 数据监听器 observers

数据监听器主要用于监听和响应任何属性(properties)和数据(data)的变化,当数据发生变化时就会
触发对应的回调函数,从而方便开发者进行业务逻辑的处理
在组件中如果需要进行数据监听,需要使用 observer 字段
  1. 监听一个数据
 observers:{
  //  key:需要监听的数据  value:就是一个回调函数,默认 形参:最新的数据
  // 监听一个数据
  num:function(newNum){
    console.log(newNum)
  },
}

2.监听多个数据

 observers:{
 // 同时监听多个数据
  'num,count':function(newNum,newCount){
    console.log(newNum,newCount)
  },
 }
  1. 监听属性以及内部数据的变化
 // 支持监听属性以及内部数据的变化
 observers:{
  'obj.name':function(newName){
    console.log(newName)
  },
  'arr[1]':function(newItem){
    console.log(newItem)
  },
 }
  1. 监听对象中所有属性
 observers:{
  // 监听对象中所有属性
  'obj.**':function(newObj){
    console.log(newObj)
  },
}
  1. 监听组件使用者传递的数据
//  用来监听数据或者属性是否发生了变化
 observers:{
  // 监听label
  // 只要组件使用者传递了数据,这时候监听器中就能获取传递的数据
  // 也就是说,监听器立即就执行了
  label:function(newLabel){
    console.log(newLabel)
  }
 },

组件通信

1. 父往子传值

父组件如果需要向子组件传递数据,只需要两个步骤:
1. 在父组件 WXML 中使用 数据绑定 的方式向子组件传递动态数据
2. 子组件内部使用 properties 接收父组件传递的数据即可

2.子往父传值

子组件如果需要向父组件传递数据,可以通过小程序提供的事件系统实现,可以传递任意数据。
1. 自定义组件内部使用 triggerEvent 方法发射一个自定义的事件,同时可以携带数据
2. 自定义组件标签上通过 bind 方法监听 发射的事件,同时绑定事件处理函数,在事件函数中通过
	通过事件对象获取传递的数据

在子组件中 child.wxml

<button type="primary" plain bindtap="sendData">传递数据</button>

子组件 child.js 文件 methods 定义绑定的方法

// components/child/child.js
Component({
  /**
   * 组件的初始数据
   */
  data: {
    num:100
  },
  /**
   * 组件的方法列表
   */
  methods: {
    // 将数据传递给父组件
    sendData(){
      // 如果需要使用 triggerEvent 发射自定义事件
      // 第二个参数,时携带的参数
      this.triggerEvent('myEvent',this.data.num)
    }
  }
})

使用子组件的【父组件】中 father.xml


<!-- 需要在自定义组件标签上通过 bind 方法绑定自定义事件,同时绑定事件处理函数 -->
<view>{{ num }}</view>
<child bind:myEvent="getData"></child>

使用子组件的 【父组件】中 father.js

Page({
  data:{
    num:''
  },
  // 可以通过事件对象.detail 获取子组件传递给父组件的数据
  getData(event){
   this.setData({
     num:event.detail
   })
  }
})

获取组件实例

父组件可以通过 【this.selectComponent】 方法,获取子组件实例对象,这样就可以直接访问子组件的任意数据和方法
【this.selectComponent】方法在调用时需要传入一个匹配选择器 selector

使用组件【父组件】father.wxml

<child class="childclass"></child>

<button bindtap="getChild">获取子组件实例对象</button>

使用组件【父组件】father.js

Page({
  // 获取子组件的实例对象
  // 获取到实例对象以后,就能获取子组件所有的数据,也能调用子组件的方法
  getChild(){
    console.log(this.selectComponent('.childclass'))
  }
})

自定义组件 组件的生命周期

组件的生命周期:指的是组件自身的一些钩子函数,这些函数在特定的时间节点时被自动触发
组件的生命周期函数需要在 lifetimes 字段内进行声明
组建的生命周期函数有5个:created、attached、ready、moved、detached

在这里插入图片描述

Component({
  lifetimes:{
    // 组件实例被创建好以后执行
    // 在created钩子函数中不能调用 setData
    // 可以给组件添加一些自定义属性,可以通过 this 的方式进行添加
    created(){
      this.test="测试"
      console.log("created")
    },
    // 组件被初始化完毕,模板解析完成,已经把组件挂载到页面上
    // 一般页面中的交互会在 attached 钩子函数中进行实现
    attached(){
      console.log(this.test)
      console.log("attached")
    },
    // 组件被销毁时
    detached(){
      console.log("detached")
    }
  }
})

自定义组件 组件所在页面的生命周期

组件还有一些特殊的生命周期,这类生命周期和组件没有很强的关联
主要用于组件内部监听父组件的展示、隐藏状态、从而方便组件内部执行以下业务逻辑的处理
组件所在页面的生命周期有4个:show、hide、resize、routeDone,需要在 pageLifetimes 字段内进行声明

在这里插入图片描述

Component({
  // 组件所在页面的生命周期
  pageLifetimes:{
    // 监听组件所在页面展示(后台切前台)状态
    show(){
      console.log('组件所在页面被展示')
    },
     // 监听组件所在页面隐藏(前台切后台、点击 tabBar等)状态
    hide(){
      console.log('组件所在页面被隐藏')
    },
  }
})

自定义组件-拓展-使用 Component 构造函数

Component 方法用于创建自定义组件
小程序的页面也可以视为自定义组件,因此页面也可以使用Component 方法进行创建,从而实现复杂的页面逻辑开发
 小程序页面也可以使用 Component 方法进行构造
注意事项:
1. 【 .json】 文件中 必须包含 usingComponents 字段
2. 立马的配置项需要和 Component 中的配置项保持一致
3. 页面中 Page 方法 有一些钩子函数、事件监听方法,这些钩子函数和事件监听必须放在methods 对象中
4. 组件的属性 properties 也可以接受页面的参数,在 onLoad 钩子函数中 可以通过 this.data 进行获取

为什么需要使用 Component 方法进行构造页面

Component 方法功能比 Page 方法强大很多
如果使用Component 方法构造页面,可以实现更加复杂的页面逻辑开发

自定义组件 -拓展-组件复用机制 behaviors

小程序的 behaviors 方法时一种代码复用的方式,可以将一些通用的逻辑和方法提取出来,然后在多个组件中服用,从而减少代码冗余,
提高代码的可维护性。
如果需要 behaviors 服用代码,需要使用 Behavior() 方法,每个 behavior 可以包含一组属性、数据、生命周期和方法
组件引用它时,它的属性、数据和方法会被合并到组件中,生命周期函数也会在对应时机被调用

自定义组件 文件夹内新建个文件 把公共方法放入到js文件内

const behavior=Behavior({
  /**
   * 组件的属性列表
   */
  properties: {
    label:{
      type:String,
      value:'我已同意该协议'
    }
  },

  /**
   * 组件的初始数据
   */
  data: {
    name:'Tome',
    obj:{
      name:"Tyke"
    }
  },

  /**
   * 组件的方法列表
   */
  methods: {
    updateName(){
      this.setData({
        name:'Jerry'
      })
    }
  },
  lifetimes:{
    attached(){
      console.log('我是属性的生命周期方法')
    }
  }
})
export default behavior

当前自定义组件的js里 引入 公共方法 behavior

import behavior from './behaviors'
Component({
  // 在以后开发中,使用 behaviors 进行代码复用的时候
  // 组件和behaviors 可能存在相同的字段
  // 如果存在相同的 properties ,就近原则,使用组件内部的数据
  
  // 如果存在相同的 data
  // 如果是对象类型的数据,会进行合并
  // 如果不是对象类型的数据,就近原则,展示的以组件内部为准
  behaviors:[behavior]
})

注意:
1. 如果存在相同的 properties ,就近原则,使用组件内部的数据
2. 如果存在相同的 data,如果是对象类型的数据,会进行合并, 如果不是对象类型的数据,就近原则,展示的以组件内部为准
3. 如果存在相同的方法,就近原则,使用组件内部的数据
4. 如果存在相同的生命周期函数,生命周期函数都会被触发

自定义组件的 外部样式类

默认情况下,组件和组件使用者之间如果存在相同的类名不会相互影响,组件使用者如果想修改组件的样式,需要解除样式隔离,
但是解除样式隔离以后,在极端情况下,会产生样式冲突、CSS 嵌套太深等问题,从而给我们的开发带来一定的麻烦

外部样式类:在使用组件时,组件使用者可以给组件传入 CSS 类名,通过传入的类名修改组件的样式。
如果需要使用外部样式类修改组件的样式,在 Component 中需要 externalClasses 定义若干个外部样式类。

在父组件【使用组件】wxml 中

<!-- 属性是在 externalClasses 里面定义的元素 -->
<!-- 属性值必须是一个类名 -->
<custom08 extend-class="my-class"></custom08>

在父组件【使用组件】wxss 样式文件中

.my-class{
  color:red
}

在【子组件】wxml 中

<view class="extend-class">通过外部样式类修改组件的样式</view>

在【子组件】js 中

Component({
  // 组件接受的外部样式类
  externalClasses:['extend-class'],
})

注意

  1. 在同一个节点上,如果存在外部样式类 和普通的样式类
  2. 两个类的优先级是未定义的
  3. 如果 styleIsolation 属性值是 shared 这时候 externalClasses 选项会失效
    建议:在使用外部样式类的时候,样式需要通过【 !important】添加权重

总结自定义组件

1. 组件基本使用:数据、属性、方法、插槽
2. 组件样式使用:组件样式、注意事项、样式隔离、外部样式类
3. 组件通信传值:父往子传值、子往父传值、获取组件实例
4. 组件生命周期:组件的生命周期、组件所在页面的生命周期、总结了小程序全部的生命周期
5. 组件数据监听器:observers
6. 组件拓展:使用Component构建页面、组件复用机制 behaviors 等

http://www.niftyadmin.cn/n/5536523.html

相关文章

C# Winform PropertyGrid显示中文

主要原理是在枚举上添加DescriptionAttribute属性&#xff0c;然后通过反射将其显示出来 方法1&#xff1a;继承StringConverter类 public class EnumConvertor : StringConverter {public override bool GetStandardValuesSupported(ITypeDescriptorContext context){return…

基于STM32F103C8T6的同步电机驱动-CubeMX配置与IQmath调用

基于STM32F103C8T6的同步电机驱动-CubeMX配置与IQmath调用 一、功能描述: 上位机通过CAN总线实现对电机的运动控制,主要包含三种模式:位置模式、速度模式以及力矩模式。驱动器硬件核心为STM32F103C8T6,带相电压采集电路以及母线电压采集电路。其中供电电压12V。 PWM中心对…

步进电机(STM32+28BYJ-48)

一、简介 步进电动机&#xff08;stepping motor&#xff09;把电脉冲信号变换成角位移以控制转子转动的执行机构。在自动控制装置中作为执行器。每输入一个脉冲信号&#xff0c;步进电动机前进一步&#xff0c;故又称脉冲电动机。步进电动机多用于数字式计算机的外部设备&…

STM32 HAL库实现硬件IIC通信

文章目录 一. 前言二. 关于IIC通信三. IIC通信过程四. STM32实现硬件IIC通信五. 关于硬件IIC的Bug 一. 前言 最近正在DIY一款智能电池&#xff0c;需要使用STM32F030F4P6和TI的电池管理芯片BQ40Z50进行SMBUS通信。SMBUS本质上就是IIC通信&#xff0c;项目用到STM32CubeMXHAL库…

ListView 的简单使用及 ArrayAdapter 中参数详解

&#x1f604;作者简介&#xff1a; 小曾同学.com,一个致力于测试开发的博主⛽️&#xff0c;主要职责&#xff1a;测试开发、CI/CD&#xff0c;日常还会涉及Android开发工作。 如果文章知识点有错误的地方&#xff0c;还请大家指正&#xff0c;让我们一起学习&#xff0c;一起…

记录一次Apache Tomcat 处理返回自定义的404页面

记录工作中遇到处理访问tomcat 不存在的资源&#xff0c;返回自定义的404页面 删除webapps目录下的example、docs、manager、hta-manager目录&#xff0c;只保留 ROOT目录&#xff0c;应用部署在了这个目录 删除 manager、hta-manager 我没有发现有什么异常 制作404.jsp 或者 4…

windows USB 设备驱动开发-USB设备描述符

USB的描述符是USB设备向主机报告状态的重要数据结构&#xff0c;在USB通电后&#xff0c;端点(也称为终结点)0始终处于可用状态&#xff0c;这个默认的端点就是用于主机从设备中读取描述符的。 讨论USB通讯&#xff0c;需要从软件和硬件两方面说起&#xff0c;在软件上&#x…

车牌号查车辆信息-车牌号查车辆信息接口-汽车API接口

接口简介&#xff1a;输入车牌号&#xff0c;返回车辆相关信息&#xff08;无车主信息&#xff09;。初始登记日期、上险日期、保险到期时间、车架号、品牌这些数据会返回&#xff0c;其他数据不一定全部返回&#xff0c;,详细参数请查看返回接口文档 一般在新车上险或过户后第…