文档帮助

目录

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

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

Ext.container.Container
查看源代码
lookupComponent ( item ) : Ext.Component
受保护的

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

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

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

参数

item :  Object

要添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

- 组件类型框架类（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) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。

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

桌面 -vs- 移动视图

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

查看类源代码

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

Cmd 7.8.0


顶部

目录

简介 什么是 Fashion？ JavaScript 扩展 兼容性 使用实时更新 语言扩展 动态变量 赋值 求值 提升 提升 扩展 - 需要 JavaScript 升级 动态变量 Compass 扩展 结论

Fashion

简介

借助 Sencha Cmd 6.0，我们很高兴推出一种用于为 Ext JS 6.0 开发主题的新型快速工具，称为“Fashion”。将 Fashion 和 sencha app watch 结合使用，可以为主题开发创建一种新模式，我们称之为“实时更新”。

实时更新使用 Fashion 编译，然后将最新的 CSS 注入到您正在运行的页面中。这意味着您不必重新加载即可查看主题更改，而是几乎实时地直接在浏览器中看到这些更新。

Sencha Cmd 6 在为 Ext JS 6 应用程序编译主题时也使用 Fashion。由于 Fashion 是用 JavaScript 实现的，因此不再需要 Ruby。

什么是 Fashion？

Fashion 是用于生成 CSS 的 .scss 文件的编译器。Fashion 还添加了一些 Sass 中没有的新功能，这些功能允许 Sencha Inspector 等工具直观地检查和编辑主题（或您的应用程序）定义的变量。

JavaScript 扩展

用户可以通过编写 JavaScript 模块来扩展 Fashion 的功能。一般来说，Ext JS 用户可能最熟悉 JavaScript，因此扩展行为应该比扩展 Compass 简单得多。我们将在下面详细讨论扩展 Fashion。

既然介绍已经结束，让我们来谈谈 Fashion！

兼容性

Fashion 与 CSS3 语法以及 sass-spec 验证套件的大部分兼容。由于 Fashion 确实理解大部分 Sass 代码，因此使用 Fashion 编译现有 .scss 代码应该不难。

但是，由于稍后讨论的其他功能，将 Fashion 称为“Sass 的实现”或 Fashion 编译的语言“是 Sass”是不正确的。在许多地方，“sass”一词用作磁盘上配置选项或文件夹的名称。出于兼容性原因，这些配置选项仍然命名为“sass”，即使底层语言不是严格的“Sass”。

使用实时更新

您可以在（现代）浏览器中打开应用程序，Sass 文件将代替生成的 CSS 加载。然后，Fashion 可以对文件更改做出反应并重新编译 Sass 并更新 CSS，而无需重新加载页面。

有两种方法可以启用 Fashion 以在 sencha app watch 中使用。

您可以通过编辑在 app.json 中找到的“development”对象来启用 Fashion

...
"development": {
    "tags": [
        "fashion"
    ]
},
...

或者，您可以在加载页面时将“?platformTags=fashion:1”添加到您的 URL。

现在我们准备启动了

  • 从应用程序的根文件夹执行“sencha app watch”。
  • 将浏览器导航到您的应用程序（例如，https://127.0.0.1:1841/app）。

您现在应该能够修改您的主题变量并几乎立即看到更改。

注意：实时更新仅在从 Cmd Web 服务器查看页面时有效。在 Ext JS 经典工具包中，某些 Sass 更改可能需要布局或完整页面重新加载。这在现代工具包中将不再是一个问题，因为它更多地基于 CSS3，并且将重新排列以适应更积极的更改。

语言扩展

动态变量

动态变量在 Fashion 中起着非常重要的作用。动态变量类似于普通变量，但它们的值包装在“dynamic()”中。动态变量与普通变量的不同之处在于它们如何相互作用。考虑一下

$bar: dynamic(blue);

$foo: dynamic($bar);  // Notice $foo depends on $bar

$bar: dynamic(red);

@debug $foo;  // red

请注意，$foo 是根据 $bar 计算出来的。Fashion 对此依赖关系进行了特殊处理，并且 $foo 的计算被推迟到 $bar 的最终值已知为止。

换句话说，动态变量分两个阶段处理：赋值和求值。

赋值

动态变量，如普通变量一样，以正常的“级联”顺序赋值（与 !default 不同）

$bar: dynamic(blue);

$bar: dynamic(red);

