文档帮助

术语、图标和标签

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

访问级别

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

成员类型

成员语法

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

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

  • 展开/折叠 - 在成员行的左侧是一个控件,用于展开和折叠每个成员行以显示/隐藏成员详细信息。
  • 成员名称 - 类成员的名称(在本例中为 lookupComponent
  • 方法参数 - 方法使用的任何必需或可选参数(或传递给事件处理程序方法的参数)将列在方法名称旁边的括号内(在本例中为 ( item )
  • 返回类型 - 方法或属性返回的类实例或 JavaScript 对象(在本例中为 Ext.Component)。对于不返回除 undefined 之外任何内容的方法,可以省略此项,或者可以显示为用斜杠 / 分隔的多个可能值,表示返回的内容可能取决于方法调用的结果(即,如果 get 方法调用成功,则方法可能返回 Component,如果失败,则返回 false,这将显示为 Ext.Component/Boolean)。
  • 标志 - 适用于成员的任何标志都将显示在接下来(在本例中为 PROTECTED - 请参阅下面的标志部分)
  • 成员来源 - 在成员行的右侧是最初描述成员的类(在本例中为 Ext.container.Container)。如果成员源自当前类,则源类将显示为蓝色链接;如果成员是从祖先类或混合类继承的,则显示为灰色。
  • 成员源代码 - 在成员来源类右侧下方是一个链接,用于查看成员的源代码(示例中为 view source
  • 参数列表 - 类方法的每个参数都将使用上面括号中找到的相同名称、预期的类或对象类型以及参数的描述列出(示例中为 item : Object)。
  • 返回值 - 如果类返回除 undefined 之外的值,“返回值”部分将注释返回的类或对象类型以及描述(示例中为 Ext.Component
  • Since示例中未显示)- 某些成员将显示该成员首次引入的产品版本(即 Available since 3.4.0 - 示例中未显示),就在成员描述之后
  • Default示例中未显示)- Config 通常显示要应用于类实例的默认配置值(如果未被覆盖)(即 Defaults to: false

成员标志

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

  • Required(必需)- 实例化类时必需的配置
  • Bindable(可绑定)- Config 具有 setter,允许通过 ViewModel 绑定设置此 config
  • Read Only(只读)- 属性可以读取,但不能用于在运行时配置/重新配置类实例
  • Singleton(单例)- 单例类在定义后立即实例化,并且不能手动实例化
  • Static(静态)- 静态方法或属性是属于类本身的方法或属性,而不是类的实例
  • Chainable(可链式调用)- 指的是在调用时返回类实例的方法。
    这使得可以进行链式方法调用,例如:classInstance.method1().method2().etc();
  • Deprecated(已弃用)- 计划在未来框架版本中删除的类或成员,并在当前版本中提供以实现向后兼容性。
    已弃用的类和成员将包含一条消息,指导您将来使用的首选类/方法。
  • Removed(已移除)- 已移除的类或成员,仅作为文档中存在的参考,供在框架版本之间升级的用户使用
  • Template(模板)- 在基类中定义的方法,旨在由子类重写
  • Abstract(抽象)- 类或成员可以定义为抽象的。抽象类和成员建立类结构并提供有限的(如果有)代码。特定于类的代码将通过子类中的重写来提供。
  • Preventable(可阻止)- 如果从事件处理程序返回 false,则标记为可阻止的事件将不会触发

类图标

- 表示框架类

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

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

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

成员图标

- 表示类型为 config 的类成员

- 表示类型为 property 的类成员

- 表示类型为 method 的类成员

- 表示类型为 event 的类成员

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

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

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

类成员快速导航菜单

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

Getter 和 Setter 方法

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

历史记录栏

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

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

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

搜索和过滤器

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

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

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

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

API 文档类元数据

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

  • Alternate Name(别名)- 一个或多个附加的类名同义词(在 Ext JS 6.0.0 中,Ext.button.Button 类具有 Ext.Button 的别名)。别名通常为了向后兼容性而维护。
  • Hierarchy(继承层次结构)- 继承层次结构视图列出了当前类的继承链,从祖先类一直到根基类。
  • Mixins(混入)- 混入当前类的一系列类
  • Inherited Mixins(继承的混入)- 混入当前类的祖先类的一系列类
  • Requires(依赖)- 实例化类所需定义的所有类
  • Uses(使用)- 类在其生命周期的某个时刻可能使用,但最初实例化该类不一定需要的一系列类
  • Subclasses(子类)- 扩展当前类的类

展开和折叠示例和类成员

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

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

桌面视图与移动视图

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

  • 全局导航将位于左侧菜单中,可通过汉堡菜单图标访问。菜单包含以下内容(在大多数页面上)
    • 当前产品的名称(作为指向产品着陆页的链接)
    • 用于导航回文档主页的 Sencha 图标
    • 产品菜单下拉按钮
    • API 文档和指南的导航树选项卡
  • 当前上下文导航和工具位于右侧,可通过齿轮图标访问。上下文菜单包含以下内容
    • 全局搜索输入字段
    • API 文档)“过滤器”选项卡,包含成员过滤器、展开/折叠所有示例按钮、展开/折叠所有成员行按钮、访问级别过滤器复选框以及每个成员的计数
    • API 文档)“相关类”选项卡,包含与当前类相关的元数据菜单
    • 指南)指南的目录

查看类源代码

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

Cmd


顶部

Fashion

简介

在 Sencha Cmd 6.0 中,我们很高兴推出一个名为“Fashion”的新的快速工具,用于为 Ext JS 6.0 开发主题。将 Fashion 和 sencha app watch 结合使用,为主题开发创建了一种新模式,我们称之为“Live Update”。

Live Update 使用 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”。

使用 Live Updates

您可以在(现代)浏览器中打开应用程序,并且将加载 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)。

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

注意:Live Update 仅在从 Cmd Web 服务器查看页面时有效。在 Ext JS Classic 工具包中,某些 Sass 更改可能需要布局或完整页面重新加载。这在 Modern 工具包中将不再是一个问题,因为它更多地基于 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(或其通过 SystemJSpolyfill)来支持加载标准 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