From 12a33fad6f1f4dcb764f49e743e925f4c8e1fb9e Mon Sep 17 00:00:00 2001
From: Ben Alpert <spicyjalapeno@gmail.com>
Date: Thu, 13 Feb 2014 22:59:48 -0800
Subject: [PATCH] Add docs for new prop types
---
docs/05-reusable-components.md | 19 +++++++++++++++++--
1 file changed, 17 insertions(+), 2 deletions(-)
diff --git a/docs/05-reusable-components.md b/docs/05-reusable-components.md
index 654d5304..7eca2355 100644
--- a/docs/05-reusable-components.md
+++ b/docs/05-reusable-components.md
@@ -35,11 +35,23 @@ React.createClass({
// You can ensure that your prop is limited to specific values by treating
// it as an enum.
- optionalEnum: React.PropTypes.oneOf(['News','Photos']),
+ optionalEnum: React.PropTypes.oneOf(['News', 'Photos']),
- // Expect an array of a certain propType
+ // An object that could be one of many types
+ optionalUnion: React.PropTypes.oneOfType([
+ React.PropTypes.string,
+ React.PropTypes.number
+ ])
+
+ // An array of a certain type
optionalArrayOf: React.PropTypes.arrayOf(React.PropTypes.number)
+ // An object taking on a particular shape
+ optionalObjectWithShape: React.PropTypes.shape({
+ color: React.PropTypes.string,
+ fontSize: React.PropTypes.number
+ }),
+
// You can also declare that a prop is an instance of a class. This uses
// JS's instanceof operator.
someClass: React.PropTypes.instanceOf(SomeClass),
@@ -48,6 +60,9 @@ React.createClass({
// shown if the prop isn't provided.
requiredFunc: React.PropTypes.func.isRequired
+ // An object of any kind
+ requiredAny: React.PropTypes.any.isRequired
+
// You can also specify a custom validator.
customProp: function(props, propName, componentName) {
if (!/matchme/.test(props[propName])) {