属性绑定前缀

WXML 的属性有很多不同的绑定前缀,用于组件框架提供各种各样的特性。

以下是支持的属性绑定前缀及其参考文档的列表。

属性绑定前缀 说明 附注
let: 用于定义临时变量 仅 glass-easel 组件框架支持
class: 框架属性中的样式类 仅 glass-easel 组件框架支持
style: 框架属性中的内联样式 仅 glass-easel 组件框架支持
bind: 用于事件绑定
catch: 用于事件绑定
mut-bind: 用于事件绑定
capture-bind: 用于事件绑定
capture-catch: 用于事件绑定
capture-mut-bind: 用于事件绑定
mark: 用于事件绑定中的 mark
data: 用于事件绑定中的 dataset
slot: 用于接收动态 slot 传递的值 仅 glass-easel 组件框架支持
generic: 用于自定义组件的抽象节点
change: 监听属性变化,用于 WXS 响应函数
worklet: 用于 Skyline 渲染引擎的 worklet

临时变量

仅 glass-easel 组件框架支持

有时,逻辑层提供的数据结构很复杂,而数据中的一部分又被反复使用。

这时可以用 let: 语法创建一个临时变量,例如:

<block let:student="{{ some.complex.student.data }}">
  <view>ID:{{ student.id }}</view>
  <view>名字:{{ student.name }}</view>
  <view>年龄:{{ student.age }}</view>
</block>

let: 创建的临时变量,其作用范围仅限于它所在的标签本身及其内部。

框架属性

框架内置了一些属性。这些属性对所有组件都有效。

id 属性

组件的标识符。

<view id="hello"> Hello world! </view>

slot 属性

用来表达这个节点应该被放入 multipleSlots 模式 自定义组件 中的哪个插槽。

class 样式类

样式类主要用于结合 WXSS 来指定组件的样式。

样式类有两种写法:属性写法和前缀写法。其中,前缀写法仅 glass-easel 组件框架支持。它们的基本用法如下:

<!-- 属性写法 -->
<view class="hello"> Hello world! </view>
<!-- 等价于 -->
<!-- 前缀写法 -->
<view class:hello> Hello world! </view>

需要应用多个 class 时,可以这样写:

<!-- 属性写法 -->
<view class="hello hello-big"> Hello world! </view>
<!-- 等价于 -->
<!-- 前缀写法 -->
<view class:hello class:hello-big> Hello world! </view>

属性写法像普通属性那样接受数据绑定。对于前缀写法,每个 class: 单独接受一个数据绑定表达式,只有表达式为真时,这个 class: 才会生效。例如:

<!-- 属性写法 -->
<view class="hello {{ big ? 'hello-big' : '' }}"> Hello world! </view>
<!-- 等价于 -->
<!-- 前缀写法 -->
<view class:hello class:hello-big="{{ big }}"> Hello world! </view>

注意:每个节点都可以选择用两种写法之一;但如果在一个节点上使用了前缀写法,就不能在同一个节点的 class 属性中使用数据绑定。

前缀写法仅 glass-easel 组件框架支持。在 glass-easel 组件框架中,前缀写法往往会更直观,因而优先推荐。

style 内联样式

内联样式可以用于指定组件的样式。

内联样式有两种写法:属性写法和前缀写法。其中,前缀写法仅 glass-easel 组件框架支持。它们的基本用法如下:

<!-- 属性写法 -->
<view style="font-size: 1.2em; color: blue;"> Hello world! </view>
<!-- 等价于 -->
<!-- 前缀写法 -->
<view style:font-size="1.2em" style:color="blue"> Hello world! </view>

使用数据绑定时:

<!-- 属性写法 -->
<view style="font-size: {{ size }}em; color: {{ colorName }};"> Hello world! </view>
<!-- 等价于 -->
<!-- 前缀写法 -->
<view style:font-size="{{ size }}em" style:color="{{ colorName }}"> Hello world! </view>

注意:每个节点都可以选择用两种写法之一;但如果在一个节点上使用了前缀写法,就不能在同一个节点的 style 属性中使用数据绑定。

