We want to hear from you!Take our 2021 Community Survey!

ReactDOM

react-dom パッケージではアプリのトップレベルで使うための DOM 特有のメソッドを提供しています。また必要に応じて React モデルから外に出るための避難ハッチ用メソッドも提供しています。

import * as ReactDOM from 'react-dom';

npm で ES5 を使っている場合は、以下のように書けます:

var ReactDOM = require('react-dom');

react-dom パッケージはクライアント専用モジュールとサーバ専用モジュールも提供しています。

概要

react-dom パッケージは以下のメソッドをエクスポートしています:

以下の react-dom メソッドもエクスポートされていますが、これらはレガシーです:

補足:

renderhydrate は React 18 でいずれも新しいクライアントメソッドに置き換わりました。これらのメソッドを使った場合、React 17 と同様の動作となってしまう、という警告を表示します(詳細はこちら).

ブラウザサポート

React はすべてのモダンブラウザをサポートしていますが、古いバージョンを使う場合はいくつかのポリフィルが必要です。

補足

React は ES5 メソッドやマイクロタスクをサポートしていない Internet Explorer のような古いブラウザをサポートしていません。ページ内に es5-shim や es5-sham のようなポリフィルが含まれている場合、古いブラウザでもアプリケーションが動作することがありますが、この手段を選択するかどうかは自己責任で判断してください。

リファレンス

createPortal()

createPortal(child, container)

ポータルを作成します。ポータルは DOM コンポーネントの階層の外側に存在している DOM ノードに対して子要素をレンダーする方法を提供します。

flushSync()

flushSync(callback)

渡されたコールバック内の更新をすべて同期的に処理するよう強制します。これにより DOM が即座に更新されることが保証されます。

// Force this state update to be synchronous.
flushSync(() => {
  setCount(count + 1);
});
// By this point, DOM is updated.

補足:

flushSync はパフォーマンスを有意に低下させうるものです。慎重に使ってください。

flushSync によって保留中のサスペンスバウンダリは強制的に fallback 状態を表示するようになります。

flushSync は return する前に保留中の副作用も実行し、その内部にあるあらゆる更新を同期的に適用します。

flushSync はコールバック内の更新を適用するのに必要であれば渡されたコールバック外の更新も処理する可能性があります。例えば、クリックによって引き起こされた保留中の更新が既に存在する場合、React はコールバック内の更新を処理する前に先にそれらを処理します。

レガシーメソッドのリファレンス

render()

render(element, container[, callback])

補足:

render は React 18 で createRoot に置き換わりました。詳細は createRoot を参照してください。

渡された container の DOM に React 要素をレンダーし、コンポーネントへの参照ステートレスコンポーネントの場合は null)を返します。

React 要素がすでに container にレンダーされている場合は更新を行い、最新の React 要素を反映するために必要な DOM のみを変更します。

オプションのコールバックが渡されている場合は、コンポーネントがレンダーまたは更新された後に実行されます。

補足:

render() は与えられたコンテナの内容を制御します。コンテナ内部のあらゆる既存の DOM 要素は、最初に呼び出された時に置き換えられます。後続する呼び出しでは効率的な更新のために React の DOM 差分アルゴリズムを使用します。

render() はコンテナノードを変更しません(コンテナの子要素のみ変更します)。既存の子要素を上書きせずにコンポーネントを既存の DOM ノードに挿入することが可能な場合があります。

render() は現時点ではルートの ReactComponent インスタンスへの参照を返します。 しかし、この戻り値を使用する方法は古く、将来のバージョンの React では一部のケースで非同期にコンポーネントをレンダーするようになる可能性があるため、使用は避けるべきです。 ルートの ReactComponent インスタンスへの参照が必要な場合は、ルート要素にコールバック形式の ref を追加することを推奨します。

サーバで描画されたコンテナをクライアントで再利用するために ReactDOM.render() を使用することは非推奨となっています。代わりに hydrateRoot() を使用してください。


hydrate()

hydrate(element, container[, callback])

Note:

hydrate は React 18 で hydrateRoot に置き換わりました。詳細は hydrateRoot を参照してください。

