ExtReact 文档帮助

目录

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

简介

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

术语、图标和标签

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

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

访问级别

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

成员类型

成员语法

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

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

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

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

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

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

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

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

成员图标

- 表示类型为 config 的类成员

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

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

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

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

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

类成员快速导航菜单

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

Getter 和 Setter 方法

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

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

历史记录栏

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

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

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

搜索和过滤器

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

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

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

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

API 文档类元数据

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

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

ExtAngular 7.5.0


顶部

目录

要求 使用 Ext JS 组件创建新的 Angular 应用程序 将 Ext JS 添加到现有的 Angular 应用程序 添加 ext-angular 配置 Webpack 配置 package.json 更新 index.html HTML Doctype Viewport Meta Tag 启动您的应用程序 ESLint 在 Angular 中使用 Ext JS 组件 导入组件 配置组件 处理事件 事件 在 ExtAngular 组件内部使用 HTML 元素和非 ExtAngular 组件

Ext JS 客户指南

Ext JS 客户可以在 Angular 应用程序中使用可用的 @sencha/ext-angular 库中的 ExtAngular 组件。本指南记录了将 Ext JS 组件添加到 Angular 应用程序所需的步骤。

要求

  • Node 8.11+
  • npm 6+
  • Angular 9.1.7+
  • Webpack 4+

使用 Ext JS 组件创建新的 Angular 应用程序

如果您从头开始，我们建议克隆 ext-angular monorepo 并复制其中一个样板来创建一个新的应用程序

例如，要使用该样板

git clone https://github.com/sencha/ext-angular.git
cp -r ext-angular/packages/ext-angular-boilerplate /path/to/new/app

然后，按照样板的 README.md 中的说明设置并运行您的新应用程序。

将 Ext JS 添加到现有的 Angular 应用程序

如果您需要将 Ext JS 组件添加到现有的 Angular 应用程序，请按照以下步骤操作

添加 ext-angular

Sencha 提供了一组软件包，可帮助将 Ext JS 集成到 Angular 中。通过从 npm 安装它们，将其添加到您的 Angular 应用程序中

npm install --save @sencha/ext-angular
npm install --save @sencha/ext @sencha/ext-modern @sencha/ext-modern-theme-material
npm install --save-dev @sencha/ext-angular-webpack-plugin html-webpack-plugin webpack-filter-warnings-plugin
npm install --save webpack webpack-cli webpack-dev-server
npm install --save css-loader file-loader html-loader node-sass raw-loader sass-loader style-loader
npm install --save @ngtools/webpack

配置 Webpack

ExtAngular 需要一个 webpack 插件来捆绑和优化您在应用程序中使用的 ExtAngular 组件。将其添加到您的 webpack 配置中，如下所示

const AngularCompilerPlugin = require('@ngtools/webpack').AngularCompilerPlugin
const ExtWebpackPlugin = require('@sencha/ext-angular-webpack-plugin')
const WebpackShellPlugin = require('webpack-shell-plugin-next')
const path = require('path')
const HtmlWebpackPlugin = require('html-webpack-plugin')
const { BaseHrefWebpackPlugin } = require('base-href-webpack-plugin');
const webpack = require("webpack")
const FilterWarningsPlugin = require('webpack-filter-warnings-plugin')
const portfinder = require('portfinder')

