本文转载自:众成翻译
译者:iOSDevLog
链接:http://www.zcfy.cc/article/3818
原文:https://www.fullstackreact.com/30-days-of-react/day-8/
我们正在考虑如何在今天重新使用React组件,这样我们不仅可以在应用而且可以在团队中共享我们的组件。
唷! 我们做了第二周(相对毫发)! 通过这一点,我们已经讨论了React(props
,state
,生命周期挂钩函数,JSX等)的大部分基本特性。 在本节中,我们将看一下注解我们的组件。
PropTypes
您可能已经注意到我们在组件中使用了props
。 在大多数情况下,我们期望这些是一种特定类型或一组类型(也称为object
或string
)。 React提供了一种定义和验证这些类型的方法,使我们能够轻松暴露组件API。
文档化不仅是好习惯,对于构建也是有益的reusable react components.
React.PropTypes
对象导出一堆不同的类型,我们可以用它来定义组件的prop应该是什么类型的。 我们可以在ES6类风格的React prop中使用propTypes
方法来定义它们:
class Clock extends React.Component {
// ...
}
Clock.propTypes = {
// key is the name of the prop and
// value is the PropType
}
使用
React.createClass()
形式, 我们定义一个propTypes
的key
例如,我们可以将Clock
组件的形式重写为:const Clock = React.createClass({ proptypes: {} });
从这个prop
里面,我们可以定义一个对象,它具有一个prop的key作为我们定义的prop的名称,它应被定义的类型(或类型)的一个值。
例如,几天前我们构建的Header
组件接受一个称为title
的属性,我们期望它是一个字符串。 我们可以将其类型定义为字符串:
class Header extends React.Component {
// ...
}
Header.propTypes = {
title: React.PropTypes.string
}
React有很多类型可供选择,在React.PropTypes
对象上导出,甚至允许我们定义一个自定义的对象类型。 看看可用类型的总体列表:
[](#basic-types)基本类型
React暴露了我们可以开箱即用的几种基本类型。
类型 | 例子 | 类 |
---|---|---|
String | ‘hello’ | React.PropTypes.string |
Number | 10, 0.1 | React.PropTypes.number |
Boolean | true / false | React.PropTypes.bool |
Function | const say => (msg) => console.log("Hello world") | React.PropTypes.func |
Symbol | Symbol(“msg”) | React.PropTypes.symbol |
Object | {name: 'Ari'} | React.PropTypes.object |
Anything | ‘whatever’, 10, | {} |
可以告诉React我们希望它传递_anything_可以使用React.PropTypes.node
来呈现:
类型 | 例子 | 类 |
---|---|---|
A rendererable | 10, ‘hello’ | React.PropTypes.node |
Clock.propTypes = {
title: React.PropTypes.string,
count: React.PropTypes.number,
isOn: React.PropTypes.bool,
onDisplay: React.PropTypes.func,
symbol: React.PropTypes.symbol,
user: React.PropTypes.object,
name: React.PropTypes.node
}
我们已经看过如何使用props
从父组件到子组件进行通信。 我们可以使用函数从子组件到父组件进行通信。 当我们想要操作一个子组件的父组件时,我们会经常使用这种模式。
集合类型
我们可以通过我们的props
中的可迭代的集合。 当我们通过我们的活动通过一个数组时,我们已经看到了如何做到这一点。 要将组件的proptype声明为数组,我们可以使用 React.PropTypes.array
注解。
我们也可以要求数组只能使用某种类型的对象 React.PropTypes.arrayOf([])
.
类型 | 例子 | 类 |
---|---|---|
Array | [] | React.PropTypes.array |
Array of numbers | [1, 2, 3] | React.PropTypes.arrayOf([type]) |
Enum | [‘Red’, ‘Blue’] | React.PropTypes.oneOf([arr]) |
可以使用React.PropTypes.oneOfType([types])
来描述可以是几种不同类型之一的对象。
Clock.propTypes = {
counts: React.PropTypes.array,
users: React.PropTypes.arrayOf(React.PropTypes.object),
alarmColor: React.PropTypes.oneOf(['red', 'blue']),
description: React.PropTypes.oneOfType([
React.PropTypes.string,
React.PropTypes.instanceOf(Title)
]),
}
对象类型
可以定义需要某个特定类型的特定类型或实例的类型。
类型 | 例子 | 类 |
---|---|---|
Object | {name: 'Ari'} | React.PropTypes.object |
Number object | {count: 42} | React.PropTypes.objectOf() |
Instance | new Message() | React.PropTypes.objectOf() |
Object shape | {name: 'Ari'} | React.PropTypes.shape() |
Clock.propTypes = {
basicObject: React.PropTypes.object,
numbers: React.PropTypes
.objectOf(React.PropTypes.numbers),
messages: React.PropTypes
.instanceOf(Message),
contactList: React.PropTypes.shape({
name: React.PropTypes.string,
phone: React.PropTypes.string,
})
}
React类型
我们也可以通过React元素从父组件到子组件。 这对于构建模板和提供模板的定制非常有用。
类型 | 例子 | 类 |
---|---|---|
Element | <Title /> | React.PropTypes.element |
Clock.propTypes = {
displayEle: React.PropTypes.element
}
当我们使用_element_时,React希望我们能够接受一个单独的子组件。 也就是说,我们将无法传递多个元素。
// Invalid for elements
<Clock displayElement={
<div>Name</div>
<div>Age</div>
}></Clock>
// Valid
<Clock displayElement={
<div>
<div>Name</div>
<div>Age</div>
</div>
}></Clock>
必需类型
可以通过在_任意_个属性类型中附加.isRequired
中描述来将需要传递给一个组件:
Clock.propTypes = {
title: React.PropTypes.name.isRequired,
}
根据需要设置prop
是非常有用的。当组件依赖于一个prop
被它的父组件传递,如果没有它将不会工作。
自定义类型
最后,还可以传递一个函数来定义自定义类型。 我们可以做一个单一属性或验证数组。 自定义函数的一个要求是,如果验证确定_not_ 传递,则期望我们返回一个 Error
对象:
类型 | 例子 | 类 |
---|---|---|
Custom | ‘something_crazy’ | function(props, propName, componentName) {} |
CustomArray | [‘something’, ‘crazy’] | React.PropTypes.arrayOf(function(props, propName, componentName) {}) |
UserLink.propTypes = {
userWithName: (props, propName, componentName) => {
if (!props[propName] || !props[propName].name) {
return new Error(
"Invalid " + propName + ": No name property defined for component " + componentName
)
}
}
}
默认属性
rendered, so we can define a common title instead by setting it’s default prop value.有时,我们希望能够为属性设置默认值。 例如,我们昨天构建的组件
可能不需要传递标题。 如果不是,我们仍然需要一个标题来渲染,所以我们可以通过设置它的默认支持值来定义一个通用的标题。
要设置默认的prop值,我们可以在组件上使用defaultProps
对象键。
Header.defaultProps = {
title: 'Github activity'
}
当使用
React.createClass()
形式时,我们可以定义一个名为getDefaultProps()
的对象键,该对象键将返回具有默认值道具的对象。React.createClass({ getDefaultProps: () => ({ name: 'Github activity' }) })
呃,今天我们浏览了很多文档。 使用组件的propTypes
和defaultProps
属性构建可重用组件是一个好主意。 不仅可以使开发人员之间进行沟通变得更加容易,而且在离开组件几天后我们也可以轻松回收。 接下来,我们将回到代码,并开始将某些风格整合到我们的组件中。