前缀写法仅 glass-easel 组件框架支持。在 glass-easel 组件框架中,前缀写法往往会更直观,因而优先推荐。

在实践中,静态样式定义写在 WXSS 中更有利于代码可读性;只有需要动态改变的样式才应使用 style 指定。换句话说,如果 style 没有数据绑定,那就应该考虑写在 WXSS 中,以提升代码的可维护性。

框架标签

有些标签并不对应着组件,而是承担着特殊的框架语义。

虚拟块

虚拟块 <block> 自身没有语义,也不对应于任何组件,但可以在它标签体中放入属性。它支持很多属性:

  • 框架属性 中的 id slot 和 slot 变量引用;
  • 临时变量 let:
  • 条件渲染 wx:if
  • 列表渲染 wx:for wx:for-item wx:for-index wx:key

简单来说,除了 WXSS 样式相关的属性不能使用之外,其他常用属性都能使用。

插槽节点

插槽节点 <slot> 用于在 自定义组件 中表达承载父组件提供的子树的结构。

数据绑定表达式

数据绑定 {{ ... }} 内部的表达式,可以使用大部分 JS 运算符。

一个复杂表达式的例子:

<view>{{ a !== 0 ? 'Number: ' + a : 'Zero' }}</view>

关键字

部分标识符被视为关键字,它们不被视为数据字段。这些关键字的含义和 JS 中的相同。

关键字
undefined
null
false
true

字面量

支持字面量有以下几种。

字面量类型 示例
字符串 "示例字符串" '示例字符串'
数值 2017 1.9
数组字面量 [ 1, 2, 34 ]
对象字面量 { a: 1, b, c: 3 + 4 }

数组字面量、对象字面量内可以使用 ... 展开其他数组、对象。

对象字面量简写

glass-easel 组件框架完全支持对象字面量简写;对于 exparser 组件框架,只有 template data 可以使用对象字面量简写。

如果数据绑定表达式完全就是一个对象字面量,那可以省略对象字面量的花括号 { }

<view mark:ab="{{ a: 1, b }}" />
<!-- 等价于 -->
<view mark:ab="{{ { a: 1, b } }}" />

支持的运算符列表

以下是支持的运算符列表。各个运算符语义与 JS 中的相同。

分类 运算符 示例 附注
成员访问和函数调用 . obj.field
[...] obj[field]
(...) func(arg1, arg2) 请参考 函数调用限制
一元运算 ! !cond
~ ~int
+ +num
- -num
typeof typeof value 仅 glass-easel 组件框架支持
void void value 仅 glass-easel 组件框架支持
乘除 * a * b
/ a / b
% a % b
加减 + a + b
- a - b
移位运算 << int << 2
>> int >> 2
>>> int >>> 2
大小比较 < a < b
> a > b
<= a <= b
>= a >= b
instanceof value instanceof type 仅 glass-easel 组件框架支持
相等判断 == a == b
!= a != b
=== a === b
!== a !== b
按位与 & int1 & int2
按位异或 ^ int1 ^ int2
按位或 \| int1 \| int2
逻辑与 && a && b
逻辑或和空值合并 \|\| a \|\| b
?? a ?? b 仅 glass-easel 组件框架支持
条件运算 ? ... : a ? b : c

自动可选链化

成员访问和函数调用运算符,会自动转换成他们的可选链版本。

  • . 被自动视为 ?.
  • [...] 被自动视为 ?.[...]
  • (...) 被自动视为 ?.(...)

因此不需要写可选链运算符 ?.。若访问 undefinednull 的成员,表达式结果为 undefined

函数调用限制

可以使用 (...) 来进行函数调用。但函数调用有一定的限制和注意事项。

  • 组件框架执行模板中函数的时机是不确定的,可能在运行期间的任何时候调用函数,也可能会跳过函数调用。
  • 在 exparser 组件框架中,只有 WXS 中定义的函数能被调用。
  • 参数列表中不能使用 ...

引用

WXML 提供两种文件引用方式importinclude

import

import可以在该文件中使用目标文件定义的template,如:

