From 9c3fd71b5209fcc3050f44604bd54d18e62c7d1b Mon Sep 17 00:00:00 2001 From: Aaron Franks Date: Sun, 7 Dec 2014 23:17:27 -0800 Subject: [PATCH 1/3] Add type signature info to top-level API docs. --- docs/ref-01-top-level-api.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/ref-01-top-level-api.md b/docs/ref-01-top-level-api.md index 39bc37b16..08425b730 100644 --- a/docs/ref-01-top-level-api.md +++ b/docs/ref-01-top-level-api.md @@ -14,7 +14,7 @@ redirect_from: "/docs/reference.html" ### React.createClass ```javascript -function createClass(object specification) +ReactComponent createClass(object specification) ``` Create a component given a specification. A component implements a `render` method which returns **one single** child. That child may have an arbitrarily deep child structure. One thing that makes components different than standard prototypal classes is that you don't need to call new on them. They are convenience wrappers that construct backing instances (via new) for you. @@ -25,14 +25,14 @@ For more information about the specification object, see [Component Specs and Li ### React.createElement ```javascript -function createElement( +ReactElement createElement( string/ReactComponent type, [object props], [children ...] ) ``` -Create and return a new ReactElement of the given type. The type argument can be either an +Create and return a new `ReactElement` of the given type. The type argument can be either an html tag name string (eg. 'div', 'span', etc), or a `ReactComponent` class that was created with `React.createClass`. From 5f88afbb74eb9ef99b1049607471f100d5fda4be Mon Sep 17 00:00:00 2001 From: Aaron Franks Date: Mon, 8 Dec 2014 07:54:13 -0800 Subject: [PATCH 2/3] Add top-level API docs for React.createFactory. --- docs/ref-01-top-level-api.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/ref-01-top-level-api.md b/docs/ref-01-top-level-api.md index 08425b730..b51772268 100644 --- a/docs/ref-01-top-level-api.md +++ b/docs/ref-01-top-level-api.md @@ -37,6 +37,19 @@ html tag name string (eg. 'div', 'span', etc), or a `ReactComponent` class that with `React.createClass`. +### React.createFactory + +```javascript +factoryFunction createFactory( + string/ReactComponent type +) +``` + +Return a function that produces ReactElements of a given type. Like `React.createElement`, +the type argument can be either an html tag name string (eg. 'div', 'span', etc), or a +`ReactComponent` class that was created with `React.createClass`. + + ### React.render ```javascript From 9c918ebe364ffc845fb5080be49e689afeec27f3 Mon Sep 17 00:00:00 2001 From: Aaron Franks Date: Sun, 14 Dec 2014 17:03:02 -0800 Subject: [PATCH 3/3] Docs: ReactComponent -> ReactClass in a few places --- docs/ref-01-top-level-api.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/ref-01-top-level-api.md b/docs/ref-01-top-level-api.md index b51772268..7beb8b152 100644 --- a/docs/ref-01-top-level-api.md +++ b/docs/ref-01-top-level-api.md @@ -14,10 +14,10 @@ redirect_from: "/docs/reference.html" ### React.createClass ```javascript -ReactComponent createClass(object specification) +ReactClass createClass(object specification) ``` -Create a component given a specification. A component implements a `render` method which returns **one single** child. That child may have an arbitrarily deep child structure. One thing that makes components different than standard prototypal classes is that you don't need to call new on them. They are convenience wrappers that construct backing instances (via new) for you. +Create a component class, given a specification. A component implements a `render` method which returns **one single** child. That child may have an arbitrarily deep child structure. One thing that makes components different than standard prototypal classes is that you don't need to call new on them. They are convenience wrappers that construct backing instances (via new) for you. For more information about the specification object, see [Component Specs and Lifecycle](/react/docs/component-specs.html). @@ -26,28 +26,27 @@ For more information about the specification object, see [Component Specs and Li ```javascript ReactElement createElement( - string/ReactComponent type, + string/ReactClass type, [object props], [children ...] ) ``` Create and return a new `ReactElement` of the given type. The type argument can be either an -html tag name string (eg. 'div', 'span', etc), or a `ReactComponent` class that was created -with `React.createClass`. +html tag name string (eg. 'div', 'span', etc), or a `ReactClass` (created via `React.createClass`). ### React.createFactory ```javascript factoryFunction createFactory( - string/ReactComponent type + string/ReactClass type ) ``` Return a function that produces ReactElements of a given type. Like `React.createElement`, the type argument can be either an html tag name string (eg. 'div', 'span', etc), or a -`ReactComponent` class that was created with `React.createClass`. +`ReactClass`. ### React.render