ExtReact 文档帮助

简介

ExtReact 产品的文档与其他 Sencha 产品的文档有所不同。以下部分描述了所有产品的文档，除非特别指出 ExtReact 独有。

术语、图标和标签

许多类都有快捷名称，用于在使用配置对象创建（实例化）类时使用。快捷名称被称为 alias（或 xtype，如果该类扩展了 Ext.Component）。别名/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

view source

lookupComponent ( item ) : Ext.Component

protected

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

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

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

参数

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）
Since（示例中未显示）- 某些成员将显示该成员首次引入的产品版本（即 Available since 3.4.0 - 示例中未显示），就在成员描述之后
Default（示例中未显示）- Configs 通常显示要应用于类实例的默认 config 值（如果未被覆盖）（即 Defaults to: false）

成员标志

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

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

类图标

- 表示框架类

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

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

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

成员图标

- 表示 config 类型的类成员

或者在 ExtReact 组件类的情况下，这表示 prop 类型的成员

- 表示 property 类型的类成员

- 表示 method 类型的类成员

- 表示 event 类型的类成员

- 表示 theme variable 类型的类成员

- 表示 theme mixin 类型的类成员

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

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

Getter 和 Setter 方法

与类 config 选项相关的 getter 和 setter 方法将显示在方法部分以及 API 文档和成员类型菜单的 configs 部分中，紧挨着它们所使用的 config。getter 和 setter 方法文档将在 config 行中找到，以便于参考。

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

历史记录栏

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

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

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

搜索和过滤器

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

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

桌面 -vs- 移动视图

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

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

查看类源代码

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

ExtReact 7.5.0

显示私有类

顶部

为多环境和屏幕开发

ExtReact 帮助开发人员在所有设备和屏幕尺寸上提供出色的用户体验。本指南解释了如何使用 ExtReact 实现响应式和自适应设计，从而为每个环境创建合适的 ui。

`fullscreen` config

大多数使用 ExtReact 的应用程序都是单页应用程序，它们占据浏览器窗口的完整高度和宽度。为了实现这一点，您的应用程序中的根 ExtReact 组件应配置为将 fullscreen prop 设置为 true。例如

import { Container } from '@sencha/ext-modern';

export default function App() {
  return (
    <Container fullscreen>
      ...
    </Container>
  )
}

Flexible Layouts

ExtReact 提供了以下布局，这些布局根据可用空间自动调整子元素的大小

fit - 调整单个子元素的大小，使其填充父元素的 100% 高度和宽度。
box - 子级根据其 flex props 的相对值按比例调整大小。
hbox - 具有水平对齐方式的 box 布局的子类。
vbox - 具有垂直对齐方式的 box 布局的子类。

例如，要在两个组件之间均匀分配可用的水平空间

import { Container } from '@sencha/ext-modern';

function App() {
  return (
    <Container layout="hbox">
      <Panel title="Left" flex={1}>...</Panel>
      <Panel title="Right" flex={1}>...</Panel>
    </Container>
  )
}

您还可以固定某些子级的大小，同时允许其他子级填充剩余空间

<Container layout="hbox">
  <Panel title="Left" width={300}>...</Panel>
  <Panel title="Right" flex={1}>...</Panel>
</Container>

或者，允许子级增长或缩小到特定大小，不再进一步

<Container layout="hbox">
  <Panel title="Left" maxWidth={500} flex={1}>...</Panel>
  <Panel title="Right" flex={1}>...</Panel>
</Container>

使用相对 flex 值来指定每个子级的比例空间量。例如，要将水平空间的 1/3 分配给左侧面板，将 2/3 分配给右侧面板

<Container layout="hbox">
  <Panel title="Left" flex={1}>...</Panel>
  <Panel title="Right" flex={2}>...</Panel>
</Container>

Platform Queries

ExtReact 允许您使 UI 适应用户的设备类型和平台

`Ext.platformTags`

您可以使用 Ext.platformTags 来检查您的应用程序运行的平台。这是一个在手机上运行时显示单独 UI 组件的示例

function App(props) {
  if (Ext.platformTags.phone) {
    return <PhoneUI/>
  } else {
    return <DesktopUI/>
  }
}

您还可以检查特定的浏览器，例如：Ext.platformTags.safari，或操作系统：Ext.platformTags.android。

要检查特定的操作系统版本，请使用 Ext.os.version。

`platformConfig` prop

您可以使用 platformConfig prop 为不同的环境指定不同的 props。这是一个示例，该示例在手机上使用垂直布局，在所有其他环境中使用水平布局

import { Container } from '@sencha/ext-modern';

function App() {
  return (
    <Container 
      layout="hbox"
      platformConfig={{
        "phone": {
          layout: 'vbox'
        }
      }}
    >
      ...
    </Container>
  )
}

您可以使用否定 ("!") 来定位除特定环境之外的所有环境。上面示例中的 Container 也可以写成

