ExtReact 文档帮助

目录

简介 术语、图标和标签 访问级别 成员类型 成员语法 成员标志 类图标 成员图标 导航和功能 类成员快速导航菜单 Getter 和 Setter 方法 历史记录栏 搜索和过滤器 API 文档类元数据 展开和折叠示例及类成员 桌面与移动视图 查看类源代码

简介

ExtReact 产品的文档在某种程度上与其他 Sencha 产品的文档有所不同。以下章节描述了除另有说明为 ExtReact 独有的所有产品的文档。

术语、图标和标签

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

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

访问级别

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

成员类型

成员语法

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

Ext.container.Container
查看源代码
lookupComponent ( item ) : Ext.Component
受保护的

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

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

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

参数

item :  Object

要添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

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

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

成员图标

- 表示类型为 config 的类成员

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

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

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

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

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

类成员快速导航菜单

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

Getter 和 Setter 方法

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

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

历史记录栏

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

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

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

搜索和过滤器

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

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

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

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

API 文档类元数据

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

展开和折叠示例及类成员

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

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

桌面与移动视图

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

查看类源代码

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

ExtAngular 7.5.0


顶部

目录

为 @sencha/ext-angular-modern 使用 ext-webpack-plugin 将 Sencha ext-webpack-plugin 添加到 Angular CLI 应用程序 按照入门指南中的步骤创建带有 ExtAngular 的 Angular CLI 应用程序 执行以下步骤： 编辑 package.json 的 scripts 部分 编辑 angular.json、index.html、app.module.ts、app 组件文件，并添加 custom-webpack.config.js 运行应用程序

为 @sencha/ext-angular-modern 使用 ext-webpack-plugin

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

本文档定义了将 Sencha ext-webpack-plugin 添加到使用 Angular CLI 生成的 Angular 应用程序所需的步骤。Angular CLI 在 Angular CLI 概述中进行了描述

另请参阅 packages/ext-angular-kitchensink，其中包含使用 ext-webpack-plugin 的应用程序示例。

按照入门指南中的步骤创建带有 ExtAngular 的 Angular CLI 应用程序

对于 ext-angular-modern

对于后续步骤，请确保您已登录到 Sencha npm 存储库 - 有关说明，请参阅此链接：https://extjs.cn/extangular/7.5.0/guides/getting_started/creating_ext_angular_app_modern.html#getting_started-_-creating_ext_angular_app_modern_-_step_2__install_packages_from_npm

执行以下步骤：

将以下内容添加到 package.json 的 dependencies 部分

"@sencha/ext-modern-runtime": "~7.5.0",
"@sencha/ext-angular-modern": "~7.5.0",
"@sencha/ext": "^7.5.0",
"@sencha/ext-modern": "^7.5.0",
"@sencha/ext-modern-theme-material": "^7.5.0",
"@sencha/ext-webpack-plugin": "^7.5.0",
"@angular-builders/custom-webpack": "^9.1.0",
"@angular-builders/dev-server": "^7.3.1",
"@angular-devkit/build-angular": "~0.901.0",

要安装 npm 依赖项，请在终端或命令窗口中运行以下命令

npm install

编辑 package.json 的 scripts 部分

将以下内容添加到 package.json 的 scripts 部分

"buildprod": "env basehref=/ ng build --prod",

编辑 angular.json、index.html、app.module.ts、app 组件文件，并添加 custom-webpack.config.js

要引入自定义 webpack 配置，我们首先需要在 angular.json 文件中进行更改。

对于 ng build 命令，请在 angular.json 文件中配置 architect/build 对象，并将 builder 从 @angular-devkit/build-angular:browser 更新为 @angular-builders/custom-webpack:browser，并在 options 中添加 customWebpackConfig 键，如下所示

"builder": "@angular-builders/custom-webpack:browser",
"options": {
  "customWebpackConfig": {
    "path": "./custom-webpack.config.js",
    "replaceDuplicatePlugins": false,
    "mergeStrategies":{"externals":"replace"}
  },
   ... other options

对于 ng serve 命令，更新 angular.json 文件中的 serve/builder

 "serve": {
   "builder": "@angular-builders/custom-webpack:dev-server",
... other options

要在 Angular 中为 webpack 配置 ext-webpack-plugin，请在根目录（package.json 所在的位置）中创建一个名为 custom-webpack.config.js 的文件，并添加以下内容

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

module.exports = function(config, options) {
  config.plugins.push(
    new ExtWebpackPlugin({
      framework: 'angular',
      toolkit: 'modern',
      theme: 'theme-material',
      packages: [],
      script: '',
      emit: 'no',
      port: '1962',
      profile: '',
      environment: 'development',
      treeshake: 'no',
      browser: 'no',
      watch: 'no',
      verbose: 'no',
      inject: 'yes',
      intellishake: 'no'
    })
  )
  return config;
}

运行应用程序

在终端或命令窗口中，运行应用程序

ng serve

或

npm start

用于生产构建

npm run buildprod

在浏览器中浏览到 https://:4200。您应该在浏览器中看到带有 ExtAngular Panel 和 Grid 的 Angular 启动器应用程序。

ExtAngular 7.5.0