在前面,我们只使用了以字符串数组形式列出的 prop:
props: ['title', 'likes', 'isPublished', 'commentIds', 'author']
但是,通常我们都希望能为每个 prop 指定值的数据类型。这样的好处非常多,建议作为开发规范执行。
我们只需要以对象形式列出 prop,键值对的名称和值分别是 prop 各自的名称和数据类型:
props: { title: String, likes: Number, isPublished: Boolean, commentIds: Array, author: Object, callback: Function, contactsPromise: Promise // 或任何其他构造函数 }
这不仅为你的组件提供了文档,还可以在浏览器的console控制台获取帮助信息。
我们可以像下面这样给 prop 传入一个静态的值:
<blog-post title="My journey with Vue"></blog-post>
上面的title
脱离了Vue的管理,是个静态的纯写死的赋值。
我们可以通过 v-bind
动态赋值,例如:
<!-- 动态赋予一个变量的值 --> <blog-post :title="post.title"></blog-post> <!-- 动态赋予一个复杂表达式的值 --> <blog-post :title="post.title + ' by ' + post.author.name"></blog-post>
在上述两个示例中,我们传入的最终值都是字符串类型的,但它们是由Vue控制并生成的,不是单纯的字符串,可以动态变化。
实际上可以给prop传递任何类型的值。
<!-- 即便 `42` 是静态的,我们仍然需要 `v-bind` 来告诉 Vue --> <!-- 这是一个 JavaScript 表达式而不是一个字符串。 --> <blog-post :likes="42"></blog-post> <!-- 用一个变量进行动态赋值。likes是点赞数量,数值类型--> <blog-post :likes="post.likes"></blog-post>
<!-- 包含该 prop 没有值的情况在内,都意味着 `true`。 --> <!-- 如果没有在 props 中把 is-published 的类型设置为 Boolean,则这里的值为空字符串,而不是“true” 。 --> <blog-post is-published></blog-post> <!-- 即便 `false` 是静态的,我们仍然需要 `v-bind` 来告诉 Vue --> <!-- 这是一个 JavaScript 表达式而不是一个字符串。 --> <blog-post :is-published="false"></blog-post> <!-- 用一个变量进行动态赋值。 --> <blog-post :is-published="post.isPublished"></blog-post>
<!-- 即便数组是静态的,我们仍然需要 `v-bind` 来告诉 Vue --> <!-- 这是一个 JavaScript 表达式而不是一个字符串。 --> <blog-post :comment-ids="[234, 266, 273]"></blog-post> <!-- 用一个变量进行动态赋值。 --> <blog-post :comment-ids="post.commentIds"></blog-post>
<!-- 即便对象是静态的,我们仍然需要 `v-bind` 来告诉 Vue --> <!-- 这是一个 JavaScript 表达式而不是一个字符串。 --> <blog-post :author="{ name: 'Veronica', company: 'Veridian Dynamics' }" ></blog-post> <!-- 用一个变量进行动态赋值。 --> <blog-post :author="post.author"></blog-post>
如果你想要将一个对象的所有 property 都作为 prop 传入,你可以使用不带参数的 v-bind
(取代 v-bind
:prop-name
)。例如,对于一个给定的对象 post
:
post: { id: 1, title: 'My Journey with Vue' }
下面的模板:
<blog-post v-bind="post"></blog-post> // 注意此时不能缩写v-bind,下面是错误的 <blog-post :="post"></blog-post>
等价于:
<blog-post v-bind:id="post.id" v-bind:title="post.title"></blog-post>
所有的 prop 都使得父子组件之间形成了一个单向下行绑定:父级 prop 的更新会向下流动到子组件中,但是反过来则不行。这样可以防止子组件意外变更父级组件的状态,从而导致你的应用的数据流向难以理解。
另外,每次父级组件发生变更时,子组件中所有的 prop 都将会刷新为最新的值。这意味着你不应该在一个子组件内部改变 prop。如果你这样做了,Vue 会在浏览器的控制台中发出警告。
下面有两种常见的试图变更一个 prop 的情形:
一、这个 prop 用来传递一个初始值;这个子组件接下来希望将其作为一个本地的 prop 数据来使用。在这种情况下,最好定义一个本地的 data 属性并将这个 prop 作为其初始值:
props: ['initialCounter'], data() { return { counter: this.initialCounter } }
这其实就是化外部为内部,对数据做一份拷贝。
二、这个 prop 以一种原始的值传入且需要进行转换。在这种情况下,最好使用这个 prop 的值来定义一个计算属性:
props: ['size'], computed: { normalizedSize() { return this.size.trim().toLowerCase() } }
第一种方法的升级版,对数据做了处理再变为内部变量。
注意:在 JavaScript 中对象和数组是通过引用传入的(所谓的浅拷贝),所以对于一个数组或对象类型的 prop 来说,在子组件中改变这个对象或数组本身将会影响到父组件的状态。
我们可以为组件的 prop 指定要进行哪些数据验证。
如果验证未通过, Vue 会在浏览器控制台中弹出警告信息。
具体方法就是为 props
中的值提供一个带有验证需求的对象,而不仅仅是一个字符串数组。例如:
app.component('my-component', { props: { // 基础的类型检查 (`null` 和 `undefined` 会通过任何类型验证) propA: Number, // 多个可能的类型 propB: [String, Number], // 必填的字符串 propC: { type: String, required: true }, // 带有默认值的数字 propD: { type: Number, default: 100 }, // 带有默认值的对象 propE: { type: Object, // 对象或数组默认值必须从一个工厂函数获取 // 请思考一下,这个default的语法 default() { return { message: 'hello' } } }, // 自定义验证函数 propF: { validator(value) { // 这个值必须匹配下列字符串中的一个 return ['success', 'warning', 'danger'].includes(value) } }, // 具有默认值的函数 propG: { type: Function, // 与对象或数组默认值不同,这不是一个工厂函数 —— 这是一个用作默认值的函数 default() { return 'Default function' } } } })
prop 会在一个组件实例创建之前进行验证,所以实例的选项(如
data
、computed
等) 在default
或validator
函数中是不可用的。
你可以将prop的数据类型定义成下列原生构造函数中的一个:
此外,还可以是一个自定义的构造函数,并且通过 instanceof
来进行检查确认。
例如,给定下面的构造函数:
function Person(firstName, lastName) { this.firstName = firstName this.lastName = lastName }
你可以这么做:
app.component('blog-post', { props: { author: Person } })
HTML 中的属性名是大小写不敏感的,所以浏览器会把所有大写字符解释为小写字符。
这意味着当你使用 DOM 中的模板时,camelCase (驼峰命名法) 的 prop 名需要使用其等价的 kebab-case (短横线分隔命名) 命名:
const app = Vue.createApp({}) app.component('blog-post', { // 在字符串模板和单文件组件中,你可以使用驼峰式的prop名字 props: ['postTitle'], template: '<h3>{{ postTitle }}</h3>' })
<!-- 但在HTML模板中,你只能使用短横线连接的名字 --> <blog-post post-title="hello!"></blog-post>
非 prop 的属性是指,传向一个组件,但是该组件并没有相应 props 或 emits 定义的属性。
常见的如 class
、style
和 id
等属性。它们不应该出现在props选项中。
当组件返回单个根节点时,非 prop属性将被自动添加到根节点的属性中。
假设我们有一个 <date-picker>
组件:
app.component('date-picker', { template: ` <div class="date-picker"> <input type="datetime-local" /> </div> ` })
如果我们为该组件添加了一个data-status
属性:
<!-- 具有非prop attribute的Date-picker组件--> <date-picker data-status="activated"></date-picker> <!-- 最后渲染出来的 date-picker 组件的真实HTML模板 --> <div class="date-picker" data-status="activated"> <input type="datetime-local" /> </div>
<date-picker @change="submitChange"></date-picker>
app.component('date-picker', { created() { console.log(this.$attrs) // { onChange: () => {} } } })
当有一个具有 change
事件的 HTML 元素将作为 date-picker
的根元素时,这可能会有帮助。
app.component('date-picker', { template: ` <select> <option value="1">Yesterday</option> <option value="2">Today</option> <option value="3">Tomorrow</option> </select> ` })
在这种情况下,change
事件监听器从父组件传递到子组件,它将在原生 select
的 change
事件上触发。我们不需要显式地从 date-picker
发出事件:
<div id="date-picker" class="demo"> <date-picker @change="showChange"></date-picker> </div>
const app = Vue.createApp({ methods: { showChange(event) { console.log(event.target.value) // 将记录所选选项的值 } } })
如果你不希望组件的根元素继承父组件传递过来的属性,你可以在组件的选项中设置 inheritAttrs: false
。
通过将 inheritAttrs
选项设置为 false
,你可以访问组件的 $attrs
属性,该属性包括组件 props
和 emits
属性中未包含的所有属性 (例如,class
、style
、v-on
监听器等)。
以上一节继承中的 date-picker
组件为例,如果需要将所有非 prop 属性应用于 input
元素而不是根 div
元素,则可以使用 v-bind
来完成。
app.component('date-picker', { inheritAttrs: false, template: ` <div class="date-picker"> <input type="datetime-local" v-bind="$attrs" /> </div> ` })
这么一操作,data-status
将应用于 input
元素!
<!-- Date-picker 组件 使用非 prop attribute --> <date-picker data-status="activated"></date-picker> <!-- 渲染 date-picker 组件 --> <div class="date-picker"> <input type="datetime-local" data-status="activated" /> </div>
与单个根节点组件不同,具有多个根节点的组件不具有自动继承行为。
如果未显式绑定 $attrs
,将弹出运行时警告。
<custom-layout id="custom-layout" @click="changeValue"></custom-layout>
// 这将发出警告 app.component('custom-layout', { template: ` <header>...</header> <main>...</main> <footer>...</footer> ` }) // 这么做没有警告,$attrs被传递到<main>元素 app.component('custom-layout', { template: ` <header>...</header> <main v-bind="$attrs">...</main> <footer>...</footer> ` })