@debug $bar;  // red

这允许工具将自定义值附加到任何代码块并控制其动态变量。

对动态变量的赋值只能在文件范围内且在任何控制结构之外发生。例如，这是非法的

$bar: dynamic(blue);

@if something {
    $bar: dynamic(red); // ILLEGAL
}

应该使用以下形式代替上述形式

$bar: dynamic(if(something, red, blue));

此要求对于启用下面讨论的求值和提升行为是必要的。

动态变量可以在声明后赋值，无论是否使用 dynamic() 包装器。

$bar: dynamic(blue);

$bar: red;  // reassigns $bar to red

$bar: green !default;  // reassigns $bar to green

@debug $bar;  // green

没有“默认动态”这样的东西。

求值

动态变量按依赖顺序求值，而不是声明顺序。声明顺序仅适用于各个变量赋值的级联。这可以在上面的示例中看到。这种排序还意味着我们甚至可以删除 $bar 的第一次设置，代码也会有相同的结果。

考虑更详细的示例

$bar: dynamic(mix($colorA, $colorB, 20%));

$bar: dynamic(lighten($colorC, 20%));

$bar 的原始表达式使用了 $colorA 和 $colorB。如果这是对 $bar 的唯一赋值，那么 $bar 将依赖于这两个变量，并在它们之后进行求值。由于 $bar 被重新赋值，并且随后仅使用了 $colorC，因此在最终分析中，$bar 仅依赖于 $colorC。对 $bar 的原始赋值可能从未发生过。

提升

为了完成所有这些，Fashion 收集所有动态变量，并在 Sass 代码的任何其他执行之前对其进行求值。换句话说，类似于 JavaScript 变量，动态变量被“提升”到顶部。

提升

当变量用于赋值动态变量时，这些变量会提升为动态变量。

$foo: blue;

$bar: dynamic($foo);

即使 $foo 被声明为普通变量，因为 $bar 使用 $foo，Fashion 也会将 $foo 提升为动态变量。

注意： 这意味着 $foo 现在必须遵循动态变量的规则。

支持此行为是为了最大限度地提高 Sencha Cmd 早期版本的可移植性。当变量被提升时，将生成警告。在未来的版本中，此警告将变为错误。我们建议更正此代码以将所需的变量正确声明为 dynamic()。

扩展 - 需要 JavaScript

您可以通过在 JavaScript 中编写代码来扩展 Fashion。要从需要它的 Sass 代码中需要此代码，请使用 require()。例如

require("my-module");

// or

require("../path/file.js"); // relative to scss file

在内部，Fashion 使用 ECMAScript 6 (ES6) System.import API（或其 polyfill 通过 SystemJS）来支持加载标准 JavaScript 模块。

模块可以用 pre-ES6 语法编写，如下所示

exports.init = function(runtime) {
    runtime.register({
        magic: function (first, second) {
            // ...
        }
    });
};

使用 SystemJS，您可以启用“转译器”以在任何浏览器中编写 ES6 代码。以上在 ES6 中看起来像这样

module foo {
    export function init (runtime) {
        runtime.register({
            magic: function (first, second) {
                // ...
            }
        });
    }
}

升级

动态变量

升级到 Ext JS 6 时，动态变量的内部使用可能会影响这些变量在应用程序和自定义主题中的赋值方式。虽然不是必需的，但我们建议您更改变量赋值以使用 dynamic()。在大多数情况下，这将机械地将 !default（早期版本中采用的方法）替换为 dynamic()

// before:

$base-color: green !default;

// after:

$base-color: dynamic(green);

如果基于动态变量赋值的更严格的性质生成错误，这将使其更加明显。

Compass 扩展

依赖 Ruby 代码的 Compass 功能将不可用，因为不再使用 Ruby。必须使用 JavaScript 创建等效项。这可以在许多情况下使用 require() 来实现 JavaScript 中缺少的功能来提供。但是，Compass 中的 Sass 代码包含在 Fashion 中，因此并非所有 Compass 功能都受到影响。一般来说，如果您没有使用任何自定义或基于 Ruby 的 Compass 功能，您很可能不需要进行任何更改。

结论

我们对 Fashion 感到非常兴奋，希望您也一样！快速为您的应用程序设置主题从未如此简单，现在可以使用与框架相同的语言扩展 Sass。请务必在 论坛 上给我们留下任何反馈。

Cmd 7.8.0