ExtReact 文档帮助

内容

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

简介

ExtReact 产品的文档与其他 Sencha 产品的文档略有不同。以下部分描述了除 ExtReact 独有部分以外的所有产品的文档。

术语、图标和标签

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

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

访问级别

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

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

成员类型

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 配置时，或当新项目被添加或 {@link #insert 插入} 时，将原始配置对象添加到此容器时调用。

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

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

参数

item : Object

要添加的配置对象。

返回值

Ext.Component

要添加的组件。

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

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

成员标志

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

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

类图标

- 表示框架类

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

- 组件类型框架类（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 原语页面）都有一个与该类相关的元数据的菜单视图。此元数据视图将包含以下一项或多项

替代名称 - 一个或多个其他类名称同义词（在 Ext JS 6.0.0 中，Ext.button.Button 类有一个替代类名称Ext.Button）。替代类名称通常为了向后兼容而维护。
层次结构 - 层次结构视图列出了当前类的继承链，从当前类一直到其祖先类，直到根基类。
混合类 - 混合到当前类中的类列表
继承的混合类 - 混合到当前类祖先中的类列表
依赖项 - 类实例化所需的所有类
使用 - 类在其生命周期中可能使用的类列表，但不一定需要在类最初实例化时使用
子类 - 扩展当前类的类

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

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

查看类源代码

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

ExtAngular 7.5.0

显示私有类

顶部

内容

灵活布局平台查询 prop 属性响应式属性

为多个环境和屏幕开发

ExtAngular 帮助开发人员在所有设备和屏幕尺寸上提供出色的用户体验。本指南介绍了如何使用 ExtAngular 实现响应式和自适应设计，以针对每个环境创建合适的 UI。

灵活布局

ExtAngular 提供以下布局，这些布局会根据可用空间自动调整子元素的大小

fit - 将单个子元素的大小调整为填充父元素的 100% 高度和宽度。
box - 子元素的大小根据其 flex 属性的相对值按比例调整。
hbox - 具有水平对齐的 box 布局的子类。
vbox - 具有垂直对齐的 box 布局的子类。

例如，要将可用水平空间平均分配到两个组件之间

<container layout="hbox">
  <panel title="Left" flex=1>...</panel>
  <panel title="Right" flex=1>...</panel>
</container>

您也可以固定某些子元素的大小，同时允许其他子元素填充剩余空间

<container layout="hbox">
  <panel title="Left" width=300>...</panel>
  <panel title="Right" flex=1>...</panel>
</container>

或者，允许子元素增长或缩小到特定大小，不再增长或缩小

<container layout="hbox">
  <panel title="Left" maxWidth=500 flex=1>...</panel>
  <panel title="Right" flex=1>...</panel>
</container>

使用相对 flex 值为每个子元素指定比例空间。例如，要将 1/3 的水平空间分配给左侧面板，将 2/3 的水平空间分配给右侧面板

<container layout="hbox">
  <panel title="Left" flex=1>...</panel>
  <panel title="Right" flex=1>...</panel>
</container>

平台查询

ExtAngular 允许您根据用户的设备类型和平台调整 UI

`Ext.platformTags`

您可以使用 Ext.platformTags 检查应用程序运行的平台。以下示例在手机上运行时显示单独的 UI 组件

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

@Component({
    selector: 'app-root-1',
    styles: [``],
    template: `
        <PhoneUI *ngIf="isPhone"></PhoneUI>
        <DesktopUI *ngIf="!isPhone"></DesktopUI>
    `
})
export class ExampleComponent {
    isPhone = Ext.platformTags.phone;
}

您还可以检查特定浏览器，例如：Ext.platformTags.safari，或操作系统：Ext.platformTags.android。

要检查特定操作系统版本，请使用 Ext.os.version.

`platformConfig` 属性

您可以使用 platformConfig 属性为不同的环境指定不同的属性。以下示例在手机上使用垂直布局，在所有其他环境中使用水平布局

<container 
  [layout]="'hbox'"
  [platformConfig]="{
    'phone': {
      layout: 'vbox'
    }
  }"
>
  ...
</container>

您可以使用否定（“！”）来定位除特定环境之外的所有环境。上面的示例中的 Container 也可以写成

