React 属性验证 propTypes

24 篇文章 0 订阅
23 篇文章 0 订阅

React 组件可以根据预先设置进行属性验证。

React prop验证使用 propTypes,它可以保证我们的应用组件被正确使用,React.PropTypes 提供很多验证器 (validator) 来验证传入数据是否有效。当向 props 传入无效数据时,JavaScript 控制台会抛出警告。

以下实例创建一个 MyTest 组件,属性 title 是必须的且是字符串,非字符串类型会自动转换为字符串 :

var title = "菜鸟教程";
// var title = 123;
class MyTest extends React.Component {
  render() {
    return (
      <h1>Hello, {this.props.title}</h1>
    );
  }
}
 
MyTitle.propTypes = {
  title: PropTypes.string
};
ReactDOM.render(
    <MyTest title={title} />,
    document.getElementById('example')
);

以下是React 常用的一些验证器样本,写在这里方便摘抄。

MyComponent.propTypes = {
	// 可以声明 prop 为指定的 JS 基本数据类型,默认情况,这些数据是可选的
	myPropArray: React.PropTypes.array,
	myPropBool: React.PropTypes.bool,
	myPropFunc: React.PropTypes.func,
	myPropNumber: React.PropTypes.number,
	myPropObject: React.PropTypes.object,
	myPropString: React.PropTypes.string,

	// 可以被渲染的对象 numbers, strings, elements 或 array
	myPropNode: React.PropTypes.node,

	//  React 元素
	myPropElement: React.PropTypes.element,

	// 用 JS 的 instanceof 操作符声明 prop 为类的实例。
	myPropMessage: React.PropTypes.instanceOf(Message),

	// 用 enum 来限制 prop 只接受指定的值。
	myPropEnum: React.PropTypes.oneOf(['News', 'Photos']),

	// 可以是多个对象类型中的一个
	myPropUnion: React.PropTypes.oneOfType([
		React.PropTypes.string,
		React.PropTypes.number,
		React.PropTypes.instanceOf(Message)
	]),
 
	// 指定类型组成的数组
	myPropArrayOf: React.PropTypes.arrayOf(React.PropTypes.number),

	// 指定类型的属性构成的对象
	myPropObjectOf: React.PropTypes.objectOf(React.PropTypes.number),

	// 特定 shape 参数的对象
	myPropObjectWithShape: React.PropTypes.shape({
		color: React.PropTypes.string,
		fontSize: React.PropTypes.number
	}),
 
    // 任意类型加上 `isRequired` 来使 prop 不可空。
    myPropFunc: React.PropTypes.func.isRequired,
 
    // 不可空的任意类型
    myPropAny: React.PropTypes.any.isRequired,
 
    // 自定义验证器。如果验证失败需要返回一个 Error 对象。不要直接使用 `console.warn` 或抛异常,因为这样 `oneOfType` 会失效。
    myCustomProp: function(props, propName, componentName) {
		if (!/matchme/.test(props[propName])) {
			return new Error('Validation failed!');
		}
    }
}

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值