直接跳到内容

渲染选项

template

用于声明组件的字符串模板。

  • 类型

    ts
    interface ComponentOptions {
      template?: string
    }
  • 详细信息

    通过 template 选项提供的模板将会在运行时即时编译。这仅在使用了包含模板编译器的 Vue 构建版本的情况下支持。文件名中带有 runtime 的 Vue 构建版本未包含模板编译器,例如 vue.runtime.esm-bundler.js。请查阅构建文件指南了解不同构建版本之间的详细区别。

    如果该字符串以 # 开头,它将被用作 querySelector 的选择器,并使用所选中元素的 innerHTML 作为模板字符串。这让我们能够使用原生 <template> 元素来书写源模板。

    如果 render 选项也同时存在于该组件中,template 将被忽略。

    如果应用的根组件不含任何 templaterender 选项,Vue 将会尝试使用所挂载元素的 innerHTML 来作为模板。

    安全性注意

    务必只使用可以信任的模板来源。不要直接将用户提供的内容用作模板。查看安全指南了解更多细节。

render

用于编程式地创建组件虚拟 DOM 树的函数。

  • 类型

    ts
    interface ComponentOptions {
      render?(this: ComponentPublicInstance) => VNodeChild
    }
    
    type VNodeChild = VNodeChildAtom | VNodeArrayChildren
    
    type VNodeChildAtom =
      | VNode
      | string
      | number
      | boolean
      | null
      | undefined
      | void
    
    type VNodeArrayChildren = (VNodeArrayChildren | VNodeChildAtom)[]
  • 详细信息

    render 是字符串模板的一种替代,可以使你利用 JavaScript 的丰富表达力来完全编程式地声明组件最终的渲染输出。

    预编译的模板,例如单文件组件中的模板,会在构建时被编译为 render 选项。如果一个组件中同时存在 rendertemplate,则 render 将具有更高的优先级。

  • 参考

compilerOptions

用于配置组件模板的运行时编译器选项。

  • 类型

    ts
    interface ComponentOptions {
      compilerOptions?: {
        isCustomElement?: (tag: string) => boolean
        whitespace?: 'condense' | 'preserve' // 默认:'condense'
        delimiters?: [string, string] // 默认:['{{', '}}']
        comments?: boolean // 默认:false
      }
    }
  • 详细信息

    这个配置选项仅在使用完整构建版本 (即可以在浏览器中编译模板的 vue.js 文件) 时才有效。它支持与应用级的 app.config.compilerOptions 相同的选项,并针对当前组件有更高的优先级。

  • 参考 app.config.compilerOptions

slots

一个在渲染函数中以编程方式使用插槽时辅助类型推断的选项。仅在 Vue 3.3+ 中支持。

  • 详情

    该选项的运行时值不会被使用。实际类型应通过 SlotsType 类型辅助工具进行类型转换来声明:

    ts
    import { SlotsType } from 'vue'
    
    defineComponent({
      slots: Object as SlotsType<{
        default: { foo: string; bar: number }
        item: { data: number }
      }>,
      setup(props, { slots }) {
        expectType<
          undefined | ((scope: { foo: string; bar: number }) => any)
        >(slots.default)
        expectType<undefined | ((scope: { data: number }) => any)>(
          slots.item
        )
      }
    })
渲染选项已经加载完毕