官方文档:https://cn.vuejs.org/v2/guide/components-props.html
1.Prop的大小写
HTML中的属性名是大小写不敏感的,故浏览器会把所有大小写字符解释为小写字符,使用驼峰命名法的prop名需要使用其等价的kebab-case(短横线分隔命名),如果使用字符串模板,则不存在这个限制。
Vue.component('blog-post', {
// 在 JavaScript 中是 camelCase 的
props: ['postTitle'],
template: '<h3>{{ postTitle }}</h3>'
})
<!-- 在 HTML 中是 kebab-case 的 -->
<blog-post post-title="hello!"></blog-post>
2.Prop类型
(1) 以字符串形式列出的prop
props: ['title', 'likes', 'isPublished', 'commentIds', 'author']
(2) 以对象形式列出prop,可指定值类型
每个prop也可以是一个对象,用于对属性进行验证;
props: {
title: String,
likes: Number,
isPublished: [String,Number],
commentIds: Array,
author: Object,
callback: Function,
contactsPromise: Promise // or any other constructor,
propA:{
type:Object,
default:function(){
return {message:'hello'}
}
}
}
3.向prop传递值
(1) 传递静态值
<blog-post title="My journey with Vue"></blog-post>
(2) 传递动态值
<!-- 动态赋予一个变量的值 -->
<blog-post v-bind:title="post.title"></blog-post>
<!-- 动态赋予一个复杂表达式的值 -->
<blog-post v-bind:title="post.title + ' by ' + post.author.name"></blog-post>
(3) 传入一个数字
<!-- 即便 `42` 是静态的,我们仍然需要 `v-bind` 来告诉 Vue -->
<!-- 这是一个 JavaScript 表达式而不是一个字符串。-->
<blog-post v-bind:likes="42"></blog-post>
<!-- 用一个变量进行动态赋值。-->
<blog-post v-bind:likes="post.likes"></blog-post>
(4) 传入一个布尔值
<!-- 包含该 prop 没有值的情况在内,都意味着 `true`。-->
<blog-post is-published></blog-post>
<!-- 即便 `false` 是静态的,我们仍然需要 `v-bind` 来告诉 Vue -->
<!-- 这是一个 JavaScript 表达式而不是一个字符串。-->
<blog-post v-bind:is-published="false"></blog-post>
<!-- 用一个变量进行动态赋值。-->
<blog-post v-bind:is-published="post.isPublished"></blog-post>
(5) 传入一个是数组
<!-- 即便数组是静态的,我们仍然需要 `v-bind` 来告诉 Vue -->
<!-- 这是一个 JavaScript 表达式而不是一个字符串。-->
<blog-post v-bind:comment-ids="[234, 266, 273]"></blog-post>
<!-- 用一个变量进行动态赋值。-->
<blog-post v-bind:comment-ids="post.commentIds"></blog-post>
(6) 传入一个对象
<!-- 即便对象是静态的,我们仍然需要 `v-bind` 来告诉 Vue -->
<!-- 这是一个 JavaScript 表达式而不是一个字符串。-->
<blog-post
v-bind:author="{
name: 'Veronica',
company: 'Veridian Dynamics'
}"
></blog-post>
<!-- 用一个变量进行动态赋值。-->
<blog-post v-bind:author="post.author"></blog-post>
(7) 传入一个对象的所有property
直接将对象赋值
post: {
id: 1,
title: 'My Journey with Vue'
}
<blog-post v-bind="post"></blog-post>
<!-- 等价于 -->
<blog-post
v-bind:id="post.id"
v-bind:title="post.title"
></blog-post>
5.单向数据流
- 所有的 prop 都使得其父子 prop 之间形成了一个单向下行绑定:父级 prop 的更新会向下流动到子组件中,但是反过来则不行。这样会防止从子组件意外变更父级组件的状态,从而导致应用的数据流向难以理解;
- 每次父级组件发生变更时,子组件中所有的 prop 都将会刷新为最新的值;这意味着你不应该在一个子组件内部改变 prop。如果你这样做了,Vue 会在浏览器的控制台中发出警告。
- JavaScript 中对象和数组是通过引用传入的,所以对于一个数组或对象类型的 prop 来说,在子组件中改变变更这个对象或数组本身将会影响到父组件的状态;
- 有两种常见的试图变更一个prop的情形:
(1) prop 用来传递一个初始值
这个 prop 用来传递一个初始值;这个子组件接下来希望将其作为一个本地的 prop 数据来使用。在这种情况下,最好定义一个本地的 data property 并将这个 prop 用作其初始值:
props: ['initialCounter'],
data: function () {
return {
//在子组件定义一个新的变量接收父组件传递的值
counter: this.initialCounter
}
}
(2) prop以一种原始的值传入且需要进行转换
即prop传入后,在子组件需要转换后再使用,这种情况下,最好用这个 prop 的值来定义一个计算属性:
props: ['size'], // 传入size属性
computed: {
// 定义计算属性对接收的属性进行转换
normalizedSize: function () {
return this.size.trim().toLowerCase()
}
}
6.Prop验证
- 为组件的 prop 指定验证要求,例如知道的某些类型。如果有一个需求没有被满足,则 Vue 会在浏览器控制台中发出警告。这在开发一个会被别人用到的组件时尤其有帮助.
- 为prop提供一个带有验证需求的对象
Vue.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: function () {
return { message: 'hello' }
}
},
// 自定义验证函数
propF: {
validator: function (value) {
// 这个值必须匹配下列字符串中的一个
return ['success', 'warning', 'danger'].indexOf(value) !== -1
}
}
}
})
(1) type类型
type可以是
- String
- Number
- Boolean
- Array
- Object
- Array
- Object
- Date
- Function
- Symbol
(2) type为自定义的构造函数
type还可以是一个自定义的构造函数,并且通过instanceof来进行检查确认:
function Person (firstName, lastName) {
this.firstName = firstName
this.lastName = lastName
}
// 使用
Vue.component('blog-post', {
props: {
// 验证author prop的值是否通过new Person创建的
author: Person
}
})
7.非Prop的Attribute
(1)定义
- 一个非 prop 的 attribute 是指传向一个组件,但是该组件并没有相应 prop 定义的 attribute;
- 显式定义的 prop 适用于向一个子组件传入信息,然而组件库的作者并不总能预见组件会被用于怎样的场景。这也是为什么组件可以接受任意的 attribute,而这些 attribute 会被添加到这个组件的根元素上;
- 举例:通过一个 Bootstrap 插件使用了一个第三方的 <bootstrap-date-input>组件,这个插件需要在其 上用到一个attribute。我们可以将这个 attribute 添加到你的组件实例上:
<bootstrap-date-input data-date-picker="activated"></bootstrap-date-input>
(2) 替换/合并已有的 Attribute
- 场景:父组件在使用子组件时,定义了与子组件内部相同的属性
<!-- <bootstrap-date-input>内部 -->
<input type="date" class="form-control">
<!-- 为了日期选择器插件定制一个主题,在使用时可能需要添加一个特别的类名 -->
<bootstrap-date-input
data-date-picker="activated"
class="date-picker-theme-dark"
></bootstrap-date-input>
在这种情况下,我们定义了两个不同的 class 的值:
- form-control:在组件的模板内设置好的;
- date-picker-theme-dark,从组件的父级传入的;
对于绝大多数 attribute 来说,从外部提供给组件的值会替换掉组件内部设置好的值。所以如果传入 type=“text” 就会替换掉 type=“date” 并把它破坏。但class 和 style 属性则可以将内部和外部传入的值合并起来,从而得到最终的值:form-control date-picker-theme-dark。
(3) 禁用Attribute继承(没搞懂应用场景)
如果不希望组件的根元素继承 attribute,你可以在组件的选项中设置 inheritAttrs: false,如:
Vue.component('my-component', {
inheritAttrs: false,
// ...
})
这尤其适合配合实例的 $attrs property 使用,该 property 包含了传递给一个组件的 attribute 名和 attribute 值,例如:
{
required: true,
placeholder: 'Enter your username'
}
有了 inheritAttrs: false 和 $attrs,就可以手动决定这些 attribute 会被赋予哪个元素。在撰写基础组件的时候是常会用到的.
Vue.component('base-input', {
inheritAttrs: false,
props: ['label', 'value'],
template: `
<label>
{{ label }}
<input
v-bind="$attrs"
v-bind:value="value"
v-on:input="$emit('input', $event.target.value)"
>
</label>
`
})
- inheritAttrs: false 选项不会影响 style 和 class 的绑定。
- inheritAttrs:false模式允许你在使用基础组件的时候更像是使用原始的 HTML 元素,而不会担心哪个元素是真正的根元素:
<base-input
v-model="username"
required
placeholder="Enter your username"
></base-input>