使用 PropTypes 进行类型检查

注意：从 React v15.5 开始，React.PropTypes 助手函数已被弃用，建议使用 prop-types 库来定义contextTypes。

import PropTypes from 'prop-types';

class Greeting extends React.Component {

render() {

return (

<h1>Hello, {this.props.name}</h1>

);

}

Greeting.propTypes = {

name: PropTypes.string

};

PropTypes

这里是一个示例记录提供的不同的验证器：

import PropTypes from 'prop-types';

MyComponent.propTypes = {

// 你可以声明一个 prop 是一个特定的 JS 原始类型。

// 默认情况下，这些都是可选的。

optionalArray: PropTypes.array,

optionalBool: PropTypes.bool,

optionalFunc: PropTypes.func,

optionalNumber: PropTypes.number,

optionalObject: PropTypes.object,

optionalString: PropTypes.string,

optionalSymbol: PropTypes.symbol,

// 任何东西都可以被渲染:numbers, strings, elements,或者是包含这些类型的数组(或者是片段)。

optionalNode: PropTypes.node,

// 一个 React 元素。

optionalElement: PropTypes.element,

// 你也可以声明一个 prop 是类的一个实例。

// 使用 JS 的 instanceof 运算符。

optionalMessage: PropTypes.instanceOf(Message),

// 你可以声明 prop 是特定的值，类似于枚举

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

}),

// 你可以使用 `isRequired' 链接上述任何一个，以确保在没有提供 prop 的情况下显示警告。

requiredFunc: PropTypes.func.isRequired,

// 任何数据类型的值

requiredAny: PropTypes.any.isRequired,

// 你也可以声明自定义的验证器。如果验证失败返回 Error 对象。不要使用 `console.warn` 或者 throw ，

// 因为这不会在 `oneOfType` 类型的验证器中起作用。

customProp: function(props, propName, componentName) {

if (!/matchme/.test(props[propName])) {

return new Error(

'Invalid prop `' + propName + '` supplied to' +

' `' + componentName + '`. Validation failed.'

);

}

},

// 也可以声明`arrayOf`和`objectOf`类型的验证器，如果验证失败需要返回Error对象。

// 会在数组或者对象的每一个元素上调用验证器。验证器的前两个参数分别是数组或者对象本身，

// 以及当前元素的键值。

customArrayProp: PropTypes.arrayOf(function(propValue, key, componentName, location, propFullName) {

if (!/matchme/.test(propValue[key])) {

return new Error(

'Invalid prop `' + propFullName + '` supplied to' +

' `' + componentName + '`. Validation failed.'

);

}

})

};

要求单独的 Child

使用 PropTypes.element ，可以指定仅将单一子元素传递给组件，作为子节点。

默认的 prop 值

可以通过赋值特定的 defaultProps 属性为 props 定义默认值：

class Greeting extends React.Component {

render() {

return (

<h1>Hello, {this.props.name}</h1>

);

}

// 指定 props 的默认值：

Greeting.defaultProps = {

name: 'Stranger'

};

// 渲染为 "Hello, Stranger":

ReactDOM.render(

<Greeting />,

document.getElementById('example')

);