render函数具体参数解析（2024-09-11）

---

一、Render函数定义

在 Vue 2 中，render函数是一个用于创建 Vue 组件虚拟DOM的函数。它允许你以编程方式定义组件的结构，而不是使用模板语法。
render 函数接受一个 createElement 函数作为参数，并返回一个虚拟 DOM 节点。createElement 函数用于创建 Vue 的虚拟节点（ VNode）。

（在 Vue.js 中，h 函数通常是 createElement 的别名。）

// render 基本结构

render(createElement) {
  return createElement(
    'div',             // 标签名
    { class: 'is-parent' },  // 属性对象
    [
      createElement('h1', 'Hello World'),  // 子节点
      createElement('p', 'This is a child.') // 子节点
    ]
  );
}

---

二、函数三种用法

1、创建普通元素用法

创建了一个 div 元素，具有 class="my-class"，并包含文本 “Hello World”。

h('div', { class: 'my-class' }, 'Hello World')

2、创建组件用法

创建了一个 MyComponent 组件，并传递了 someProp 属性。

h(MyComponent, { props: { someProp: 'value' } })

3、嵌套子组件用法

创建了一个 ul 元素，包含两个 li 子节点。

h('ul', [
  h('li', 'Item 1'),
  h('li', 'Item 2')
])

---

三、函数参数解析

h函数：通常接收三个参数

1、标签名或组件（tag）：可以是一个字符串(表示 HTML 标签) 或者是一个组件对象（必填）。

2、数据对象（data）：一个包含属性、事件、样式等信息的对象（可选）。

3、子节点（children）：一个子节点、一个子节点数组或者是字符串（可选）。

h函数：两个参数的情况

当使用 Vue.js 的 h 函数（createElement）时，如果只提供两个参数，这两个参数通常是标签名或组件以及子节点。数据对象（第二个参数）是可选的，所以如果你只提供两个参数，Vue 会将第二个参数解释为子节点。

h('div', 'Hello World')

到这里基本可以熟练的掌握用 h 函数来创建基本的虚拟 DOM 元素的了。

---

常用项需要注意的几个点：

1、class 和 style 直接定义, HTML属性定义在 attrs 对象内

2、组件的 prop 定义在 props 中, DOM 属性定义在 domProps 中

3、组件事件在 on 中定义，原生事件在 nativeOn 中定义

4、作用域插槽在 scopedSlot 中定义

{
  // 与 `v-bind:class` 的 API 相同，
  // 接受一个字符串、对象或字符串和对象组成的数组
  'class': {
    foo: true,
    bar: false
  },


  // 与 `v-bind:style` 的 API 相同，
  // 接受一个字符串、对象，或对象组成的数组
  style: {
    color: 'red',
    fontSize: '14px'
  },


  // 普通的 HTML attribute
  attrs: {
    id: 'foo'
  },


  // 组件 prop
  props: {
    myProp: 'bar'
  },


  // DOM property
  domProps: {
    innerHTML: 'baz'
  },


  // 事件监听器在 `on` 内，
  // 但不再支持如 `v-on:keyup.enter` 这样的修饰器。
  // 需要在处理函数中手动检查 keyCode。
  on: {
    click: this.clickHandler
  },


  // 仅用于组件，用于监听原生事件，而不是组件内部使用
  // `vm.$emit` 触发的事件。
  nativeOn: {
    click: this.nativeClickHandler
  },


  // 自定义指令。注意，你无法对 `binding` 中的 `oldValue`
  // 赋值，因为 Vue 已经自动为你进行了同步。
  directives: [
    {
      name: 'my-custom-directive',
      value: '2',
      expression: '1 + 1',
      arg: 'foo',
      modifiers: {
        bar: true
      }
    }
  ],


  // 作用域插槽的格式为
  // { name: props => VNode | Array<VNode> }
  scopedSlots: {
    default: props => createElement('span', props.text)
  },


  // 如果组件是其它组件的子组件，需为插槽指定名称
  slot: 'name-of-slot',


  // 其它特殊顶层 property
  key: 'myKey',
  ref: 'myRef',


  // 如果你在渲染函数中给多个元素都应用了相同的 ref 名，
  // 那么 `$refs.myRef` 会变成一个数组。
  refInFor: true
}

---

四、函数示例

1、渲染组件

render: (h, {column,row,index}) => {
  return h('div', [
    h(
      'Button', {
        props: {
          type: 'primary'
        },
        on: {
          click: () => {
            this.handleClick(row.id)
          }
        }
      },
      '编辑'
    )])

2、渲染作用域插槽

  render: (h, params) => {
    return h("i-switch", {
      props: {
        size: "large",
        trueValue: 1,
        falseValue: 0,
        value: params.row.status,
        disabled: !params.row.disbaled
      },
      scopedSlots: {
        open: () => h("span", "是"),
        close: () => h("span", "否")
      },
      on: {
        "on-change": value => {
          this.handleChange(value);
        }
      }
    });
  }
},

---