prop-Types验证

5 篇文章 0 订阅
import React from "react";
import PropTypes from "prop-types";

class MyComponent extends React.Component {
  render() {
    // 利用属性做更多得事
  }
}

MyComponent.propTypes = {
  // 你可以定义一个属性是特定的JS类型(Array,Boolean,Function,Number,Object,String,Symbol)。默认情况下,这些都是可选的。

  optionalArray: PropTypes.array,
  optionalBool: PropTypes.bool,
  optionalFunc: PropTypes.func,
  optionalNumber: PropTypes.number,
  optionalObject: PropTypes.object,
  optionalString: PropTypes.string,
  optionalSymbol: PropTypes.symbol,

  // 指定类型为:任何可以被渲染的元素,包括数字,字符串,react 元素,数组,fragment。
  optionalNode: PropTypes.node,

  // 指定类型为:一个react 元素
  optionalElement: PropTypes.element,

  // 你可以类型为某个类的实例,这里使用JS的instanceOf操作符实现
  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({
    optionalProperty: PropTypes.string,
    requiredProperty: PropTypes.number.isRequired,
  }),

  // 指定类型为对象,且可以指定对象的哪些属性必须有,哪些属性可以没有。如果出现没有定义的属性,会出现警告。
  // 下面的代码optionalObjectWithStrictShape的属性值为对象,但是对象的属性最多有两个,optionalProperty 和 requiredProperty。
  // 出现第三个属性,控制台出现警告。
  optionalObjectWithStrictShape: PropTypes.exact({
    optionalProperty: PropTypes.string,
    requiredProperty: PropTypes.number.isRequired,
  }),

  // 加上isReqired限制,可以指定某个属性必须提供,如果没有出现警告。
  requiredFunc: PropTypes.func.isRequired,
  requiredAny: PropTypes.any.isRequired,

  // 你也可以指定一个自定义的验证器。如果验证不通过,它应该返回Error对象,而不是`console.warn `或抛出错误。`oneOfType`中不起作用。
  customProp(props, propName, componentName) {
    if (!/matchme/.test(props[propName])) {
      return new Error(
        `Invalid prop \`${propName}\` supplied to` +
          ` \`${componentName}\`. Validation failed.`
      );
    }
  },

  // 你也可以提供一个自定义的验证器 arrayOf和objectOf。如果验证失败,它应该返回一个Error对象。
  // 验证器用来验证数组或对象的每个值。验证器的前两个参数是数组或对象本身,还有对应的key。
  customArrayProp: PropTypes.arrayOf(
    (propValue, key, componentName, location, propFullName) => {
      if (!/matchme/.test(propValue[key])) {
        return new Error(
          `Invalid prop \`${propFullName}\` supplied to` +
            ` \`${componentName}\`. Validation failed.`
        );
      }
    }
  ),
};

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值