likes
comments
collection
share

小程序自定义组件Component超全实用指南

作者站长头像
站长
· 阅读数 13

小知识，大挑战！本文正在参与“程序员必备小知识”创作活动。

本文同时参与 「掘力星计划」，赢取创作大礼包，挑战创作激励金

在小程序中，想要将页面内的功能模块抽象出来，在不同的页面中重复使用，我们可以使用它的自定义组件，自定义组件可以将复杂的页面拆分成多个低耦合的模块，这样不仅使用起来方便，而且还有助于我们的代码维护。

前言

本文你将收获

👉 小程序如何使用自定义组件

👉 自定义组件之间的各种传值

👉 自定义组件中插槽的使用

💥 排雷，本文的小程序指的是微信小程序（不过其他的小程序思路应该差不多）

💥 排雷，本文主要内容是自定义组件的各种用法，不是教大家怎么封装组件哈！

基础准备（可忽略）

新增文件夹

首先在根目录下创建一个专门放自定义组件的文件夹（文件夹名称任意，位置也任意）

小程序自定义组件Component超全实用指南

新建Component文件

然后在小程序编辑器里，右键，新建Component

小程序自定义组件Component超全实用指南

为什么要特意说这一步呢？

不知道有没有小伙伴们和我一样一直只把小程序开发工具当预览工具用，然后开发是用其他编辑器的。

小程序自定义组件Component超全实用指南

后面发现直接在小程序新建Component或者Page，它会一口气把四个文件都建好，并且内容模板也会填好，所以现在开发者工具除了预览，我还用它新建文件。

小程序自定义组件Component超全实用指南

示例背景说明

我们后面就以类似下图中的模块分割标题为例写一个简单的组件示例（只是瞎举例）

小程序自定义组件Component超全实用指南

怎么引入自定义组件？

创建不多说，如以上【新建Component文件】即可，如果是自己手动创建，别忘了在json文件声明（小程序开发工具新建的默认就有）

{
  "component": true
}

引入组件方法

小程序自定义组件Component超全实用指南

在页面的 json 文件中进行引用声明

<!-- 引用组件的json文件 -->
{
  "usingComponents": {
    "x-title": "/components/title/title"
  }
}

在页面的 wxml 中像使用基础组件一样使用自定义组件（名字和声明的保持一致）

<!-- 引用组件的wxml文件 -->
<x-title></x-title>

怎么传值？

父组件给子组件传值

可以看到我们上面把标题的内容写死了，但是实际中使用我们肯定是需要根据不同的模块，传入不同的标题内容，这样我们就需要使用到父子之间的传值了。

父级给子级传值

<!-- 父级wxml -->
<x-title titleText="全部订单"></x-title>

<!-- 如果父级的值是一个变量则 -->
<x-title titleText="{{currentTitle}}"></x-title>

子级接收父级传过来的值

<!-- 子级js -->
properties: {
        titleText:{
            type:String,
            value:'其他'
        }
    },

小程序自定义组件Component超全实用指南

子组件给父组件传值

把组件稍微修改一下，新增了详情操作按钮，当前通过循环已得出多个模块，现在想在点击详情的时候，子级把当前模块的id传给父级。

小程序自定义组件Component超全实用指南

子组件给父组件传参

<!-- 子级wxml -->
 <view class="title-oper" bindtap="gotoDetail">详情</view>
 
 <!-- 子级js -->
 gotoDetail(){
    this.triggerEvent('gotoDetail',this.data.titleId)
 }

小程序自定义组件Component超全实用指南

父组件接收子组件的参数

<!-- 父级 wxml -->
<x-title titleText="{{item.title}}"
             titleId="{{item.id}}"
             bind:gotoDetail="gotoDetail"></x-title>
             
<!-- 父级 js -->
//通过e.detail获取子组件传过来的参数
gotoDetail(e){ 
    const id = e.detail 
    console.log('从子组件接收到的id',id)
}

小程序自定义组件Component超全实用指南

父级调用子组件的方法

子组件定义了一个方法

<!-- 子级 js -->
childMethod(){
    console.log('我是子组件的方法')
 },

父级先给子组件一个id

<!-- 父级 wxml -->
<x-title id="titleCom"></x-title>

<van-button type="primary" bindtap="triggerChildMethod">调用子组件方法</van-button>

在js页面的生命周期中获取组件，然后存到我们自定义的变量titleCom中，接着便可直接调用子组件里面的方法了

<!-- 父级 js -->
 onReady(){
    this.titleCom = this.selectComponent("#titleCom");
  },
  
triggerChildMethod(){
    this.titleCom.childMethod();
  }

