使用 Webpack
ExtReact 产品的文档与其他 Sencha 产品的文档有所不同。以下章节描述了除标明为 ExtReact 特有的所有产品的文档。
许多类在使用配置对象创建（实例化）类时都有快捷名称。快捷名称被称为 别名（如果类扩展自 Ext.Component，则为 xtype）。别名/xtype 列在适用类的类名旁边，以便快速参考。
ExtReact 组件类在 API 类文档的顶部突出显示可配置的名称，然后是完全限定的类名。
框架类或其成员可以指定为 private 或 protected。否则，类/成员为 public。Public、protected 和 private 是访问描述符，用于传达类或类成员应如何以及何时使用。
Public 类和类成员可供任何其他类或应用程序代码使用，并且在主要产品版本中可以作为稳定和持久的依赖项。Public 类和成员可以通过子类安全地扩展。
Protected 类成员是稳定的 public 成员，旨在由拥有类或其子类使用。Protected 成员可以通过子类安全地扩展。
Private 类和类成员在框架内部使用，不供应用程序开发人员使用。Private 类和成员可能会随时更改或从框架中省略，恕不另行通知，并且不应在应用程序逻辑中依赖它们。
ExtReact 组件类将配置选项显示为 props
ExtReact 组件类不将属性列为专用成员类型，而是列为 read only props
static 标签。*请参阅下面的静态。下面是一个示例类成员，我们可以对其进行剖析，以显示类成员的语法（在本例中，是从 Ext.button.Button 类查看的 lookupComponent 方法）。
让我们看一下成员行的每个部分
lookupComponent）( item )）Ext.Component）。对于不返回除 undefined 以外任何内容的方法，可以省略此项，或者可以显示为由正斜杠 / 分隔的多个可能值，表示返回的内容可能取决于方法调用的结果（即，如果 get 方法调用成功，则方法可能返回 Component，如果失败，则返回 false，这将显示为 Ext.Component/Boolean）。PROTECTED - 请参阅下面的标志部分）Ext.container.Container）。如果成员源自当前类，则源类将显示为蓝色链接，如果它从祖先类或混合类继承，则显示为灰色。view source）item : Object）。undefined 以外的值，“返回值”部分将注释返回的类或对象类型以及描述（示例中为 Ext.Component）Available since 3.4.0 - 示例中未显示），紧随成员描述之后Defaults to: false）API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。
除非装饰为 immutable，否则所有 ExtReact props 都是 bindable
Immutable ExtReact props 在实例化组件时不能用作可配置的 prop
classInstance.method1().method2().etc();false，则标记为 preventable 的事件将不会触发- 表示框架类
- Singleton 框架类。*有关更多信息，请参阅 singleton 标志
- 组件类型的框架类（Ext JS 框架中扩展自 Ext.Component 的任何类）
- 表示类、成员或指南在当前查看的版本中是新的
- 表示类型为 config 的类成员
或者在 ExtReact 组件类的情况下，这表示类型为 prop 的成员
- 表示类型为 property 的类成员
- 表示类型为 method 的类成员
- 表示类型为 event 的类成员
- 表示类型为 theme variable 的类成员
- 表示类型为 theme mixin 的类成员
- 表示类、成员或指南在当前查看的版本中是新的
在 API 文档页面上的类名正下方是一行按钮，对应于当前类拥有的成员类型。每个按钮显示按类型计数的成员数量（此计数在应用过滤器时更新）。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单，以便快速导航。
与类 config 选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的 configs 部分中，就在它们使用的 config 下方。Getter 和 Setter 方法文档将在 config 行中找到，以便于参考。
ExtReact 组件类不会将 Getter/Setter 方法提升到 prop 中。所有方法都将在 Methods 部分中描述
您的页面历史记录保存在本地存储中，并在顶部标题栏下方显示（使用可用的实际空间）。默认情况下，显示的唯一搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选按钮来扩展显示的内容。这将显示所有产品/版本的所有最近页面。
在历史记录配置菜单中，您还将看到最近访问页面的列表。结果按“当前产品/版本”和“全部”单选按钮过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。
如果在历史记录配置菜单中选择“全部”，“在历史记录栏中显示产品详细信息”的复选框选项将启用。选中后，每个历史页面的产品/版本将在历史记录栏中与页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会将产品/版本显示为工具提示。
可以使用页面顶部的搜索字段搜索 API 文档和指南。
在 API 文档页面上，还有一个过滤器输入字段，该字段使用过滤器字符串过滤成员行。除了按字符串过滤外，您还可以按访问级别、继承和只读过滤类成员。这是通过使用页面顶部的复选框完成的。
API 类导航树底部的复选框过滤类列表以包含或排除私有类。
单击空的搜索字段将显示您最近 10 次搜索，以便快速导航。
每个 API 文档页面（Javascript 原始页面除外）都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项
Ext.button.Button 类具有 Ext.Button 的备用类名）。备用类名通常是为了向后兼容性而维护的。可运行的示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。
类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或全局使用右上角的展开/折叠全部切换按钮来展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小外形尺寸优化的视图。桌面视图和“移动”视图之间的主要区别在于
可以通过单击 API 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“view source”链接来查看类成员的源代码。
本指南将介绍如何使用 webpack 打包 Sencha Ext JS Web 组件。
在 webpack.config.js 中，将 ExtWebpackPlugin 添加到插件配置
// Import
const ExtWebpackPlugin = require('@sencha/ext-webpack-plugin');
// Configure
new ExtWebpackPlugin({
framework: 'web-components',
toolkit: 'modern',
theme: 'theme-material',
emit: emit,
script: './extract-code.js',
port: port,
packages: [],
profile: profile,
environment: environment,
treeshake: treeshake,
browser: browser,
watch: watch,
verbose: verbose
})
| 属性 | 默认值 | 选项 | 描述 |
|---|---|---|---|
| framework | extjs | [ 'react', 'extjs', 'web-components' ] | 哪个 Ext JS 框架？ |
| toolkit | modern | [ 'modern', 'classic' ] | 哪个 Ext JS 工具包？ |
| theme | theme-material | 依赖于工具包。从工具包中选择一个主题。例如 [ 'theme-material', 'theme-triton', ... ] | 哪个 Ext JS 主题？ |
| emit | yes | ['yes', 'no' ] | 生成文件？ |
| script | null | 脚本文件名，例如 './extract-code.js' | 命名生成的文件？ |
| port | 1962 | Web 服务器端口，例如 1962。 | Web 服务器端口是什么？ |
| packages | [] | 列表 | 应包含哪些 Ext JS 包？ |
| profile | '' | ||
| environment | development | ['development', 'production' ] | 为开发还是生产编译？ |
| treeshake | no | ['yes', 'no' ] | 剔除死代码？ |
| browser | yes | ['yes', 'no' ] | 运行浏览器？ |
| watch | yes | ['yes', 'no' ] | 监视更改？ |
| verbose | no | ['yes', 'no' ] | 打开详细日志记录？ |
| inject | yes | ['yes', 'no' ] | |
| intellishake | yes | ['yes', 'no' ] |
ExtWebComponents | 使用条款