API 参考

¥API Reference

此参考尝试记录 React Flow 导出的每个函数、钩子、组件和类型。如果你正在寻找指南和教程，请参阅我们的 学习部分。

¥This reference attempts to document every function, hook, component, and type exported by React Flow. If you are looking for guides and tutorials, please refer to our learn section.

如何使用此参考

¥How to use this reference

我们认为文档应该回答两个大问题：“这是什么东西？” 和 “如何使用它？”

¥We think that documentation should answer two broad questions: “what is this thing?” and “how do I use it?”

为此，我们的 API 参考旨在简明扼要地回答第一个问题，学习部分将更详细地介绍第二个问题。如果你发现自己在点击参考资料时想知道这到底是什么意思，也许我们有一个指南可以帮助你！

¥To that end, our API reference aims to concisely answer that first question and learn section goes into more detail on the second. If you find yourself clicking around the reference wondering what the heck any of this means, maybe we have a guide that can help you out!

长期用户须知

¥A note for our long-term users

如果你是从我们的旧 API 页面转到此处，情况可能会有所不同！我们重新组织了我们的文档，如果你知道要查找的内容，可以更轻松地查找内容。我们所有的类型、组件、钩子和实用函数现在都有自己的页面，以帮助你准确找到所需的内容。

¥If you’re coming here from our old API pages things might look a bit different! We’ve reorganized our documentation to make it easier to look things up if you know what you’re looking for. All our types, components, hooks, and util functions get their own page now to help you find exactly what you need.

如果你是 React Flow 的新手，或者不确定在哪里查找某些内容，请查看下面的部分。

¥If you’re new to React Flow or you’re not sure where to look for something, take a look at the section below.

JavaScript 用户须知

¥A note for JavaScript users

React Flow 是用 TypeScript 编写的，但我们知道并不是每个人都使用它。我们鼓励开发者使用最适合他们的技术，并且在我们的整个文档中都有 TypeScript 和 JavaScript 示例的混合。

¥React Flow is written in TypeScript, but we know that not everyone uses it. We encourage developers to use the technology that works best for them, and throughout our documentation there is a blend of TypeScript and JavaScript examples.

但是，对于我们的 API 参考，我们使用 TypeScript 的语法来记录 props 和函数的类型。以下是有关如何阅读它的速成课程：

¥For our API reference, however, we use TypeScript’s syntax to document the types of props and functions. Here’s a quick crash course on how to read it:

• ? 表示字段或参数是可选的。

¥• ? means that the field or argument is optional.

• 类型定义中的 <T> 表示泛型类型参数。就像函数参数一样，但用于类型！定义 type Array<T> = ... 表示一种名为 Array 的类型，它采用通用类型参数 T。

¥• <T> in a type definition represents a generic type parameter. Like a function argument but for types! The definition type Array<T> = ... means a type called Array that takes a generic type parameter T.

• <T> 在引用类型时就像 “填写” 一样是泛型类型参数。这就像调用函数，但针对类型！类型 Array<number> 是类型 Array，通用类型参数 T 用类型 number 填充。

¥• <T> when referring to a type is like “filling in” a generic type parameter. It’s like calling a function but for types! The type Array<number> is the type Array with the generic type parameter T filled in with the type number.

• T | U 表示类型是 T 或 U：这通常称为并集。

¥• T | U means that the type is either T or U: this is often called a union.

• T & U 表示类型是 T 和 U：这通常称为交集。

¥• T & U means that the type is both T and U: this is often called an intersection.

TypeScript 人员有自己的 阅读类型的便捷指南 ，你可能会觉得有用。如果你仍然遇到问题，请随时访问我们的 Discord  并寻求帮助！

¥The TypeScript folks have their own handy guide for reading types  that you might find useful. If you’re still stuck on something, feel free to drop by our Discord  and ask for help!