amis-editor-core 6.11.0-beta.4 → 6.11.0-beta.5

package/lib/inlineEdit.d.ts

@@ -0,0 +1,28 @@
+import { InlineEditableElement } from './plugin';
+import { EditorNodeType } from './store/node';
+/**
+ * 内联编辑上下文接口定义
+ * @interface InlineEditContext
+ * @property {EditorNodeType} node - 当前编辑器节点实例
+ * @property {HTMLElement} elem - 需要编辑的DOM元素
+ * @property {InlineEditableElement} config - 内联编辑的配置信息
+ * @property {MouseEvent} [event] - 触发编辑的鼠标事件对象
+ * @property {Function} onConfirm - 编辑确认后的回调函数,参数为编辑后的内容
+ * @property {Function} onCancel - 取消编辑的回调函数
+ */
+export interface InlineEditContext {
+    node: EditorNodeType;
+    elem: HTMLElement;
+    config: InlineEditableElement;
+    event?: MouseEvent;
+    onConfirm: (value: string) => void;
+    onCancel: () => void;
+    richTextToken?: string;
+    richTextOptions?: any;
+}
+/**
+ * 启动内联编辑
+ * 根据配置的mode选择对应的编辑模式
+ * @param {InlineEditContext} context - 编辑上下文
+ */
+export declare function startInlineEdit(context: InlineEditContext): void;

package/lib/manager.d.ts

@@ -2,7 +2,7 @@
 /// <reference types="lodash" />
 import { DataSchema } from 'amis';
 import { RenderOptions, GlobalVariableItem } from 'amis-core';
-import { PluginInterface, BasicPanelItem, RendererInfo, SubRendererInfo, PluginEvent, RegionConfig, ContextMenuItem, ContextMenuEventContext, EventContext, PluginEventFn, ScaffoldForm, RendererPluginEvent, PluginEvents, PluginActions } from './plugin';
+import { PluginInterface, BasicPanelItem, RendererInfo, SubRendererInfo, PluginEvent, RegionConfig, ContextMenuItem, ContextMenuEventContext, EventContext, PluginEventFn, ScaffoldForm, RendererPluginEvent, PluginEvents, PluginActions, InlineEditableElement } from './plugin';
 import { EditorStoreType, SubEditorContext } from './store/editor';
 import { EditorNodeType } from './store/node';
 import { EditorProps } from './component/Editor';
