Props

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

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

    1. title: String,
    2. likes: Number,
    3. isPublished: Boolean,
    4. commentIds: Array,
    5. author: Object,
    6. callback: Function,
    7. contactsPromise: Promise // 或任何其他构造函数
    8. }

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

    这样,你已经知道了可以像这样给 prop 传入一个静态的值:

    1. <blog-post title="My journey with Vue"></blog-post>

    你也知道 prop 可以通过 v-bind 或简写 : 动态赋值,例如:

    1. <!-- 动态赋予一个变量的值 -->
    2. <blog-post :title="post.title"></blog-post>
    3. <!-- 动态赋予一个复杂表达式的值 -->
    4. <blog-post :title="post.title + ' by ' + post.author.name"></blog-post>

    在上述两个示例中,我们传入的值都是字符串类型的,但实际上任何类型的值都可以传给一个 prop。

    1. <!-- 即便 `42` 是静态的,我们仍然需要 `v-bind` 来告诉 Vue -->
    2. <!-- 这是一个 JavaScript 表达式而不是一个字符串。 -->
    3. <blog-post :likes="42"></blog-post>
    4. <!-- 用一个变量进行动态赋值。-->
    5. <blog-post :likes="post.likes"></blog-post>

    传入一个布尔值

    1. <!-- 包含该 prop 没有值的情况在内,都意味着 `true`。 -->
    2. <blog-post is-published></blog-post>
    3. <!-- 即便 `false` 是静态的,我们仍然需要 `v-bind` 来告诉 Vue -->
    4. <!-- 这是一个 JavaScript 表达式而不是一个字符串。 -->
    5. <blog-post :is-published="false"></blog-post>
    6. <!-- 用一个变量进行动态赋值。 -->
    7. <blog-post :is-published="post.isPublished"></blog-post>

    传入一个对象

    1. <!-- 即便对象是静态的,我们仍然需要 `v-bind` 来告诉 Vue -->
    2. <!-- 这是一个 JavaScript 表达式而不是一个字符串。 -->
    3. :author="{
    4. name: 'Veronica',
    5. company: 'Veridian Dynamics'
    6. }"
    7. ></blog-post>
    8. <!-- 用一个变量进行动态赋值。 -->

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

    1. post: {
    2. id: 1,
    3. title: 'My Journey with Vue'
    4. }
    1. <blog-post v-bind="post"></blog-post>

    等价于:

    1. <blog-post v-bind:id="post.id" v-bind:title="post.title"></blog-post>

    所有的 prop 都使得其父子 prop 之间形成了一个单向下行绑定:父级 prop 的更新会向下流动到子组件中,但是反过来则不行。这样会防止从子组件意外变更父级组件的状态,从而导致你的应用的数据流向难以理解。

    另外,每次父级组件发生变更时,子组件中所有的 prop 都将会刷新为最新的值。这意味着你应该在一个子组件内部改变 prop。如果你这样做了,Vue 会在浏览器的控制台中发出警告。

    这里有两种常见的试图变更一个 prop 的情形:

    1. 这个 prop 用来传递一个初始值;这个子组件接下来希望将其作为一个本地的 prop 数据来使用。在这种情况下,最好定义一个本地的 data property 并将这个 prop 作为其初始值:
    1. props: ['initialCounter'],
    2. data() {
    3. return {
    4. counter: this.initialCounter
    5. }
    6. }
    1. 这个 prop 以一种原始的值传入且需要进行转换。在这种情况下,最好使用这个 prop 的值来定义一个计算属性:

    提示

    注意在 JavaScript 中对象和数组是通过引用传入的,所以对于一个数组或对象类型的 prop 来说,在子组件中改变变更这个对象或数组本身将会影响到父组件的状态。

    我们可以为组件的 prop 指定验证要求,例如你知道的这些类型。如果有一个需求没有被满足,则 Vue 会在浏览器控制台中警告你。这在开发一个会被别人用到的组件时尤其有帮助。

    1. app.component('my-component', {
    2. props: {
    3. // 基础的类型检查 (`null` 和 `undefined` 会通过任何类型验证)
    4. propA: Number,
    5. // 多个可能的类型
    6. propB: [String, Number],
    7. // 必填的字符串
    8. propC: {
    9. type: String,
    10. required: true
    11. },
    12. // 带有默认值的数字
    13. propD: {
    14. type: Number,
    15. default: 100
    16. },
    17. // 带有默认值的对象
    18. propE: {
    19. type: Object,
    20. // 对象或数组默认值必须从一个工厂函数获取
    21. default: function() {
    22. return { message: 'hello' }
    23. },
    24. // 自定义验证函数
    25. validator: function(value) {
    26. // 这个值必须匹配下列字符串中的一个
    27. return ['success', 'warning', 'danger'].indexOf(value) !== -1
    28. }
    29. },
    30. // 具有默认值的函数
    31. propG: {
    32. type: Function,
    33. // 与对象或数组默认值不同,这不是一个工厂函数 —— 这是一个用作默认值的函数
    34. default: function() {
    35. return 'Default function'
    36. }
    37. }
    38. }
    39. })

    当 prop 验证失败的时候,(开发环境构建版本的) Vue 将会产生一个控制台的警告。

    提示

    注意那些 prop 会在一个组件实例创建之前进行验证,所以实例的 property (如 datacomputed 等) 在 defaultvalidator 函数中是不可用的。

    类型检查

    type 可以是下列原生构造函数中的一个:

    • String
    • Number
    • Boolean
    • Array
    • Object
    • Date
    • Function
    • Symbol

    此外,type 还可以是一个自定义的构造函数,并且通过 instanceof 来进行检查确认。例如,给定下列现成的构造函数:

    1. function Person(firstName, lastName) {
    2. this.firstName = firstName
    3. this.lastName = lastName
    4. }

    你可以使用:

    1. app.component('blog-post', {
    2. props: {
    3. author: Person
    4. }
    5. })

    用于验证 author prop 的值是否是通过 new Person 创建的。

    1. const app = Vue.createApp({})
    2. app.component('blog-post', {
    3. // camelCase in JavaScript
    4. props: ['postTitle'],
    5. template: '<h3>{{ postTitle }}</h3>'
    6. })
    1. <!-- kebab-case in HTML -->
    2. <blog-post post-title="hello!"></blog-post>

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