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 绑定设置此配置

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

  • Immutable

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

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

类图标

- 表示框架类

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

- 组件类型框架类(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) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。

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

桌面 -vs- 移动视图

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

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

查看类源代码

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

ExtReact 7.5.0


顶部

ExtReact 包

ExtReact 包含多个可以通过 npm 安装的 npm 包。

所有 Ext JS npm 包都使用命名空间 @sencha

包 @sencha 产品层级 描述
ext-react 标准 主要的 ExtReact 包
ext 标准/专业版 基于经典版、现代版和核心的依赖框架
ext-core 标准/专业版 所有核心 - 布局、DOM 类
ext-react-modern 标准/专业版 所有现代组件
ext-react-classic 标准/专业版 所有经典组件
ext-react-gen 标准/专业版 ExtReact 应用程序生成器
ext-react-transition 标准/专业版 过渡组件
ext-react-renderercell 标准/专业版 Renderer Cell 组件
ext-charts 标准/专业版 提供数据可视化功能的图表包
ext-amf 标准/专业版 Action Message Format (AMF) 包
ext-font-awesome 标准/专业版 font-awesome 图标
ext-font-ext 标准/专业版 Ext JS 字体包
ext-font-ios 标准/专业版 iOS 主题的字体
ext-font-pictos 标准/专业版 Pictos 字体包
ext-google 标准/专业版 Google 地图和日历
ext-soap 标准/专业版 简单对象访问协议
ext-ux 标准/专业版 UX 包提供诸如 Gauge、Ratings 之类的组件
ext-modern-treegrid 高级/企业版 此包允许您使用树和网格
ext-exporter 高级/企业版 导出为各种文件格式
ext-pivot 高级/企业版 快速汇总大型数据集
ext-pivot-d3 高级/企业版 Pivot with D3
ext-pivot-locale 高级/企业版 Pivot 网格上的 locale 功能
ext-d3 高级/企业版 数据可视化
ext-calendar 高级/企业版 自定义日历
ext-modern-theme-base 标准/专业版 现代版下所有主题的基础
ext-modern-theme-material 标准/专业版 现代工具包的 Material 主题。
ext-modern-theme-ios 标准/专业版 现代 iOS 主题
ext-modern-theme-neptune 标准/专业版 现代无边框主题
ext-modern-theme-triton 标准/专业版 现代扁平、无边框主题
ext-modern-locale 标准/专业版 现代工具包的 Locale 包。
ext-classic-locale 标准/专业版 经典工具包的 Locale 包
ext-classic-theme-base 标准/专业版 经典版下所有主题的基础
ext-classic-theme-classic 标准/专业版 经典蓝色 Ext JS 主题
ext-classic-theme-neptune 标准/专业版 无边框主题
ext-classic-theme-neptune-touch 标准/专业版 基于 Neptune 的 Touch 主题
ext-classic-theme-triton 标准/专业版 扁平、无边框主题
ext-classic-theme-crisp 标准/专业版 简约主题
ext-classic-theme-crisp-touch 标准/专业版 基于 Crisp 的 Touch 主题
ext-classic-theme-graphite 标准/专业版 基于 Triton 的辅助功能主题
ext-react-babel-plugin 标准 Babel 插件
ext-react-webpack-plugin 标准 WebPack 插件
ext-react-classic-boilerplate 标准 经典 Boilerplate 示例
ext-react-modern-boilerplate 标准 现代 Boilerplate 示例
ext-react-modern-typescript-boilerplate 标准 ExtReact typescript boilerplate
ext-react-conference-app 标准 会议应用程序示例
ext-react-demo 标准 演示示例
ext-react-kitchensink 标准 Kitchensink 示例
ext-react-rest-example 标准 Rest 应用程序示例
cra-template-ext-react-modern 标准 此 npm 包包含将 @sencha/ext-react-modern 包添加到 React 应用程序所需的文件
cra-template-ext-react-classic 标准 此 npm 包包含将 @sencha/ext-react-classic 包添加到 React 应用程序所需的文件

ExtReact 7.5.0