ExtReact 文档帮助

目录

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

简介

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

术语、图标和标签

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

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

访问级别

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

成员类型

成员语法

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

Ext.container.Container
查看源代码
lookupComponent ( item ) : Ext.Component
protected

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

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

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

参数

item :  Object

要添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

- 组件类型的框架类（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


顶部

目录

步骤 1：安装 Angular CLI 并生成 Angular 应用程序 步骤 2：从 npm 安装软件包 如果您是试用客户 如果您是活跃客户 步骤 3：将 ExtAngular 组件添加到 Angular 应用程序 步骤 1：配置应用程序 步骤 2：配置 TypeSript 应用程序配置 步骤 3：试用 下一步

将 ExtAngular 现代组件添加到您的应用

本指南涵盖将 ExtAngular 现代组件添加到 Angular 应用程序。

步骤 1：安装 Angular CLI 并生成 Angular 应用程序

在项目中，在 package.json 中安装 ExtAngular 组件依赖项

$ npm i @angular/[email protected]

$ ng new ext-angular-modern-demo --minimal=true --interactive=false -g=true --skipInstall=false

$ cd ext-angular-modern-demo

步骤 2：从 npm 安装软件包

如果您是试用客户

ExtAngular 30 天试用软件包可从公共 npm 安装。

$ npm install @sencha/ext-modern-runtime --save
$ npm install @sencha/ext-angular-modern --save

如果您是活跃客户

ExtAngular 和所有相关的商业软件包都托管在 Sencha 的私有 npm 注册表中。使用以下命令登录到注册表，该命令配置 npm 以从 Sencha 的注册表下载 @sencha 范围内的软件包。

用户名注意： 在支持门户激活期间（购买许可证后）使用的电子邮件和密码将用于登录 Sencha 的 NPM 仓库。用户名与使用的电子邮件相同，但是，@ 字符替换为 '..' 两个句点。例如 [email protected] 转换为 name..gmail.com 作为用户名。

$ npm login --registry=https://npm.sencha.com/ --scope=@sencha

$ npm install @sencha/ext-modern-runtime --save
$ npm install @sencha/ext-angular-modern --save

步骤 3：将 ExtAngular 组件添加到 Angular 应用程序

步骤 1：配置应用程序

可选：配置 CSS

在文件 [project]/src/styles.css 中添加一些规范化 css。

/ 文件：[project]/src/styles.css /

:root {
  --base-color: #024059;
  --base-foreground-color: white;
  --background-color: white;
  --color: black;
}

配置 Angular App 模块

在文件 [project]/src/app/app.module.ts 中添加 ExtAngular 组件导入。

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
// 1. Import the ExtAngular components
import { ExtAngularModernModule } from '@sencha/ext-angular-modern';
import { AppComponent } from './app.component';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    // 2. Delclare the ExtAngular import in the app module imports.
    ExtAngularModernModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

使用 ExtAngular 组件配置组件 在文件 [project]/src/app/app.component.ts 中，在 html 模板中声明一个 ExtAngular 组件。

import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    template: `
      <!-- ExtAngular Component simple Example -->
      <ExtButton text="My Button" shadow="true"></ExtButton>
    `,
    styles: []
})
export class AppComponent {
}

步骤 2：配置 TypeSript 应用程序配置

  • 对于 @angular/cli 的 9.x 版本，更新 ./tsconfig.json
  • 对于 @angular/cli 的 10.x 版本，更新 ./tsconfig.base.json

建议您使用 @angular/cli 版本 9.1.12

  1. 添加编译器选项

    "compilerOptions": {
 ...
 "typeRoots": [
   "node_modules/@types"
 ],
 "paths": {
   "@angular/*": ["node_modules/@angular/*"],
   "@sencha/*": ["node_modules/@sencha/*"]
 },
 "noImplicitAny": false,
 "suppressImplicitAnyIndexErrors": true,
 "preserveSymlinks": true,
 ...
}

  2. 添加 includes

    "include": [
 "**/lib/**/*.ts",
 "src/**/*.ts",
 "node_modules/@sencha/**/*.ts",
]

步骤 3：试用

使用 npm start 运行应用程序

npm start

下一步

查找更多 Sencha 组件以在您的应用程序中使用。

在 Sencha Fiddle 中试用

ExtAngular 7.5.0