1️⃣ Prop 的大小写

HTML 中的特性名是大小写不敏感的,所以浏览器会把所有大写字符解释为小写字符。故:当 传递的 prop 为 短横线分隔命名时,组件内 的 props 应为 驼峰命名 。

  1. <!-- >>>>>>>>>> App.vue >>>>>>>>>> -->
  2. <template>
  3. <div id="app">
  4. <!-- 传递的 prop 为短横线分割 -->
  5. <component-one data-props="传入的数据"></component-one>
  6. </div>
  7. </template>
  8. <script>
  9. import ComponentOne from './components/ComponentOne.vue'
  10. export default {
  11. components: { ComponentOne },
  12. }
  13. </script>
  1. <!-- >>>>>>>>>> ComponentOne.vue >>>>>>>>>> -->
  2. <template>
  3. <div class="component-one">
  4. <h1>组件 - 1</h1>
  5. <!-- 组件内使用驼峰命名 -->
  6. <h2>{{ dataProps }}</h2>
  7. </div>
  8. </template>
  9. <script>
  10. export default {
  11. // 组件内使用驼峰命名
  12. props: ['dataProps'],
  13. }
  14. </script>

重申一次,如果你使用字符串模板,那么这个限制就不存在了。

1️⃣ Prop 类型

到这里,我们只看到了以字符串数组形式列出的 prop:

  1. <!-- ComponentOne.vue -->
  2. <template>
  3. <div class="component-one">
  4. <h1>组件 - 1</h1>
  5. </div>
  6. </template>
  7. <script>
  8. export default {
  9. props: ["title", "likes", "isPublished", "commentIds", "author"],
  10. };
  11. </script>

但是,通常你希望每个 prop 都有指定的值类型。这时,你可以以对象形式列出 prop,这些 property 的名称和值分别是 prop 各自的名称和类型:

  1. <!-- ComponentOne.vue -->
  2. <template>
  3. <div class="component-one">
  4. <h1>组件 - 1</h1>
  5. </div>
  6. </template>
  7. <script>
  8. export default {
  9. props: {
  10. title: String,
  11. likes: Number,
  12. isPublished: Boolean,
  13. commentIds: Array,
  14. author: Object,
  15. callback: Function,
  16. contactsPromise: Promise, // or any other constructor
  17. },
  18. };
  19. </script>

这不仅为你的组件提供了文档,还会在它们遇到错误的类型时从浏览器的 JavaScript 控制台提示用户。

1️⃣ 通过 Prop 向子组件传递数据

Prop 是你可以在组件上注册的一些自定义 attribute。当一个值传递给一个 prop attribute 的时候,它就变成了那个组件实例的一个 property。
一个组件默认可以拥有任意数量的 prop,任何值都可以传递给任何 prop。在上述模板中,你会发现我们能够在组件实例中访问这个值,就像访问 data 中的值一样。
一个 prop 被注册之后,你就可以像这样把数据作为一个自定义 attribute 传递进来:

  1. <!-- App.vue -->
  2. <template>
  3. <div id="app">
  4. <component-one data-props="传入的数据"></component-one>
  5. </div>
  6. </template>
  7. <script>
  8. import ComponentOne from './components/ComponentOne.vue'
  9. export default {
  10. components: { ComponentOne },
  11. }
  12. </script>
  1. <!-- ComponentOne.vue -->
  2. <template>
  3. <div class="component-one">
  4. <h1>组件 - 1</h1>
  5. <h2>{{ dataProps }}</h2>
  6. </div>
  7. </template>
  8. <script>
  9. export default {
  10. props: ['dataProps'],
  11. }
  12. </script>

image.png

2️⃣ 传入数字

  1. <!-- App.vue -->
  2. <template>
  3. <div id="app">
  4. <!-- String 10 -->
  5. <component-one data-parps="10"></component-one>
  6. <!-- 即便 `10` 是静态的,我们仍然需要 `v-bind` 来告诉 Vue -->
  7. <!-- 这是一个 JavaScript 表达式而不是一个字符串。-->
  8. <!-- Number 10 -->
  9. <component-one :data-parps="10"></component-one>
  10. </div>
  11. </template>
  12. <script>
  13. import ComponentOne from "./components/ComponentOne.vue";
  14. export default {
  15. components: { ComponentOne },
  16. };
  17. </script>
  1. <!-- ComponentOne.vue -->
  2. <template>
  3. <div class="component-one">
  4. <h1>组件 - 1</h1>
  5. <p>{{ dataParps }}</p>
  6. </div>
  7. </template>
  8. <script>
  9. export default {
  10. props: ["dataParps"],
  11. created() {
  12. console.log(this.dataParps);
  13. console.log(typeof this.dataParps);
  14. },
  15. };
  16. </script>

