ExtReact 文档帮助

简介

ExtReact 产品的文档在某种程度上与其他 Sencha 产品的文档有所不同。以下章节描述了所有产品的文档，除非特别指出 ExtReact 独有。

术语、图标和标签

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

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

访问级别

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

Public 类和类成员可供任何其他类或应用程序代码使用，并且在主要产品版本中可以作为稳定和持久的内容依赖。公共类和成员可以通过子类安全地扩展。
Protected 类成员是稳定的 public 成员，旨在由拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
Private 类和类成员在框架内部使用，不供应用程序开发人员使用。私有类和成员可能会随时更改或从框架中省略，恕不另行通知，不应在应用程序逻辑中依赖。

成员类型

Config - 类的配置选项。
ExtReact 组件类将配置选项显示为 props
Property - 类实例化后设置。*请参阅下面的只读。
ExtReact 组件类不将属性列为专用成员类型，而是列为 read only props
Method - 类可以执行的操作。方法应被视为实例方法，并且只能从给定类的实例调用。可以直接从类本身调用的静态方法将在方法名称旁边带有 static 标签。*请参阅下面的静态。
Event - 事件是框架事件系统特有的，允许类以编程方式引发事件，以供一个或多个事件处理程序方法处理。DOM 事件虽然由框架事件系统处理，但未在 API 文档中特别描述。*对于 DOM 事件，请参阅 MDN 的事件参考页面。
Theme Variable - 框架使用的可视化主题引擎使用的变量。
Theme Mixin - 框架使用的可视化主题引擎使用的函数，可以使用在各种主题变量中设置的值。

成员语法

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

Ext.container.Container

查看源代码

lookupComponent ( item ) : Ext.Component

受保护的

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

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

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

参数

item : Object

正在添加的配置对象。

返回值

Ext.Component

要添加的组件。

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

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

成员标志

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

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

类图标

- 表示框架类

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

- 组件类型框架类（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 原始类型页面除外）都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

备用名称 - 一个或多个附加的类名同义词（在 Ext JS 6.0.0 中，Ext.button.Button 类具有 Ext.Button 的备用类名）。备用类名通常是为了向后兼容性而维护的。
层次结构 - 层次结构视图列出了当前类的继承链，从当前类一直到根基类。
Mixins - 混合到当前类中的类列表
继承的 Mixins - 混合到当前类的祖先中的类列表
Requires - 类实例化所需定义的所有类
Uses - 类在其生命周期的某个时刻可能使用的类列表，但不一定是类最初实例化所必需的
Subclasses - 扩展当前类的类

展开和折叠示例及类成员

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

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

桌面 -vs- 移动视图

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

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

查看类源代码

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

ExtReact 7.5.0

显示私有类

顶部

主题

概述

ExtReact 包括一个主题 API，允许您配置组件的外观。本指南解释了 ExtReact 主题 API 的基础知识，并引导您完成创建自定义主题的过程。

使用 Themer

可以使用 Sencha Themer 创建 ExtReact 的自定义主题，而无需编写代码。本指南的其余部分面向那些手动创建主题（即不使用 Themer）的用户。

使用内置主题

ExtReact 包含几个内置主题

主题	描述
ext-modern-theme-material	Modern 工具包的 Material 主题。
ext-modern-theme-ios	Modern iOS 主题
ext-modern-theme-neptune	Modern 无边框主题
ext-modern-theme-triton	Modern 平面、无边框主题

ext-classic-theme-classic	经典蓝色 Ext JS 主题
ext-classic-theme-neptune	无边框主题
ext-classic-theme-neptune-touch	基于 Neptune 的 Touch 主题
ext-classic-theme-triton	平面、无边框主题
ext-classic-theme-crisp	简约主题
ext-classic-theme-crisp-touch	基于 Crisp 的 Touch 主题
ext-classic-theme-graphite	基于 Triton 的可访问主题

使用 ExtReact webpack 插件为您的应用程序设置主题

// example webpack.config.js

const ExtReactWebpackPlugin = require('@sencha/ext-react-webpack-plugin');

module.exports = {
  ...
  plugins: [
    new ExtReactWebpackPlugin({
      theme: 'theme-material' // this is the default
      port:port,
    })
  ]
  ...
}

创建自定义主题

可以扩展内置主题以创建自定义主题。安装 @sencha/ext-react 包后，您可以通过运行以下命令来创建自定义主题

*注意：theme-triton、theme-neptune 和 theme-ios 是单独的 npm 包，默认情况下不包含在 ExtReact 中。您可以通过运行以下命令来安装它们

npm install --save @sencha/ext-modern-theme-triton @sencha/ext-modern-theme-neptune @sencha/ext-modern-theme-ios

