Update propTypes documentation.

This commit is contained in:
cpojer
2014-01-21 16:00:04 -08:00
committed by Vjeux
parent 8c8841c83a
commit b66fbde0a9
+4 -4
View File
@@ -12,7 +12,7 @@ When designing interfaces, break down the common design elements (buttons, form
## Prop Validation ## Prop Validation
As your app grows it's helpful to ensure that your components are used correctly. We do this by allowing you to specify `propTypes`. `React.PropTypes` exports a range of validators that can be used to make sure the data you receive is valid. When an invalid value is provided for a prop, an error will be thrown. Here is an example documenting the different validators provided: As your app grows it's helpful to ensure that your components are used correctly. We do this by allowing you to specify `propTypes`. `React.PropTypes` exports a range of validators that can be used to make sure the data you receive is valid. When an invalid value is provided for a prop, a warning will be shown in the JavaScript console. Note that for performance reasons `propTypes` is only checked in development mode. Here is an example documenting the different validators provided:
```javascript ```javascript
React.createClass({ React.createClass({
@@ -34,14 +34,14 @@ React.createClass({
// JS's instanceof operator. // JS's instanceof operator.
someClass: React.PropTypes.instanceOf(SomeClass), someClass: React.PropTypes.instanceOf(SomeClass),
// You can chain any of the above with isRequired to make sure an error is // You can chain any of the above with isRequired to make sure a warning is
// thrown if the prop isn't provided. // shown if the prop isn't provided.
requiredFunc: React.PropTypes.func.isRequired requiredFunc: React.PropTypes.func.isRequired
// You can also specify a custom validator. // You can also specify a custom validator.
customProp: function(props, propName, componentName) { customProp: function(props, propName, componentName) {
if (!/matchme/.test(props[propName])) { if (!/matchme/.test(props[propName])) {
throw new Error('Validation failed!') console.warn('Validation failed!');
} }
} }
}, },