ExtReact 产品的文档与其他 Sencha 产品的文档有所不同。以下部分描述了除标明为 ExtReact
独有的所有产品的文档。
许多类都有快捷名称,用于在使用配置对象创建(实例化)类时。快捷名称被称为 alias
(如果类扩展了 Ext.Component,则称为 xtype
)。别名/xtype 列在适用类的类名旁边,以便快速参考。
ExtReact 组件类在 API 类文档的顶部突出列出可配置的名称,后跟完全限定的类名。
框架类或其成员可以指定为 private
或 protected
。否则,类/成员为 public
。Public
、protected
和 private
是访问描述符,用于传达应如何以及何时使用类或类成员。
Public 类和类成员可供任何其他类或应用程序代码使用,并且可以在主要产品版本中作为稳定和持久的内容依赖。公共类和成员可以通过子类安全地扩展。
Protected 类成员是稳定的 public
成员,旨在由拥有类或其子类使用。受保护的成员可以通过子类安全地扩展。
Private 类和类成员在框架内部使用,不供应用程序开发人员使用。私有类和成员可能会随时更改或从框架中省略,恕不另行通知,并且不应在应用程序逻辑中依赖。
ExtReact 组件类将配置选项显示为 props
ExtReact 组件类不将属性列为专用成员类型,而是列为 read only
props
static
标签。*请参阅下面的静态。下面是一个示例类成员,我们可以对其进行剖析,以显示类成员的语法(在本例中,从 Ext.button.Button 类查看 lookupComponent 方法)。
让我们看一下成员行的每个部分
lookupComponent
)( item )
)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 文档使用许多标志来进一步沟通类成员的功能和意图。标签可以用文本标签、缩写或图标表示。
除非装饰为 immutable
,否则所有 ExtReact props 都是 bindable
Immutable ExtReact props 在实例化组件时不能用作可配置的 prop
classInstance.method1().method2().etc();
false
,则标记为可阻止的事件将不会触发- 表示框架类
- 单例框架类。*有关更多信息,请参阅单例标志
- 组件类型框架类(Ext JS 框架中扩展 Ext.Component 的任何类)
- 表示类、成员或指南在当前查看的版本中是新的
- 表示类型为 config
的类成员
或者在 ExtReact 组件类的情况下,这表示类型为 prop
的成员
- 表示类型为 property
的类成员
- 表示类型为 method
的类成员
- 表示类型为 event
的类成员
- 表示类型为 theme variable
的类成员
- 表示类型为 theme mixin
的类成员
- 表示类、成员或指南在当前查看的版本中是新的
在 API 文档页面上的类名正下方是一行按钮,对应于当前类拥有的成员类型。每个按钮显示按类型划分的成员计数(此计数在应用过滤器时更新)。单击按钮将导航到该成员部分。将鼠标悬停在成员类型按钮上将显示该类型的所有成员的弹出菜单,以便快速导航。
与类配置选项相关的 Getter 和 setter 方法将在方法部分以及 API 文档和成员类型菜单的 configs 部分中显示,就在它们工作的配置下方。getter 和 setter 方法文档将在 config 行中找到,以便于参考。
ExtReact 组件类不会将 getter/setter 方法提升到 prop 中。所有方法都将在 Methods
部分中描述
您的页面历史记录保存在本地存储中,并在顶部标题栏正下方显示(使用可用的实际空间)。默认情况下,显示的唯一搜索结果是与您当前查看的产品/版本匹配的页面。您可以通过单击历史记录栏右侧的 按钮并选择“全部”单选按钮来扩展显示的内容。这将显示历史记录栏中所有产品/版本的所有最近页面。
在历史记录配置菜单中,您还将看到最近访问页面的列表。结果按“当前产品/版本”和“全部”单选按钮过滤。单击 按钮将清除历史记录栏以及本地存储中保存的历史记录。
如果在历史记录配置菜单中选择“全部”,则将启用“在历史记录栏中显示产品详细信息”的复选框选项。选中后,每个历史页面的产品/版本将与历史记录栏中的页面名称一起显示。将光标悬停在历史记录栏中的页面名称上也会将产品/版本显示为工具提示。
可以使用页面顶部的搜索字段搜索 API 文档和指南。
在 API 文档页面上,还有一个过滤器输入字段,该字段使用过滤器字符串过滤成员行。除了按字符串过滤外,您还可以按访问级别、继承和只读过滤类成员。这是通过使用页面顶部的复选框完成的。
API 类导航树底部的复选框过滤类列表以包含或排除私有类。
单击空的搜索字段将显示您最近 10 次搜索,以便快速导航。
每个 API 文档页面(JavaScript 原始页面除外)都有一个菜单视图,其中包含与该类相关的元数据。此元数据视图将具有以下一个或多个
Ext.button.Button
类具有 Ext.Button
的备用类名)。备用类名通常为了向后兼容性而维护。可运行的示例 (Fiddles) 默认在页面上展开。您可以使用代码块左上角的箭头单独折叠和展开示例代码块。您还可以使用页面右上角的切换按钮切换所有示例的折叠状态。切换所有状态将在页面加载之间记住。
类成员默认在页面上折叠。您可以使用成员行左侧的箭头图标或右上角的展开/折叠全部切换按钮全局展开和折叠成员。
在较窄的屏幕或浏览器上查看文档将导致针对较小外形尺寸优化的视图。桌面视图和“移动”视图之间的主要区别在于
可以通过单击 API 文档页面顶部的类名来查看类源代码。可以通过单击成员行右侧的“view source”链接来查看类成员的源代码。
请参阅 Ext JS 发行说明。
EXTREACT-126 - ExtReact 和依赖包已更新至 7.4.0,并与 Ext JS 7.4.0 兼容。已更新为使用 Sencha 新的 Ext JS 运行时 npm 包
EXTREACT-127 - ExtReact Kitchensink 示例已使用新的 ExtJS 7.4 功能更新。
在 kitchensink 中添加了树分组网格示例。此示例包括多级分组、分组面板和分组摘要。
在 kitchensink 中添加了网格 FilterBar 示例。此示例包括新的网格插件 gridfilterbar
EXTREACT-135 - ExtReact KitchenSink 示例已更新到最新软件包版本。
ExtReact 当前存在已知限制
React 功能组件钩子(useState
、useEffect
)不适用于 ExtReact 组件(未收到更新)。React 功能组件自 React 16.8 以来可用,ExtReact 目前声明它支持 React 16,其中 React 16.12 是样板/模板应用程序的默认版本。但是,ExtReact 组件仅扩展 React.component
,并且不实现功能钩子,例如 useState
或 useEffect
。
为了克服此限制,EXTREACT-115 提供了解决方案。解决方案是创建指向状态变量的引用。状态变量的引用将保持其值,并且可以在事件回调中访问。用法
var [currentSelection, setCurrentSelection] = useState(null);
var currentSelectionRef = useRef();
currentSelectionRef.current = currentSelection;
useRef 的替代选项是使用库 'react-usestateref'
import useState from 'react-usestateref';
并创建状态变量为
var [currentSelection, setCurrentSelection, currentSelectionRef] = useState(null);
我们很高兴地宣布发布 ExtReact 7.0,它支持最新的 React 框架。此版本中的主要功能包括
Extreact 7.0 Modern Grid 提供拖放和行编辑,以便最终用户可以轻松地在网格单元格中移动、重新排序或插入内容。
拖放插件 - 具有拖动元素来移动光标和注册鼠标按下事件的网格视图节点
行编辑器插件 - 允许最终用户在行或列级别进行编辑。将有一个按钮来保存或取消更改。
提供了一个 Kitchensink 示例,展示了网格的拖放和行编辑器插件的所有功能。
ExtReact 7.0 Modern Grid 提供可折叠组,以便最终用户可以展开和折叠网格中的行组。可折叠组提供了一种显示和组织大型数据集的方法,并允许最终用户查看数据的高级摘要或从单个网格深入了解特定详细信息。
ExtReact 7.0 Modern Tree view 提供 拖放插件,以便最终用户可以轻松地在树层次结构中移动和重新排序节点。与树视图关联的拖动区和放置区将参与拖放功能。拖动操作将包括指定属性
ExtReact 7.0 提供 手风琴布局,以支持可扩展手风琴样式的多个面板布局,以便默认情况下任何给定时间只能展开一个面板,以便开发人员可以将焦点放在一次特定面板上,但在其他面板上添加更多最终用户可以探索的内容。
ExtReact 7.0 Modern 面包屑工具栏,提供了一种轻松将分层数据 treestore 显示为面包屑按钮轨迹的方式。每个按钮代表存储中的一个节点。单击按钮将在树中选择该节点。非叶节点将在面包屑轨迹中相应按钮的下拉菜单上显示其子节点。
ExtReact 7.0 提供 表单组,允许将复选框或单选按钮分组,以便可以一起验证或排列它们。
ExtReact 7.0 Modern toolkit 包括 Froala 文本编辑器 作为高级软件包的一部分。Froala 是最漂亮的 WYSIWYG 高性能富文本编辑器之一,具有简洁的设计。Froala Editor 将作为高级软件包提供,该软件包作为企业许可证的一部分提供。
注意:要完全部署 Froala Editor,用户需要获得 Froala 激活密钥。
ExtReact 7.0 Modern toolkit 包括 本地化包,以便开发人员可以轻松地为非英语用户本地化应用程序。区域设置包包括荷兰语、丹麦语、意大利语、捷克语、挪威语、芬兰语、俄语、韩语、日语和简体中文。
应用程序辅助功能是企业应用程序和出色用户体验的重要要求。Ext JS 7.0 Modern toolkit 包括 辅助功能 的更新,包括键盘导航、内置 Tab 索引和焦点。
Material 主题是一种流行的主题,现在可用于 Ext JS 7.0 Classic toolkit。与 Modern toolkit 类似,Classic toolkit 中的 Material 主题将使用 CSS 变量和 Fashion 的强大功能来动态更改颜色和外观。请注意,较旧的浏览器(如 IE8、IE 9、IE 10)可能不支持 Material 主题 Ripples。
ExtReact 7.0 已升级为支持基于 SVG 的 Font Awesome 5+。
ExtReact 7.0 工具中的新增功能
ExtGen 7.0 和 Sencha Cmd 已更新为支持 ExtReact 7.0。