ExtReact 文档帮助

简介

ExtReact 产品的文档与其他 Sencha 产品的文档有所不同。以下部分描述了除特别注明为 ExtReact 独有的文档外，所有产品的文档。

术语、图标和标签

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

ExtReact 组件类在 API 类文档的顶部显着位置列出可配置的名称，后跟完全限定的类名。

访问级别

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

公共类和类成员可供任何其他类或应用程序代码使用，并且在主要产品版本中可以作为稳定和持久的内容依赖。公共类和成员可以通过子类安全地扩展。
受保护 的类成员是稳定的 public 成员，旨在由拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
私有类和类成员由框架内部使用，不供应用程序开发人员使用。私有类和成员可能会随时更改或从框架中省略，恕不另行通知，不应在应用程序逻辑中依赖。

成员类型

Config - 类的配置选项。
ExtReact 组件类将配置选项显示为 props
Property - 类实例化后设置。*请参阅下面的只读。
ExtReact 组件类不将属性列为专用成员类型，而是作为 read only（只读） props
Method - 类可以执行的操作。方法应理解为实例方法，并且只能从给定类的实例调用。可以从类本身直接调用的静态方法将在方法名称旁边带有 static（静态）标签。*请参阅下面的静态。
Event - 事件是框架事件系统特有的，允许类以编程方式引发事件，以便由一个或多个事件处理程序方法处理。DOM 事件虽然由框架事件系统处理，但未在 API 文档中专门描述。*有关 DOM 事件，请参阅 MDN 的事件参考页面。
Theme Variable - 框架采用的可视化主题引擎使用的变量。
Theme Mixin - 框架采用的可视化主题引擎使用的函数，可以使用在各种主题变量中设置的值。

成员语法

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

Ext.container.Container

查看源代码

lookupComponent ( item ) : Ext.Component

受保护

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

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

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

参数

item : Object

正在添加的配置对象。

返回值

Ext.Component

要添加的组件。

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

展开/折叠 - 在成员行的左侧是一个控件，用于展开和折叠每个成员行以显示/隐藏成员详细信息。
成员名称 - 类成员的名称（本例中为 lookupComponent）
方法参数 - 方法使用的任何必需或可选参数（或传递给事件处理程序方法的参数）将列在方法名称旁边的括号内（本例中为 ( item )）
返回类型 - 方法或属性返回的类实例或 javascript 对象（本例中为 Ext.Component）。对于不返回除 undefined 之外的任何内容的方法，可以省略此项，或者可以显示为以正斜杠 / 分隔的多个可能值，表示返回的内容可能取决于方法调用的结果（即，如果 get 方法调用成功，方法可能返回一个 Component，如果不成功，则返回 false，这将显示为 Ext.Component/Boolean）。
标志 - 适用于成员的任何标志都将显示在旁边（本例中为 受保护 - 请参阅下面的标志部分）
成员来源 - 在成员行的右侧是最初描述成员的类（本例中为 Ext.container.Container）。如果成员源自当前类，则源类将显示为蓝色链接，如果它从祖先类或混合类继承，则显示为灰色。
成员源代码 - 在成员来源类的右侧下方是一个链接，用于查看成员的源代码（示例中的 view source（查看源代码））
参数列表 - 类方法的每个参数都将使用上面括号中找到的相同名称、预期的类或对象类型以及参数的描述列出（示例中为 item : Object）。
返回值 - 如果类返回除 undefined 之外的值，“返回值”部分将注释返回的类或对象类型以及描述（示例中为 Ext.Component）
Since（示例中未显示）- 某些成员将显示成员首次引入的产品版本（即 Available since 3.4.0（自 3.4.0 版本起可用）- 示例中未显示）就在成员描述之后
Default（示例中未显示）- Configs 通常显示要应用于类实例的默认 config 值（如果未被覆盖）（即 Defaults to: false（默认为：false））

成员标志

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

Required（必需） - 实例化类时必需的 config
Bindable（可绑定） - config 具有 setter，允许通过 ViewModel 绑定设置此 config
所有 ExtReact props 都是 bindable（可绑定）的，除非被装饰为 immutable（不可变）
Immutable（不可变）
不可变的 ExtReact props 在实例化组件时不能用作可配置的 prop
Read Only（只读） - 该属性可以读取，但不能用于在运行时配置/重新配置类实例
Singleton（单例） - 单例类在定义后立即实例化，不能手动实例化
Static（静态） - 静态方法或属性是属于类本身的方法或属性，而不是类的实例
Chainable（可链式调用） - 指的是在调用时返回类实例的方法。
这使得可以进行链式方法调用，例如：classInstance.method1().method2().etc();
Deprecated（已弃用） - 计划在未来框架版本中删除的类或成员，并在当前版本中提供以实现向后兼容性。
已弃用的类和成员将包含一条消息，指导您在未来使用首选的类/方法。
Removed（已移除） - 已移除的类或成员，仅在文档中作为用户在框架版本之间升级的参考而存在
Template（模板） - 在基类中定义的方法，旨在被子类覆盖
Abstract（抽象） - 类或成员可以定义为抽象。抽象类和成员建立类结构并提供有限的（如果有的话）代码。特定于类的代码将通过子类中的覆盖提供。
Preventable（可阻止） - 如果事件处理程序返回 false，则标记为可阻止的事件将不会触发

类图标

- 表示框架类

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

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

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

成员图标

- 表示 config 类型的类成员

或者在 ExtReact 组件类的情况下，这表示 prop 类型的成员

- 表示 property 类型的类成员

- 表示 method 类型的类成员

- 表示 event 类型的类成员

- 表示 theme variable 类型的类成员

- 表示 theme mixin 类型的类成员

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

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

