简介

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 方法调用成功，则方法可能返回 Component，如果失败则返回 false，将显示为 Ext.Component/Boolean）。
• 标志 - 接下来将显示适用于该成员的任何标志（本例中为 PROTECTED - 请参见下面的标志部分）
• 成员来源 - 在成员行的右侧是最初描述成员的类（本例中为 Ext.container.Container）。如果成员源自当前类，则源类将显示为蓝色链接；如果成员是从祖先或混合类继承的，则显示为灰色。
• 成员源代码 - 在成员源代码类的右侧是一个链接，用于查看成员的源代码（本例中为 查看源代码）
• 参数列表 - 类方法的每个参数都将使用括号中上面找到的相同名称、预期的类或对象类型以及参数的描述（本例中为 item : Object）列出。
• 返回 - 如果类返回 undefined 以外的值，则“返回”部分将注明返回的类或对象类型以及描述（本例中为 Ext.Component）
• 自（示例中未显示） - 某些成员将在成员描述之后显示该成员首次引入的产品版本（即 自 3.4.0 起可用 - 示例中未显示）
• 默认（示例中未显示） - 配置通常显示应用于类实例的默认配置值（如果未覆盖）（即 默认为：false）

成员标志

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

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

  除非标记为 immutable，否则所有 ExtReact 道具均为 bindable

• 不可变

  实例化组件时，不可变的 ExtReact 道具不能用作可配置道具

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

类图标

- 表示框架类

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

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

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

成员图标

- 表示类型为 config 的类成员

或者对于 ExtReact 组件类，这表示类型为 prop 的成员

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

- 表示类型为 theme variable 的类成员

- 表示类型为 theme 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）。备用类名通常用于向后兼容。
• 层次结构 - 层次结构视图列出了当前类通过其祖先类到根基类的继承链。
• Mixins - 混合到当前类的类列表
• 继承的 Mixins - 混合到当前类祖先的类列表
• 需要 - 实例化类所需的已定义的所有类
• 使用 - 在其生命周期的某个时间点可能由类使用的类列表，但最初实例化类时不一定需要
• 子类 - 扩展当前类的类

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

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

查看类源

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