文档帮助

术语、图标和标签

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

访问级别

框架类或其成员可以指定为 private(私有的)或 protected(受保护的)。否则,类/成员是 public(公共的)。Publicprotectedprivate 是访问描述符,用于传达类或类成员应该如何以及何时使用。

成员类型

成员语法

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

lookupComponent ( item ) : Ext.Component
受保护的

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

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

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

参数

item :  Object

要添加的配置对象。

返回值
Ext.Component

要添加的组件。

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

成员标志

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

类图标

- 表示框架类

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

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

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

成员图标

- 表示 config 类型的类成员

- 表示 property 类型的类成员

- 表示 method 类型的类成员

- 表示 event 类型的类成员

- 表示 theme variable 类型的类成员

- 表示 theme mixin 类型的类成员

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

类成员快速导航菜单

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

Getter 和 Setter 方法

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

历史记录栏

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

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

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

搜索和过滤器

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

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

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

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

API 文档类元数据

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

展开和折叠示例及类成员

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

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

桌面 -vs- 移动视图

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

查看类源代码

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

ReExt


顶部

创建 React 应用程序

使用 Create React App:

  • 访问 Create React App 文档。
  • 运行命令:npx create-react-app reextcra

使用 Vite:

  • 访问 Vite 文档。
  • 运行命令:npm create vite@latest reextvite -- --template react-swc

安装 ReExt

使用 npm 安装 ReExt:

npm install @sencha/reext

安装 Sencha ExtJS SDK

重要 - EXTJS 框架要求:

ReExt 依赖于 Sencha ExtJS,要在本地运行框架,您必须在 React 项目的 public 文件夹中安装该框架。

快速入门应用程序配置为从远程服务器运行 Sencha ExtJS 7.8.0 试用版。

这仅用于演示目的,未配置用于许可开发。

可以从 Sencha 支持门户直接获取框架的许可商业版本,也可以使用 ReExt Designer VS Code 扩展(预览版)完成。

ReExt 可以配置为使用任何商业上可用的 Sencha Ext JS 框架版本(7x 及以上)。

有关更多信息,请下载 ReExt Designer VS Code 扩展(预览版)或通过 [email protected] 联系我们。

ReExt 已经过最新版本的 Sencha Ext JS 框架的测试,在本文发布时,最新版本是 Sencha ExtJS 7.8.0。

点击此处 购买商业版本的 Sencha ExtJS。

获取 Ext JS 的许可版本

要获取 Ext JS 的许可版本

  1. 登录到 Sencha 支持门户。
  2. 单击页面左侧的下载菜单 - 将显示 Sencha 下载页面。
  3. 单击“Downloads”(下载)按钮 - 将下载 7.8.0.zip 文件(这是 Ext JS 的最新版本)。
  4. 在下载了 7.8.0.zip 文件的文件系统中,解压缩该文件。
  5. 将创建一个名为 ext-7.8.0 的文件夹
  6. 将 ext-7.8.0 文件夹复制到 React 应用程序的 public 文件夹中
  7. 在 React 应用程序的组件中,更改为以下内容(“location”:“local”)
import { ReExtProvider } from '@sencha/reext';

var reactroot = ReactDOM.createRoot(document.getElementById('root'));

var ReExtData = {
  "sdkversion": "7.8.0",
  "toolkit": "classic",
  "theme": "classic",
  "rtl": false,
  "locale": "en",
  "debug": false,
  "urlbase": "./",
  "location": "local"
}
var trialkey = 'trial key from email goes here...'
reactroot.render(
  <ReExtProvider splash={true} ReExtData={ReExtData} reextkey={trialkey}>
    <App />
  </ReExtProvider>
)

ReExt 试用密钥

要获取试用密钥

  • 运行您的 ReExt 应用程序。
  • 填写出现的对话框上的表单。
  • 试用密钥将通过电子邮件发送。

React 版本

ReExt 已经过最新版本的 React (18.3.1) 的测试。

用法 - ReExtProvider

在 main.jsx 或 index.js 中使用 ReExtProvider 组件。

import { ReExtProvider } from '@sencha/reext';

var reactroot = ReactDOM.createRoot(document.getElementById('root'));