image.png

2️⃣ 传入布尔值

  1. <!-- App.vue -->
  2. <template>
  3. <div id="app">
  4. <!-- String true -->
  5. <component-one data-parps="true"></component-one>
  6. <!-- 即便 `true` 是静态的,我们仍然需要 `v-bind` 来告诉 Vue -->
  7. <!-- 这是一个 JavaScript 表达式而不是一个字符串。-->
  8. <!-- Boolean true -->
  9. <component-one :data-parps="true"></component-one>
  10. </div>
  11. </template>
  12. <script>
  13. import ComponentOne from "./components/ComponentOne.vue";
  14. export default {
  15. components: { ComponentOne },
  16. };
  17. </script>
  1. <!-- ComponentOne.vue -->
  2. <template>
  3. <div class="component-one">
  4. <h1>组件 - 1</h1>
  5. <p v-if="dataParps">dataParps 为真时显示</p>
  6. </div>
  7. </template>
  8. <script>
  9. export default {
  10. props: ["dataParps"],
  11. created() {
  12. console.log(this.dataParps);
  13. console.log(typeof this.dataParps);
  14. },
  15. };
  16. </script>

image.png

2️⃣ 传入数组

  1. <!-- App.vue -->
  2. <template>
  3. <div id="app">
  4. <!-- String [1,2,3] -->
  5. <component-one data-parps="[1, 2, 3]"></component-one>
  6. <!-- 即便数组是静态的,我们仍然需要 `v-bind` 来告诉 Vue -->
  7. <!-- 这是一个 JavaScript 表达式而不是一个字符串。-->
  8. <!-- Array [1,2,3] -->
  9. <component-one :data-parps="[1, 2, 3]"></component-one>
  10. </div>
  11. </template>
  12. <script>
  13. import ComponentOne from "./components/ComponentOne.vue";
  14. export default {
  15. components: { ComponentOne },
  16. };
  17. </script>
  1. <!-- ComponentOne.vue -->
  2. <template>
  3. <div class="component-one">
  4. <h1>组件 - 1</h1>
  5. <p>{{ dataParps }}</p>
  6. </div>
  7. </template>
  8. <script>
  9. export default {
  10. props: ["dataParps"],
  11. created() {
  12. console.log(this.dataParps);
  13. console.log(typeof this.dataParps);
  14. },
  15. };
  16. </script>

image.png

2️⃣ 传入对象

  1. <!-- App.vue xs -->
  2. <template>
  3. <div id="app">
  4. <!-- String {one:'111',two:'222'} -->
  5. <component-one data-parps="{one:'111',two:'222'}"></component-one>
  6. <!-- 即便数组是静态的,我们仍然需要 `v-bind` 来告诉 Vue -->
  7. <!-- 这是一个 JavaScript 表达式而不是一个字符串。-->
  8. <!-- Object {one:'111',two:'222'} -->
  9. <component-one :data-parps="{ one: '111', two: '222' }"></component-one>
  10. </div>
  11. </template>
  12. <script>
  13. import ComponentOne from "./components/ComponentOne.vue";
  14. export default {
  15. components: { ComponentOne },
  16. };
  17. </script>
  1. <!-- ComponentOne.vue -->
  2. <template>
  3. <div class="component-one">
  4. <h1>组件 - 1</h1>
  5. <p>{{ dataParps }}</p>
  6. </div>
  7. </template>
  8. <script>
  9. export default {
  10. props: ["dataParps"],
  11. created() {
  12. console.log(this.dataParps);
  13. console.log(typeof this.dataParps);
  14. },
  15. };
  16. </script>

image.png

2️⃣ 传入一个对象的所有 property