<Container 
  layout="vbox"
  platformConfig={{
    "!phone": {
      layout: 'hbox'
    }
  }}
>
  ...
</Container>

或

<Container 
  platformConfig={{
    "phone": {
      layout: 'vbox'
    },
    "!phone": {
      layout: 'hbox'
    }
  }}
>
  ...
</Container>

或者，使用 Ext.platformTags

<Container layout={Ext.platformTags.phone ? 'vbox' : 'hbox'}>
  ...
</Container>

Responsive Props

您可以使用 responsiveConfig prop 根据屏幕尺寸提供不同的 props。使用 responsiveConfig 时，当用户旋转或调整浏览器窗口大小时，UI 会自动更新。

例如，当屏幕宽度小于 600 像素时，缩写面板的标题

import { Panel } from '@sencha/ext-modern';

function App() {
  return (
    <Panel 
      responsiveConfig={{
        'width >= 600': {
          title: 'Manufacturing Summary'
        },
        'width < 600': {
          title: 'Mfg Summary'
        }
      }}
    >
      ...
    </Panel>
  )
}

要使用 responsiveConfig prop，请确保在您的应用程序中使用 Ext.require 在某处需要它

// App.js

Ext.require('Ext.plugin.Responsive');

您还可以为横向和纵向设置不同的 props。这是一个示例，该示例在设备处于纵向方向时缩写面板标题。

<Container 
  responsiveConfig={{
    landscape: {
      title: 'Manufacturing Summary'
    },
    portrait: {
      title: 'Mfg Summary'
    }
  }}
>
    ...
</Container>

responsiveConfig prop 也接受 platformTags。例如

<Container 
  platformConfig={{
    "phone": {
      layout: 'vbox'
    },
    "!phone": {
      layout: 'hbox'
    }
  }}
>
    ...
</Container>

您可以通过在单独的模块中定义响应式公式，在所有组件之间共享它们

// responsiveFormulas.js
export const xsmall = "width <= 576";
export const small = "width <= 768";
export const medium = "width <= 992";
export const large = "width <= 1200";
export const xlarge = "width > 1200";

并将它们导入到您的响应式组件中

// MyComponent.js
import { small, xsmall } from './responsiveFormulas';

export default function MyComponent(props) {
  return (
    <Panel 
      responsiveConfig={{
        true: {
          title: 'Summary of Manufacturing'
        }
        [small]: {
          title: 'Manufacturing Summary'
        },
        [xsmall]: {
          title: 'Mfg Summary'
        }
      }}
    >
      ...
    </Panel>
  )
}

在这里，我们对第一个键使用值 true 以提供默认标题。

您还可以将自己的自定义公式定义为函数。例如，我们可以为周末定义一个响应式公式

// responsiveFormulas.js
...
export const weekends = (context) => {
  const today = new Date().getDay();
  return today === 0 || today === 6
}

在定义您自己的响应式公式函数时，将它们作为对象导入并将它们分配给组件的 responsiveFormulas prop。然后在 responsiveConfig prop 中按名称引用每个公式

// MyComponent.js
import * as responsiveFormulas from './responsiveFormulas';

export default function MyComponent(props) {
  return (
    <Panel 
      responsiveFormulas={responsiveFormulas}
      responsiveConfig={{
        true: {
          title: 'Summary of Manufacturing'
        }
        small: {
          title: 'Manufacturing Summary'
        },
        weekends: {
          title: "Go home, it's a weekend!"
        }
      }}
    >
      ...
    </Panel>
  )
}

responsiveConfig prop 由 responsive plugin 提供，该插件会自动添加到任何具有 responsiveConfig prop 的 ExtReact 组件。

目录

简介

术语、图标和标签

访问级别

成员类型

成员语法

成员标志

类图标

成员图标

导航和功能

类成员快速导航菜单

Getter 和 Setter 方法

历史记录栏

搜索和过滤器

API 文档类元数据

展开和折叠示例和类成员

桌面 -vs- 移动视图

查看类源代码

ExtReact 7.5.0

目录

为多环境和屏幕开发

`fullscreen` config

Flexible Layouts

Platform Queries

`Ext.platformTags`

`platformConfig` prop

Responsive Props

ExtReact 7.5.0

目录

简介

术语、图标和标签

访问级别

成员类型

成员语法

成员标志

类图标

成员图标

导航和功能

类成员快速导航菜单

Getter 和 Setter 方法

历史记录栏

搜索和过滤器

API 文档类元数据

展开和折叠示例和类成员

桌面 -vs- 移动视图

查看类源代码

ExtReact 7.5.0

目录

为多环境和屏幕开发

fullscreen config

Flexible Layouts

Platform Queries

Ext.platformTags

platformConfig prop

Responsive Props

ExtReact 7.5.0

`fullscreen` config

`Ext.platformTags`

`platformConfig` prop