參考API 參考

API 參考

此參考旨在記錄 React Flow 輸出的每個函式、Hook、元件和類型。如果您正在尋找指南和教學,請參閱我們的學習章節

如何使用此參考

我們認為文件應回答兩個廣泛的問題:「這是什麼?」和「我該如何使用它?」

為此,我們的 API 參考旨在簡潔地回答第一個問題,而學習章節則會更詳細地探討第二個問題。如果您發現自己在參考資料中點來點去,想知道這些到底是什麼意思,也許我們有指南可以幫助您!

給長期使用者的注意事項

如果您是從我們舊的 API 頁面來到這裡,可能會覺得有些不同!我們重新整理了文件,如果您知道自己在尋找什麼,可以更輕鬆地查找。我們所有的類型、元件、Hook 和實用工具函式現在都有自己的頁面,以協助您找到您需要的確切內容。

如果您是 React Flow 的新手,或不確定要在哪裡尋找,請查看以下章節。

給 JavaScript 使用者的注意事項

React Flow 是用 TypeScript 編寫的,但我們知道並非所有人都在使用它。我們鼓勵開發人員使用最適合他們的技術,並且在我們的文件中,TypeScript 和 JavaScript 的範例並存。

然而,對於我們的 API 參考,我們使用 TypeScript 的語法來記錄 props 和函式的類型。以下是如何閱讀它的快速入門課程

?表示欄位或引數是選填的。

• 類型定義中的 <T> 表示泛型類型參數。就像函式引數,但用於類型!定義 type Array<T> = ... 表示一個名為 Array 的類型,它接受泛型類型參數 T

• 引用類型時的 <T> 就像「填入」泛型類型參數。它就像呼叫函式,但用於類型!類型 Array<number> 是類型 Array,其中泛型類型參數 T 填入類型 number

T | U 表示類型為 TU:這通常稱為聯集

T & U 表示類型同時為 TU:這通常稱為交集

TypeScript 的人員有他們自己的閱讀類型的實用指南,您可能會覺得有用。如果您仍然對某些事情感到困惑,請隨時加入我們的Discord 並尋求協助!