render() と同様ですが、ReactDOMServer により HTML コンテンツが描画されたコンテナをクライアントで再利用する(ハイドレーション)ために使用されます。React は既存のマークアップにイベントリスナをアタッチしようとします。

React はレンダーされる内容が、サーバ・クライアント間で同一であることを期待します。React はテキストコンテンツの差異を修復することは可能ですが、その不一致はバグとして扱い、修正すべきです。開発用モードでは、React は両者のレンダーの不一致について警告します。不一致がある場合に属性の差異が修復されるという保証はありません。これはパフォーマンス上の理由から重要です。なぜなら、ほとんどのアプリケーションにおいて不一致が発生するということは稀であり、全てのマークアップを検証することは許容不可能なほど高コストになるためです。

単一要素の属性やテキストコンテンツがサーバ・クライアント間においてやむを得ず異なってしまう場合(例えばタイムスタンプなど)、要素に suppressHydrationWarning={true} を追加することで警告の発生を停止させることが可能です。それは 1 階層下の要素までで機能するものであり、また避難ハッチとして使われるものです。そのため、多用しないでください。テキストコンテンツでない限り、React は修復を試行しようとはしないため、将来の更新まで不整合が残る可能性があります。

サーバとクライアントで異なるものをレンダーしたい場合は、2 パスレンダーを使用できます。クライアント側で異なるものをレンダーするコンポーネントでは、this.state.isClient のような state 変数を読み込み、componentDidMount()true を設定することができます。こうすると、最初のレンダーパスではサーバ側と同一の内容を描画して不一致を回避しますが、追加のパスが初回レンダーの直後に同期的に発生します。このアプローチでは 2 回レンダーが発生することによりコンポーネントのパフォーマンスが低下しますので、注意して使用してください。

低速な接続下でのユーザ体験に留意することを忘れないでください。JavaScript のコードは初回の HTML の描画より大幅に遅れてロードされる可能性があるため、クライアントでのみ何か異なるものを描画した場合、その変化は不快感を与える可能性があります。しかしうまく実行されれば、サーバ上でアプリケーションの「外枠」を描画し、クライアント上でのみ追加のウィジェットを表示することは有益になるかもしれません。マークアップの不一致の問題を発生させずにこれを実行する方法については、前の段落の説明をご参照ください。


unmountComponentAtNode()

unmountComponentAtNode(container)

補足:

unmountComponentAtNode は React 18 で root.unmount() に置き換わりました。詳細は createRoot を参照してください。

DOM からマウントされた React コンポーネントを削除し、イベントハンドラや state をクリーンアップします。コンテナにコンポーネントがマウントされていない場合、このメソッドを呼び出しても何も行いません。コンポーネントがアンマウントされた場合は true を返し、アンマウントすべきコンポーネントが存在しなかった場合は false を返します。


findDOMNode()

補足:

findDOMNode は内在する DOM ノードにアクセスするために使用される避難ハッチです。ほとんどのケースにおいて、この避難ハッチの使用はコンポーネントの抽象化に穴を開けてしまうためおすすめしません。StrictMode では非推奨になっています。

findDOMNode(component)

DOM にこのコンポーネントがマウントされている場合、このメソッドは対応するネイティブブラウザの DOM 要素を返します。このメソッドはフォームフィールドの値や DOM の大きさを計測するのに便利です。ほとんどのケースにおいて、DOM ノードに ref をアタッチすることで findDOMNode の使用を避けることができます。

コンポーネントが nullfalse をレンダーする場合、findDOMNodenull を返します。コンポーネントが文字列をレンダーする場合、findDOMNode はその値を含んだテキスト DOM ノードを返します。React 16 以降、コンポーネントは複数の子要素を含むフラグメントを返すことがありますが、その場合 findDOMNode は最初の空でない子要素に対応する DOM ノードを返します。

補足:

findDOMNode はマウントされたコンポーネントに対してのみ機能します(つまり、DOM に配置されたコンポーネント)。まだマウントされていないコンポーネントにおいてこのメソッドを呼ぼうとする場合(まだ作成されていないコンポーネントにおける render() の中で findDOMNode() を呼びだす場合など)、例外がスローされます。

findDOMNode は関数コンポーネントでは使用できません。


Is this page useful?このページを編集する