ExtReact 文档帮助

简介

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

术语、图标和标签

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

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

访问级别

框架类或其成员可以指定为 privateprotected。否则,类/成员是 publicPublicprotectedprivate 是访问描述符,用于传达应该如何以及何时使用类或类成员。

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护的

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

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

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

参数

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 文档和成员类型菜单的 config 部分中,就在它们工作的 config 下方。Getter 和 Setter 方法文档将在 config 行中找到,以便于参考。

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

历史记录栏

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

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

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

搜索和过滤器

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

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

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

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

API 文档类元数据

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

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

ExtReact 7.5.0


顶部

将 ExtReact Classic 组件添加到您的 React 应用程序。

步骤 1:从 npm 安装软件包

如果您是试用客户

ExtReact 30 天试用软件包可从公共 npm 安装。要将 @sencha/ext-react-classic 添加到使用 create-react-app 创建的现有应用程序,请在 React 应用的根文件夹中运行以下命令。

$ npm install @sencha/ext-classic-runtime
$ npm install @sencha/ext-react-classic

如果您是活跃客户

Ext JS 和所有相关的商业软件包都托管在 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-classic-runtime
$ 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”。

步骤 2:更新 src/index.js

  • 对 src/index.js 进行以下更改

注释掉这些行...

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

...并添加这些行

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

步骤 3:更新组件以使用 @sencha/ext-react-classic

  • 将 import 添加到组件 js 文件的顶部
import { ExtButton } from '@sencha/ext-react-classic';
  • 修改“render”方法以使用组件
  render() {
    return (
      <ExtButton text="click me"></ExtButton>
    )
  }

步骤 4(可选):更改 @sencha/ext-react-classic 应用的主题

在“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>

下一步

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

在 Sencha Fiddle 中试用

ExtReact 7.5.0