npx ext-react generate theme --name <theme-name> --baseTheme <theme-material|theme-neptune|theme-ios|theme-triton (optional, defaults to theme-material)>

这将在 ext-react/packages/<theme-name> 中创建一个新的自定义主题。

例如，要创建一个名为“my-theme”的新主题，该主题扩展了 material 主题，您将运行

npx ext-react generate theme --name my-theme

通过更新您的 ExtReactWebpackPlugin 设置，将主题应用于您的应用程序

new ExtReactWebpackPlugin({
  theme: '<theme-name>' 
})

自定义您的主题

语法和目录结构

ExtReact 主题由使用 Fashion 语法（Sencha 自己的 SASS 方言）的文件组成。文件使用 .scss 扩展名，并按以下目录结构组织

/sass
  /etc
  /src
  /var

etc

etc 目录包含其他实用程序函数或 mixin。all.scss 文件如果存在，则会自动包含在构建中。其他文件可以通过 @import 指令包含，或添加到主题的 package.json 中的 sencha/sass/etc 下。

src

src 目录包含规则和 UI mixin 调用，这些调用可以使用在 sass/var/ 中定义的变量。文件路径对应于 ExtReact 命名空间，并且仅在应用程序中使用相应的类时才包含在构建中。每个组件的命名空间都可以在 API 文档中找到。例如，要为 List 定义 ui，其完全限定名称为 Ext.dataview.List，请创建

/sass
  /src
    /Ext
      /dataview
        List.scss

除了基于完全限定名称包含文件外，您还可以将单个文件添加到主题的 package.json 中的 sencha.sass.src 下，或者使用 @import 指令。

var

var 目录包含全局变量。与 src 类似，文件路径对应于组件命名空间。除了基于完全限定名称包含文件外，您还可以将单个文件添加到主题的 package.json 中的 sencha.sass.var 下，或者使用 @import 指令。

设置全局变量

开始自定义主题的最佳方法是设置全局变量的值。每个组件都有自己的一组全局变量，这些变量会影响该组件所有实例的外观。例如，我们可以通过创建以下内容来更改 Panel 标题的字体系列

/sass
  /var
    /Ext
      /Panel.scss

...并添加以下内容...

// Panel.scss
$panel-header-font-family: 'Comic Sans';

除了为每个组件提供的变量外，还有许多变量会影响所有组件。这些变量在 API 文档的 Global_CSS 中列出。

例如，要为主题设置新的 $base-color，请创建

/sass
  /var
    /Ext
      /Component.scss

...并添加以下内容...

// Component.scss
$base-color: #025B80;

一些开发人员可能更喜欢将所有全局变量放在一个文件中。这可以通过简单地将它们全部放在 var/Ext/Component.scss 中或创建您选择的文件并将其添加到主题的 package.json 中的 sencha.sass.var 中来完成。

添加 UI

每个组件都可以配置一个 ui prop，该 prop 接受用于样式化组件的一个或多个 ui 的名称。UI 本质上是使用主题 API 提供的 mixin 创建的一组 css 类。UI 在主题的 sass/src 目录中定义。例如，如果我们想要创建一个看起来像这样的按钮

我们可以通过创建以下内容来实现

/sass
  /src
    /Ext
      /Button.scss

...并添加以下内容...

// Button.scss
@include button-ui(
  $ui: 'pink',
  $background-color: #E91E63,
  $color: white
)

然后，我们将“pink” ui 应用于按钮，如下所示

<Button ui="pink" text="Click Me"/>

组件可以配置多个 UI。例如，我们可以添加内置的 round 和 raised ui，使我们的按钮变为圆形和凸起

<Button ui="pink round raised" text="Click Me"/>

大模式

许多变量和 ui mixin 参数都有一个带有后缀 -big 的对应变量或参数。当 x-big css 类应用于 html body 元素时，-big 变量生效。当您的应用程序在移动设备（平板电脑或手机）上查看时，会自动发生这种情况。没有 -big 后缀的变量在应用程序在桌面上查看时生效。

进一步阅读

Modern Toolkit 中的主题

目录

简介

术语、图标和标签

访问级别

成员类型

成员语法

成员标志

类图标

成员图标

导航和功能

类成员快速导航菜单

Getter 和 Setter 方法

历史记录栏

搜索和过滤器

API 文档类元数据

展开和折叠示例及类成员

桌面 -vs- 移动视图

查看类源代码

ExtReact 7.5.0

目录

主题

概述

使用 Themer

使用内置主题

创建自定义主题

自定义您的主题

语法和目录结构

etc

src

var

设置全局变量

添加 UI

大模式

进一步阅读

ExtReact 7.5.0