模板指令
wx:if
预期：
any用法：
根据表达式的值的 truthiness 来有条件地渲染元素。在切换时元素及它的数据绑定 / 组件被销毁并重建。 注意：如果元素是
<block/>, 注意它并不是一个组件，它仅仅是一个包装元素，不会在页面中做任何渲染，只接受控制属性。WARNING
当和
wx:if一起使用时，wx:for的优先级比wx:if更高。详见列表渲染教程参考： 条件渲染 - wx:if
wx:elif
类型：
any限制： 前一兄弟元素必须有
wx:if或wx:elif用法：
表示
wx:if的“wx:elif块”。可以链式调用。<view wx:if="{{type === 'A'}}"> A </view> <view wx:elif="{{type === 'B'}}"> B </view> <view wx:elif="{{type === 'C'}}"> C </view> <view wx:else> Not A/B/C </view>参考： 条件渲染 - wx:elif
wx:else
不需要表达式
限制： 前一兄弟元素必须有
wx:if或wx:elif用法：
为
wx:if或者wx:elif添加wx:else块<view wx:if="{{type === 'A'}}"> A </view> <view wx:else> Not A </view>参考： 条件渲染 - wx:else
wx:for
预期：
Array | Object | number | string用法：
在组件上使用
wx:for控制属性绑定一个数组，即可使用数组中各项的数据重复渲染该组件。默认数组的当前项的下标变量名默认为index，数组当前项的变量名默认为item<view wx:for="{{array}}"> {{ index }}: {{ item.message }} </view> // 0: foo // 1: barPage({ data: { array: [{ message: 'foo' }, { message: 'bar' }] } })wx:for的默认行为会尝试原地修改元素而不是移动它们。要强制其重新排序元素，你需要用特殊attribute key来提供一个排序提示：<view wx:for="{{array}}" wx:key="id"> {{ item.text }} </view> // foo // barPage({ data: { array: [{ id: 1, text: 'foo' }, { id: 2, text: 'bar' }] } })WARNING
当和
wx:if一起使用时，wx:for的优先级比wx:if更高。详见列表渲染教程wx:for的详细用法可以通过以下链接查看教程详细说明。参考： 列表渲染 - wx:for
wx:for-index
预期：
string用法：
使用 wx:for-index 可以指定数组当前下标的变量名：
<view wx:for="{{array}}" wx:key="id" wx:for-index="idx"> {{ idx }}: {{ item.text }} </view> // 0: foo // 1: barPage({ data: { array: [{ id: 1, text: 'foo' }, { id: 2, text: 'bar' }] } })参考： 列表渲染 - wx:for-index
wx:for-item
预期：
string用法：
使用 wx:for-item 可以指定数组当前元素的变量名：
<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>参考： 列表渲染 - wx:for-item
wx:key
预期：
number | string用法：
如果列表中项目的位置会动态改变或者有新的项目添加到列表中，并且希望列表中的项目保持自己的特征和状态，需要使用 wx:key 来指定列表中项目的唯一的标识符。 注意：如不提供 wx:key，会报一个 warning， 如果明确知道该列表是静态，或者不必关注其顺序，可以选择忽略。
有相同父元素的子元素必须有独特的 key。重复的 key 会造成渲染错误。
常见的用例是结合
wx:for：<view wx:for="{{array}}" wx:key="id"> {{ item.text }} </view>参考： 列表渲染 - wx:for
wx:class
用法：
绑定HTML Class: 类似vue的class绑定
#对象用法
我们可以传给
wx:class一个对象，以动态地切换 class：<view wx:class="{{ {active: isActive} }}"> 这是一段测试文字 </view>你可以在对象中传入更多字段来动态切换多个 class。此外，
wx:class指令也可以与普通的 class attribute 共存。<view class="static" wx:class="{{ {active: isActive, text-danger: hasError} }}"> 这是一段测试文字 </view><script> import {createComponent} from '@mpxjs/core' createComponent({ data: { isActive: true, hasError: false } }) </script>渲染为：
<view class="static active"> 这是一段测试文字 </view>注意：由于微信的限制，
wx:class中的 key 值不能使用引号（如: { 'my-class-name': xx }）绑定的数据对象不必内联定义在模板里：
<view wx:class="{{ classObject }}"> 这是一段测试文字 </view><script> import {createComponent} from '@mpxjs/core' createComponent({ data: { classObject: { active: true, 'text-danger': false } } }) </script>我们也可以在这里绑定一个返回对象的计算属性。
如果你也想根据条件切换列表中的 class，可以用三元表达式：
<view wx:class="{{ isActive ? 'active' : '' }}"> 这是一段测试文字 </view>#数组用法
我们可以把一个数组传给
wx:class，以应用一个 class 列表：<view wx:class="[{{activeClass}},{{errorClass}}]"> 这是一段测试文字 </view><script> import {createComponent} from '@mpxjs/core' createComponent({ data: { activeClass: 'active', errorClass: 'text-danger' } }) </script>渲染为：
<view wx:class="active text-danger"> 这是一段测试文字 </view>参考： 类名样式绑定 - 类名绑定
wx:style
用法：
wx:style的对象语法十分直观——看着非常像 CSS，但其实是一个 JavaScript 对象。CSS property 名可以用驼峰式 (camelCase) 或短横线分隔 (kebab-case) 来命名：<view wx:style="color: {{activeColor}}; font-size: {{fontSize}}px; fontWeight: bold"> 这是一段测试文字 </view><script> import {createComponent} from '@mpxjs/core' createComponent({ data: { activeColor: 'red', fontSize: 30 } }) </script>直接绑定到一个样式对象通常更好，这会让模板更清晰：
<view wx:style="{{styleObject}}"> 这是一段测试文字 </view><script> import {createComponent} from '@mpxjs/core' createComponent({ styleObject: { color: 'red', fontWeight: 'bold' }, }) </script>示例：
<template> <view wx:for="{{list}}" wx:style="{{item.style}}">{{item.name}}</view> </template> <script> import {createComponent} from '@mpxjs/core' createComponent({ data:{ list:[ { name: 'red', style: { color: 'red' } }, { name: 'blue', style: { color: 'blue' } } ] } }) </script>同样的，对象语法常常结合返回对象的计算属性使用。
wx:style的数组语法可以将多个样式对象应用到同一个元素上<view wx:style="[baseStyles, overridingStyles]"> 这是一段测试文字 </view>参考： 类名样式绑定 - 样式绑定
wx:model
除了小程序原生指令之外，mpx 基于input事件提供了一个指令 wx:model, 用于双向绑定。
示例：
<template>
<view>
<input wx:model="{{val}}"/>
<input wx:model="{{test.val}}"/>
<input wx:model="{{test['val']}}"/>
</view>
</template>
<script>
import {createComponent} from '@mpxjs/core'
createComponent({
data: {
val: 'test',
test: {
val: 'xxx'
}
}
})
</script>wx:model并不会影响相关的事件处理函数，比如像下面这样：
<input wx:model="{{inputValue}}" bindinput="handleInput"/>- 参考： 双向绑定
wx:model-prop
wx:model 默认使用 value 属性传值，使用 wx:model-prop 定义 wx:model 指令对应的属性；
wx:model-event
wx:model 默认监听 input 事件，可以使用 wx:model-event 定义 wx:model 指令对应的事件；
示例：
父组件
<template>
<customCheck wx:model="{{checked}}" wx:model-prop="checkedProp" wx:model-event="checkedChange"></customCheck>
</template>
<script>
import {createPage} from '@mpxjs/core'
createPage({
data: {
checked: true
}
})
</script>
<script type="application/json">
{
"usingComponents": {
"customCheck": "./customCheck"
}
}
</script>
子组件：(customCheck.mpx)
<template>
<view bindtap="handleTap" class="viewProps">{{checkedProp}}</view>
</template>
<style lang="stylus">
.viewProps {
width 100px
height 100px
color #000
}
</style>
<script>
import {createComponent} from '@mpxjs/core'
createComponent({
properties: {
checkedProp: Boolean
},
methods: {
handleTap () {
// 这里第二个参数为自定义事件的detail，需要以下面的形式传递值以保持与原生组件对齐
this.triggerEvent('checkedChange', {
value: !this.checkedProp
})
}
}
})
</script>如示例，当子组件被点击时，父组件的checked数据会发生变化
注意：由于微信限制，如果事件名使用横线分割（'checked-change'）,将不可以再使用该特性
wx:model-value-path
指定 wx:model 双向绑定时的取值路径； 并非所有的组件都会按微信的标注格式 event.target.value 来传值，例如 vant 的 input 组件，值是通过抛出 event.target 本身传递的，这时我们可以使用 wx:model-value-path 重新指定取值路径。
<vant-field wx:model-value-path="[]" wx:model="{{a}}"></vant-field>wx:model-filter
在使用 wx:model 时我们可能需要像 Vue 的 .trim 、.lazy 这样的修饰符来对双向数据绑定的数据进行过滤和修饰；Mpx 通过增强指令 wx:model-filter 可以实现这一功能； 该指令可以绑定内建的 filter 或者自定义的 filter 方法，该方法接收过滤前的值，返回过滤操作后的值。
例如我们希望拿到的 input 元素中的数据是经过 trim 的。示例：
当然，Mpx 已经内置了 trim 过滤器；可以通过 wx:model-filter="trim" 直接使用；
<template>
<view class="cover-page">
<view>
<!-- wx:model-filter 过滤wx:model 的值-->
<input type="text" wx:model-filter="trimSpace" wx:model="{{filterData}}" />
<view >{{filterData.length}}</view>
</view>
</view>
</template>
<script>
import { createPage } from '@mpxjs/core'
createPage({
data: {
filterData: 'model-filter'
},
trimSpace (val) {
// wx:model-filter 绑定的 filter 方法
return typeof val === 'string' && val.trim()
},
methods: {
}
})
</script>filter 方法除可以是和 methods 平级的方法，还可以是 methods 中的方法。
<template>...</template>
<script>
import { createPage } from '@mpxjs/core'
createPage({
data: {
filterData: 'model-filter'
},
methods: {
trimSpace (val) {
// wx:model-filter 支持将过滤器方法定义成 methods 中的方法
return typeof val === 'string' && val.trim()
}
}
})
</script>wx:ref
预期：
String用法：
Mpx提供了
wx:ref=xxx来更方便获取 WXML 节点信息的对象。在JS里只需要通过this.$refs.xxx 即可获取节点。
<view wx:ref="tref">
123
</view>
<script>
Page({
ready () {
this.$refs.tref.fields({size: true}, function (res) {
console.log(res)
}).exec()
}
})
</script>- 参考： 获取组件实例 - wx:ref
wx:show
预期：
Boolean用法： 与
wx:if所不同的是不会移除节点，而是设置节点的style为display: none。<view wx:show="{{show}}"> 123 </view>Page({ data: { show: false } })
bind
预期：
String用法：
让
bind + (:?) + eventType作为属性值比如：
bindtap<view bindtap="tapTest"> Click me! </view> <view bind:tap="tapTest1(testVal, $event)"> Click me! </view>Page({ methods: { tapTest () { // todo }, tapTest1 (val, event) { console.log(val, event) } } })Mpx做了增强的内联传参能力以及具体有哪些事件类型参考下方
参考： 事件处理 - bind
catch
预期：
String用法：
让
catch + (:?) + eventType作为属性值除
bind外，也可以用catch来绑定事件。与bind不同，catch会阻止事件向上冒泡。<view id="outer" bindtap="handleTap1"> outer view <view id="middle" catchtap="handleTap2"> middle view <view id="inner" bindtap="handleTap3"> inner view </view> </view> </view>Page({ methods: { handleTap1 () { console.log('outer') }, handleTap2 () { console.log('middle') }, handleTap3 () { console.log('inner') } } }) // 通过几个操作看出被catchtap的middle view阻止了向上冒泡 // click outer // outer // click middle // middle // click inner // inner // outer参考： 事件处理 - catch
capture-bind
预期：
String用法：
让
capture-bind + (:?) + eventType作为属性值capture-bind要在bind之前执行，是因为事件是先捕获后冒泡，注意：仅触摸类事件支持捕获阶段
<view id="outer" bind:touchstart="handleTap1" capture-bind:touchstart="handleTap2"> outer view <view id="inner" bind:touchstart="handleTap3" capture-bind:touchstart="handleTap4"> inner view </view> </view>点击inner view的调用顺序是(handleTap)2、4、3、1
参考： 事件处理 - capture-bind
capture-catch
预期：
String用法：
让
capture-catch + (:?) + eventType作为属性值capture-catch中断捕获阶段和取消冒泡阶段
<view id="outer" bind:touchstart="handleTap1" capture-catch:touchstart="handleTap2"> outer view <view id="inner" bind:touchstart="handleTap3" capture-bind:touchstart="handleTap4"> inner view </view> </view>点击inner view仅执行handleTap2
参考： 事件处理 - capture-catch