Document return value of unmountComponentAtNode
Ben Alpert committed
Jan 8, 2014 at 21:56 UTC
87a95155beb39cae9892897489b8349493018054
1 file changed
+4
-4
docs/docs/ref-01-top-level-api.md
+4
-4
@@ -31,7 +31,7 @@ Configure React's event system to handle touch events on mobile devices.
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.
34
+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.
35
36
For more information about the specification object, see [Component Specs and Lifecycle](/react/docs/component-specs.html).
37
@@ -46,7 +46,7 @@ ReactComponent renderComponent(
46
)
47
```
48
49
-Renders a React component into the DOM in the supplied `container`.
49
+Render 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
@@ -56,10 +56,10 @@ If the optional callback is provided, it will be executed after the component is
56
### React.unmountComponentAtNode
57
58
```javascript
59
-unmountComponentAtNode(DOMElement container)
59
+boolean unmountComponentAtNode(DOMElement container)
60
```
61
62
-Remove a mounted React component from the DOM and clean up its event handlers and state.
62
+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.
63
64
> Note:
65
>