简介

ExtReact 产品的文档与其他 Sencha 产品的文档略有不同。以下部分描述了除 ExtReact 独有部分以外的所有产品的文档。

术语、图标和标签

许多类在使用配置对象创建（实例化）类时使用快捷名称。快捷名称称为 别名（如果类扩展了 Ext.Component，则称为 xtype）。别名/xtype 列在适用类的类名称旁边，以便快速参考。

ExtReact 组件类在 API 类文档的顶部突出显示可配置名称，后跟完全限定的类名称。

访问级别

框架类或其成员可以指定为 private 或 protected。否则，类/成员为 public。Public、protected 和 private 是访问描述符，用于传达类或类成员的使用方式和时间。

• Public 类和类成员可供任何其他类或应用程序代码使用，并且可以作为主要产品版本中稳定且持久的部分来依赖。公共类和成员可以通过子类安全地扩展。

• Protected 类成员是稳定的 public 成员，旨在供拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。

• Private 类和类成员由框架内部使用，不打算供应用程序开发人员使用。私有类和成员可能会随时更改或从框架中省略，恕不另行通知，并且不应在应用程序逻辑中依赖它们。

成员类型

• Config - 类的配置选项。

  ExtReact 组件类将配置选项显示为 props

• Property - 在实例化类后设置一次。*请参阅下面的只读。

  ExtReact 组件类不将属性列为专用成员类型，而是作为 read only props

• Method - 类可以执行的操作。方法应被视为实例方法，只能从给定类的实例调用。可以直接从类本身调用的静态方法将在方法名称旁边有一个 static 标签。*请参阅下面的静态。
• Event - 事件特定于框架事件系统，允许类以编程方式引发事件，由一个或多个事件处理程序方法处理。DOM 事件虽然由框架事件系统处理，但不会在 API 文档中专门描述。*有关 DOM 事件，请参阅 MDN 的 事件参考 页面。
• Theme Variable - 框架使用的视觉主题引擎使用的变量。
• Theme Mixin - 框架使用的视觉主题引擎使用的函数，可以使用各种主题变量中设置的值。

成员语法

以下是一个示例类成员，我们可以对其进行分析以显示类成员的语法（在本例中，从 Ext.button.Button 类中查看的 lookupComponent 方法）。

让我们看看成员行的每个部分

• 展开/折叠 - 在成员行的左侧是一个用于展开和折叠每个成员行以显示/隐藏成员详细信息的控件。
• 成员名称 - 类成员的名称（在本例中为lookupComponent）
• 方法参数 - 方法（或传递给事件处理程序方法）使用的任何必需或可选参数都将在方法名称旁边列出，括号内（在本例中为( item )）
• 返回类型 - 方法或属性返回的类实例或 JavaScript 对象（在本例中为Ext.Component）。对于不返回任何内容（除了undefined）的方法，这可以省略，或者可以显示为用正斜杠/分隔的多个可能值，表示返回的内容可能取决于方法调用的结果（例如，如果 get 方法调用成功，则方法可能返回一个组件，如果失败则返回false，这将显示为Ext.Component/Boolean）。
• 标志 - 适用于该成员的任何标志都将在旁边显示（在本例中为PROTECTED - 请参阅下面的标志部分）
• 成员来源 - 在成员行的右侧是最初描述该成员的类（在本例中为Ext.container.Container）。如果成员来自当前类，则源类将显示为蓝色链接，如果它从祖先类或混合类继承，则显示为灰色。
• 成员源代码 - 在成员来源类下方右侧是一个用于查看成员源代码的链接（在本例中为view source）
• 参数列表 - 类方法的每个参数都将使用上面括号中找到的相同名称、预期类或对象的类型以及参数的描述列出（在本例中为item : Object）。
• 返回值 - 如果类返回的值不是undefined，则“返回值”部分将记录返回的类或对象的类型以及描述（在本例中为Ext.Component）。
• 自（示例中未显示） - 一些成员将显示成员首次引入的产品版本（例如Available since 3.4.0 - 示例中未显示），紧接在成员描述之后。
• 默认值（示例中未显示） - 配置通常会显示应用于类实例的默认配置值，如果未被覆盖（例如Defaults to: false）。

成员标志

API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。

• 必需 - 实例化类时所需的配置。
• 可绑定 - 该配置有一个 setter，允许通过 ViewModel 绑定设置此配置。

  所有 ExtReact 属性都是可绑定的，除非装饰为不可变。

• 不可变

  不可变的 ExtReact 属性不能用作实例化组件时的可配置属性。

• 只读 - 属性可以读取，但不能用于在运行时配置/重新配置类实例。
• 单例 - 单例类在定义后立即实例化，不能手动实例化。
• 静态 - 静态方法或属性是属于类本身的方法或属性，而不是类的实例。
• 可链式 - 指的是在调用时返回类实例本身的方法。
  这使得链式方法调用成为可能，例如：classInstance.method1().method2().etc();
• 已弃用 - 计划在未来框架版本中删除的类或成员，在当前版本中提供以确保向后兼容性。
  已弃用的类和成员将有一条消息，指导您使用未来的首选类/方法。