module.exports = function (env) {
  var browserprofile
  var watchprofile
  var buildenvironment = env.environment || process.env.npm_package_extbuild_defaultenvironment
  if (buildenvironment == 'production') {
    browserprofile = false
    watchprofile = 'no'
  }
  else {
    if (env.browser == undefined) {env.browser = true}
    browserprofile = JSON.parse(env.browser) || true
    watchprofile = env.watch || 'yes'
  }
  const isProd = buildenvironment === 'production'
  var basehref = env.basehref || '/'
  var buildprofile = env.profile || process.env.npm_package_extbuild_defaultprofile
  var buildenvironment = env.environment || process.env.npm_package_extbuild_defaultenvironment
  var buildverbose = env.verbose || process.env.npm_package_extbuild_defaultverbose
  if (buildprofile == 'all') { buildprofile = '' }
  if (env.genProdData == undefined) {env.genProdData = false}
  var genProdData = env.genProdData ? JSON.parse(env.genProdData) : false
  var mode = isProd ? 'production': 'development'

  portfinder.basePort = (env && env.port) || 1962
  return portfinder.getPortPromise().then(port => {
    const plugins = [
      new AngularCompilerPlugin({
        tsConfigPath: './tsconfig.json',
        entryModule: "src/app/app.module#AppModule",
        mainPath: "./src/main.ts",
        skipCodeGeneration: true
      }),
      new HtmlWebpackPlugin({
        template: "index.html",
        hash: true,
        inject: "body"
      }),
      new BaseHrefWebpackPlugin({ baseHref: basehref }),
      new ExtWebpackPlugin({
        framework: 'angular',
        port: port,
        emit: true,
        browser: browserprofile,
        genProdData,
        watch: watchprofile,
        profile: buildprofile, 
        environment: buildenvironment, 
        verbose: buildverbose,
        prodFileReplacementConfig: [
          {
            "replace": "src/environments/environment.ts",
            "with": "src/environments/environment.prod.ts"
          }
        ],
        theme: 'theme-material',
        packages: []
      }),
      new WebpackShellPlugin({
        onBuildEnd:{
          scripts: ['node extract-code.js'],
          blocking: false,
          parallel: true
        }
      }),

      new webpack.ContextReplacementPlugin(
          /\@angular(\\|\/)core(\\|\/)fesm5/,
          path.resolve(__dirname, 'src'),{}
      ),
      new FilterWarningsPlugin({
          exclude: /System.import/
      })
    ]
  return {
    mode,
    entry: {
      polyfills: "./polyfills.ts",
      main: "./main.ts"
    },
    context: path.join(__dirname, './src'),
    output: {
      path: path.resolve(__dirname, 'build'),
      filename: "[name].js"
    },
    module: {
      rules: [
        {test: /\.css$/, loader: ['to-string-loader', "style-loader", "css-loader"]},
        {test: /\.(png|svg|jpg|jpeg|gif)$/, use: ['file-loader']},
        {test: /\.html$/,loader: "html-loader"},
        {test: /\.ts$/,  loader: '@ngtools/webpack'},
        //{test: /\.scss$/,loader: ["raw-loader", "sass-loader?sourceMap"]}
      ]
    },
    plugins,
    node: false,
    devtool: "source-map",
    devServer: {
      contentBase: './build',
      historyApiFallback: true,
      hot: false,
      host: '0.0.0.0',
      port: port,
      disableHostCheck: false,
      compress: isProd,
      inline: !isProd,
      stats: {
        assets: false,
        children: false,
        chunks: false,
        hash: false,
        modules: false,
        publicPath: false,
        timings: false,
        version: false,
        warnings: false,
        colors: {
          green: '\u001b[32m'
        }
      }
    }
  }
})
}

注意：如果您使用的是 html-webpack-plugin，请确保它在插件数组中位于 ExtWebpackPlugin 之前，以便将 ext.js 和 ext.css 的标签包含在生成的 index.html 中。

有关为 Angular 配置 ExtWebpackPlugin 的更多信息，请参阅 使用 Webpack 构建。

您还可以使用 ExtAngular 样板中的 webpack 配置文件 作为参考

配置 package.json

配置 package.json 以模仿 ext-angular-boilerplate 中的以下示例

