Vue学习笔记进阶篇——Render函数
本文为转载，原文：Vue学习笔记进阶篇——Render函数
基础
Vue 推荐在绝大多数情况下使用 template 来创建你的 HTML。然而在一些场景中，你真的需要 JavaScript 的完全编程的能力，这就是 render 函数，它比 template 更接近编译器。
<h1> <a name="hello-world" href="#hello-world"> Hello world! </a> </h1>
现在我们打算使用vue组件实现以上的渲染结果，我们渴望定义的接口如下:
<anchored-heading :level="1">Hello world!</anchored-heading>
level的值决定了，动态生成heading。
如果我们使用之前学到的知识实现通过level prop 动态生成heading 标签的组件，你可能很快想到这样实现：
<script type="text/x-template" id="anchored-heading-template"> <h1 v-if="level === 1"> <slot></slot> </h1> <h2 v-else-if="level === 2"> <slot></slot> </h2> <h3 v-else-if="level === 3"> <slot></slot> </h3> <h4 v-else-if="level === 4"> <slot></slot> </h4> <h5 v-else-if="level === 5"> <slot></slot> </h5> <h6 v-else-if="level === 6"> <slot></slot> </h6> </script>
Vue.component('anchored-heading', {
template: '#anchored-heading-template',
props: {
level: {
type: Number,
required: true
}
}
})
在这种场景中使用 template 并不是最好的选择：首先代码冗长，为了在不同级别的标题中插入锚点元素，我们需要重复地使用 <slot></slot>。
虽然模板在大多数组件中都非常好用，但是在这里它就不是很简洁的了。那么，我们来尝试使用render 函数重写上面的例子：
<div id="app"> <anchored-heading :level="1">hello</anchored-heading> </div>
Vue.component('anchored-heading',{
render:function (createElement) {
return createElement(
'h' + this.level,
this.$slots.default
)
},
props:{
level:{
type:Number,
required:true
}
}
})
new Vue({
el:'#app'
})
运行结果如下：
简单清晰很多！简单来说，这样代码精简很多，但是需要非常熟悉 Vue 的实例属性。在这个例子中，你需要知道当你不使用 slot 属性向组件中传递内容时，比如anchored-heading 中的 Hello world!, 这些子元素被存储在组件实例中的 $slots.default中。
createElement参数
从上面的例子中，我们看到了使用了一个createElement的方法，这个方法的作用显而易见，那就是用来创建元素，生成模板的。它接受的参数如下：
// @returns {VNode} createElement( // {String | Object | Function} // 一个 HTML 标签字符串，组件选项对象，或者一个返回值类型为String/Object的函数，必要参数 'div', // {Object} // 一个包含模板相关属性的数据对象 // 这样，您可以在 template 中使用这些属性.可选参数. { // (详情见下一节) }, // {String | Array} // 子节点 (VNodes)，由 `createElement()` 构建而成， // 或简单的使用字符串来生成“文本结点”。可选参数。 [ '先写一些文字', createElement('h1', '一则头条'), createElement(MyComponent, { props: { someProp: 'foobar' } }) ] )
- 第一个参数是一个html标签，前面已经说了这个函数是用来创建元素，但是创建什么元素呢，那就取决于第一个参数，而这个参数就是所需创建元素的html标签，如
div,span,p等.- 第二个参数是可选参数，这个参数是用来描述所创建的元素的，为所创建的元素设置属性，如
class,style,props等等.- 第三个参数就是创建的元素的子节点了。由
createElement()构建而成，
或简单的使用字符串来生成“文本结点”。也同样是可选参数。
深入data object参数
有一件事要注意：正如在模板语法中，v-bind:class和v-bind:style ，会被特别对待一样，在 VNode 数据对象中，下列属性名是级别最高的字段。该对象也允许你绑定普通的 HTML 特性，就像 DOM 属性一样，比如 innerHTML (这会取代 v-html指令)。
{ // 和`v-bind:class`一样的 API 'class': { foo: true, bar: false }, // 和`v-bind:style`一样的 API style: { color: 'red', fontSize: '14px' }, // 正常的 HTML 特性 attrs: { id: 'foo' }, // 组件 props props: { myProp: 'bar' }, // DOM 属性 domProps: { innerHTML: 'baz' }, // 事件监听器基于 `on` // 所以不再支持如 `v-on:keyup.enter` 修饰器 // 需要手动匹配 keyCode。 on: { click: this.clickHandler }, // 仅对于组件，用于监听原生事件，而不是组件内部使用 `vm.$emit` 触发的事件。 nativeOn: { click: this.nativeClickHandler }, // 自定义指令. 注意事项：不能对绑定的旧值设值 // Vue 会为您持续追踪 directives: [ { name: 'my-custom-directive', value: '2', expression: '1 + 1', arg: 'foo', modifiers: { bar: true } } ], // Scoped slots in the form of // { name: props => VNode | Array<VNode> } scopedSlots: { default: props => createElement('span', props.text) }, // 如果组件是其他组件的子组件，需为 slot 指定名称 slot: 'name-of-slot', // 其他特殊顶层属性 key: 'myKey', ref: 'myRef' }
完整示例
有了以上的知识，我们就可以实现我们想要实现的功能了，以下为完整示例：
<div id="app"> <my-heading :level="2"> <p>Hello Chain</p> </my-heading> </div>
var getChildrenTextContent = function (children) {
return children.map(function (node) {
return node.children ? getChildrenTextContent(node.children)
:node.text
}).join('')
}
Vue.component('my-heading', {
render:function (createElement) {
var headingId = getChildrenTextContent(this.$slots.default)
.toLowerCase()
.replace(/\W/g, '-')
.replace(/(^\-|\-$)/g, '')
return createElement(
'h' + this.level,
[
createElement('a',{
attrs:{
name:headingId,
href:'#'+headingId
}
}, this.$slots.default)
]
)
},
props:{
level:{
type:Number,
required:true
}
}
})
new Vue({
el:'#app'
})
运行结果：
约束
VNodes 必须唯一
组件树中的所有 VNodes必须是唯一的。这意味着，下面的 render function 是无效的：
render: function (createElement) {
var myParagraphVNode = createElement('p', 'hi')
return createElement('div', [
// 错误-重复的VNodes
myParagraphVNode, myParagraphVNode
])
}
如果你真的需要重复很多次的元素/组件，你可以使用工厂函数来实现。例如，下面这个例子 render 函数完美有效地渲染了 20 个重复的段落：
render: function (createElement) { return createElement('div', Array.apply(null, { length: 20 }).map(function () { return createElement('p', 'hi') }) ) }
使用javascript代替模板功能
v-if 和 v-for
由于使用原生的 JavaScript 来实现某些东西很简单，Vue 的 render 函数没有提供专用的 API。比如， template 中的v-if 和 v-for,这些都会在 render 函数中被 JavaScript 的 if/else 和 map重写。 请看下面的示例：
<div id="app-list"> <list-component :items="items"></list-component> </div>
Vue.component('list-component',{
render:function (createElement) {
if (this.items.length){
return createElement('ul',this.items.map(function (item) {
return createElement('li', item.name)
}))
}
else {
return createElement('p', 'No items found. ')
}
},
props:['items']
})
new Vue({
el:'#app-list',
data:{
items:[
{name:'item1'},
{name:'item1'},
{name:'item1'}
]
}
})
运行结果：
当items为空时:
v-model
render函数中没有与v-model相应的api - 你必须自己来实现相应的逻辑。请看下面一个实现了双向绑定的render示例：
<div id="app-input"> <p>{{value}}</p> <my-input :value="value" @input="updateValue"></my-input> </div>
Vue.component('my-input',{
render:function (createElement) {
var self = this
return createElement('input',{
domProps:{
value:self.myValue
},
on:{
input:function (event) {
self.myValue = event.target.value
self.$emit('input', event.target.value)
}
},
attrs:{
type:'text',
step:10
}
})
},
props:['value'],
computed:{
myValue:function () {
return this.value
}
},
})
var app_input = new Vue({
el:'#app-input',
data:{
value:''
},
methods:{
updateValue:function (val) {
this.value = val
}
}
})
运行结果：
这就是深入底层要付出的,尽管麻烦了一些，但相对于 v-model来说，你可以更灵活地控制。
事件和按键修饰符
对于 .passive、.capture 和 .once事件修饰符, Vue 提供了相应的前缀可以用于 on:
| Modifier(s) | Prefix |
|---|---|
.passive |
& |
.capture |
! |
.once |
~ |
.capture.once or .once.capture |
~! |
例如:
on: { '!click': this.doThisInCapturingMode, '~keyup': this.doThisOnce, `~!mouseover`: this.doThisOnceInCapturingMode }
对于其他的修饰符, 前缀不是很重要, 因为你可以直接在事件处理函数中使用事件方法:
| Modifier(s) | Equivalent in Handler |
|---|---|
.stop |
event.stopPropagation() |
.prevent |
event.preventDefault() |
.self |
if (event.target !== event.currentTarget) return |
Keys:.enter, .13 |
if (event.keyCode !== 13) return (change 13 to another key code for other key modifiers) |
Modifiers Keys:.ctrl, .alt, .shift, .meta |
if (!event.ctrlKey) return (change ctrlKey to altKey, shiftKey, or metaKey, respectively) |
我们在上一个例子上加入一个keyup的事件，当按了enter按键时弹框。修改createElement的第二参数的on, 修改后的代码如下：
on:{ input:function (event) { self.myValue = event.target.value self.$emit('input', event.target.value) }, 'keyup':function (event) { if (event.keyCode == 13){ alert(event.target.value) } } }
在输入框内输入内容，按回车键，结果如下：
slots
你可以从this.$slots获取VNodes列表中的静态内容:
render: function (createElement) { // `<div><slot></slot></div>` return createElement('div', this.$slots.default) }
还可以从this.$scopedSlots 中获得能用作函数的作用域插槽，这个函数返回 VNodes:
render: function (createElement) { // `<div><slot :text="msg"></slot></div>` return createElement('div', [ this.$scopedSlots.default({ text: this.msg }) ]) }
请看下面使用this.$scopedSlots的例子：
<div id="app-slot"> <com-scoped-slot> <template scope="props"> <p>parent value</p> <p>{{props.text}}</p> </template> </com-scoped-slot> </div>
Vue.component('com-scoped-slot',{
render:function (h) {
return h('div', [
this.$scopedSlots.default({
text:this.msg
})
])
},
props:['text'],
data:function () {
return {
msg:'child value'
}
}
})
new Vue({
el:'#app-slot'
})
运行结果：
