自定义元素交互

breaking

概览

  • 非兼容：自定义元素白名单现在在模板编译期间执行，应该通过编译器选项而不是运行时配置来配置。
  • 非兼容：特定 is prop 用法仅限于保留的 <component> 标记。
  • 新：有了新的 v-is 指令来支持 2.x 用例，其中在原生元素上使用了 v-is 来处理原生 HTML 解析限制。

自主定制元素

如果我们想添加在 Vue 外部定义的自定义元素 (例如使用 Web 组件 API)，我们需要“指示”Vue 将其视为自定义元素。让我们以下面的模板为例。

  1. <plastic-button></plastic-button>

2.x 语法

在 Vue 2.x 中，将标记作为自定义元素白名单是通过 Vue.config.ignoredElements：

  1. // 这将使Vue忽略在Vue外部定义的自定义元素
  2. // (例如：使用 Web Components API)
  4. Vue.config.ignoredElements = ['plastic-button']

3.x 语法

在 Vue 3.0 中，此检查在模板编译期间执行指示编译器将 <plastic-button> 视为自定义元素：

  • 如果使用生成步骤：将 isCustomElement 传递给 Vue 模板编译器，如果使用 vue-loader，则应通过 vue-loader 的 compilerOptions 选项传递：

    1. // webpack 中的配置
    2. rules: [
    3.   {
    4.     test: /\.vue$/,
    5.     use: 'vue-loader',
    6.     options: {
    7.       compilerOptions: {
    8.         isCustomElement: tag => tag === 'plastic-button'
    9.       }
    10.     }
    11.   }
    12.   // ...
    13. ]

  • 如果使用动态模板编译，请通过 app.config.isCustomElement 传递：

    1. const app = Vue.createApp({})
    2. app.config.isCustomElement = tag => tag === 'plastic-button'

    需要注意的是，运行时配置只会影响运行时模板编译——它不会影响预编译的模板。

定制内置元素

自定义元素规范提供了一种将自定义元素用作自定义内置模板 自定义元素交互 - 图1 (opens new window)的方法，方法是向内置元素添加 is 属性：

  1. <button is="plastic-button">点击我!</button>

Vue 对 is 特殊 prop 的使用是在模拟 native attribute 在浏览器中普遍可用之前的作用。但是，在 2.x 中，它被解释为渲染一个名为 plastic-button 的 Vue 组件，这将阻止上面提到的自定义内置元素的原生使用。

在 3.0 中，我们仅将 Vue 对 is 属性的特殊处理限制到 <component> tag。

  • 在保留的 <component> tag 上使用时，它的行为将与 2.x 中完全相同；

  • 在普通组件上使用时，它的行为将类似于普通 prop：

    1. <foo is="bar" />
    • 2.x 行为：渲染 bar 组件。
    • 3.x 行为：通过 is prop 渲染 foo 组件。

  • 在普通元素上使用时，它将作为 is 选项传递给 createElement 调用，并作为原生 attribute 渲染，这支持使用自定义的内置元素。

    1. <button is="plastic-button">点击我！</button>

    • 2.x 行为：渲染 plastic-button 组件。

    • 3.x 行为：通过回调渲染原生的 button。

      1. document.createElement('button', { is: 'plastic-button' })

v-is 用于 DOM 内模板解析解决方案

提示：本节仅影响直接在页面的 HTML 中写入 Vue 模板的情况。 在 DOM 模板中使用时，模板受原生 HTML 解析规则的约束。一些 HTML 元素，例如 <ul>，<ol>，<table> 和 <select> 对它们内部可以出现的元素有限制，和一些像 <li>，<tr>，和 <option> 只能出现在某些其他元素中。

2x 语法

在 Vue 2 中，我们建议通过在原生 tag 上使用 is prop 来解决这些限制：

  1. <table>
  2.   <tr is="blog-post-row"></tr>
  3. </table>

3.x 语法

随着 is 的行为变化，我们引入了一个新的指令 v-is，用于解决这些情况：

  1. <table>
  2.   <tr v-is="'blog-post-row'"></tr>
  3. </table>

WARNING

v-is 函数像一个动态的 2.x :is 绑定——因此，要按注册名称渲染组件，其值应为 JavaScript 字符串文本：

  1. <!-- 不正确，不会渲染任何内容 -->
  2. <tr v-is="blog-post-row"></tr>
  4. <!-- 正确 -->
  5. <tr v-is="'blog-post-row'"></tr>

迁移策略

  • 替换 config.ignoredElements 与 vue-loader 的 compilerOptions (使用 build 步骤) 或 app.config.isCustomElement (使用动态模板编译)

  • 将所有非 <component> tags 与 is 用法更改为 <component is="..."> (对于 SFC 模板) 或 v-is (对于 DOM 模板)。