{
  "name": "@sencha/ext-angular-boilerplate",
  "version": "7.1.1",
  "description": "ext-angular-boilerplate",
  "scripts": {
    "start": "npm run dev",
    "clean": "rimraf build",
    "dev": "webpack-dev-server --env.environment=development",
    "prod": "npm run build",
    "build": "npm run clean && cross-env webpack --env.environment=production --env.genProdData=true && cross-env webpack --env.environment=production --env.basehref='/'"
  },
  "extbuild": {
    "defaultprofile": "",
    "defaultenvironment": "development",
    "defaultverbose": "no"
  },
  "devDependencies": {
    "@sencha/ext": "~7.1.1",
    "@sencha/ext-angular": "~7.1.1",
    "@sencha/ext-modern": "~7.1.1",
    "@sencha/ext-modern-treegrid": "~7.1.1",
    "@sencha/ext-modern-theme-material": "~7.1.1",
    "@sencha/ext-angular-webpack-plugin": "~7.1.1",
    "@sencha/ext-ux": "~7.1.1",

    "@angular/common": "^9.1.7",
    "@angular/compiler": "^9.1.7",
    "@angular/compiler-cli": "^9.1.7",
    "@angular/core": "^9.1.7",
    "@angular/forms": "^9.1.7",
    "@angular/http": "^9.1.7",
    "@angular/platform-browser": "^9.1.7",
    "@angular/platform-browser-dynamic": "^9.1.7",
    "@angular/router": "^9.1.7",
    "core-js": "^3.2.1",
    "zone.js": "^0.10.2",

    "typescript": "^3.5.3",
    "@types/core-js": "^2.5.2",
    "@types/node": "^12.7.5",
    "rimraf": "^3.0.0",
    "cross-env": "^5.2.1",

    "@ngtools/webpack":"^8.3.4",
    "portfinder": "^1.0.24",
    "css-loader": "^3.2.0",
    "file-loader":"^4.2.0",
    "html-loader": "^0.5.5",
    "node-sass": "^4.11.0",
    "raw-loader": "^1.0.0",
    "sass-loader": "^7.1.0",
    "style-loader": "^1.0.0",

    "html-webpack-plugin": "^3.2.0",
    "base-href-webpack-plugin": "^2.0.0",
    "webpack-filter-warnings-plugin": "^1.2.1",

    "webpack": "^4.40.2",
    "webpack-cli": "^3.3.9",
    "webpack-dev-server": "^3.8.1"
  },
  "dependencies": {},
  "private": false,
  "main": "",
  "repository": {
    "type": "git",
    "url": "git+https://github.com/sencha"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "bugs": {
    "url": "https://github.com/sencha"
  },
  "homepage": "https://github.com/sencha"
}

更新 index.html

如果您使用的是 html-webpack-plugin，则 ExtWebpackPlugin 为 angular 生成的 JavaScript 和 CSS 资源将在构建时自动添加到您的 index.html 文件中。如果不是，则需要手动添加它们

<!doctype html>
<html>
<head>
    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
    <link href="ext-angular/ext.css" rel="stylesheet">
    ...
</head>
<body>
    ...
    <script type="text/javascript" src="ext-angular/ext.js"></script>
    ...
</body>

HTML Doctype

ExtAngular 组件需要 HTML5 doctype 声明才能正确显示。请确保此声明存在于您的 HTML 文档顶部

<!doctype html>

Viewport Meta Tag

ExtAngular 需要一个 viewport meta 标签。应将其添加到您的 index.html 中的 <head> 元素中。

<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">

启动您的应用程序

要启动您的应用程序，请将以下内容添加到您的 main.ts 文件（您的 webpack 入口点）

import { enableProdMode } from '@angular/core'
import { bootstrapModule } from '@sencha/ext-angular/esm5/lib/ext-angular-bootstrap.component';
import {AppModule} from './app/app.module';
import { environment } from './environments/environment'

if (environment.production) {enableProdMode()}
bootstrapModule(AppModule);

这里 AppModule 是您的应用程序根模块。您将需要一个引导组件和一个引导服务才能成功启动带有已创建文件夹的应用程序。您可以在应用程序的根模块中使用它们来启动您的应用程序，如下所示

declare var Ext: any
import { NgModule } from '@angular/core'
import { ExtAngularModule } from '@sencha/ext-angular'
import { ExtAngularBootstrapService } from '@sencha/ext-angular/esm5/lib/ext-angular-bootstrap.service'
import { ExtAngularBootstrapComponent } from '@sencha/ext-angular/esm5/lib/ext-angular-bootstrap.component'
import { AppComponent } from './app.component'

@NgModule({
  imports:         [ExtAngularModule],
  declarations:    [ExtAngularBootstrapComponent, AppComponent],
  providers:       [ExtAngularBootstrapService],
  entryComponents: [AppComponent],
  bootstrap:       [ExtAngularBootstrapComponent]
})
export class AppModule {
  constructor(extAngularService : ExtAngularBootstrapService) {
    extAngularService.setBootStrapComponent(AppComponent)
  }
}

确保

  1. ExtAngularBootstrapComponent 已导入并添加到 declarations 和 bootstrap 条目中。
  2. ExtAngularBootstrapService 已导入并添加到 providers 条目中。
  3. 您在 AppModule 构造函数中注入 ExtAngularBootstrapService 服务，并调用 extAngularService.setBootStrapComponent(AppComponent)，其中 AppComponent 是您的入口组件。

ESLint

如果您正在使用 ESLint，请添加 Ext 作为允许的全局变量

"globals": {
    "Ext": true
}

在 Angular 中使用 Ext JS 组件

导入组件

@sencha/ext-angular 包使所有带有 xtypes 的 Ext JS 类都可用作 Angular 组件。组件名称源自 xtype 的首字母大写、驼峰形式。要使所有组件都可用于您的 Angular 应用程序，请在应用程序的根模块中添加以下导入语句。

import { ExtAngularModule } from '@sencha/ext-angular'

配置组件

Angular 属性将转换为 Ext JS configs。以下是 Ext.grid.Grid 的典型用法

declare var Ext: any
import { Component } from '@angular/core'

@Component({
  selector: 'app-root-1',
  styles: [``],
  template: `
      <grid title="Users" [store]="this.store">
          <column text="Name" dataIndex="name"></column>
          <column text="Email" dataIndex="email"></column>
      </grid>
  `
})
export class UsersGrid {
  store = Ext.create('Ext.data.Store', {
      fields: ['name', 'email'],
      data: [
        { name: 'Tim Smith', email: '[email protected]' },
        { name: 'Jill Lindsey', email: '[email protected]' }
      ]
    })
}

在上面的示例中，我们使用属性设置 Grid 的 title（未数据绑定，因此没有 []）和 store 配置。我们使用 column 子元素而不是使用 columns 属性来设置 columns 配置。两种形式都是可以接受的，但我们认为使用子元素对于 Angular 开发人员来说更直观，因此这是您将在我们所有示例中看到的形式。ExtAngular 自动知道将某些子元素（如 Column）映射到父组件上的 configs。另一个例子是 Menu

<button [text]="'Options'">
    <menu>
        <menuttem [text]="'Options 1'"></menuttem>
        <menuttem [text]="'Options 2'"></menuttem>
        <menuttem [text]="'Options 3'"></menuttem>
    </menu>
</button>

也可以写成

<button 
  text="Options"
  [menu]="[
    { text: 'Option 1' },
    { text: 'Option 2' },
    { text: 'Option 3' }
  ]"