小程序自定义组件Component超全实用指南

如果this.selectComponent()返回为null

1、检查wxml定义的id和js使用的是否一致；

2、自定义组件是否渲染，例如你使用了wx:if，导致组件还未渲染

传值官网相关文档：地址

在自定义组件中使用插槽（slot）

我们上面在自定义组件中加了【详情】查看的操作按钮，但是有的地方我们可能并不想用文字，想改成图标或者按钮，当某处放置的节点内容不确定时，我们就可以使用插槽来处理。

插槽就相当于在子组件中放一个占位符，这样父组件就可以向子组件填充html了。

小程序自定义组件Component超全实用指南

单插槽

小程序自定义组件Component超全实用指南

在子组件加入插槽

<!-- 子级 wxml -->
 <slot></slot>

父级即可在组件内任意填充内容，比如插入一个图标（如果子级没有加slot，及时填充了html也不会被渲染）

<!-- 父级 wxml -->
 <x-title>
 	<view class="oper-wrap">
            <van-icon name="arrow" />
    </view>
 </x-title>

小程序自定义组件Component超全实用指南

多插槽

小程序自定义组件Component超全实用指南

先在子组件的js开启一下多slot支持

 <!-- 子级 js -->
 options: {
        multipleSlots: true // 在组件定义时的选项中启用多slot支持
    },

在子组件加上插槽需要给插槽加上名字

 <!-- 子级 wxml --> 
 <slot name="icon"></slot>
 
  <slot name="oper"></slot>

在父级使用

 <!-- 父级 wxml --> 
 <view class="icon-wrap" slot="icon">
    <van-icon name="orders-o" size="24"/>
 </view>

<view class="oper-wrap"  slot="oper">
   <van-button type="primary" custom-style="{{customStyle}}">更多</van-button>
</view>

小程序自定义组件Component超全实用指南

注意

问：为什么加了插槽，却没有反应？

小程序自定义组件Component超全实用指南

虽然我只在【子组件】加了1个插槽，但是因为加上了名字，所以同样需要在【子组件】的js里开启多插槽

 options: {
        multipleSlots: true // 在组件定义时的选项中启用多slot支持
    },

插槽官网文档：地址

Component的生命周期

Component({
  lifetimes: {
    attached: function() {
      // 在组件实例进入页面节点树时执行
    },
    detached: function() {
      // 在组件实例被从页面节点树移除时执行
    },
  },
  //组件所在页面的生命周期
   pageLifetimes: {
    show: function() {
      // 页面被展示
    },
    hide: function() {
      // 页面被隐藏
    },
    resize: function(size) {
      // 页面尺寸变化
    }
  }
  // 以下是旧式的定义方式，可以保持对 <2.2.3 版本基础库的兼容
  attached: function() {
    // 在组件实例进入页面节点树时执行
  },
  detached: function() {
    // 在组件实例被从页面节点树移除时执行
  },
  // ...
})

生命周期官网：地址

关于组件样式隔离

21/12/07新增

语法：

Component({
  options: {
    styleIsolation: 'isolated'
  }
})

styleIsolation选项从基础库版本 2.6.5 开始支持。它支持以下取值：

  • isolated 表示启用样式隔离，在自定义组件内外，使用 class 指定的样式将不会相互影响（一般情况下的默认值）；

  • apply-shared 表示页面 wxss 样式将影响到自定义组件，但自定义组件 wxss 中指定的样式不会影响页面；

  • shared 表示页面 wxss 样式将影响到自定义组件，自定义组件 wxss 中指定的样式也会影响页面和其他设置了 apply-shared 或 shared 的自定义组件。（这个选项在插件中不可用。）

组件样式隔离官网：地址

关于数据监听

21/12/10新增

语法：

Component({
  attached: function() {
    this.setData({
      numberA: 1,
      numberB: 2,
    })
  },
  observers: {
    'numberA, numberB': function(numberA, numberB) {
      // 在 numberA 或者 numberB 被设置时，执行这个函数
      this.setData({
        sum: numberA + numberB
      })
    }
  }
})

注意：如果在数据监听器函数中使用 setData 设置本身监听的数据字段，可能会导致死循环，需要特别留意。

组件数据监听官网：地址

结语

🎨【点赞】【关注】不迷路，更多前端干货等你解锁

往期推荐

👉 小程序引入vant-Weapp保姆级教程及安装过程的问题解决

👉 最全的CSS阴影总结

👉 喊你来学JavaScript的加减乘除啦！

👉 HTTP备忘录 | 常用状态码&请求头&响应头&Cookies及请求方法合集