在 item.wxml 中定义了一个叫itemtemplate

<!-- item.wxml -->
<template name="item">
  <text>{{text}}</text>
</template>

在 index.wxml 中引用了 item.wxml,就可以使用item模板:

<import src="item.wxml"/>
<template is="item" data="{{text: 'forbar'}}"/>

import 的作用域

import 有作用域的概念,即只会 import 目标文件中定义的 template,而不会 import 目标文件 import 的 template。

如:C import B,B import A,在C中可以使用B定义的template,在B中可以使用A定义的template,但是C不能使用A定义的template

<!-- A.wxml -->
<template name="A">
  <text> A template </text>
</template>
<!-- B.wxml -->
<import src="a.wxml"/>
<template name="B">
  <text> B template </text>
</template>
<!-- C.wxml -->
<import src="b.wxml"/>
<template is="A"/>  <!-- Error! Can not use tempalte when not import A. -->
<template is="B"/>

include

include 可以将目标文件除了 <template/> <wxs/> 外的整个代码引入,相当于是拷贝到 include 位置,如:

<!-- index.wxml -->
<include src="header.wxml"/>
<view> body </view>
<include src="footer.wxml"/>
<!-- header.wxml -->
<view> header </view>
<!-- footer.wxml -->
<view> footer </view>

模板

微信小程序中的 WXML 提供了模板(template)功能,你可以在模板中定义代码片段,然后在不同的地方调用这些代码片段。

定义模板

使用 name 属性来给模板命名。然后在<template/>标签内编写代码片段,例如:

<!--
  index: int
  msg: string
  time: string
-->
<template name="msgItem">
  <view>
    <text> {{index}}: {{msg}} </text>
    <text> Time: {{time}} </text>
  </view>
</template>

使用模板

使用 is 属性来声明你需要使用的模板,然后把模板需要的数据通过 data 传入,例如:

<template is="msgItem" data="{{...item}}"/>
Page({
  data: {
    item: {
      index: 0,
      msg: 'this is a template',
      time: '2016-09-15'
    }
  }
})

is 属性还可以使用 Mustache 语法,来动态决定具体渲染哪个模板:

<template name="odd">
  <view> odd </view>
</template>
<template name="even">
  <view> even </view>
</template>

<block wx:for="{{[1, 2, 3, 4, 5]}}">
  <template is="{{item % 2 == 0 ? 'even' : 'odd'}}"/>
</block>

模板的作用域

模板有自己独立的作用域,它只能使用通过 data 传入的数据,以及模板定义文件中定义的 <wxs /> 模块。

条件渲染

wx:if

微信小程序框架中,使用 wx:if="" 来判断是否需要渲染该代码块:

<view wx:if="{{condition}}"> True </view>

也可以用 wx:elifwx:else 来添加一个 else 块:

<view wx:if="{{length > 5}}"> 1 </view>
<view wx:elif="{{length > 2}}"> 2 </view>
<view wx:else> 3 </view>

block wx:if

因为 wx:if 是一个控制属性,需要将它添加到一个标签上。如果要一次性判断多个组件标签,可以使用一个 <block/> 标签将多个组件包装起来,并在上边使用 wx:if 控制属性。

<block wx:if="{{true}}">
  <view> view1 </view>
  <view> view2 </view>
</block>

注意: <block/> 并不是一个组件,它仅仅是一个包装元素,不会在页面中做任何渲染,只接受控制属性。

wx:if vs hidden

因为 wx:if 之中的模板也可能包含数据绑定,所以当 wx:if 的条件值切换时,微信小程序框架有一个局部渲染的过程,因为它会确保条件块在切换时销毁或重新渲染。

同时 wx:if 也是惰性的,如果在初始渲染条件为 false,微信小程序框架什么也不做,在条件第一次变成真的时候才开始局部渲染。

相比之下,hidden 就简单的多,组件始终会被渲染,只是简单的控制显示与隐藏。

一般来说,wx:if 有更高的切换消耗而 hidden 有更高的初始渲染消耗。因此,如果需要频繁切换的情景下,用 hidden 更好,如果在运行时条件不大可能改变则 wx:if 较好。