<container 
  layout="vbox"
  [platformConfig]="{
    '!phone': {
      layout: 'hbox'
    }
  }"
>
  ...
</container>

或者

<container 
  [platformConfig]="{
   'phone': {
      layout: 'vbox'
    },
    '!phone': {
      layout: 'hbox'
    }
  }"
>
  ...
</container>

或者，使用 Ext.platformTags

<container [layout]="Ext.platformTags.phone ? 'vbox' : 'hbox'">
  ...
</container>

响应式属性

您可以使用 responsiveConfig 属性根据屏幕大小提供不同的属性。使用 responsiveConfig 时，当用户旋转或调整浏览器窗口大小时，UI 会自动更新。

例如，当屏幕宽度小于 600 像素时，缩写面板的标题

<panel 
  [responsiveConfig[="{
    'width >= 600': {
      title: 'Manufacturing Summary'
    },
    'width < 600': {
      title: 'Mfg Summary'
    }
  }"
>
  ...
</panel>

要使用 responsiveConfig 属性，请确保在应用程序中使用 Ext.require 要求它

// App.js

Ext.require('Ext.plugin.Responsive');

您还可以为横向和纵向设置不同的属性。以下示例在设备处于纵向模式时缩写面板标题。

<container 
  [responsiveConfig]="{
    landscape: {
      title: 'Manufacturing Summary'
    },
    portrait: {
      title: 'Mfg Summary'
    }
  }"
>
    ...
</container>

responsiveConfig 属性还接受 platformTags。例如

<container 
  [platformConfig]="{
    "phone": {
      layout: 'vbox'
    },
    "!phone": {
      layout: 'hbox'
    }
  }"
>
    ...
</container>

您可以通过在单独的模块中定义响应式公式来在所有组件之间共享它们

// responsiveFormulas.js
export const xsmall = "width <= 576";
export const small = "width <= 768";
export const medium = "width <= 992";
export const large = "width <= 1200";
export const xlarge = "width > 1200";

并将它们导入到您的响应式组件中

// MyComponent.ts
import { small, xsmall } from './responsiveFormulas';
import { Component } from '@angular/core';
declare var Ext: any;

@Component({
    selector: 'app-root-1',
    styles: [``],
    template: `
    <panel 
      [responsiveConfig]="{
        true: {
          title: 'Summary of Manufacturing'
        }
        [small]: {
          title: 'Manufacturing Summary'
        },
        [xsmall]: {
          title: 'Mfg Summary'
        }
      }"
    >
      ...
    </panel>`
})
export class ExampleComponent {
}

这里我们使用第一个键的 true 值来提供默认标题。

您还可以将自定义公式定义为函数。例如，我们可以为周末定义一个响应式公式

// responsiveFormulas.js
...
export const weekends = (context) => {
  const today = new Date().getDay();
  return today === 0 || today === 6
}

定义自己的响应式公式函数时，将它们作为对象导入并将其分配给组件的 responsiveFormulas 属性。然后在 responsiveConfig 属性中按名称引用每个公式

// MyComponent.ts
import * as responsiveFormulas from './responsiveFormulas';

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

@Component({
    selector: 'app-root-1',
    styles: [``],
    template: `
    <panel 
      [responsiveFormulas]="responsiveFormulas"
      [responsiveConfig]="{
        true: {
          title: 'Summary of Manufacturing'
        }
        small: {
          title: 'Manufacturing Summary'
        },
        weekends: {
          title: "Go home, it's a weekend!"
        }
      }"
    >
      ...
    </panel>
    `
})
export class ExampleComponent {
}

responsiveConfig 属性由响应式插件提供，该插件会自动添加到具有 responsiveConfig 属性的任何 ExtAngular 组件中。

内容

简介

术语、图标和标签

访问级别

成员类型

成员语法

成员标志

类图标

成员图标

导航和功能

类成员快速导航菜单

Getter 和 Setter 方法

历史记录栏

搜索和过滤器

API 文档类元数据

展开和折叠示例和类成员

桌面 -vs- 移动视图

查看类源代码

ExtAngular 7.5.0

内容

为多个环境和屏幕开发

灵活布局

平台查询

Ext.platformTags

platformConfig 属性

响应式属性

ExtAngular 7.5.0

`Ext.platformTags`

`platformConfig` 属性