OSSForks/react
1
0
Fork 0
mirror of https://github.com/zebrajr/react.git synced 2026-01-15 12:15:22 +00:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

Merge pull request #6400 from jimfb/return-value-legacy

Browse Source 
Document legacyness of the return value of ReactDOM.render()
This commit is contained in:
Jim
2016-04-07 14:03:56 -07:00
parent 62f64a84a4 ceb377254a
commit 1dc7c581db
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/docs/ref-01-top-level-api.md
View File

@@ -139,7 +139,7 @@ The `react-dom` package provides DOM-specific methods that can be used at the to
### ReactDOM.render
```javascript
ReactComponent render(
render(
ReactElement element,
DOMElement container,
[function callback]
@@ -161,6 +161,10 @@ If the optional callback is provided, it will be executed after the component is
> `ReactDOM.render()` does not modify the container node (only modifies the children of the container). In
> the future, it may be possible to insert a component to an existing DOM node without overwriting
> the existing children.
>
> `ReactDOM.render()` currently returns a reference to the root `ReactComponent` instance. However, using this return value is legacy
> and should be avoided because future versions of React may render components asynchronously in some cases. If you need a reference to the root `ReactComponent` instance, the preferred solution is to attach a
> [callback ref](/react/docs/more-about-refs.html#the-ref-callback-attribute) to the root element.
### ReactDOM.unmountComponentAtNode