></button>

处理事件

所有 ExtJS 事件都可以在 ExtAngular 中使用。

declare var Ext: any
import { Component } from '@angular/core'

@Component({
  selector: 'app-root-1',
  styles: [``],
  template: `
  <sliderfield
    minValue=0
    maxValue=100
    (change)="onChange($event)"
  ></sliderfield>
  `
})
export class MyComponent {
  onChange = (event) => {
    console.log("Value set to " + event.newValue);
  }
}

您还可以使用 listeners 对象，这在传统的 Ext JS 中很常见

declare var Ext: any
import { Component } from '@angular/core'

@Component({
  selector: 'app-root-1',
  styles: [``],
  template: `
  <sliderfield
    minValue=0
    maxValue=100
    [listeners]="myListeners"
  ></sliderfield>
  `
})
export class MyComponent {
  onChange = (slider, value) => {
    console.log("Value set to " + value);
  }
  myListeners = {
    change: this.onChange
  }
}

ready 事件

ready 事件可用于指向 Ext JS 组件实例

declare var Ext: any
import { Component } from '@angular/core'

@Component({
  selector: 'app-root-1',
  styles: [``],
  template: `
  <sliderfield
    minValue=0
    maxValue=100
    (ready)="sliderReady($event)"
    (change)="onChange($event)"
  ></sliderfield>
  `
})
export class MyComponent {
  slider:any;
  sliderReady = (event) => {
      this.slider = event.ext;    
  }

  onChange = (event) => {
      console.log("Value set to" + this.slider.getValue());
  }
}

在 ExtAngular 组件内部使用 HTML 元素和非 ExtAngular 组件

当 HTML 元素出现在 ExtAngular 组件中时，它们会被包装在 Ext.Component 实例中。这允许 ExtAngular 布局正确地定位非 Angular 组件。例如...

<panel [layout]="'hbox'">
  <container>
    <span #extitem>
      <div>left</div>
      <div>right</div>
    </span>
  </container>
</panel>

... 将导致两个并排的 div。创建的组件结构等效于

Ext.create({
  xtype: 'panel',
  layout: 'hbox'
  items: [
    {
      xtype: 'container',
      items: [
        {
          xtype: 'container',
          width: '100%', height: '100%',
          html: '<span #extitem><div>left</div><div>right</div></span>'
        }
      ]
    }
  ]
});

ExtAngular 7.5.0