微信小程序——自定义组件

什么是微信小程序的自定义组件以及意义

自定义组件,类似于Vue中的组件概念(事件通信机制非常类似),将页面内的一些功能模块抽象成自定义组件,以便在不同的页面中重复使用,也可以将复杂的页面拆分成多个低耦合的模块,有助于代码的维护。

创建自定义组件

自定义组件和页面类似,也是需要四个部分组成。wxss,wxml,js,json

在自定义组件的js文件中,需要使用Component()来注册组件,并提供组件的属性定义、内部数据和自定义方法。

属性和内部数据都是被用于wxml的渲染,其中属性值是可由外部组件传入的。

如何使用自定义组件

怎样在一个具体的页面中使用自定义组件呢?首先,我们需要告诉页面我们引用了哪一个自定义组件,也就需要在页面的json中进行引用声明。如下所示,提供每个自定义组件的标签名以及对应的自定义组件的文件路径。

{
  "usingComponents": {
    "component-tag-name": "path/to/the/custom/component"
  }
}

然后,我们在页面的wxml中就可以像使用基础组件一样使用自定义组件。节点名即自定义组件的标签名,节点属性即传递给组件的属性值。如下所示:

<view>
  <!-- 以下是对一个自定义组件的引用 -->
  <component-tag-name inner-text="Some text"></component-tag-name>
</view>

注意事项

  • 在组件wxss中不应该使用ID选择器、属性选择器和标签选择器

  • 因为wxml节点标签名只能是小写字母,中划线和下划线组成,所以自定义组件也只能包含这些这些字符。

  • 在properties定义段中,属性名采用驼峰写法(propertyName);在wxml中,指定属性值的时候则对应使用连字符写法(component-tag-name property-name="attr name"),应用于数据绑定的时候采用驼峰写法(attr="propertyName")

  • 使用this.data可以获取内部数据和属性值,但不要直接修改它们,应该使用setData修改

组件模板

组件模板与组件数据结合后生成的节点树,将被插入到组件的引用位置上。

在组件模板中可以提供一个<slot>节点,用于承载组件引用时提供的子节点。
如下所示:

<!-- 组件模板 -->
<view class="wrapper">
  <view>这里是组件的内部节点</view>
  <slot></slot>
</view>
<!-- 引用组件的页面模版 -->
<view>
  <component-tag-name>
    <!-- 这部分内容将被放置在组件 <slot> 的位置上 -->
    <view>这里是插入到组件slot中的内容</view>
  </component-tag-name>
</view>

当然,也可以使用多个slot,如果使用多个slot的时候,组件需要指定slot的name属性,然后在使用组件的时候,使用slot属性将节点插入到不同的slot中上。
官方的例子如下:

<!-- 组件模板 -->
<view class="wrapper">
  <slot name="before"></slot>
  <view>这里是组件的内部细节</view>
  <slot name="after"></slot>
</view>
<!-- 引用组件的页面模版 -->
<view>
  <component-tag-name>
    <!-- 这部分内容将被放置在组件 <slot name="before"> 的位置上 -->
    <view slot="before">这里是插入到组件slot name="before"中的内容</view>
    <!-- 这部分内容将被放置在组件 <slot name="after"> 的位置上 -->
    <view slot="after">这里是插入到组件slot name="after"中的内容</view>
  </component-tag-name>
</view>

组件样式

组件对应的wxss文件中的样式,只对组件中wxml生效,编写组件样式的时候,需要特别注意:

  • 继承样式。如font、color,会从组件外继承到组件内。
  • 除了继承样式外,app.wxss中的样式、组件所在页面的样式对自定义组组件无效。
  • 子选择器(.a>.b)只能用于view组件与其子节点之间,用于其他组件可能导致非预期的结果

Component构造器

ComPonent构造器可用于定义组件,调用Component构造器的时候可以指定组件的属性、数据、方法等

组件间通信与事件

组件之间的基本通信方法有以下几种:

  • wxml数据绑定:用于父组件向子组件的指定属性设置数据,仅能设置JSON兼容数据
  • 事件:用于子组件向父组件传递数据,可以传递任何数据
  • 如果以上两种方式还不足以满足需求,那么父组件还可以通过this.selectComponent方法获取子组件的实例对象,这样就可以直接访问组件中的任意数据和方法了。

下面就介绍通过事件进行通信
自定义组件触发事件
自定义组件触发事件的时候,需要通过triggerEvent方法,指定事件名称、detail对象和事件选项。官方例子如下:

<!-- 在自定义组件中 -->
<button bindtap="onTap">点击这个按钮将触发“myevent”事件</button>
Component({
  properties: {}
  methods: {
    onTap: function(){
      var myEventDetail = {} // detail对象,提供给事件监听函数
      var myEventOption = {} // 触发事件的选项
      this.triggerEvent('myevent', myEventDetail, myEventOption)
    }
  }
})

其中触发事件的选项包括:


调用组件,监听事件
引用组件的页面可以监听这些事件。如下:

<!-- 当自定义组件触发“myevent”事件时,调用“onMyEvent”方法 -->
<component-tag-name bindmyevent="onMyEvent" />
<!-- 或者可以写成 -->
<component-tag-name bind:myevent="onMyEvent" />
Page({
  onMyEvent: function(e){
    e.detail // 自定义组件触发事件时提供的detail对象
  }
})
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,222评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,455评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,720评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,568评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,696评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,879评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,028评论 3 409
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,773评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,220评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,550评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,697评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,360评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,002评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,782评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,010评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,433评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,587评论 2 350

推荐阅读更多精彩内容