ExtReact 文档帮助

内容

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

简介

ExtReact 产品的文档与其他 Sencha 产品的文档略有不同。以下部分描述了所有产品的文档，除非另有说明，否则这些文档是 ExtReact 独有的。

术语、图标和标签

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

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

访问级别

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

成员类型

成员语法

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

Ext.container.Container
查看源代码
lookupComponent ( item ) : Ext.Component
protected

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

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

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

参数

item :  Object

正在添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

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

展开和折叠示例和类成员

可运行示例（Fiddles）默认情况下在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您也可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间保存。

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

桌面 -vs- 移动视图

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

查看类源代码

可以通过单击 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 应用程序

将 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 文档或按照以下步骤回答。

  • 对于“请选择一个预设：”，选择“手动选择功能”。
  • 对于“检查项目所需的特性：”，取消选择“Linter / Formatter”并按“Enter”。
  • 对于“您更喜欢将 Babel、PostCSS、ESLint 等的配置放在哪里？”，选择默认选项（按“Enter”）。
  • 对于“将此保存为未来项目的预设？”，选择默认选项（按“Enter”）。

“vue create”命令将运行。

“vue create”命令完成后，移至新创建的文件夹并运行应用程序。

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

在浏览器中浏览到 http://localhost:8080。您应该在浏览器中看到“欢迎使用您的 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

在浏览器中浏览到 http://localhost:8080。您应该在浏览器中看到带有 ExtWebComponents 面板的 Vue.js 启动应用程序。

Vue.js with ExtWebComponents

ExtWebComponents 7.5.0