var ReExtData = {
  "sdkversion": "7.8.0",
  "toolkit": "classic",
  "theme": "classic",
  "rtl": false,
  "locale": "en",
  "debug": false,
  "urlbase": "./",
  "location": "remote"
}
var trialkey = 'trial key from email goes here...'
reactroot.render(
  <ReExtProvider splash={true} ReExtData={ReExtData} reextkey={trialkey}>
    <App />
  </ReExtProvider>
)

用法 - 示例代码

import React, { useState, useRef } from 'react';
import ReExt from '@sencha/reext';

const App=()=>{
 const [labelcmp, setLabelCmp] = useState(null);
 const labelcmpRef = useRef();
 labelcmpRef.current = labelcmp;
 const [labeltext, setLabelText] = useState('initial text');
 const [row, setRow] = useState(null);

 return (
  <div style={{
   boxSizing:'border-box',height:'100%',
   display:'flex',flexDirection:'column'
  }}>
   <ReExt xtype='logo'/>
   <div style={{display:'flex'}}>
    <ReExt xtype='button'
     config={{text:'click me',width:100,ariaLabel:'demobutton'}}
     onTap={()=>{
      labelcmpRef.current.setHtml('set using method call');
      setLabelText('set using state');
     }}
    />
   </div>
   <ReExt xtype='grid'
    style={{height:300}}
    config={{
     title: 'grid',
     columns: [
      {text:'Name',dataIndex:'name',width:200},
      {text:'Email',dataIndex:'email',flex:1},
      {text:'Phone',dataIndex:'phone',width:200}
     ],
     data: [
      {name:'Lisa',email:'[email protected]',phone:'555-111-1224'},
      {name:'Bart',email:'[email protected]',phone:'555-222-1234'},
      {name:'Homer',email:'[email protected]',phone:'555-333-1244'},
      {name:'Marge',email:'[email protected]',phone:'555-444-1254'}
     ]
    }}
    onSelect={(grid, selected)=>{
     var row = selected[0].data
     setRow(row)
     var rowString = JSON.stringify(row)
     labelcmpRef.current.setHtml(rowString)
     setLabelText(rowString)
    }}
   />
   <div style={{flex:1,padding:20,border:'1px solid gray'}}>
    {row !== null &&
     <>
     <ReExt xtype='label' config={{html: `name: ${row.name}`}}/>
     <ReExt xtype='label' config={{html: `email: ${row.email}`}}/>
     <ReExt xtype='label' config={{html: `phone: ${row.phone}`}}/>
     </>
    }
   </div>
   <div style={{flex:1,padding:20,border:'1px solid gray'}}>
    <ReExt xtype='label'
     config={{html:'initial text'}}
     ready={(cmp)=>{
      setLabelCmp(cmp)
     }}
    />
    <ReExt xtype='label'
     config={{html:labeltext}}
    />
   </div>
  </div>
 )
}
export default App

运行应用程序

  • Create React App:运行 npm start
  • Vite:运行 npx vite --open

ReExt 组件

ReExt React 组件具有 5 个静态 props(只有 xtype 是必需的)和任意数量的可选事件 props

示例:ReExt Button(按钮)

<ReExt xtype='button'
 className='okbutton'
 style={{color:'green'}}
 references={false}
 child={false}
 config={{text:'OK'}}
 ready={(cmp)=>{console.log(cmp)}}
 onTap={(button,e,eOpts)=>{console.log(`${button.text}`)}}
/>

以下是从上面示例到 Ext JS 文档的链接

有关 ReExt props 的更多详细信息

  • xtype(必需):组件的 xtype,如 Sencha 文档 中定义。
  • className(可选):要附加到底层 Ext JS 组件的父 div 的 css 类(每个底层 ExtJS 组件都用父 div 包裹,该父 div 的宽度为“100%”,高度为“100%” - 除非在 className 或 style 配置中覆盖)
  • style(可选):要附加到 ExtJS 组件的父 div 的 css 样式。
  • references(可选):如果使用 Ext JS reference,则使用。
  • config(可选):一个 JavaScript 对象,包含组件的 configs(配置),如 Sencha 文档 中定义。
  • ready(cmp)(可选):当底层 ExtJS 组件创建时,由 ReExt 组件触发的事件。此配置的值是 React 宿主组件中的一个函数,参数是创建的 ExtJS 对象。
  • storeloaded(store, cmp)(可选):当与组件关联的异步 store 加载时,由 ReExt 组件触发的事件。
  • 'on' props(可选):与 ExtJS 组件触发的事件对应的 prop;遵循“on”模式,事件的第一个字母大写。(即,button xtype 具有 tap 事件,相应的 prop 是 onTap)。此 prop 的值是 React 宿主组件中的一个函数。

