ExtReact 文档帮助

简介

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

术语、图标和标签

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

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

访问级别

框架类或其成员可以指定为 private(私有)或 protected(受保护)。否则,该类/成员为 public(公共)。Publicprotectedprivate 是访问描述符,用于传达类或类成员应如何以及何时使用。

成员类型

成员语法

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

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

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

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

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

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

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

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

成员图标

- 表示类型为 config 的类成员

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

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

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

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

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

类成员快速导航菜单

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

Getter 和 Setter 方法

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

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

历史记录栏

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

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

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

搜索和过滤器

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

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

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

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

API 文档类元数据

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

展开和折叠示例和类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

ExtReact 7.5.0


顶部

ExtReact 7.5 的新增功能

ExtReact 7.4 的新增功能

版本 7.3 的新增功能

独立的现代和经典包

7.3 现在支持 Ext JS 的现代和经典工具包的独立包

  • @sencha/ext-react-modern
  • @sencha/ext-react-classic

ExtReact 7.2 的新增功能

@sencha/ext-react-modern 的新增功能

版本 7.1 的新增功能

独立的现代和经典包

7.1 现在支持 Ext JS 的现代和经典工具包的独立包

  • @sencha/ext-react-modern
  • @sencha/ext-react-classic

@sencha/ext-react 包已弃用

已弃用的包 - 请参阅 git 仓库

  • deprecate-ext-react
  • deprecate-ext-react-babel-plugin
  • deprecate-ext-react-classic-demo
  • deprecate-ext-react-renderercell(此功能现在嵌入在 ext-react-modern 和 ext-react-classic 中)
  • deprecate-ext-react-transition
  • deprecate-ext-react-webpack-plugin(现在为 ext-webpack-plugin)

启动应用程序

ExtReact 应用程序的启动已简化

import React from 'react';
//import ReactDOM from 'react-dom';
import ExtReactDOM from '@sencha/ext-react-modern';
import App from './App';

ExtReactDOM.render(<App />, document.getElementById('root'));

移除对以下内容的需求:根元素

所有导入现在都来自 '@sencha/ext-react-modern'

所有导入的元素现在都以 Ext 为前缀

import { ExtGrid, ExtButton } from "@sencha/ext-react-modern";

新的 viewport="true" 属性

onReady 事件 - 所有组件可用,cmp 和 cmpObj

使用 cmpObj

要使用 Ext JS 视口,请将其添加到根元素

<ExtContainer
  viewport={ true }
  extname="containerExt"
  ref={ containerReact => this.containerReact = containerReact }
  onReady={ this.extReactDidMount }
>
</ExtContainer>

extReactDidMount = ({cmp, cmpObj}) => {
  for (var prop in cmpObj) {this[prop] = cmpObj[prop]}
  console.log(this['containerExt'])
  console.log(this.containerExt)
  console.log(this.containerReact.cmp)
}

事件名称大小写更改

例如:onActiveTabChange 现在是 onActivetabchange

事件参数现在遵循文档中的描述

例如:对于选项卡更改事件

  onTabChange = ({sender, value, oldValue}) => {

  }

从 .babelrc 和/或 package.json 中移除 ext-react-babel-plugin

需要一个 rood
围绕纯文本

可选 - 无需 webpack 插件

  • 有关示例,请参阅入门指南

@sencha/ext-react-classic 的新增功能

版本 7.1 的新增功能

独立的现代和经典包

7.1 现在支持 Ext JS 的现代和经典工具包的独立包

  • @sencha/ext-react-modern
  • @sencha/ext-react-classic

@sencha/ext-react 包已弃用

已弃用的包 - 请参阅 git 仓库

  • deprecate-ext-react
  • deprecate-ext-react-babel-plugin
  • deprecate-ext-react-classic-demo
  • deprecate-ext-react-renderercell(此功能现在嵌入在 ext-react-modern 和 ext-react-classic 中)
  • deprecate-ext-react-transition
  • deprecate-ext-react-webpack-plugin(现在为 ext-webpack-plugin)

启动应用程序

ExtReact 应用程序的启动已简化

import React from 'react';
//import ReactDOM from 'react-dom';
import ExtReactDOM from '@sencha/ext-react-modern';
import App from './App';

ExtReactDOM.render(<App />, document.getElementById('root'));

移除对以下内容的需求:根元素

所有导入现在都来自 '@sencha/ext-react-modern'

所有导入的元素现在都以 Ext 为前缀

import { ExtGrid, ExtButton } from "@sencha/ext-react-modern";

新的 viewport="true" 属性

onReady 事件 - 所有组件可用,cmp 和 cmpObj

使用 cmpObj

要使用 Ext JS 视口,请将其添加到根元素

<ExtContainer
  viewport={ true }
  extname="containerExt"
  ref={ containerReact => this.containerReact = containerReact }
  onReady={ this.extReactDidMount }
>
</ExtContainer>

extReactDidMount = ({cmp, cmpObj}) => {
  for (var prop in cmpObj) {this[prop] = cmpObj[prop]}
  console.log(this['containerExt'])
  console.log(this.containerExt)
  console.log(this.containerReact.cmp)
}

事件名称大小写更改

例如:onActiveTabChange 现在是 onActivetabchange

事件参数现在遵循文档中的描述

例如:对于选项卡更改事件

  onTabChange = ({sender, value, oldValue}) => {

  }

从 .babelrc 和/或 package.json 中移除 ext-react-babel-plugin

需要一个 rood
围绕纯文本

可选 - 无需 webpack 插件

  • 有关示例,请参阅入门指南

ExtReact 7.5.0