通过自定义检查扩展反应道具类型验证

Question

我正在尝试对组件中的 array prop 进行 propTypes 验证。我的 propTypes 验证看起来像这样

Foo.propTypes = {
 columns: PropTypes.arrayOf(
    PropTypes.shape({
      identifier: PropTypes.string,
      displayName: PropTypes.string,
      type: PropTypes.string,
      align: PropTypes.oneOf(['right', 'left', 'center']),
      sort: PropTypes.bool
    })
  )
}

现在我想通过自定义验证来扩展此验证，方法是验证 sort 属性的列数组中只有一个值应该是 true

我有一个选择是为整个列数组编写自定义验证，这将执行 PropTypes.arrayOf 和 PropTypes.shape 验证，然后执行 sort 验证并抛出 error或 null

但我不想返工，想利用内置的 React.PropTypes 进行所有验证，然后添加我的自定义验证

Answer 1

prop-types 用于运行时类型检查，您要完成的工作不属于该领域，更像是数据验证。我不建议为此使用 prop-types，即使可能。

我特别要警告不要这样做，因为 prop-types 只在开发中发出警告。如果您的数据无效，我想您会想要比这更多的结果，例如取消除一列以外的所有列的排序，或者向您的用户显示某些内容。

Answer 2

您也可以在自定义验证器中使用 PropTypes 包。所以用下面的代码解决了我的问题

Foo.propTypes = {
 columns: function(propValue, key, componentName, location, propFullName) {
    PropTypes.arrayOf(
      PropTypes.shape({
        identifier: PropTypes.string,
        displayName: PropTypes.string,
        type: PropTypes.string,
        align: PropTypes.oneOf(['right', 'left', 'center']),
        sort: PropTypes.bool
      })
    );
    if (propValue.columns.filter(i => i.sort === true).length > 1) {
      return new Error(
        `Invalid prop ${propFullName} supplied to ${componentName}. Only single object can have sort value as true`
      );
    }
    return null;
  }
}

通过自定义检查扩展反应道具类型验证

Extending react prop-types validation with custom checking

reactjs

react-proptypes