mirror of
https://github.com/facebook/react.git
synced 2025-11-01 09:12:30 +00:00
Dan Abramov
464 lines
17 KiB
HTML
464 lines
17 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<!--[if IE]><![endif]-->
|
||
<html>
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||
<title>ReactDOM - React</title>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<meta property="og:title" content="ReactDOM - React">
|
||
<meta property="og:type" content="website">
|
||
<meta property="og:url" content="https://facebook.github.io/react/docs/react-dom.html">
|
||
<meta property="og:image" content="https://facebook.github.io/react/img/logo_og.png">
|
||
<meta property="og:description" content="A JavaScript library for building user interfaces">
|
||
<meta property="fb:app_id" content="623268441017527">
|
||
|
||
<link rel="shortcut icon" href="/react/favicon.ico">
|
||
<link rel="alternate" type="application/rss+xml" title="React" href="https://facebook.github.io/react/feed.xml">
|
||
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/1/docsearch.min.css" />
|
||
<link rel="stylesheet" href="/react/css/syntax.css">
|
||
<link rel="stylesheet" href="/react/css/codemirror.css">
|
||
<link rel="stylesheet" href="/react/css/react.css">
|
||
|
||
<script src="//use.typekit.net/vqa1hcx.js"></script>
|
||
<script>try{Typekit.load();}catch(e){}</script>
|
||
|
||
<!--[if lte IE 8]>
|
||
<script src="https://unpkg.com/html5shiv@3.7.3/dist/html5shiv.min.js"></script>
|
||
<script src="https://unpkg.com/es5-shim@4.5.9/es5-shim.min.js"></script>
|
||
<script src="https://unpkg.com/es5-shim@4.5.9/es5-sham.min.js"></script>
|
||
<![endif]-->
|
||
<script src="https://unpkg.com/docsearch.js@1.5.0/dist/cdn/docsearch.min.js"></script>
|
||
<script src="https://unpkg.com/codemirror@5.15.2"></script>
|
||
<script src="https://unpkg.com/codemirror@5.15.2/mode/javascript/javascript.js"></script>
|
||
<script src="https://unpkg.com/codemirror@5.15.2/mode/xml/xml.js"></script>
|
||
<script src="https://unpkg.com/codemirror@5.15.2/mode/jsx/jsx.js"></script>
|
||
<script src="https://unpkg.com/react/dist/react.min.js"></script>
|
||
<script src="https://unpkg.com/react-dom/dist/react-dom.min.js"></script>
|
||
<script src="https://unpkg.com/babel-standalone@6.15.0/babel.min.js"></script>
|
||
<script src="/react/js/live_editor.js"></script>
|
||
</head>
|
||
<body>
|
||
|
||
<div class="container">
|
||
|
||
<div class="nav-main">
|
||
<div class="wrap">
|
||
<a class="nav-home" href="/react/">
|
||
<img class="nav-logo" src="/react/img/logo.svg" width="36" height="36">
|
||
React
|
||
</a>
|
||
<div class="nav-lists">
|
||
<ul class="nav-site nav-site-internal">
|
||
<li><a href="/react/docs/hello-world.html" class="active">Docs</a></li>
|
||
<li><a href="/react/tutorial/tutorial.html">Tutorial</a></li>
|
||
<li><a href="/react/community/support.html">Community</a></li>
|
||
<li><a href="/react/blog/">Blog</a></li>
|
||
<li class="nav-site-search">
|
||
<input id="algolia-doc-search" type="text" placeholder="Search docs..." />
|
||
</li>
|
||
</ul>
|
||
<ul class="nav-site nav-site-external">
|
||
<li><a href="https://github.com/facebook/react">GitHub</a></li>
|
||
<li><a href="https://github.com/facebook/react/releases">v15.6.1</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<section class="content wrap documentationContent">
|
||
<div class="inner-content">
|
||
<a class="edit-page-link" href="https://github.com/facebook/react/tree/master/docs/docs/reference-react-dom.md" target="_blank">Edit on GitHub</a>
|
||
<h1>
|
||
ReactDOM
|
||
</h1>
|
||
<div class="subHeader"></div>
|
||
|
||
<p>If you load React from a <code><script></code> tag, these top-level APIs are available on the <code>ReactDOM</code> global. If you use ES6 with npm, you can write <code>import ReactDOM from 'react-dom'</code>. If you use ES5 with npm, you can write <code>var ReactDOM = require('react-dom')</code>.</p>
|
||
|
||
<h2>Overview</h2>
|
||
|
||
<p>The <code>react-dom</code> package provides DOM-specific methods that can be used at the top level of your app and as an escape hatch to get outside of the React model if you need to. Most of your components should not need to use this module.</p>
|
||
|
||
<ul>
|
||
<li><a href="#render"><code>render()</code></a></li>
|
||
<li><a href="#unmountcomponentatnode"><code>unmountComponentAtNode()</code></a></li>
|
||
<li><a href="#finddomnode"><code>findDOMNode()</code></a></li>
|
||
</ul>
|
||
|
||
<h3>Browser Support</h3>
|
||
|
||
<p>React supports all popular browsers, including Internet Explorer 9 and above.</p>
|
||
|
||
<blockquote>
|
||
<p>Note</p>
|
||
|
||
<p>We don't support older browsers that don't support ES5 methods, but you may find that your apps do work in older browsers if polyfills such as <a href="https://github.com/es-shims/es5-shim">es5-shim and es5-sham</a> are included in the page. You're on your own if you choose to take this path.</p>
|
||
</blockquote>
|
||
|
||
<hr>
|
||
|
||
<h2>Reference</h2>
|
||
|
||
<h3><code>render()</code></h3>
|
||
<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="nx">ReactDOM</span><span class="p">.</span><span class="nx">render</span><span class="p">(</span>
|
||
<span class="nx">element</span><span class="p">,</span>
|
||
<span class="nx">container</span><span class="p">,</span>
|
||
<span class="p">[</span><span class="nx">callback</span><span class="p">]</span>
|
||
<span class="p">)</span>
|
||
</code></pre></div>
|
||
<p>Render a React element into the DOM in the supplied <code>container</code> and return a <a href="/react/docs/more-about-refs.html">reference</a> to the component (or returns <code>null</code> for <a href="/react/docs/components-and-props.html#functional-and-class-components">stateless components</a>).</p>
|
||
|
||
<p>If the React element was previously rendered into <code>container</code>, this will perform an update on it and only mutate the DOM as necessary to reflect the latest React element.</p>
|
||
|
||
<p>If the optional callback is provided, it will be executed after the component is rendered or updated.</p>
|
||
|
||
<blockquote>
|
||
<p>Note:</p>
|
||
|
||
<p><code>ReactDOM.render()</code> controls the contents of the container node you pass in. Any existing DOM elements inside are replaced when first called. Later calls use React’s DOM diffing algorithm for efficient updates.</p>
|
||
|
||
<p><code>ReactDOM.render()</code> does not modify the container node (only modifies the children of the container). It may be possible to insert a component to an existing DOM node without overwriting the existing children.</p>
|
||
|
||
<p><code>ReactDOM.render()</code> currently returns a reference to the root <code>ReactComponent</code> 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 <code>ReactComponent</code> instance, the preferred solution is to attach a
|
||
<a href="/react/docs/more-about-refs.html#the-ref-callback-attribute">callback ref</a> to the root element.</p>
|
||
</blockquote>
|
||
|
||
<hr>
|
||
|
||
<h3><code>unmountComponentAtNode()</code></h3>
|
||
<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="nx">ReactDOM</span><span class="p">.</span><span class="nx">unmountComponentAtNode</span><span class="p">(</span><span class="nx">container</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
<p>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 <code>true</code> if a component was unmounted and <code>false</code> if there was no component to unmount.</p>
|
||
|
||
<hr>
|
||
|
||
<h3><code>findDOMNode()</code></h3>
|
||
<div class="highlight"><pre><code class="language-javascript" data-lang="javascript"><span class="nx">ReactDOM</span><span class="p">.</span><span class="nx">findDOMNode</span><span class="p">(</span><span class="nx">component</span><span class="p">)</span>
|
||
</code></pre></div>
|
||
<p>If this component has been mounted into the DOM, this returns the corresponding native browser DOM element. This method is useful for reading values out of the DOM, such as form field values and performing DOM measurements. <strong>In most cases, you can attach a ref to the DOM node and avoid using <code>findDOMNode</code> at all.</strong> When <code>render</code> returns <code>null</code> or <code>false</code>, <code>findDOMNode</code> returns <code>null</code>.</p>
|
||
|
||
<blockquote>
|
||
<p>Note:</p>
|
||
|
||
<p><code>findDOMNode</code> is an escape hatch used to access the underlying DOM node. In most cases, use of this escape hatch is discouraged because it pierces the component abstraction.</p>
|
||
|
||
<p><code>findDOMNode</code> only works on mounted components (that is, components that have been placed in the DOM). If you try to call this on a component that has not been mounted yet (like calling <code>findDOMNode()</code> in <code>render()</code> on a component that has yet to be created) an exception will be thrown.</p>
|
||
|
||
<p><code>findDOMNode</code> cannot be used on functional components.</p>
|
||
</blockquote>
|
||
|
||
|
||
<div class="docs-prevnext">
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div class="nav-docs">
|
||
<!-- Docs Nav -->
|
||
|
||
<div class="nav-docs-section">
|
||
<h3>Quick Start</h3>
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/react/docs/installation.html">Installation</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/hello-world.html">Hello World</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/introducing-jsx.html">Introducing JSX</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/rendering-elements.html">Rendering Elements</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/components-and-props.html">Components and Props</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/state-and-lifecycle.html">State and Lifecycle</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/handling-events.html">Handling Events</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/conditional-rendering.html">Conditional Rendering</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/lists-and-keys.html">Lists and Keys</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/forms.html">Forms</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/lifting-state-up.html">Lifting State Up</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/composition-vs-inheritance.html">Composition vs Inheritance</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/thinking-in-react.html">Thinking In React</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="nav-docs-section">
|
||
<h3>Advanced Guides</h3>
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/react/docs/jsx-in-depth.html">JSX In Depth</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/typechecking-with-proptypes.html">Typechecking With PropTypes</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/refs-and-the-dom.html">Refs and the DOM</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/uncontrolled-components.html">Uncontrolled Components</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/optimizing-performance.html">Optimizing Performance</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/react-without-es6.html">React Without ES6</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/react-without-jsx.html">React Without JSX</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/reconciliation.html">Reconciliation</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/context.html">Context</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/web-components.html">Web Components</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/higher-order-components.html">Higher-Order Components</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/integrating-with-other-libraries.html">Integrating with Other Libraries</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/accessibility.html">Accessibility</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="nav-docs-section">
|
||
<h3>Reference</h3>
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/react/docs/react-api.html">React</a>
|
||
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/react/docs/react-component.html">React.Component</a>
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/react-dom.html" class="active">ReactDOM</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/react-dom-server.html">ReactDOMServer</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/dom-elements.html">DOM Elements</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/events.html">SyntheticEvent</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/test-utils.html">Test Utilities</a>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/docs/shallow-renderer.html">Shallow Renderer</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
<!-- Contributing Nav -->
|
||
|
||
<div class="nav-docs-section">
|
||
<h3>Contributing</h3>
|
||
<ul>
|
||
|
||
<li>
|
||
<a href="/react/contributing/how-to-contribute.html">How to Contribute</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/contributing/codebase-overview.html">Codebase Overview</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/contributing/implementation-notes.html">Implementation Notes</a>
|
||
</li>
|
||
|
||
<li>
|
||
<a href="/react/contributing/design-principles.html">Design Principles</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
</section>
|
||
|
||
|
||
<footer class="nav-footer">
|
||
<section class="sitemap">
|
||
<a href="/react/" class="nav-home">
|
||
</a>
|
||
<div>
|
||
<h5><a href="/react/docs/">Docs</a></h5>
|
||
<a href="/react/docs/hello-world.html">Quick Start</a>
|
||
<a href="/react/docs/thinking-in-react.html">Thinking in React</a>
|
||
<a href="/react/tutorial/tutorial.html">Tutorial</a>
|
||
<a href="/react/docs/jsx-in-depth.html">Advanced Guides</a>
|
||
</div>
|
||
<div>
|
||
<h5><a href="/react/community/support.html">Community</a></h5>
|
||
<a href="http://stackoverflow.com/questions/tagged/reactjs" target="_blank">Stack Overflow</a>
|
||
<a href="https://discuss.reactjs.org/" target="_blank">Discussion Forum</a>
|
||
<a href="https://discord.gg/0ZcbPKXt5bZjGY5n" target="_blank">Reactiflux Chat</a>
|
||
<a href="https://www.facebook.com/react" target="_blank">Facebook</a>
|
||
<a href="https://twitter.com/reactjs" target="_blank">Twitter</a>
|
||
</div>
|
||
<div>
|
||
<h5><a href="/react/community/support.html">Resources</a></h5>
|
||
<a href="/react/community/conferences.html">Conferences</a>
|
||
<a href="/react/community/videos.html">Videos</a>
|
||
<a href="https://github.com/facebook/react/wiki/Examples" target="_blank">Examples</a>
|
||
<a href="https://github.com/facebook/react/wiki/Complementary-Tools" target="_blank">Complementary Tools</a>
|
||
</div>
|
||
<div>
|
||
<h5>More</h5>
|
||
<a href="/react/blog/">Blog</a>
|
||
<a href="https://github.com/facebook/react" target="_blank">GitHub</a>
|
||
<a href="http://facebook.github.io/react-native/" target="_blank">React Native</a>
|
||
<a href="/react/acknowledgements.html">Acknowledgements</a>
|
||
</div>
|
||
</section>
|
||
<a href="https://code.facebook.com/projects/" target="_blank" class="fbOpenSource">
|
||
<img src="/react/img/oss_logo.png" alt="Facebook Open Source" width="170" height="45"/>
|
||
</a>
|
||
<section class="copyright">
|
||
Copyright © 2017 Facebook Inc.
|
||
</section>
|
||
</footer>
|
||
|
||
</div>
|
||
|
||
<div id="fb-root"></div>
|
||
<script src="/react/js/anchor-links.js"></script>
|
||
<script>
|
||
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
||
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
||
ga('create', 'UA-41298772-1', 'facebook.github.io');
|
||
ga('send', 'pageview');
|
||
|
||
!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="https://platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");
|
||
|
||
(function(d, s, id) {
|
||
var js, fjs = d.getElementsByTagName(s)[0];
|
||
if (d.getElementById(id)) return;
|
||
js = d.createElement(s); js.id = id;
|
||
js.src = "//connect.facebook.net/en_US/sdk.js#xfbml=1&version=v2.6&appId=623268441017527";
|
||
fjs.parentNode.insertBefore(js, fjs);
|
||
}(document, 'script', 'facebook-jssdk'));
|
||
|
||
docsearch({
|
||
apiKey: '36221914cce388c46d0420343e0bb32e',
|
||
indexName: 'react',
|
||
inputSelector: '#algolia-doc-search'
|
||
});
|
||
</script>
|
||
</body>
|
||
</html>
|