基于 Vue | ExtWebComponents 7.5.0

ExtReact 文档帮助

简介

ExtReact 产品的文档与其他 Sencha 产品的文档有所不同。以下章节描述了除特别注明为 ExtReact 特有的所有产品的文档。

术语、图标和标签

许多类都有快捷名称，在通过配置对象创建（实例化）类时使用。快捷名称被称为 alias（别名）（如果类扩展自 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（主题 Mixin） - 框架采用的可视化主题引擎使用的函数，可以使用在各种主题变量中设置的值。

成员语法

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

Ext.container.Container

查看源代码

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（默认值）（示例中未显示） - 配置通常显示要应用于类实例的默认配置值（如果未被覆盖）（即 Defaults to: false）

成员标志

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

Required（必需） - 实例化类时必需的配置
Bindable（可绑定） - 配置具有 setter，允许通过 ViewModel 绑定设置此配置
除非标记为 immutable（不可变），否则所有 ExtReact props（属性）都是 bindable（可绑定）的
Immutable（不可变）
不可变的 ExtReact props（属性）在实例化组件时不能用作可配置的属性
Read Only（只读） - 属性可以读取，但不能用于在运行时配置/重新配置类实例
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 原始类型页面除外）都有一个与该类相关的元数据菜单视图。此元数据视图将具有以下一项或多项

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 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“查看源代码”链接来查看类成员的源代码。

ExtWebComponents 7.5.0

显示私有类

顶部

将 Sencha ExtWebComponents 添加到 Vue CLI 应用程序

本文档定义了将 Sencha ExtWebComponents 添加到使用 Vue CLI 生成的 Vue.js 应用程序所需的步骤。Vue CLI 在 Vue CLI 概述中进行了描述

如果您不想遵循下面提到的步骤，则可以使用示例 ExtWebComponents 应用程序在 ext-web-components-boilerplate-vue-cli 中使用样板代码。

要求

现有的 Vue 应用程序
node & npm

安装 Vue CLI

更多详细信息请访问： https://cli.vuejs.ac.cn/guide/installation.html

要安装 Vue CLI，请打开终端或命令窗口并使用以下命令

npm install -g @vue/cli

创建 Vue CLI 启动器应用程序

更多详细信息请访问： https://cli.vuejs.ac.cn/guide/creating-a-project.html#vue-create

要创建 Vue CLI 启动器应用程序，请继续在终端或命令窗口中操作，并 'cd' 到您要创建新应用程序的文件夹。然后，使用以下命令创建新的 Vue CLI 应用程序。

vue create ext-web-components-boilerplate-vue-cli

Vue CLI 启动，然后提出一系列问题作为选择 - 请参阅上面提到的 Vue 文档或按以下方式回答

对于 'Please pick a preset:'（请选择预设：），选择 'Manually select features'（手动选择功能）
对于 'Check the features needed for your project:'（检查项目需要的功能：），取消选择 'Linter / Formatter'（代码检查/格式化程序）并按 'enter'（回车）
对于 'Where do you prefer placing config for Babel, PostCSS, ESLint, etc.?'（您希望将 Babel、PostCSS、ESLint 等的配置放在哪里？），选择默认值（按 'enter'（回车））
对于 'Save this as a preset for future projects?'（将此保存为未来项目的预设吗？），选择默认值（按 'enter'（回车））

'vue create' 命令将运行。

一旦 'vue create' 命令完成，移动到新创建的文件夹并运行应用程序

cd  ext-web-components-boilerplate-vue-cli
npm run serve

在浏览器中浏览 https://127.0.0.1:8080。您应该在浏览器中看到 'Welcome to Your Vue.js App'（欢迎来到您的 Vue.js 应用程序）页面。

现在，停止在终端/命令窗口中运行 'create vue' 应用程序 (ctrl-c)。这为您接下来的步骤做准备。

将 Sencha ExtWebComponents 添加到 Vue CLI 启动器应用程序

要将 ExtWebComponents 添加到新创建的 Vue CLI 启动器应用程序，请在您喜欢的编辑器或 IDE 中打开创建的应用程序 - 例如，要使用 Visual Studio Code，请取消当前在终端或命令窗口中运行的示例应用程序，然后在终端或命令窗口中键入 'code .'。

code .

对于接下来的步骤，请确保您已登录到 Sencha npm 存储库 - 有关说明，请参阅此链接： https://ext.js.cn/extjs/7.0.0/guides/open_tooling_npm/npm_repo_access.html

在终端/命令窗口中运行以下命令

npm install --save @sencha/ext-web-components-modern @sencha/ext @sencha/ext-modern @sencha/ext-modern-theme-material
npm install --save @sencha/ext-webpack-plugin
npm install --save @webcomponents/webcomponentsjs

编辑 vue.config.js, src/main.js, src/App.vue

要在 Vue 中为 webpack 配置 ext-webpack-plugin，请在根目录（package.json 所在的目录）中创建一个名为 vue.config.js 的文件，并添加以下内容

const ExtWebpackPlugin = require('@sencha/ext-webpack-plugin');
const path = require('path');

module.exports = {
  devServer: {
    contentBase: 'build',
    hot: true,
    historyApiFallback: true,
    host: '0.0.0.0',
    port: '8080',
    disableHostCheck: false,
    compress: false,
    inline: true,
    stats: 'none',
  },
  outputDir: path.join(__dirname, 'build'),
  configureWebpack: {
    plugins: [
        new ExtWebpackPlugin({
            framework: 'web-components',
            toolkit: 'modern',
            emit: 'yes',
            browser: 'no',
            packages: [],
            profile: '',
            verbose: 'no',
            treeshake:'no',
            environment: 'development'
        }),
    ]
  }
}

将 src/main.js 替换为以下内容

/*global Ext*/
import Vue from 'vue'
import App from './App.vue'
import '@sencha/ext-web-components-modern/dist/ext-panel.component';

Ext.onReady(function() {
  new Vue({
    render: h => h(App)
  }).$mount('#app')
});

将 src/App.vue 替换为以下内容

<template>
    <ext-panel
        title="EWC Panel in Vue.js"
        bodyPadding="20px"
    >
        <h1>I am the ExtWebComponents Panel</h1>
    </ext-panel>
</template>
<script>
    export default {
        name: 'app',
    }
</script>

运行 ExtWebComponents Vue.js 应用程序

在终端或命令窗口中，运行应用程序

npm run serve

在浏览器中浏览 https://127.0.0.1:8080。您应该在浏览器中看到带有 ExtWebComponents Panel 的 Vue.js 启动器应用程序。

Vue.js with ExtWebComponents

目录

简介

术语、图标和标签

访问级别

成员类型

成员语法

成员标志

类图标

成员图标

导航和功能

类成员快速导航菜单

Getter 和 Setter 方法

历史记录栏

搜索和过滤器

API 文档类元数据

展开和折叠示例以及类成员

桌面与移动视图

查看类源代码

ExtWebComponents 7.5.0

目录

将 Sencha ExtWebComponents 添加到 Vue CLI 应用程序

要求

安装 Vue CLI

创建 Vue CLI 启动器应用程序

将 Sencha ExtWebComponents 添加到 Vue CLI 启动器应用程序

编辑 vue.config.js, src/main.js, src/App.vue

运行 ExtWebComponents Vue.js 应用程序

ExtWebComponents 7.5.0