@@ -112,10 +112,6 @@ export declare class EditorManager {
             readonly removable: boolean;
             readonly duplicatable: boolean;
             readonly replaceable: boolean;
-            /**
-             * 在 component/Editor.tsx 里面实例化的。
-             * 辅助 component/Editor.tsx 实现一些非 UI 相关的功能。
-             */
             memberImmutable(region: string): boolean;
             readonly isRegion: boolean;
             readonly childRegions: any[];
@@ -180,10 +176,6 @@ export declare class EditorManager {
                 readonly removable: boolean;
                 readonly duplicatable: boolean;
                 readonly replaceable: boolean;
-                /**
-                 * 在 component/Editor.tsx 里面实例化的。
-                 * 辅助 component/Editor.tsx 实现一些非 UI 相关的功能。
-                 */
                 memberImmutable(region: string): boolean;
                 readonly isRegion: boolean;
                 readonly childRegions: any[];
@@ -247,10 +239,6 @@ export declare class EditorManager {
                 readonly removable: boolean;
                 readonly duplicatable: boolean;
                 readonly replaceable: boolean;
-                /**
-                 * 在 component/Editor.tsx 里面实例化的。
-                 * 辅助 component/Editor.tsx 实现一些非 UI 相关的功能。
-                 */
                 memberImmutable(region: string): boolean;
                 readonly isRegion: boolean;
                 readonly childRegions: any[];
@@ -341,10 +329,6 @@ export declare class EditorManager {
                 readonly removable: boolean;
                 readonly duplicatable: boolean;
                 readonly replaceable: boolean;
-                /**
-                 * 在 component/Editor.tsx 里面实例化的。
-                 * 辅助 component/Editor.tsx 实现一些非 UI 相关的功能。
-                 */
                 memberImmutable(region: string): boolean;
                 readonly isRegion: boolean;
                 readonly childRegions: any[];
@@ -408,10 +392,6 @@ export declare class EditorManager {
                 readonly removable: boolean;
                 readonly duplicatable: boolean;
                 readonly replaceable: boolean;
-                /**
-                 * 在 component/Editor.tsx 里面实例化的。
-                 * 辅助 component/Editor.tsx 实现一些非 UI 相关的功能。
-                 */
                 memberImmutable(region: string): boolean;
                 readonly isRegion: boolean;
                 readonly childRegions: any[];
@@ -509,10 +489,6 @@ export declare class EditorManager {
             readonly removable: boolean;
             readonly duplicatable: boolean;
             readonly replaceable: boolean;
-            /**
-             * 在 component/Editor.tsx 里面实例化的。
-             * 辅助 component/Editor.tsx 实现一些非 UI 相关的功能。
-             */
             memberImmutable(region: string): boolean;
             readonly isRegion: boolean;
             readonly childRegions: any[];
@@ -577,10 +553,6 @@ export declare class EditorManager {
                 readonly removable: boolean;
                 readonly duplicatable: boolean;
                 readonly replaceable: boolean;
-                /**
-                 * 在 component/Editor.tsx 里面实例化的。
-                 * 辅助 component/Editor.tsx 实现一些非 UI 相关的功能。
-                 */
                 memberImmutable(region: string): boolean;
                 readonly isRegion: boolean;
                 readonly childRegions: any[];
@@ -644,10 +616,6 @@ export declare class EditorManager {
                 readonly removable: boolean;
                 readonly duplicatable: boolean;
                 readonly replaceable: boolean;
-                /**
-                 * 在 component/Editor.tsx 里面实例化的。
-                 * 辅助 component/Editor.tsx 实现一些非 UI 相关的功能。
-                 */
                 memberImmutable(region: string): boolean;
                 readonly isRegion: boolean;
                 readonly childRegions: any[];
@@ -738,10 +706,6 @@ export declare class EditorManager {
                 readonly removable: boolean;
                 readonly duplicatable: boolean;
                 readonly replaceable: boolean;
-                /**
-                 * 在 component/Editor.tsx 里面实例化的。
-                 * 辅助 component/Editor.tsx 实现一些非 UI 相关的功能。
-                 */
                 memberImmutable(region: string): boolean;
                 readonly isRegion: boolean;
                 readonly childRegions: any[];
@@ -805,10 +769,6 @@ export declare class EditorManager {
                 readonly removable: boolean;
                 readonly duplicatable: boolean;
                 readonly replaceable: boolean;
-                /**
-                 * 在 component/Editor.tsx 里面实例化的。
-                 * 辅助 component/Editor.tsx 实现一些非 UI 相关的功能。
-                 */
                 memberImmutable(region: string): boolean;
                 readonly isRegion: boolean;
                 readonly childRegions: any[];
@@ -1178,6 +1138,7 @@ export declare class EditorManager {
      * 获取可用上下文待绑定字段
      */
     getAvailableContextFields(node: EditorNodeType): Promise<any>;
+    startInlineEdit(node: EditorNodeType, elem: HTMLElement, config: InlineEditableElement, event?: MouseEvent): void;
     /**
      * 初始化全局变量
      */

package/lib/plugin.d.ts

@@ -127,6 +127,11 @@ export interface RendererScaffoldInfo {
     type?: string;
     scaffold?: any;
 }
+export interface InlineEditableElement {
+    match: string;
+    mode?: 'plain-text' | 'rich-text';
+    key: string;
+}
 /**
  * 渲染器信息。
  */
@@ -148,6 +153,10 @@ export interface RendererInfo extends RendererScaffoldInfo {
      * 配置区域。
      */
     regions?: Array<RegionConfig>;
+    /**
+     * 支持内联编辑的元素集合
+     */
+    inlineEditableElements?: Array<InlineEditableElement>;
     /**
      *  选中不需要高亮
      */
@@ -347,9 +356,10 @@ export interface PanelProps {
 export interface PanelItem {
     nodeId?: string;
     key: string;
-    icon: string;
+    icon: React.ReactNode;
+    tooltip?: string;
     pluginIcon?: string;
-    title: string | JSX.Element;
+    title?: React.ReactNode;
     component?: React.ComponentType<PanelProps | any>;
     order: number;
     position?: 'left' | 'right';

package/lib/store/editor.d.ts

@@ -463,6 +463,7 @@ export declare const MainStore: import("mobx-state-tree").IModelType<{
     hoverRegion: import("mobx-state-tree").IType<string | undefined, string, string>;
     activeId: import("mobx-state-tree").IType<string | undefined, string, string>;
     activeRegion: import("mobx-state-tree").IType<string | undefined, string, string>;
+    activeElement: import("mobx-state-tree").IType<string | undefined, string, string>;
     mouseMoveRegion: import("mobx-state-tree").IType<string | undefined, string, string>;
     selections: import("mobx-state-tree").IOptionalIType<import("mobx-state-tree").IType<string[], string[], string[]>, [undefined]>;
     contextId: import("mobx-state-tree").IType<string | undefined, string, string>;
@@ -3661,6 +3662,7 @@ export declare const MainStore: import("mobx-state-tree").IModelType<{
     moveSchema(event: PluginEvent<MoveEventContext>): void;
     setActiveId(id: string, region?: string, selections?: Array<string>, onEditorActive?: boolean): void;
     setActiveIdByComponentId(id: string): void;
+    setActiveElement(selector: string): void;
     setSelections(ids: Array<string>): void;
     clearSelection(): void;
     setHoverId(id: string, region?: string): void;