ReExt 配置和事件

ReExt 通过为 ReExt 'xtype' prop 提供一个值来利用 Ext JS 框架组件。此 prop 映射到 ExtJS 文档中的 xtype。您可以在 Ext JS 文档页面的右上角搜索任何 xtype。

例如,经典工具包的 <ReExt xtype="button"/> 映射到 Ext JS 7.8 文档中的此页面:

configs(配置)

configs(配置)选项卡显示 ReExt 'config' prop 的所有有效值。<ReExt xtype="button" config={}/>

events(事件)

events(事件)选项卡显示所有事件 - 要使用,请在事件名称前加上“on”并大写第一个字母

例如,此处是 ReExt 'onClick' 事件的页面 <ReExt xtype="button" onClick={()=>{}}/>

methods(方法)

methods(方法)选项卡 显示可以使用 ReExt ready 事件的 cmp 参数调用的所有方法 <ReExt xtype="button" ready={(cmp)=>{cmp.setText('new text')}}/>

使用 ExtJS Overrides(覆盖)

  1. public 文件夹中创建 classicoverrides.jsmodernoverrides.js
  2. 在此文件中包含所有 override(覆盖)类。
  3. 在 ReExtData 对象中设置 overrides: true(仅适用于 location = 'local')。

示例

var ReExtData = {
    "sdkversion": "7.8.0",
    "toolkit": "classic",
    "theme": "classic",
    "rtl": false,
    "locale:" "en",
    "debug": false,
    "urlbase": "./",
    "location": "local",
    "overrides": true
}

自定义 Ext JS 组件

要使用自定义 Ext JS 组件

  1. 使用 Ext JS 定义创建组件(例如,MainList.jsx)。
  2. 在您的 React 应用程序中导入并使用此组件。

在 ./app/layout.js` 中

'use client';
import { ReExtProvider } from '@sencha/reext';

export default function RootLayout({ children }) {
  var ReExtData = { 
  sdkversion: '7.8.0', 
  toolkit: 'classic', 
  theme: 'classic', 
  urlbase: './', 
  location: 'local' 
  };
  return (
    <html lang="en">
      <body>
          <ReExtProvider ReExtData={ReExtData}>
            {children}
          </ReExtProvider>
      </body>
    </html>
  )
}

现在可以将自定义 ExtJS 组件作为导入添加。

在 app/personnel/page.js` 中

'use client'
import ReExt from '@sencha/reext';
import { useState, useEffect } from 'react';

export default function Page() {
  const [ready, setReady] = useState(false);
  useEffect(() => {
    const doAsync = async () => {
      try {
        await import('./MainList');
        setReady(true)
      } catch (e) {
        console.error('fail', e)
      }
    }
    doAsync()
  }, []);
  if (!ready) {
    return <div>Loading...</div>
  }
  else {
    return (
      <ReExt xtype='mainlist'
        style={{ flex: 2, border: '1px solid gray' }}
        onSelect={(sender, record) => 
        { 
            console.log('row selected', record[0])
        }}
      />
    )
  }
}

在 ./MainList.jsx` 中

import './PersonnelStore'
Ext.define('ReExt.view.main.List', {
    extend: 'Ext.grid.Panel',
    xtype: 'mainlist',
    store: { type: 'personnel' },
    columns: [
        { text: 'Name', dataIndex: 'name' }
    ]
})

在 ./PersonnelStore.jsx` 中

Ext.define('ReExt.store.Personnel', {
    extend: 'Ext.data.Store',
    alias: 'store.personnel',
    data: { items: [
{name:'Jean Luc',email:"[email protected]",phone:"555-111-1111"},
{name:'Worf',email:"[email protected]",phone:"555-222-2222"},
{name:'Deanna',email:"[email protected]",phone:"555-333-3333"},
{name:'Data',email:"[email protected]",phone:"555-444-4444"}
    ]},
    proxy: {
     type: 'memory',
     reader: {
      type: 'json',
      rootProperty: 'items'
     }
    }
   })

许可证

试用

ReExt