列表渲染

wx:for

在组件上使用 wx:for 控制属性绑定一个数组,即可使用数组中各项的数据重复渲染该组件。

默认数组的当前项的下标变量名默认为 index,数组当前项的变量名默认为 item

<view wx:for="{{array}}">
  {{index}}: {{item.message}}
</view>
Page({
  data: {
    array: [{
      message: 'foo',
    }, {
      message: 'bar'
    }]
  }
})

使用 wx:for-item 可以指定数组当前元素的变量名,

使用 wx:for-index 可以指定数组当前下标的变量名:

<view wx:for="{{array}}" wx:for-index="idx" wx:for-item="itemName">
  {{idx}}: {{itemName.message}}
</view>

wx:for 也可以嵌套,下边是一个九九乘法表

<view wx:for="{{[1, 2, 3, 4, 5, 6, 7, 8, 9]}}" wx:for-item="i">
  <view wx:for="{{[1, 2, 3, 4, 5, 6, 7, 8, 9]}}" wx:for-item="j">
    <view wx:if="{{i <= j}}">
      {{i}} * {{j}} = {{i * j}}
    </view>
  </view>
</view>

block wx:for

类似 block wx:if,也可以将 wx:for 用在<block/>标签上,以渲染一个包含多节点的结构块。例如:

<block wx:for="{{[1, 2, 3]}}">
  <view> {{index}}: </view>
  <view> {{item}} </view>
</block>

wx:key

如果列表中项目的位置会动态改变或者有新的项目添加到列表中,并且希望列表中的项目保持自己的特征和状态(如 input 中的输入内容,switch 的选中状态),需要使用 wx:key 来指定列表中项目的唯一的标识符。

wx:key 的值以两种形式提供

  1. 字符串,代表在 for 循环的 array 中 item 的某个 property,该 property 的值需要是列表中唯一的字符串或数字,且不能动态改变。
  2. 保留关键字 *this 代表在 for 循环中的 item 本身,这种表示需要 item 本身是一个唯一的字符串或者数字。

当数据改变触发渲染层重新渲染的时候,会校正带有 key 的组件,框架会确保他们被重新排序,而不是重新创建,以确保使组件保持自身的状态,并且提高列表渲染时的效率。

如不提供 wx:key,会报一个 warning, 如果明确知道该列表是静态,或者不必关注其顺序,可以选择忽略。

示例代码

在开发者工具中预览效果

<switch wx:for="{{objectArray}}" wx:key="unique" style="display: block;"> {{item.id}} </switch>
<button bindtap="switch"> Switch </button>
<button bindtap="addToFront"> Add to the front </button>

<switch wx:for="{{numberArray}}" wx:key="*this" style="display: block;"> {{item}} </switch>
<button bindtap="addNumberToFront"> Add to the front </button>
Page({
  data: {
    objectArray: [
      {id: 5, unique: 'unique_5'},
      {id: 4, unique: 'unique_4'},
      {id: 3, unique: 'unique_3'},
      {id: 2, unique: 'unique_2'},
      {id: 1, unique: 'unique_1'},
      {id: 0, unique: 'unique_0'},
    ],
    numberArray: [1, 2, 3, 4]
  },
  switch: function(e) {
    const length = this.data.objectArray.length
    for (let i = 0; i < length; ++i) {
      const x = Math.floor(Math.random() * length)
      const y = Math.floor(Math.random() * length)
      const temp = this.data.objectArray[x]
      this.data.objectArray[x] = this.data.objectArray[y]
      this.data.objectArray[y] = temp
    }
    this.setData({
      objectArray: this.data.objectArray
    })
  },
  addToFront: function(e) {
    const length = this.data.objectArray.length
    this.data.objectArray = [{id: length, unique: 'unique_' + length}].concat(this.data.objectArray)
    this.setData({
      objectArray: this.data.objectArray
    })
  },
  addNumberToFront: function(e){
    this.data.numberArray = [ this.data.numberArray.length + 1 ].concat(this.data.numberArray)
    this.setData({
      numberArray: this.data.numberArray
    })
  }
})

