Skip to content

Commit 570019b

Browse files
JinjiangJustineo
authored andcommitted
translated components-props.md (#702)
* translated components-props.md * Update components-props.md
1 parent 2d4b7d8 commit 570019b

File tree

1 file changed

+313
-0
lines changed

1 file changed

+313
-0
lines changed

src/v2/guide/components-props.md

+313
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,313 @@
1+
---
2+
title: Prop
3+
type: guide
4+
order: 102
5+
---
6+
7+
> 该页面假设你已经阅读过了[组件基础](components.html)。如果你还对组件不太了解,推荐你先阅读它。
8+
9+
## Prop 的大小写 (camelCase vs kebab-case)
10+
11+
HTML 中的特性名是大小写不敏感的,所以浏览器会把所有大写字符解释为小写字符。这意味着当你使用 DOM 中的模板时,camelCase (驼峰命名法) 的 prop 名需要使用其等价的 kebab-case (短横线分隔命名) 命名:
12+
13+
``` js
14+
Vue.component('blog-post', {
15+
// 在 JavaScript 中是 camelCase 的
16+
props: ['postTitle'],
17+
template: '<h3>{{ postTitle }}</h3>'
18+
})
19+
```
20+
21+
``` html
22+
<!-- 在 HTML 中是 kebab-case 的 -->
23+
<blog-post post-title="hello!"></blog-post>
24+
```
25+
26+
重申一次,如果你使用字符串模板,那么这个限制就不存在了。
27+
28+
## 静态的和动态的 Prop
29+
30+
像这样,你已经知道了可以想这样给 prop 传入一个静态的值:
31+
32+
```html
33+
<blog-post title="My journey with Vue"></blog-post>
34+
```
35+
36+
你也知道 prop 可以通过 `v-bind` 动态赋值,例如:
37+
38+
```html
39+
<blog-post v-bind:title="post.title"></blog-post>
40+
```
41+
42+
在上述两个示例中,我们传入的值都是字符串类型的,但实际上_任何_类型的值都可以传给一个 prop。
43+
44+
### 传入一个数字
45+
46+
```html
47+
<!-- 即便 `42` 是静态的,我们仍然需要 `v-bind` 来告诉 Vue -->
48+
<!-- 这是一个 JavaScript 表达式而不是一个字符串。-->
49+
<blog-post v-bind:likes="42"></blog-post>
50+
51+
<!-- 用一个变量进行动态赋值。-->
52+
<blog-post v-bind:likes="post.likes"></blog-post>
53+
```
54+
55+
### 传入一个布尔值
56+
57+
```html
58+
<!-- 包含该 prop 没有值的情况在内,都意味着 `true`。-->
59+
<blog-post favorited></blog-post>
60+
61+
<!-- 即便 `false` 是静态的,我们仍然需要 `v-bind` 来告诉 Vue -->
62+
<!-- 这是一个 JavaScript 表达式而不是一个字符串。-->
63+
<base-input v-bind:favorited="false">
64+
65+
<!-- 用一个变量进行动态赋值。-->
66+
<base-input v-bind:favorited="post.currentUserFavorited">
67+
```
68+
69+
### 传入一个数组
70+
71+
```html
72+
<!-- 即便数组是静态的,我们仍然需要 `v-bind` 来告诉 Vue -->
73+
<!-- 这是一个 JavaScript 表达式而不是一个字符串。-->
74+
<blog-post v-bind:comment-ids="[234, 266, 273]"></blog-post>
75+
76+
<!-- 用一个变量进行动态赋值。-->
77+
<blog-post v-bind:comment-ids="post.commentIds"></blog-post>
78+
```
79+
80+
### 传入一个对象
81+
82+
```html
83+
<!-- 即便对象是静态的,我们仍然需要 `v-bind` 来告诉 Vue -->
84+
<!-- 这是一个 JavaScript 表达式而不是一个字符串。-->
85+
<blog-post v-bind:comments="{ id: 1, title: 'My Journey with Vue' }"></blog-post>
86+
87+
<!-- 用一个变量进行动态赋值。-->
88+
<blog-post v-bind:post="post"></blog-post>
89+
```
90+
91+
### 传入一个对象的所有属性
92+
93+
如果你想要将一个对象的所有属性都作为 prop 传入,你可以使用不带参数的 `v-bind` (取代 `v-bind:prop-name`)。例如,对于一个给定的对象 `post`
94+
95+
``` js
96+
post: {
97+
id: 1,
98+
title: 'My Journey with Vue'
99+
}
100+
```
101+
102+
下面的模板:
103+
104+
``` html
105+
<blog-post v-bind="post"></blog-post>
106+
```
107+
108+
等价于:
109+
110+
``` html
111+
<blog-post
112+
v-bind:id="post.id"
113+
v-bind:title="post.title"
114+
></blog-post>
115+
```
116+
117+
## 单向数据流
118+
119+
所有的 prop 都使得其父子 prop 之间形成了一个**单向下行绑定**:父级 prop 的更新会向下流动到子组件中,但是反过来则不行。这样会防止从子组件意外改变父级组件的状态,从而导致你的应用的数据流向难以理解。
120+
121+
额外的,每次父级组件发生更新时,子组件中所有的 prop 都将会刷新为最新的值。这意味着你****应该在一个子组件内部改变 prop。如果你这样做了,Vue 会在浏览器的控制台中发出警告。
122+
123+
这里有两种常见的试图改变一个 prop 的情形:
124+
125+
1. **这个 prop 用来传递一个初始值;这个子组件接下来希望将其作为一个本地的 prop 数据来使用。**在这种情况下,最好定义一个本地的 data 属性并将这个 prop 用作其初始值:
126+
127+
``` js
128+
props: ['initialCounter'],
129+
data: function () {
130+
return {
131+
counter: this.initialCounter
132+
}
133+
}
134+
```
135+
136+
2. **这个 prop 以一种原始的值传入且需要进行转换。**在这种情况下,最好使用这个 prop 的值来定义一个计算属性:
137+
138+
``` js
139+
props: ['size'],
140+
computed: {
141+
normalizedSize: function () {
142+
return this.size.trim().toLowerCase()
143+
}
144+
}
145+
```
146+
147+
<p class="tip">注意在 JavaScript 中对象和数组是通过引用传入的,所以对于一个数组或对象类型的 prop 来说,在子组件中改变这个对象或数组本身**将会**影响到父组件的状态。</p>
148+
149+
## Prop 验证
150+
151+
我们可以为组件的 prop 指定需求。如果有一个需求没有被满足,则 Vue 会在浏览器控制台中警告你。这在开发一个会被别人用到的组件时尤其有帮助。
152+
153+
为了定制 prop 的验证方式,你可以为 `props` 中的值提供一个带有验证需求的对象,而不是一个字符串数组。例如:
154+
155+
``` js
156+
Vue.component('my-component', {
157+
props: {
158+
// 基础的类型检查 (`null` 匹配任何类型)
159+
propA: Number,
160+
// 多个可能的类型
161+
propB: [String, Number],
162+
// 必填的字符串
163+
propC: {
164+
type: String,
165+
required: true
166+
},
167+
// 带有默认值的数字
168+
propD: {
169+
type: Number,
170+
default: 100
171+
},
172+
// 带有默认值的对象
173+
propE: {
174+
type: Object,
175+
// 对象或数组且一定会从一个工厂函数返回默认值
176+
default: function () {
177+
return { message: 'hello' }
178+
}
179+
},
180+
// 自定义验证函数
181+
propF: {
182+
validator: function (value) {
183+
// 这个值必须匹配下列字符串中的一个
184+
return ['success', 'warning', 'danger'].indexOf(value) !== -1
185+
}
186+
}
187+
}
188+
})
189+
```
190+
191+
当 prop 验证失败的时候,(开发环境构建版本的) Vue 将会产生一个控制台的警告。
192+
193+
<p class="tip">注意那些 prop 会在一个组件实例创建**之前**进行验证,所以实例的属性 (如 `data`、`computed` 等) 在 `default` 或 `validator` 函数中是不可用的。</p>
194+
195+
### 类型检查
196+
197+
`type` 可以是下列原生构造函数中的一个:
198+
199+
- `String`
200+
- `Number`
201+
- `Boolean`
202+
- `Function`
203+
- `Object`
204+
- `Array`
205+
- `Symbol`
206+
207+
额外的,`type` 还可以是一个自定义的构造函数,并且通过 `instanceof` 来进行检查确认。例如,给定下列现成的构造函数:
208+
209+
```js
210+
function Person (firstName, lastName) {
211+
this.firstName = firstName
212+
this.lastName = lastName
213+
}
214+
```
215+
216+
你可以使用:
217+
218+
```js
219+
Vue.component('blog-post', {
220+
props: {
221+
author: Person
222+
}
223+
})
224+
```
225+
226+
来验证 `author` prop 的值是否是通过 `new Person` 创建的。
227+
228+
## 非 Prop 的特性
229+
230+
一个非 prop 特性是指传向一个组件,但是该组件并没有相应 prop 定义的特性。
231+
232+
因为显式定义的 prop 适用于向一个子组件传入信息,然而组件库的作者并不总能预见组件会被用于怎样的场景。这也是为什么组件可以接受任意的特性,而这些特性会被添加到这个组件的根元素上。
233+
234+
例如,想象一下你通过一个 Bootstrap 插件使用了一个第三方的 `<bootstrap-data-input>` 组件,这个插件需要在其 `<input>` 上用到一个 `data-date-picker` 特性。我们可以将这个特性添加到你的组件实例上:
235+
236+
``` html
237+
<bootstrap-date-input data-date-picker="activated"></bootstrap-date-input>
238+
```
239+
240+
然后这个 `data-date-picker="activated"` 特性就会自动添加到 `<bootstrap-date-input>` 的根元素上。
241+
242+
### 替换/合并已有的特性
243+
244+
想象一下 `<bootstrap-date-input>` 的模板是这样的:
245+
246+
``` html
247+
<input type="date" class="form-control">
248+
```
249+
250+
为了给我们的日期选择器插件定制一个主题,我们可能需要像这样添加一个特别的类名:
251+
252+
``` html
253+
<bootstrap-date-input
254+
data-date-picker="activated"
255+
class="date-picker-theme-dark"
256+
></bootstrap-date-input>
257+
```
258+
259+
在这种情况下,我们定义了两个不同的 `class` 的值:
260+
261+
- `form-control`,这是在组件的模板内设置好的
262+
- `date-picker-theme-dark`,这是从组件的父级传入的
263+
264+
对于绝大多数特性来说,从外部提供给组件的值会替换掉组件内部设置好的值。所以如果传入 `type="text"` 就会替换掉 `type="date"` 并把它破坏!庆幸的是,`class``style` 特性会稍微智能一些,即两边的值会被合并起来,从而得到最终的值:`form-control date-picker-theme-dark`
265+
266+
### 禁用特性继承
267+
268+
如果你****希望组件的根元素继承特性,你可以设置在组件的选项中设置 `inheritAttrs: false`。例如:
269+
270+
```js
271+
Vue.component('my-component', {
272+
inheritAttrs: false,
273+
// ...
274+
})
275+
```
276+
277+
这尤其适合配合实例的 `$attrs` 属性使用,该属性包含了传递给一个组件的特性名和特性值,例如:
278+
279+
```js
280+
{
281+
class: 'username-input',
282+
placeholder: 'Enter your username'
283+
}
284+
```
285+
286+
有了 `inheritAttrs: false``$attrs`,你就可以手动决定这些特性会被赋予哪个元素。在撰写[基础组件](../style-guide/#基础组件名-强烈推荐)的时候是常会用到的:
287+
288+
```js
289+
Vue.component('base-input', {
290+
inheritAttrs: false,
291+
props: ['label', 'value'],
292+
template: `
293+
<label>
294+
{{ label }}
295+
<input
296+
v-bind="$attrs"
297+
v-bind:value="value"
298+
v-on:input="$emit('input', $event.target.value)"
299+
>
300+
</label>
301+
`
302+
})
303+
```
304+
305+
这个模式允许你在使用基础组件的时候更像是使用原始的 HTML 元素,而不会担心哪个元素是真正的根元素:
306+
307+
```html
308+
<base-input
309+
v-model="username"
310+
class="username-input"
311+
placeholder="Enter your username"
312+
></base-input>
313+
```

0 commit comments

Comments
 (0)