了解 App Classic | ExtReact 7.5.0

ExtReact 文档帮助

内容

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

简介

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

术语、图标和标签

许多类在使用具有配置对象的类（实例化）时具有快捷名称。快捷名称称为 别名（如果类扩展 Ext.Component，则称为 xtype）。对于可应用的类，别名/xtype 会列在类名称旁边以供快速参考。

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

访问级别

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

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

成员类型

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

成员语法

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

Ext.container.Container

查看源

lookupComponent ( item ) : Ext.Component

protected

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

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

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

参数

item : Object

正在添加的配置对象。

Ext.Component

要添加的组件。

我们来看看成员行中的每个部分

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

成员标志

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

必需 - 实例化类时的必需配置
可绑定 - 配置具有一个 setter，允许通过 ViewModel 绑定设置此配置
除非标记为 immutable，否则所有 ExtReact 属性都是 bindable
不可变
实例化组件时，不可变的 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）。备用类名通常用于向后兼容。
层次结构 - 层次结构视图列出了当前类的继承链，从其祖先类一直到根基类。
混合 - 混合到当前类的类列表
继承的 Mixin - 混合到当前类祖先中的类列表
需要 - 类实例化所需的全部类定义
使用 - 类在其生命周期的某个时刻可能使用的类列表，但类最初实例化时不一定需要
子类 - 扩展当前类的类

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

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

查看类源代码

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

ExtReact 7.5.0

显示私有类

顶部

内容

了解 @sencha/ext-react-classic 的应用程序将 ExtReact 添加到现有的 React 应用程序更改 ExtReact 应用程序的主题初始化 ExtReact 应用程序在应用程序中使用 ExtReact 组件了解 ExtReact 'ready' 事件在网格列渲染函数中使用 JSX

了解 @sencha/ext-react-classic 的应用程序

本指南将说明 React 应用程序中 ExtReact 的一些主要功能。要创建启动应用程序，请遵循入门指南。

将 ExtReact 添加到现有的 React 应用程序

要将 ExtReact 添加到使用 create-react-app 创建的现有应用程序，请在 React 应用程序的根文件夹中运行以下命令

npm install @sencha/ext-react-classic

这将创建一个 'public/ext-runtime-classic' 文件夹，并在 'public/index.html' 文件中添加几个条目。

<script src="%PUBLIC_URL%/ext-runtime-classic/classic.engine.js"></script>
<link href="%PUBLIC_URL%/ext-runtime-classic/material/material-all.css" rel="stylesheet" type="text/css"></link>

原始 index.html 作为 public.indexBack.html' 备份

更改 ExtReact 应用程序的主题

在“public/ext-runtime-classic”文件夹中，您会看到几个主题文件夹。要更改并使用其中一个主题，请找到以下行

<link href="%PUBLIC_URL%/ext-runtime-classic/material/material-all.css" rel="stylesheet" type="text/css"></link>

请注意，此行指向 material 文件夹和 material-all.css 文件。例如，要更改为 triton，请更新为以下内容

<link href="%PUBLIC_URL%/ext-runtime-classic/triton/triton-all.css" rel="stylesheet" type="text/css"></link>

以下是所有可用的经典主题

<link href="%PUBLIC_URL%/ext-runtime-classic/graphite/graphite-all.css" rel="stylesheet" type="text/css"></link>
<link href="%PUBLIC_URL%/ext-runtime-classic/material/material-all.css" rel="stylesheet" type="text/css"></link>
<link href="%PUBLIC_URL%/ext-runtime-classic/triton/triton-all.css" rel="stylesheet" type="text/css"></link>

初始化 ExtReact 应用程序

要在 ExtReact 应用程序中呈现根节点，“src/index.js”文件包含一个“ExtReactDOM.render”方法。此方法与“ReactDOM.render”完全相同，只是执行了一些必要的 ExtReact 初始化。

原始呈现（已注释）

//import ReactDOM from 'react-dom';
//ReactDOM.render(<App />, document.getElementById('root'));

更新的呈现（适用于 ExtReact）

import ExtReactDOM from '@sencha/ext-react-classic';
ExtReactDOM.render(<App />, document.getElementById('root'));

在应用程序中使用 ExtReact 组件

要使用 ExtReact 组件及其所需的导入语句

import { ExtPanel } from "@sencha/ext-react-classic";
import { ExtButton } from "@sencha/ext-react-classic";

这也可以合并到一行中

import { ExtPanel, ExtButton } from "@sencha/ext-react-classic";

了解 ExtReact“ready”事件

在使用 ExtReact 组件时，您需要确保在调用任何组件方法或在代码中更新属性之前，这些组件完全可用。因此，每个组件都有一个“ready”事件。

当监听此事件时，它会向您的应用程序指示页面上的所有 ExtReact 组件已准备就绪并可用。在此事件中，将发送两个参数，第一个是调用 ready 事件的 ExtReact 组件，第二个是页面上应用了“extname”属性的组件数组。

  pageReady = ({cmp, cmpObj}) => {
    //ExtPanel component available as cmp parm
    //ExtButton available as cmpObj['theButton1']
    //can now call the following:
    //cmpObj['theButton1'].setText('new button1 text')
    //ExtButton available as cmpObj['theButton2']
  }

  render() {
    return (
      <ExtPanel
        extname="thePanel"
        onReady={ this.pageReady }
      >
        <ExtButton text="Click Me" extname="theButton1"></ExtButton>
        <ExtButton text="Click Me" extname="theButton2"></ExtButton>
    )
  }

您还可以使用“ref”属性识别任何 ExtReact 组件

  render() {
    return (
      <ExtGrid
        ref={ grid => this.grid = grid }

此属性会将 ExtGrid 组件作为“this.grid”提供。但是，请注意，在调用“ready”事件之前，无法保证任何 ExtReact 组件的完整功能可用

  pageReady = ({cmp, cmpObj}) => {
    //ExtButton available as this.button1
    //can now call the following:
    //this.button1.setText('new button1 text')
    //ExtButton available as cmpObj['theButton2']
  }

  render() {
    return (
      <ExtPanel
        extname="thePanel"
        onReady={ this.pageReady }
      >
        <ExtButton text="Click Me" ref={ button1 => this.button1 = button1 }></ExtButton>
        <ExtButton text="Click Me" extname="theButton2"></ExtButton>
    )
  }

在网格列呈现函数中使用 JSX

ExtColumn 支持将呈现函数作为 JSX

  renderName = (value, context) => (
    <div style={{height:'15px'}}>
      <span>span - { context.data.name }</span>
      <ext-button shadow="true" text={ context.data.name }></ext-button>
    </div>
  )


  render() {
    return (
      <ExtGrid

      >
        <ExtColumn text="Name" dataIndex="name" flex= renderer={ this.renderName }/>

      </ExtGrid>
    )
  }