文档帮助

术语、图标和标签

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

访问级别

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

类图标

- 表示框架类

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

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

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

成员图标

- 表示类型为 config 的类成员

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

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

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

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

类成员快速导航菜单

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

Getter 和 Setter 方法

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

历史记录栏

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

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

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

搜索和过滤器

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

Ext JS 7.8.0 - Modern Toolkit


顶部
指南适用于: modern

NPM - Webpack + Sencha Cmd 配置

本指南解释了在使用 Sencha 的 OpenTooling (@sencha/ext-gen) 生成应用程序时创建的 webpack 配置。

虽然以下某些配置选项是可选的或可以修改,但许多是 OpenTooling 驱动 ExtJS 构建过程所必需的,该过程在后台使用 Sencha Cmd。可以更改的配置标记为 CONFIGURABLE。

1. Sencha Cmd 配置

app.json

webpack 包应在 app.js 之前包含(加载),以确保所有第三方 npm 包都可用于 Ext JS 运行时。如果此顺序指定不正确,则 webpack 包中包含的包在应用程序运行时期间在类定义等位置将不可用。以下示例指示 webpack 包和 sencha cmd 应用程序包的正确加载顺序

// Production
"js": [
      {"path": "${app.webpack.bundle}"},
      {"path": "app.js", "bundle": true}
],

// Development
"js": [
      {"path": "main.js", "includeInBundle": true},
      {"path": "app.js", "bundle": true}
],

2. 变量和脚本参数

Sencha Cmd

  • contextFolder: Sencha Cmd 的有效工作区/项目路径
  • toolkit: Sencha Cmd 要构建的工具包。可以通过 package.json 脚本更改为任何 ExtJS 工具包
  • theme: 用于构建项目的 ExtJS 主题
  • packages: 要包含在 Sencha Cmd 构建过程中的包
  • script: 可选脚本,在 Webpack thisCompilation 同步钩子期间运行
  • profile: [CONFIGURABLE] 要构建的构建配置文件,在 app.json 中定义
  • environment: 开发或生产环境
  • watch: 确定 ExtWebpackPlugin 应该为生产执行 sencha app build 还是为开发执行 sencha app watch

Sencha Webpack 插件

  • outputFolder: 发出资产的位置;目前这是运行 Sencha Cmd 的根目录
  • entryFile: 设置为 index.js 作为加载第三方 npm 包的入口点
  • emit: 允许插件确定在构建周期期间是否应发生 emit
  • treeshake: ES5 死代码消除,挂钩到 Sencha Cmd 转译启用
  • browser: 是否应在指定的主机:端口启动浏览器
  • verbose: 启用详细模式

特殊常量

  • bundleFormat: [CONFIGURABLE] 指定 webpack 包的格式。如果修改,则需要更新 app.json 中的开发设置,以适应开发模式下使用的任何包格式。生产模式应支持所有 webpack 包文件名格式化选项。
  • ignoreFolders: [CONFIGURABLE] Live Reload 应忽略的文件夹

2. 插件

ExtWebpackPlugin

  • Open Tooling 应用程序唯一需要的插件是 Sencha 的 ExtWebpackPlugin。此插件挂钩到各种 webpack 编译器钩子,以使用 Sencha Cmd 构建 ExtJS 项目。

3. 选项

  • mode: 根据开发或生产环境处理 webpack 优化
  • devtool: [CONFIGURABLE] 启用源映射、映射样式等,以实现更好的调试目的
  • context: 指向有效的 Sencha Cmd 工作区或应用程序目录
  • entry: 入口点,由上面的 entryFile 定义
  • output: 组合 bundleFormat 并在指定路径发出资产。Sencha Cmd 期望这是有效 Sencha Cmd 工作区或应用程序的根目录
  • plugins: [CONFIGURABLE] 需要 ExtWebpackPlugin,可以添加其他插件
  • module: [CONFIGURABLE]
  • resolve: [CONFIGURABLE]
  • performance: [CONFIGURABLE] 控制 webpack 资产发出通知、大小等。
  • stats: [CONFIGURABLE] 控制包信息级别
  • optimization: [CONFIGURABLE] 用于代码块拆分、缩小等的控件。
  • devServer
    • watchOptions: 配置为忽略包含生成内容的特定 Sencha Cmd 文件夹
    • contentBase: 配置为与 sencha app watch 期望的目录相同
    • watchContentBase: 确保 Live Reload 将监视对应用程序所做的更改
    • liveReload: [CONFIGURABLE] 启用 Live Reload
    • historyAPIFallback: [CONFIGURABLE] 启用 HTML 5 History API 回退到 index.html
    • host: [CONFIGURABLE]
    • port: [CONFIGURABLE]
    • disabledHostCheck: [CONFIGURABLE] 启用绕过主机检查
    • compress: [CONFIGURABLE] 在所有 webpack 发出的资产上启用 GZIP 压缩
    • inline: [CONFIGURABLE] 在 wepback dev esrver 的两种模式之间切换
    • stats: [CONFIGURABLE] 控制包信息级别

Ext JS 7.8.0 - Modern Toolkit