ExtReact 文档帮助

简介

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

术语、图标和标签

许多类在使用配置对象创建(实例化)类时都有快捷名称。快捷名称被称为 别名(或 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 文档和成员类型菜单的方法部分以及配置部分中,就在它们所处理的配置下方。getter 和 setter 方法文档将在配置行中找到,以便于参考。

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

历史记录栏

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

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

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

搜索和过滤器

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

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

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

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

API 文档类元数据

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

展开和折叠示例以及类成员

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

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

桌面与移动视图

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

查看类源代码

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

ExtReact 7.5.0


顶部

使用 @sencha/ext-react-modern 创建新的 create-react-app 项目

步骤 1:从 npm 安装软件包并创建 React 应用程序

使用 create-react-app 和 ExtReact 模板创建 React 应用程序

如果您是试用客户

ExtReact 30 天试用软件包可从公共 npm 安装。要使用 ExtReact 模板 create-react-app,请运行以下命令。

$ npx create-react-app --template @sencha/ext-react-modern ext-react-modern-demo

如果您是活跃客户

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

用户名注意事项:

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

$ npm login --registry=https://npm.sencha.com/ --scope=@sencha
$ npx create-react-app --template @sencha/ext-react-modern ext-react-modern-demo

步骤 2:启动 ExtReact 应用程序

当 create-react-app 完成后,运行以下命令

$ cd ext-react-modern-demo

要启动 ExtReact 应用程序,请在终端窗口中运行以下命令

$ npm start

步骤 3(可选):更改 @sencha/ext-react-modern 应用程序的主题

  • 要更改主题,请编辑 'public/index.html' 并取消注释此行下方的链接之一
<link href="%PUBLIC_URL%/ext-runtime-modern/material/material-all.css" rel="stylesheet" type="text/css"></link>

ExtReact 应用程序将在浏览器窗口中加载!

下一步

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

在 Sencha Fiddle 中试用

ExtReact 7.5.0