注意:从React v15.5开始,
React.PropTypes
助手函数已被启用,建议使用prop-types库来定义contextTypes
。
PropTypes
输出了一系列的验证器,可以用来确保接收到的参数是有效的。例如,我们可以使用PropTypes.string
语句。当给 prop
传递了一个不正确的值时,JavaScript控制台将会显示一条警告。
使用目的
若你再之后的项目维护中或开发中,修改了prop的属性类型,则可以在控制台中发现并改正,从而可以避免造成不必要的bug。
默认的 prop 值
可以通过赋值特定的defaultProps
属性为props
定义默认值,如果父组件没有为this.props.name
传值,defaultProps
会给其一个默认值。propTypes
的类型检测是在defaultProps
解析之后发生的,因此也会对默认属性defaultProps
进行类型检测。
import PropTypes from 'prop-types';
class Greeting extends React.Component {
render() {
return (
<h1>Hello, {this.props.name}</h1>
);
}
}
Greeting.propTypes = {
name: PropTypes.string
};
在本例中, 我们使用了 PropTypes.string
。当传入的 prop
值类型不正确时,JavaScript 控制台将会显示警告。出于性能的原因,propTypes
仅在开发模式中检测。
defaultProps 用于确保 this.props.name 在父组件没有指定其值时,有一个默认值。从而组件不会因为没有值而变成空白或者报错。propTypes 类型检查发生在 defaultProps 赋值后,所以类型检查也适用于 defaultProps。
PropTypes
以下提供了使用不同验证器的例子:
import PropTypes from 'prop-types';
MyComponent.propTypes = {
optionalArray: PropTypes.array,
optionalBool: PropTypes.bool,
optionalFunc: PropTypes.func,
optionalNumber: PropTypes.number,
optionalObject: PropTypes.object,
optionalString: PropTypes.string,
optionalSymbol: PropTypes.symbol,
optionalNode: PropTypes.node,
optionalElement: PropTypes.element,
optionalMessage: PropTypes.instanceOf(Message),
optionalEnum: PropTypes.oneOf(['News', 'Photos']),
optionalUnion: PropTypes.oneOfType([
PropTypes.string,
PropTypes.number,
PropTypes.instanceOf(Message)
]),
optionalArrayOf: PropTypes.arrayOf(PropTypes.number),
optionalObjectOf: PropTypes.objectOf(PropTypes.number),
optionalObjectWithShape: PropTypes.shape({
color: PropTypes.string,
fontSize: PropTypes.number
}),
requiredFunc: PropTypes.func.isRequired,
requiredAny: PropTypes.any.isRequired
};
网友评论