简介

ExtReact 产品的文档与其他 Sencha 产品的文档有所不同。以下章节描述了除标明为 ExtReact 独有的所有产品的文档。

术语、图标和标签

许多类在使用配置对象创建（实例化）类时都有快捷名称。快捷名称被称为 alias（别名）（如果类扩展了 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）
• Since（始于）（示例中未显示）- 某些成员将显示该成员首次引入的产品版本（即 Available since 3.4.0 - 示例中未显示），就在成员描述之后
• Default（默认值）（示例中未显示）- 配置通常显示要应用于类实例的默认配置值（如果未被覆盖）（即 Defaults to: false）

成员标志

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

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

  所有 ExtReact props（属性）都是 bindable（可绑定的），除非被装饰为 immutable（不可变的）

• Immutable（不可变的）

  不可变的 ExtReact props（属性）在实例化组件时不能用作可配置的属性

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

类图标

- 表示框架类

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

- 组件类型框架类（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 原始类型页面除外）都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

• Alternate Name（备用名称） - 一个或多个附加的类名同义词（在 Ext JS 6.0.0 中，Ext.button.Button 类有一个备用类名 Ext.Button）。备用类名通常为了向后兼容性而维护。
• Hierarchy（继承关系） - 继承关系视图列出了当前类的继承链，从祖先类一直到根基类。
• Mixins（混入） - 混入当前类中的类列表
• Inherited Mixins（继承的混入） - 混入当前类的祖先类中的类列表
• Requires（需要） - 类实例化所需定义的所有类
• Uses（使用） - 类在其生命周期的某个时刻可能使用的类列表，但不一定是类最初实例化所必需的
• Subclasses（子类） - 扩展当前类的类

展开和折叠示例及类成员

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

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

桌面与移动视图

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

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

查看类源码

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