React is the entry point to the React framework. If you're using one of the prebuilt packages it's available as a global; if you're using CommonJS modules you can
function 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.
For more information about the specification object, see Component Specs and Lifecycle.
Render a React component into the DOM in the supplied
container and return a reference to the component.
If the React component was previously rendered into
container, this will perform an update on it and only mutate the DOM as necessary to reflect the latest React component.
If the optional callback is provided, it will be executed after the component is rendered or updated.
React.renderComponent()replaces the contents of the container node you pass in. In the future, it may be possible to insert a component to an existing DOM node without overwriting the existing children.
boolean unmountComponentAtNode(DOMElement container)
Remove a mounted React component from the DOM and clean up its event handlers and state. If no component was mounted in the container, calling this function does nothing. Returns
true if a component was unmounted and
false if there was no component to unmount.
string renderComponentToString(ReactComponent component)
Render a component to its initial HTML. This should only be used on the server. React will return an HTML string. You can use this method to generate HTML on the server and send the markup down on the initial request for faster page loads and to allow search engines to crawl your pages for SEO purposes.
If you call
React.renderComponent() on a node that already has this server-rendered markup, React will preserve it and only attach event handlers, allowing you to have a very performant first-load experience.
string renderComponentToStaticMarkup(ReactComponent component)
renderComponentToString, except this doesn't create extra DOM attributes such as
data-react-id, that React uses internally. This is useful if you want to use React as a simple static page generator, as stripping away the extra attributes can save lots of bytes.
boolean isValidClass(* factory)
Verifies the factory is a React class descriptor. See
boolean isValidComponent(* object)
Verifies the object is a React component descriptor.
React.DOM provides all of the standard HTML tags needed to build a React app. You generally don't use it directly; instead, just include it as part of the
/** @jsx React.DOM */ docblock.
React.PropTypes includes types that can be used with a component's
propTypes object to validate props being passed to your components. For more information about
propTypes, see Reusable Components.
Configure React's event system to handle touch events on mobile devices.
React.Children provides utilities for dealing with the
this.props.children opaque data structure.
object React.Children.map(object children, function fn [, object context])
fn on every immediate child contained within
this set to
children is a nested object or array it will be traversed:
fn will never be passed the container objects. If children is
undefined rather than an empty object.
React.Children.forEach(object children, function fn [, object context])
React.Children.map() but does not return an object.
number React.Children.count(object children)
Return the total number of components in
children, equal to the number of times that a callback passed to
forEach would be invoked.
object React.Children.only(object children)
Return the only child in
children. Throws otherwise.