如果你想要将一个对象的所有 property 都作为 prop 传入,你可以使用不带参数的 v-bind ( 取代 v-bind:prop-name )。

  1. <!-- App.vue -->
  2. <template>
  3. <div id="app">
  4. <component-one v-bind="obj"></component-one>
  5. </div>
  6. </template>
  7. <script>
  8. import ComponentOne from "./components/ComponentOne.vue";
  9. export default {
  10. data() {
  11. return {
  12. obj: { one: "111", two: "222" },
  13. };
  14. },
  15. components: { ComponentOne },
  16. };
  17. </script>
  1. <!-- ComponentOne.vue -->
  2. <template>
  3. <div class="component-one">
  4. <h1>组件 - 1</h1>
  5. <p>{{ one }}</p>
  6. <p>{{ two }}</p>
  7. </div>
  8. </template>
  9. <script>
  10. export default {
  11. props: ["one", "two"],
  12. };
  13. </script>

image.png

1️⃣ 单项数据流

所有的 prop 都使得其父子 prop 之间形成了一个单向下行绑定:父级 prop 的更新会向下流动到子组件中,但是反过来则不行。这样会防止从子组件意外变更父级组件的状态,从而导致你的应用的数据流向难以理解。
额外的,每次父级组件发生变更时,子组件中所有的 prop 都将会刷新为最新的值。这意味着你不应该在一个子组件内部改变 prop。如果你这样做了,Vue 会在浏览器的控制台中发出警告。
这里有两种常见的试图变更一个 prop 的情形:
这个 prop 用来传递一个初始值;这个子组件接下来希望将其作为一个本地的 prop 数据来使用。在这种情况下,最好定义一个本地的 data property 并将这个 prop 用作其初始值:

  1. props: ['initialCounter'],
  2. data() {
  3. return {
  4. counter: this.initialCounter
  5. }
  6. }

这个 prop 以一种原始的值传入且需要进行转换。在这种情况下,最好使用这个 prop 的值来定义一个计算属性:

  1. props: ['size'],
  2. computed: {
  3. normalizedSize: function () {
  4. return this.size.trim().toLowerCase()
  5. }
  6. }

1️⃣ 动态语法

类似于用 v-bind 将 HTML 特性绑定到一个表达式,我们也可以用 v-bind 将动态 props 绑定到父组件的数据。每当父组件的数据变化时,该变化也会传导给子组件。

  1. <!-- App.vue -->
  2. <template>
  3. <div id="app">
  4. <component-one :data-props="msg"></component-one>
  5. </div>
  6. </template>
  7. <script>
  8. import ComponentOne from './components/ComponentOne.vue'
  9. export default {
  10. data() {
  11. return {
  12. msg: '动态 props 数据',
  13. }
  14. },
  15. components: { ComponentOne },
  16. }
  17. </script>
  1. <!-- ComponentOne.vue -->
  2. <template>
  3. <div class="component-one">
  4. <h1>组件 - 1</h1>
  5. <h2>{{ dataProps }}</h2>
  6. </div>
  7. </template>
  8. <script>
  9. export default {
  10. props: ['dataProps'],
  11. }
  12. </script>

image.png
然而在一个典型的应用中,你可能在 data 里有一个博文的数组:
并想要为每篇博文渲染一个组件:

  1. <!-- App.vue -->
  2. <template>
  3. <div id="app">
  4. <component-one v-for="item in arr" :key="item" :title="item">
  5. </component-one>
  6. </div>
  7. </template>
  8. <script>
  9. import ComponentOne from "./components/ComponentOne.vue";
  10. export default {
  11. data() {
  12. return {
  13. arr: ["数据 - 1", "数据 - 2", "数据 - 3"],
  14. };
  15. },
  16. components: { ComponentOne },
  17. };
  18. </script>
  1. <!-- ComponentOne.vue -->
  2. <template>
  3. <div class="component-one">
  4. <h1>组件 - 1</h1>
  5. <h2>{{ title }}</h2>
  6. </div>
  7. </template>
  8. <script>
  9. export default {
  10. props: ["title"],
  11. };
  12. </script>

如上所示,你会发现我们可以使用 v-bind 来动态传递 prop。这在你一开始不清楚要渲染的具体内容,比如从一个 API 获取博文列表的时候,是非常有用的。
image.png

1️⃣ Prop 验证

