APIリファレンス
このリファレンスでは、React Flowによってエクスポートされるすべての関数、フック、コンポーネント、および型を文書化しようと試みています。ガイドとチュートリアルをお探しの方は、学習セクションを参照してください。
このリファレンスの使用方法
ドキュメントは、「これは何か？」と「どのように使うのか？」という2つの大きな質問に答えるべきだと考えています。
そのため、APIリファレンスでは最初の質問に簡潔に答え、学習セクションでは2番目の質問について詳しく説明しています。リファレンスを閲覧していても意味が分からなくなったら、役立つガイドがあるかもしれません！
カスタムノード
React Flowの強力な機能の1つに、カスタムノードを追加する機能があります。カスタムノード内では、必要なものをすべてレンダリングできます。複数のソースとターゲットハンドルを定義し、たとえばフォーム入力やチャートをレンダリングできます。このガイドでは、アプリケーションの別の部分でテキストを更新する入力フィールドを持つノードを実装します。
詳細はこちらレイアウト
React Flowでのレイアウト処理方法について、頻繁に質問されます。React Flowに基本的なレイアウト機能を組み込むこともできますが、アプリケーションの要件を最もよく理解しているのは皆さんだと考えており、多くの選択肢があるため、最適なツールを選択することをお勧めします。このガイドでは、4つのレイアウトライブラリとそれらの使用方法について説明します。
詳細はこちら長年のユーザーの皆様へ
以前のAPIページからご覧になっている場合、少し見た目が異なるかもしれません！検索しやすくするためにドキュメントを再編成しました。すべての型、コンポーネント、フック、およびユーティリティ関数は、必要なものを見つけやすくするために、それぞれ独自のページを持つようになりました。
React Flowを初めて使用する方、または何かを探す場所がわからない場合は、以下のセクションをご覧ください。
JavaScriptユーザーの皆様へ
React FlowはTypeScriptで記述されていますが、全員がTypeScriptを使用しているわけではありません。開発者は自分に最適なテクノロジーを使用することをお勧めしており、ドキュメント全体ではTypeScriptとJavaScriptの例が混在しています。
ただし、APIリファレンスでは、プロパティと関数の型を文書化するためにTypeScriptの構文を使用しています。簡単な概要を以下に示します。
• ? は、フィールドまたは引数がオプションであることを意味します。
• 型定義内の<T>は、ジェネリック型パラメーターを表します。関数の引数に似ていますが、型用です！定義type Array<T> = ...は、ジェネリック型パラメーターTを取るArrayという型を意味します。
• 型を参照する際の<T>は、ジェネリック型パラメーターを「埋め込む」ようなものです。関数を呼び出すようなものですが、型用です！型Array<number>は、ジェネリック型パラメーターTに型numberを埋め込んだArray型です。
• T | Uは、型がTまたはUのいずれかであることを意味します。これは多くの場合、*ユニオン*と呼ばれます。
• T & Uは、型がTとUの両方であることを意味します。これは多くの場合、*インターセクション*と呼ばれます。
TypeScriptチームが作成した、型の読み方の便利なガイドがありますので、ご活用ください。それでも何か詰まった場合は、お気軽にDiscordにご参加いただき、ご質問ください！