文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
protected

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

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

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

参数

item :  Object

要添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

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

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

成员图标

- 表示 config 类型的类成员

- 表示 property 类型的类成员

- 表示 method 类型的类成员

- 表示 event 类型的类成员

- 表示 theme variable 类型的类成员

- 表示 theme mixin 类型的类成员

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

类成员快速导航菜单

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

Getter 和 Setter 方法

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

历史记录栏

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

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

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

搜索和过滤器

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

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

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

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

API 文档类元数据

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

展开和折叠示例及类成员

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

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

桌面与移动视图

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

查看类源代码

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

Ext JS 7.8.0 - Modern Toolkit


顶部
指南适用于: modern

npm 故障排除

以下是一些 npm (node package manager) 故障排除的技巧和窍门。

如果您是试用客户

Ext JS 30 天试用包可从公共 npm 安装。使用以下命令安装最新的 Ext JS 版本,然后跳到步骤 2。

$ npm install -g @sencha/ext-gen

如果您是活跃客户

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 -g @sencha/ext-gen

社区版

https://extjs.cn/extjs/7.0.0-CE/index.html

npm 重置

如果遇到身份验证问题 (403) 或校验和错误,可以使用这些步骤来重置 npm 系统。

Linux / macOS

  1. 运行 rm ~/.npmrc - 删除存储的 npm 仓库凭据。此位置在您的系统上可能有所不同。
  2. 运行 npm cache clean --forcerm -rf ~/.npm - 通过删除 npm 包缓存来清理它。
  3. 运行 npm login --registry=https://npm.sencha.com --scope=@sencha - 重新登录到仓库。
  4. 运行 npm install -g @sencha/ext-gennpm install -g @sencha/ext-react-gen

Windows (命令提示符)

  1. 运行 del %HOMEPATH%\.npmrc - 删除存储的 npm 仓库凭据。此位置在您的系统上可能有所不同。
  2. 运行 npm cache clean --forcermdir /s /q %HOMEPATH%\AppData\Roaming\npm - 清理 npm 包。
  3. 运行 rmdir /s /q %HOMEPATH%\AppData\Roaming\npm-cache - 通过删除 npm 缓存来清理它。
  4. 运行 npm login --registry=https://npm.sencha.com --scope=@sencha - 重新登录到仓库。
  5. 运行 npm install -g @sencha/ext-gennpm install -g @sencha/ext-react-gen

403 错误

npm.sencha.com 上出现授权错误时。

首先要做的是验证您是否已通过我们的仓库正确身份验证,方法是验证您是否已在 .npmrc 文件中获得访问令牌。

Windows:验证授权令牌,查看 .npmrc 的内容

  1. 从主目录 (%HOMEPATH% 或您的安装将此文件放置在何处) 运行 type .npmrc

Linux / macOS:验证授权令牌,查看 .npmrc 的内容

  1. 从主目录 (~/ 或您的安装将此文件放置在何处) 运行 cat .npmrc

尝试重新身份验证

  1. 运行 npm login --registry=https://npm.sencha.com --scope=@sencha 并再次登录 npm 仓库。
  2. 运行 npm --registry https://npm.sencha.com whoami 测试您的授权。
  3. 运行 npm install -g @sencha/ext-gennpm install -g @sencha/ext-react-gen 以验证您已登录。

高级组件的 403 错误

高级组件要求您已在 商店的产品矩阵中购买了高级组件。如果您尚未购买产品的高级组件,当您尝试为产品的高级组件运行 npm install 时,它将抛出 403 异常。

  • 查看商店以比较产品包矩阵。检查支持门户订阅信息、产品代码,这些信息可以告诉您在商店的产品矩阵中拥有哪个产品包版本。

项目重置

有时可能需要重置项目中的 node 包/依赖项。

Windows (命令提示符)

  1. 运行 rmdir /s /q node_modules 删除项目中的 node_modules 目录。
  2. 运行 npm install 再次下载依赖项。

Linux / macOS

  1. 运行 rm -rf node_modules 删除项目中的 node_modules 目录。
  2. 运行 npm install 再次下载依赖项。

npm 运行脚本

在 npm 脚本中使用构建配置文件

当您使用 ExtGen 生成应用程序时,会提供两个 npm 构建脚本以帮助您入门。第一个脚本是 devdev 脚本将构建应用程序的开发版本并在浏览器中启动它。第二个脚本是 build 脚本。此脚本旨在创建应用程序的生产就绪版本。

与 Sencha Cmd 一样,您的 app.json 将在 builds 对象中包含构建配置文件。默认情况下,桌面构建配置文件指定为您要在 build 脚本中用于构建生产应用程序的构建配置文件。您可以通过为 --env.profile 设置脚本参数来指定要在 npm 脚本中使用的构建配置文件,如下所示

"dev": "webpack-dev-server --env.profile=phone --env.browser=yes --env.verbose=no",
"build": "npm run clean && cross-env webpack --env.profile=desktop --env.environment=production --env.treeshake=yes"

我添加了构建配置文件,但现在无法构建

在 app.json 中添加构建配置文件时,您必须查看它并验证所有路径是否存在。例如,如果您使用 ext-gen 生成应用程序,请确保 {build.id}/some/path 存在于您的项目中。确保您浏览整个 app.json 并验证所有路径都存在于您的代码中。

当 app.json 属性路径不存在时,会出现此错误。

% sencha app build
Sencha Cmd v7.X.X.X
[INF] Processing Build Descriptor : desktop (production environment)
[INF] Loading compiler context
[INF] Loading app json manifest...
[ERR] Failed to resolve dependency MyExtGenApp.Application for file MyExtGenApp.app.$Application
[ERR] 
[ERR] BUILD FAILED
[ERR] com.sencha.exceptions.ExNotFound: Unknown definition for dependency : MyExtGenApp.Application
[ERR] 
[ERR] Total time: 3 seconds
...

一旦您从项目中的 app.json 添加缺失的路径,它就会构建。

  • 您可以创建任意数量的脚本来满足您的需求,我们只是为了您的方便提供开发构建和生产构建的示例。

Ext JS 7.8.0 - Modern Toolkit