• 已删除 - 已删除的类或成员，仅在文档中存在，供用户在框架版本之间升级时参考。
• 模板 - 在基类中定义的方法，旨在被子类覆盖。
• 抽象 - 类或成员可以定义为抽象。抽象类和成员建立类结构，并提供有限的代码（如果有的话）。类特定的代码将通过子类中的覆盖来提供。
• 可预防 - 如果事件处理程序返回 `false`，则标记为可预防的事件将不会触发

类图标

- 表示框架类

- 单例框架类。*有关更多信息，请参阅单例标志

- 组件类型框架类（Ext JS 框架中任何扩展 Ext.Component 的类）

- 表示该类、成员或指南是在当前查看的版本中新添加的

成员图标

- 表示类型为 `config` 的类成员

或者在 ExtReact 组件类的情况下，这表示类型为 `prop` 的成员

- 表示类型为 `property` 的类成员

- 表示类型为 `method` 的类成员

- 表示类型为 `event` 的类成员

- 表示类型为 `主题变量` 的类成员

- 表示类型为 `主题 mixin` 的类成员

- 表示该类、成员或指南是在当前查看的版本中新添加的

导航和功能

类成员快速导航菜单

在 API 文档页面上的类名称下方是一排按钮，对应于当前类拥有的成员类型。每个按钮都显示了按类型划分的成员数量（此数量会随着应用过滤器而更新）。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示一个弹出菜单，其中包含该类型的所有成员，以便快速导航。

Getter 和 Setter 方法

与类配置选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中，位于它们所关联的配置下方。Getter 和 Setter 方法文档将在配置行中找到，以便于参考。

ExtReact 组件类不会将 Getter/Setter 方法提升到 prop 中。所有方法将在 `Methods` 部分中描述

历史记录栏

您的页面历史记录保存在本地存储中，并在顶部标题栏下方显示（使用可用的空间）。默认情况下，仅显示与您当前查看的产品/版本匹配的页面搜索结果。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选按钮来扩展显示的内容。这将显示所有产品/版本的历史记录栏中的所有最近页面。

在历史记录配置菜单中，您还将看到最近页面访问的列表。结果按“当前产品/版本”和“全部”单选按钮进行过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。

如果在历史记录配置菜单中选择了“全部”，则“在历史记录栏中显示产品详细信息”的复选框选项将被启用。选中后，每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将鼠标悬停在历史记录栏中的页面名称上也会显示产品/版本作为工具提示。

搜索和过滤器

可以使用页面顶部的搜索字段搜索 API 文档和指南。

在 API 文档页面上，还有一个过滤器输入字段，使用过滤器字符串过滤成员行。除了按字符串过滤外，您还可以按访问级别、继承和只读过滤类成员。这是使用页面顶部的复选框完成的。

API 类导航树底部的复选框过滤类列表，以包含或排除私有类。

单击空搜索字段将显示您最近的 10 次搜索，以便快速导航。

API 文档类元数据

每个 API 文档页面（除了 Javascript 原语页面）都具有与该类相关的元数据的菜单视图。此元数据视图将包含以下一项或多项

• 备用名称 - 一个或多个其他类名称同义词（在 Ext JS 6.0.0 中，`Ext.button.Button` 类有一个备用类名称 `Ext.Button`）。备用类名称通常为了向后兼容而维护。
• 层次结构 - 层次结构视图列出了当前类的继承链，一直到其祖先类，直到根基类。
• Mixin - 混合到当前类中的类列表
• 继承 Mixin - 列出当前类的祖先类中混合的类
• 需要 - 类实例化所需定义的所有类
• 使用 - 列出类在其生命周期的某个时间点可能使用的类，但不一定需要类最初实例化
• 子类 - 扩展当前类的类

展开和折叠示例和类成员

可运行示例（Fiddles）默认情况下在页面上展开。您可以使用代码块左上角的箭头分别折叠和展开示例代码块。您也可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间保存。

类成员默认情况下在页面上折叠。您可以使用成员行左侧的箭头图标或使用右上角的展开/折叠所有切换按钮全局展开和折叠成员。

桌面 -vs- 移动视图

在较窄的屏幕或浏览器上查看文档将导致视图针对较小的外形尺寸进行优化。桌面视图和“移动”视图之间的主要区别在于

• 全局导航将位于左侧菜单中，可通过汉堡菜单图标访问。菜单包含以下内容（在大多数页面上）
  • 当前产品的名称（作为指向产品登录页面的链接）
  • 用于导航回文档主页的 Sencha 图标
  • 产品菜单下拉按钮
  • API 文档和指南的导航树的标题
• 当前上下文导航和工具位于右侧，可通过齿轮图标访问。上下文菜单包含以下内容
  • 全局搜索输入字段
  • (API 文档) 带有成员过滤器、展开/折叠所有示例按钮、展开/折叠所有成员行按钮、访问级别过滤器复选框以及每个成员数量的“过滤器”标题
  • (API 文档) 包含与当前类相关的元数据菜单的“相关类”标题
  • (指南) 指南的目录

查看类源代码

可以通过单击 API 文档页面顶部的类名称来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。