ExtReact 文档帮助

简介

ExtReact 产品的文档在某种程度上与其他 Sencha 产品的文档有所不同。以下章节描述了除特别指出 ExtReact 独有的所有产品的文档。

术语、图标和标签

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

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

访问级别

框架类或其成员可以指定为 private(私有)或 protected(受保护)。否则,类/成员为 public(公共)。Publicprotectedprivate 是访问描述符,用于传达类或类成员应如何以及何时使用。

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护 (protected)

当原始配置对象添加到此容器时调用,无论是在初始化 items 配置期间,还是在添加新项目 added) 或 {@link #insert inserted} 时调用。

此方法将传递的对象转换为实例化的子组件。

当需要对子组件创建应用特殊处理时,可以在子类中覆盖此方法。

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

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

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

成员图标

- 表示 config(配置)类型的类成员

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

- 表示 property(属性)类型的类成员

- 表示 method(方法)类型的类成员

- 表示 event(事件)类型的类成员

- 表示 theme variable(主题变量)类型的类成员

- 表示 theme mixin(主题 mixin)类型的类成员

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

类成员快速导航菜单

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

Getter 和 Setter 方法

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

ExtReact 组件类不会将 Getter/Setter 方法提升到 prop 中。所有方法都将在 Methods(方法)部分中描述

历史记录栏

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

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

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

搜索和过滤器

可以使用页面顶部的搜索字段搜索 API 文档和指南。

在 API 文档页面上,还有一个过滤器输入字段,可以使用过滤器字符串过滤成员行。除了按字符串过滤外,您还可以按访问级别、继承和只读来过滤类成员。这可以使用页面顶部的复选框完成。

API 类导航树底部的复选框过滤类列表,以包含或排除私有类。

单击空的搜索字段将显示您最近 10 次搜索,以便快速导航。

API 文档类元数据

每个 API 文档页面(Javascript 原始类型页面除外)都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

展开和折叠示例及类成员

可运行的示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。

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

桌面与移动视图

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

查看类源代码

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

ExtReact 7.5.0


顶部

为 @sencha/ext-react-classic 使用 ext-webpack-plugin

将 ext-webpack-plugin 添加到应用程序

1. 使用 npm 安装 ExtReact 包

要添加 ext-webpack-plugin,我们必须首先 eject(弹出)

要弹出,请在应用程序的根目录中运行以下命令。

npm run eject

创建了两个新文件夹

  • config
  • scripts

此外,许多程序包条目已添加到“package.json”文件的“dependencies”(依赖项)部分

2. 添加到 package.json

在 "@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

3. 将 ext-webpack-plugin 添加到 'config/webpack.config.js'

将以下内容添加到 config/webpack.config.js 的顶部

const ExtWebpackPlugin = require('@sencha/ext-webpack-plugin');

添加以下插件条目

  • 搜索 'new HtmlWebpackPlugin'
  • 在 ), 对于该插件条目之后,(大约在第 540 行)添加以下内容
      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'
      }),

4. 在 'config/webpack.config.js' 中,大约在第 171 行,更改为:

    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>
-->

6. (可选)要停止构建清除屏幕,请在以下每个文件中进行以下更改:

  • 在 'scripts/start.js' 中,大约在第 36 行
  • 在 'scripts/build.js' 中,大约在第 39 行
  • 在 'node_modules/react-dev-utils/WebpackDevServerUtils.js' 中,大约在第 23 行
//const isInteractive = process.stdout.isTTY;
const isInteractive = false;

7. 将 .ext-reactrc 添加到项目的根目录

由于 create-react-app 对开发和生产使用单独的 webpack 配置文件,我们建议将 ExtReactWebpackPlugin 的共享配置选项放在项目根目录中的 .ext-reactrc 文件中。例如,以下设置 ExtReact 捆绑包的输出路径为 static/js/ext-react,以匹配 create-react-app 设置的默认输出路径。

{
    "output": "static/js/ext-react"
}

8. 将 Ext 作为全局变量添加到 ESLint 配置

在 package.json 中,通过将 eslintConfig 更改为以下内容,将 Ext 添加为全局变量

"eslintConfig": {
  "extends": "react-app",
  "globals": {
    "Ext": true
  }
}

9. 运行 create-react-app 应用程序

npm start

ExtReact 应用程序将在浏览器窗口中使用 ext-webpack-plugin 加载!

ExtReact 7.5.0