ExtReact 文档帮助

介绍

ExtReact 产品的文档在某种程度上与其他 Sencha 产品的文档有所不同。以下部分描述了所有产品的文档,除非另有说明为 ExtReact 独有。

术语、图标和标签

许多类都有快捷名称,用于在使用配置对象创建(实例化)类时。快捷名称被称为 alias(或 xtype,如果该类扩展了 Ext.Component)。别名/xtype 列在适用类的类名旁边,以供快速参考。

ExtReact 组件类在 API 类文档的顶部显着地列出了可配置的名称,后跟完全限定的类名。

访问级别

框架类或其成员可以指定为 privateprotected。否则,该类/成员为 publicPublicprotectedprivate 是访问描述符,用于传达应如何以及何时使用类或类成员。

成员类型

成员语法

下面是一个示例类成员,我们可以对其进行剖析,以显示类成员的语法(在本例中,从 Ext.button.Button 类查看的 lookupComponent 方法)。

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

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

成员标志

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

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

    除非装饰为 immutable,否则所有 ExtReact props 都是 bindable

  • Immutable(不可变)

    不可变的 ExtReact props 在实例化组件时不能用作可配置的 prop

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

类图标

- 表示框架类

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

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

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

成员图标

- 表示 config 类型的类成员

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

- 表示 property 类型的类成员

- 表示 method 类型的类成员

- 表示 event 类型的类成员

- 表示 theme variable 类型的类成员

- 表示 theme mixin 类型的类成员

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

类成员快速导航菜单

在 API 文档页面上的类名正下方是一行按钮,对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员计数(此计数会随着过滤器的应用而更新)。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。

Getter 和 Setter 方法

与类 config 选项相关的 Getter 和 setter 方法将显示在方法部分以及 API 文档和成员类型菜单的 configs 部分中,就在它们所作用的 config 下方。Getter 和 setter 方法文档将在 config 行中找到,以便于参考。

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 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“view source”链接来查看类成员的源代码。

ExtReact 7.5.0


顶部

ExtMoveToLatest

ExtMoveToLatest 是一个免费工具,用于将现有的 ExtGenExtReactExtAngularExtJS Reactor 应用程序依赖项和工具升级到最新版本。

由旧版本的 Sencha Open Tools 生成的有效应用程序将自动更新到生成初始应用程序的同一产品的最新版本。

例如,如果应用程序是使用 ExtGen(用于生成 Ext 应用程序的 CLI 工具)从 6.7.0 版本创建的,则将升级到 7.0 版本。所有底层依赖项都将升级,以便您的应用程序的工具和框架将具有相同的最新 7.0 版本。

功能

  • 将 ExtJS 框架版本升级到最新版本。
  • 将工具(ExtGen、ExtReact 等)升级到最新版本。
  • 更新 npm 包依赖项。
  • 更新 Sencha 的自定义 webpack 插件。

要求

在升级之前,现有应用程序必须使用您已安装的当前版本的工具平台和 ExtJS 框架进行编译、构建和运行。ExtMoveToLatest 不保证解决现有问题。

支持的工具版本

ExtAngular ExtReact ExtGen ExtJS Reactor
6.7.0 6.7.0 6.7.0 1.1.2
6.6.4 1.0.3 1.1.1
6.6.3 1.0.2 1.1.0
6.6.2 1.0.1 1.0.2
6.6.1 1.0.0 1.0.1
6.6.0 1.0.0

入门

步骤 1: 打开您的终端和/或命令提示符,并将目录更改为项目的根目录。

  • 这应该是您的项目配置文件 (app/workspace.json) 所在的同一目录。

步骤 2: 运行 npm install -g @sencha/ext-movetolatest 以在您的系统路径上安装 ext-movetolatest 二进制文件。

步骤 3: 在应用程序目录的根目录中运行 ext-movetolatest 以启动升级。

步骤 4: 运行 npm install 以安装升级过程中的新依赖项。

步骤 5: 运行 npm start 以验证其是否有效。

常见问题解答

  • ExtMoveToLatest 仅升级底层工具和所有依赖项,以帮助从旧版本迁移到最新版本。
  • 升级实用程序会生成一个名为 extBackup 的备份文件夹,但是,建议手动备份您即将升级的应用程序目录,并将其放置在安全的位置。
  • 一旦您确认升级成功,您可以删除备份文件夹。

ExtReact 7.5.0