ExtReact 产品的文档在某种程度上与其他 Sencha 产品的文档有所不同。以下章节描述了除特别指出 ExtReact
独有的所有产品的文档。
许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 alias
(别名)(如果类扩展了 Ext.Component,则为 xtype
)。别名/xtype 列在适用类的类名旁边,以供快速参考。
ExtReact 组件类在 API 类文档的顶部突出显示可配置的名称,后跟完全限定的类名。
框架类或其成员可以指定为 private
(私有)或 protected
(受保护)。否则,类/成员为 public
(公共)。Public
、protected
和 private
是访问描述符,用于传达类或类成员应如何以及何时使用。
公共 (Public) 类和类成员可供任何其他类或应用程序代码使用,并且可以作为主要产品版本中的稳定和持久的内容来依赖。公共类和成员可以通过子类安全地扩展。
受保护 (Protected) 的类成员是稳定的 public
成员,旨在由拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
私有 (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
(自 3.4.0 版本起可用)- 未在示例中显示),紧随成员描述之后Defaults to: false
(默认为:false))API 文档使用许多标志来进一步传达类成员的功能和意图。标签可以用文本标签、缩写或图标表示。
所有 ExtReact props 都是 bindable
(可绑定)的,除非被装饰为 immutable
(不可变)
不可变的 ExtReact props 在实例化组件时不能用作可配置的 prop
classInstance.method1().method2().etc();
false
,则标记为可阻止的事件将不会触发- 表示框架类
- 单例框架类。*有关更多信息,请参阅单例标志
- 组件类型的框架类(Ext JS 框架中扩展 Ext.Component 的任何类)
- 表示类、成员或指南在当前查看的版本中是新的
- 表示 config
(配置)类型的类成员
或者,在 ExtReact 组件类的情况下,这表示 prop
(属性)类型的成员
- 表示 property
(属性)类型的类成员
- 表示 method
(方法)类型的类成员
- 表示 event
(事件)类型的类成员
- 表示 theme variable
(主题变量)类型的类成员
- 表示 theme mixin
(主题 mixin)类型的类成员
- 表示类、成员或指南在当前查看的版本中是新的
在 API 文档页面上的类名正下方是一行按钮,对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员计数(此计数会随着过滤器的应用而更新)。单击该按钮会将您导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。
与类配置选项相关的 Getter 和 Setter 方法将显示在方法部分以及 API 文档和成员类型菜单的配置部分中,就在它们所作用的配置下方。Getter 和 Setter 方法文档将在配置行中找到,以便于参考。
ExtReact 组件类不会将 Getter/Setter 方法提升到 prop 中。所有方法都将在 Methods
(方法)部分中描述
您的页面历史记录保存在本地存储中,并在顶部标题栏正下方显示(使用可用的实际空间)。默认情况下,显示的唯一搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选按钮来扩展显示的内容。这将显示历史记录栏中所有产品/版本的所有最近页面。
在历史记录配置菜单中,您还将看到最近页面访问的列表。结果按“当前产品/版本”和“全部”单选按钮过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。
如果在历史记录配置菜单中选择了“全部”,则“在历史记录栏中显示产品详细信息”复选框选项将启用。选中后,每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会将产品/版本显示为工具提示。
可以使用页面顶部的搜索字段搜索 API 文档和指南。
在 API 文档页面上,还有一个过滤器输入字段,可以使用过滤器字符串过滤成员行。除了按字符串过滤外,您还可以按访问级别、继承和只读来过滤类成员。这可以使用页面顶部的复选框完成。
API 类导航树底部的复选框过滤类列表,以包含或排除私有类。
单击空的搜索字段将显示您最近 10 次搜索,以便快速导航。
每个 API 文档页面(Javascript 原始类型页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项
Ext.button.Button
类具有 Ext.Button
的备用类名)。备用类名通常为了向后兼容性而维护。可运行的示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。
类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或右上角的展开/折叠全部切换按钮全局展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小外形尺寸优化的视图。桌面视图和“移动”视图之间的主要区别在于
可以通过单击 API 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“view source”(查看源代码)链接来查看类成员的源代码。
要添加 ext-webpack-plugin,我们必须首先 eject(弹出)
要弹出,请在应用程序的根目录中运行以下命令。
npm run eject
创建了两个新文件夹
此外,许多程序包条目已添加到“package.json”文件的“dependencies”(依赖项)部分
在 "@sencha/ext-react-classic": "^7.5.0", 之后,将以下内容添加到“package.json”的 dependencies(依赖项)部分
"@sencha/ext": "^7.5.0",
"@sencha/ext-classic": "^7.5.0",
"@sencha/ext-classic-theme-material": "^7.5.0",
"@sencha/ext-webpack-plugin": "^7.5.0",
运行 npm install
npm install
将以下内容添加到 config/webpack.config.js 的顶部
const ExtWebpackPlugin = require('@sencha/ext-webpack-plugin');
添加以下插件条目
new ExtWebpackPlugin({
framework: 'react',
toolkit: 'classic',
theme: 'theme-material',
packages: [],
script: '',
emit: 'yes',
port: 1962,
profile: '',
environment: 'development',
treeshake: 'no',
browser: 'no',
watch: 'yes',
verbose: 'no',
inject: 'no',
intellishake: 'no'
}),
output: {
// The build folder.
//path: isEnvProduction ? paths.appBuild : undefined,
path: isEnvProduction ? paths.appBuild : paths.appPublic,
<title>React App</title>
<script src="/ext/ext.js"></script>
<link rel="stylesheet" type="text/css" href="/ext/ext.css">
<!--
<script src="%PUBLIC_URL%/ext-runtime-classic/boot.js"></script>
<script src="%PUBLIC_URL%/ext-runtime-classic/engine.js"></script>
<script src="%PUBLIC_URL%/ext-runtime-classic/themes/css.classic.material.js"></script>
-->
//const isInteractive = process.stdout.isTTY;
const isInteractive = false;
由于 create-react-app 对开发和生产使用单独的 webpack 配置文件,我们建议将 ExtReactWebpackPlugin 的共享配置选项放在项目根目录中的 .ext-reactrc
文件中。例如,以下设置 ExtReact 捆绑包的输出路径为 static/js/ext-react,以匹配 create-react-app 设置的默认输出路径。
{
"output": "static/js/ext-react"
}
在 package.json 中,通过将 eslintConfig 更改为以下内容,将 Ext 添加为全局变量
"eslintConfig": {
"extends": "react-app",
"globals": {
"Ext": true
}
}
npm start
ExtReact 应用程序将在浏览器窗口中使用 ext-webpack-plugin 加载!