Getter 和 Setter 方法

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

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

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

桌面与移动视图

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

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

查看类源代码

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

ExtReact 7.5.0

显示私有类

顶部

配置 Webpack 和 Babel

Sencha 建议使用 Webpack 4+ 来构建您的 ExtReact 应用程序。ExtReact 包含一个 webpack 插件，用于捆绑和优化您的应用程序中使用的 ExtReact 组件。本指南记录了该插件的配置选项。

安装

首先，从 Sencha 的 npm 注册表安装 ExtReact webpack 插件

npm install --save-dev @sencha/ext-react-webpack-plugin

然后，将其导入到您的 webpack 配置中

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

module.exports = {
  ...
  plugins: [
    ...
    new ExtWebpackPlugin({
      framework: 'react',
      port: port,
      emit: true,
      browser: browserprofile,
      treeshake: treeshake,
      watch: watchprofile,
      profile: buildprofile, 
      environment: buildenvironment, 
      verbose: buildverbose,
      theme: 'theme-material',
      packages: []
    }),
    ...
  ]
  ...
}

Webpack 插件配置

ExtReactWebpackPlugin 的构造函数接受带有多个设置的配置对象。

常用选项

framework

设置为 'react' 以用于 ExtReact

port

webpack 开发服务器将从中提供的 http 端口

emit

是否发出 Ext JS 组件代码（仅供开发使用）（true/false）

browser

是否显示浏览器窗口（true/false）

treeshake

生产构建过程用于构建 ext.js 的最小版本（true/false）

watch

用于控制构建过程是否监视已更改的文件（true/false）

profile

正在构建的 Ext JS profile

environment

生产或开发

verbose

控制是否显示详细消息（是/否）

theme

默认值："theme-material"

内置 ExtReact 主题之一的名称

theme-material
theme-ios
theme-triton
theme-neptune

您还可以指定位于 ext-react/packages 中的自定义主题的名称，或自定义主题的路径。例如，要使用位于 ext-react/packages/custom-theme 的自定义主题

new ExtWebpackPlugin({
  framework: 'react',
  theme: 'custom-theme',
  ...
});

packages

要包含在构建中的 Ext JS 包

配置 Babel

为了构建您的应用程序，@sencha/ext-react-babel-plugin 必须包含在您的 babel 配置中，并且必须关闭 ES6 模块转译。这是一个 .babelrc 示例

{
  "presets": [
    [
      "@babel/preset-env",
      {
        "modules": false
      }
    ],
    "@babel/preset-react"
  ],
  "plugins": [
    "react-hot-loader/babel",
    "@sencha/ext-react-babel-plugin",
    "@babel/plugin-transform-runtime",
    "@babel/plugin-syntax-dynamic-import",
    "@babel/plugin-syntax-import-meta",
    "@babel/plugin-proposal-class-properties",
    "@babel/plugin-proposal-json-strings",
    [
      "@babel/plugin-proposal-decorators",
      {
        "legacy": true
      }
    ],
    "@babel/plugin-proposal-function-sent",
    "@babel/plugin-proposal-export-namespace-from",
    "@babel/plugin-proposal-numeric-separator",
    "@babel/plugin-proposal-throw-expressions"
  ],
  "ignore": [
    "build"
  ],
  "env": {
    "test": {
      "presets": [
        "@babel/preset-env",
        "@babel/preset-react"
      ],
      "plugins": [
        "@babel/plugin-syntax-dynamic-import",
        "@babel/plugin-syntax-import-meta",
        "@babel/plugin-proposal-class-properties",
        "@babel/plugin-proposal-json-strings",
        [
          "@babel/plugin-proposal-decorators",
          {
            "legacy": true
          }
        ],
        "@babel/plugin-proposal-function-sent",
        "@babel/plugin-proposal-export-namespace-from",
        "@babel/plugin-proposal-numeric-separator",
        "@babel/plugin-proposal-throw-expressions"
      ]
    }
  }
}

配置 TypeScript

使用 TypeScript 的应用程序也应使用 @sencha/ext-react-babel-plugin。在您的 webpack 配置中，将 babel-loader 添加到您的 ts|tsx 文件的规则中

{
  test: /\.(ts|tsx)$/,
  exclude: /node_modules/,
  use: [
    {
      loader: 'babel-loader',
      options: {
        "plugins": [
          "@sencha/ext-react-babel-plugin"
        ]
      }
    },
    {
      loader: 'awesome-typescript-loader'
    }
  ]
}

然后，在您的 tsconfig.json 中，将 "module" 配置设置为 "es2015"。这是一个 tsconfig.json 示例

{
  "compilerOptions": {
    "sourceMap": true,
    "target": "es5",
    "jsx": "react",
    "module": "es2015",
    "moduleResolution": "node",
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "declaration": false,
    "noImplicitAny": false,
    "noImplicitReturns": false,
    "removeComments": true,
    "strictNullChecks": false,
    "outDir": "build",
    "lib": [
      "es6",
      "es7",
      "dom"
    ]
  },
  "exclude": [
    "dist",
    "build",
    "node_modules"
  ]
}

目录

简介

术语、图标和标签

访问级别

成员类型

成员语法

成员标志

类图标

成员图标

导航和功能

类成员快速导航菜单

Getter 和 Setter 方法

历史记录栏

搜索和过滤器

API 文档类元数据

展开和折叠示例及类成员

桌面与移动视图

查看类源代码

ExtReact 7.5.0

目录

配置 Webpack 和 Babel

安装

Webpack 插件配置

常用选项

framework

port

emit

browser

treeshake

watch

profile

environment

verbose

theme

packages

配置 Babel

配置 TypeScript

ExtReact 7.5.0