|
| 1 | +--- |
| 2 | +id: top-level-api |
| 3 | +title: Top-Level API |
| 4 | +layout: docs |
| 5 | +permalink: top-level-api.html |
| 6 | +next: component-api.html |
| 7 | +--- |
| 8 | + |
| 9 | +## React |
| 10 | + |
| 11 | +`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 `require()` it. |
| 12 | + |
| 13 | + |
| 14 | +### React.DOM |
| 15 | + |
| 16 | +`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. |
| 17 | + |
| 18 | + |
| 19 | +### React.initializeTouchEvents |
| 20 | + |
| 21 | +```javascript |
| 22 | +initializeTouchEvents(boolean shouldUseTouch) |
| 23 | +``` |
| 24 | + |
| 25 | +Configure React's event system to handle touch events on mobile devices. |
| 26 | + |
| 27 | + |
| 28 | +### React.createClass |
| 29 | + |
| 30 | +```javascript |
| 31 | +function createClass(object specification) |
| 32 | +``` |
| 33 | + |
| 34 | +Creates 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. |
| 35 | + |
| 36 | +For more information about the specification object, see [Component Specs and Lifecycle](component-specs.html). |
| 37 | + |
| 38 | + |
| 39 | +### React.renderComponent |
| 40 | + |
| 41 | +```javascript |
| 42 | +ReactComponent renderComponent( |
| 43 | + ReactComponent component, |
| 44 | + DOMElement container, |
| 45 | + [function callback] |
| 46 | +) |
| 47 | +``` |
| 48 | + |
| 49 | +Renders a React component into the DOM in the supplied `container`. |
| 50 | + |
| 51 | +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. |
| 52 | + |
| 53 | +If the optional callback is provided, it will be executed after the component is rendered or updated. |
| 54 | + |
| 55 | + |
| 56 | +### React.unmountAndReleaseReactRootNode |
| 57 | + |
| 58 | +```javascript |
| 59 | +unmountAndReleaseReactRootNode(DOMElement container) |
| 60 | +``` |
| 61 | + |
| 62 | +Remove a mounted React component from the DOM and clean up its event handlers and state. |
| 63 | + |
| 64 | + |
| 65 | +### React.renderComponentToString |
| 66 | + |
| 67 | +```javascript |
| 68 | +renderComponentToString(ReactComponent component, function callback) |
| 69 | +``` |
| 70 | + |
| 71 | +Render a component to its initial HTML. This should only be used on the server. React will call `callback` with an HTML string when the markup is ready. You can use this method to can 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. |
| 72 | + |
| 73 | +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. |
0 commit comments