API リファレンス
このリファレンスは、Svelte Flow によってエクスポートされたすべての関数、フック、コンポーネント、および型を文書化することを試みています。ガイドをお探しの場合は、学習セクションをご覧ください。
このパッケージは現在アルファ版であり、活発に開発中です。 API は変更される可能性があります。最新の変更点については、「新着情報」セクションをご覧ください。
このリファレンスの使用方法
ドキュメントは、「これは何ですか？」と「どのように使用しますか？」という 2 つの大きな質問に答える必要があると考えています。
そのため、私たちの API リファレンスは、最初の質問に**簡潔に**答えることを目的としており、ガイドでは 2 番目の質問について詳しく説明しています。リファレンスをクリックして、これが何を意味するのか疑問に思っている場合は、役に立つガイドがあるかもしれません！
カスタムノード
Svelte Flow の強力な機能は、カスタムノードを追加できることです。カスタムノード内では、必要なものをすべてレンダリングできます。複数のソースハンドルとターゲットハンドルを定義し、たとえばフォーム入力やチャートをレンダリングできます。このガイドでは、アプリケーションの別の部分のテキストを更新する入力フィールドを持つノードを実装します。
続きを読むサブフロー
これはフロー内のフローですか？ はい！ フローの一部をグループとして、または単一のノードとして扱う場合があります。これは、サブフローが作用するところです。このガイドでは、ノード間に親子関係を作成し、さまざまなタイプのサブフローを実装する方法を学習します。
続きを読むJavaScript ユーザーへの注意
Svelte 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 にアクセスしてヘルプを求めてください！