组件可以为 peops 指定验证要求。当组件给其他人使用时,可以确保其他人正确的使用组件。此时 prop 的值是一个对象。

  1. 1. type 可以是下列原生构造函数中的一个:
  2. 1. StringNumberBooleanArrayObjectDateFunctionSymbol
  1. <!-- >>>>>>>>>> ComponentOne.vue >>>>>>>>>> -->
  2. <template>
  3. <div class="component-one">
  4. <h1>组件 - 1</h1>
  5. </div>
  6. </template>
  7. <script>
  8. export default {
  9. props: {
  10. // 基础的类型检查 (`null` 和 `undefined` 会通过任何类型验证)
  11. propA: Number,
  12. // 多个可能的类型
  13. propB: [String, Number],
  14. // 必填的字符串
  15. propC: {
  16. type: String,
  17. required: true,
  18. },
  19. // 带有默认值的数字
  20. propD: {
  21. type: Number,
  22. default: 100,
  23. },
  24. // 带有默认值的对象
  25. propE: {
  26. type: Object,
  27. // 对象或数组默认值必须从一个工厂函数获取
  28. default: function () {
  29. return { message: "hello" };
  30. },
  31. },
  32. // 自定义验证函数
  33. propF: {
  34. // 第一种方式
  35. validator: function (value) {
  36. // 这个值必须匹配下列字符串中的一个
  37. return ["success", "warning", "danger"].indexOf(value) !== -1;
  38. },
  39. // 或者使用这一种
  40. validator: s => ['square', 'rounded'].includes(s)
  41. },
  42. },
  43. };
  44. </script>

1️⃣ 非 Prop 的 Attribute

非 Prop 特性指的是,一个未被组件注册的特性。当组件接收了一个非 Prop 特性时,该特性会被添加到这个组件的根元素上。

  1. <!-- App.vue -->
  2. <template>
  3. <div id="app">
  4. <component-one data-props="red"></component-one>
  5. </div>
  6. </template>
  7. <script>
  8. import ComponentOne from "./components/ComponentOne.vue";
  9. export default {
  10. components: { ComponentOne },
  11. };
  12. </script>
  1. <!-- ComponentOne.vue -->
  2. <template>
  3. <div class="component-one">
  4. <h1>组件 - 1</h1>
  5. </div>
  6. </template>

image.png

2️⃣ 替换/合并已有的 Attribute

当动态添加一个 class 和 直接在组件是添加一个 class 时,两边的值会被合并起来,从而得到最终的值:

  1. 1. <div class="one two"></div>
  2. 2. 对于绝大多数特性来说,从外部提供给组件的值会替换掉组件内部设置好的值。所以如果传入 type="text" 就会替换掉 type="date" 并把它破坏!庆幸的是,class style 特性会稍微智能一些,即两边的值会被合并起来,从而得到最终的值:my-cmp b
  1. <!-- App.vue -->
  2. <template>
  3. <div id="app">
  4. <component-one :class="'red'"></component-one>
  5. </div>
  6. </template>
  7. <script>
  8. import ComponentOne from "./components/ComponentOne.vue";
  9. export default {
  10. components: { ComponentOne },
  11. };
  12. </script>
  1. <!-- ComponentOne.vue -->
  2. <template>
  3. <div class="component-one"></div>
  4. </template>

image.png

2️⃣ 禁用 Attribute 继承

如果不希望组件的根元素继承特性,那么可以在组件选项中设置 inheritAttrs: false

  1. <!-- App.vue -->
  2. <template>
  3. <div id="app">
  4. <component-one data-props="red"></component-one>
  5. </div>
  6. </template>
  7. <script>
  8. import ComponentOne from "./components/ComponentOne.vue";
  9. export default {
  10. components: { ComponentOne },
  11. };
  12. </script>
  1. <!-- ComponentOne.vue -->
  2. <template>
  3. <div class="component-one"></div>
  4. </template>
  5. <script>
  6. export default {
  7. inheritAttrs: false,
  8. };
  9. </script>

image.png
这尤其适合配合实例的 $attrs property 使用,该 property 包含了传递给一个组件的 attribute 名和 attribute 值,例如:

  1. <!-- App.vue -->
  2. <template>
  3. <div id="app">
  4. <component-one data-props="red"></component-one>
  5. </div>
  6. </template>
  7. <script>
  8. import ComponentOne from "./components/ComponentOne.vue";
  9. export default {
  10. components: { ComponentOne },
  11. };
  12. </script>
  1. <!-- ComponentOne.vue -->
  2. <template>
  3. <div class="component-one"></div>
  4. </template>
  5. <script>
  6. export default {
  7. inheritAttrs: false,
  8. mounted() {
  9. console.log(this.$attrs);
  10. },
  11. };
  12. </script>

image.png
有了 inheritAttrs: false 和 $attrs,你就可以手动决定这些 attribute 会被赋予哪个元素。在撰写基础组件的时候是常会用到的