注意事项

wx:for 的值为字符串时,会将字符串解析成字符串数组

<view wx:for="array">
  {{item}}
</view>

等同于

<view wx:for="{{['a','r','r','a','y']}}">
  {{item}}
</view>

注意: 花括号和引号之间如果有空格,将最终被解析成为字符串

<view wx:for="{{[1,2,3]}} ">
  {{item}}
</view>

等同于

<view wx:for="{{[1,2,3] + ' '}}" >
  {{item}}
</view>

数据绑定

WXML 中的动态数据均来自对应 Page 的 data。

简单绑定

数据绑定使用 Mustache 语法(双大括号)将变量包起来,可以作用于:

内容

<view> {{ message }} </view>
Page({
  data: {
    message: 'Hello MINA!'
  }
})

组件属性(需要在双引号之内)

<view id="item-{{id}}"> </view>
Page({
  data: {
    id: 0
  }
})

控制属性(需要在双引号之内)

<view wx:if="{{condition}}"> </view>
Page({
  data: {
    condition: true
  }
})

关键字(需要在双引号之内)

true:boolean 类型的 true,代表真值。

false: boolean 类型的 false,代表假值。

<checkbox checked="{{false}}"> </checkbox>

特别注意:不要直接写 checked="false",其计算结果是一个字符串,转成 boolean 类型后代表真值。

运算

可以在 {{}} 内进行简单的运算,支持的有如下几种方式:

三元运算

<view hidden="{{flag ? true : false}}"> Hidden </view>

算数运算

<view> {{a + b}} + {{c}} + d </view>
Page({
  data: {
    a: 1,
    b: 2,
    c: 3
  }
})

view中的内容为 3 + 3 + d

逻辑判断

<view wx:if="{{length > 5}}"> </view>

字符串运算

<view>{{"hello" + name}}</view>
Page({
  data:{
    name: 'MINA'
  }
})

数据路径运算

<view>{{object.key}} {{array[0]}}</view>
Page({
  data: {
    object: {
      key: 'Hello '
    },
    array: ['MINA']
  }
})

组合

也可以在 Mustache 内直接进行组合,构成新的对象或者数组。

数组

<view wx:for="{{[zero, 1, 2, 3, 4]}}"> {{item}} </view>
Page({
  data: {
    zero: 0
  }
})

最终组合成数组[0, 1, 2, 3, 4]

对象

<template is="objectCombine" data="{{foo: a, bar: b}}"></template>
Page({
  data: {
    a: 1,
    b: 2
  }
})

最终组合成的对象是 {foo: 1, bar: 2}

也可以用扩展运算符 ... 来将一个对象展开

<template is="objectCombine" data="{{...obj1, ...obj2, e: 5}}"></template>
Page({
  data: {
    obj1: {
      a: 1,
      b: 2
    },
    obj2: {
      c: 3,
      d: 4
    }
  }
})

最终组合成的对象是 {a: 1, b: 2, c: 3, d: 4, e: 5}

如果对象的 key 和 value 相同,也可以间接地表达。

<template is="objectCombine" data="{{foo, bar}}"></template>
Page({
  data: {
    foo: 'my-foo',
    bar: 'my-bar'
  }
})

最终组合成的对象是 {foo: 'my-foo', bar:'my-bar'}

注意:上述方式可以随意组合,但是如有存在变量名相同的情况,后边的会覆盖前面,如:

<template is="objectCombine" data="{{...obj1, ...obj2, a, c: 6}}"></template>
Page({
  data: {
    obj1: {
      a: 1,
      b: 2
    },
    obj2: {
      b: 3,
      c: 4
    },
    a: 5
  }
})

最终组合成的对象是 {a: 5, b: 3, c: 6}

注意: 花括号和引号之间如果有空格,将最终被解析成为字符串

<view wx:for="{{[1,2,3]}} ">
  {{item}}
</view>

等同于

<view wx:for="{{[1,2,3] + ' '}}">
  {{item}}
</view>