@nocobase/flow-engine 2.1.0-alpha.4 → 2.1.0-alpha.45

package/lib/components/settings/wrappers/contextual/FlowsFloatContextMenu.d.ts

@@ -9,13 +9,14 @@
 import React from 'react';
 import { FlowModel } from '../../../../models';
 import { ToolbarItemConfig } from '../../../../types';
-interface ModelProvidedProps {
-    model: FlowModel<any>;
+type ToolbarPosition = 'inside' | 'above' | 'below';
+interface BaseFloatContextMenuProps {
     children?: React.ReactNode;
     enabled?: boolean;
     showDeleteButton?: boolean;
     showCopyUidButton?: boolean;
     containerStyle?: React.CSSProperties;
+    /** 自定义工具栏样式，`top/left/right/bottom` 会作为 portal overlay 的 inset 使用。 */
     toolbarStyle?: React.CSSProperties;
     className?: string;
     /**
@@ -42,68 +43,47 @@ interface ModelProvidedProps {
      * Extra toolbar items to add to this context menu instance
      */
     extraToolbarItems?: ToolbarItemConfig[];
-    /**
-     * @default 'inside'
-     */
-    toolbarPosition?: 'inside' | 'above' | 'below';
-}
-interface ModelByIdProps {
-    uid: string;
-    modelClassName: string;
-    children?: React.ReactNode;
-    enabled?: boolean;
-    showDeleteButton?: boolean;
-    showCopyUidButton?: boolean;
-    containerStyle?: React.CSSProperties;
-    className?: string;
     /**
      * @default true
      */
-    showBorder?: boolean;
-    /**
-     * @default true
-     */
-    showBackground?: boolean;
-    /**
-     * @default false
-     */
-    showTitle?: boolean;
-    /**
-     * Settings menu levels: 1=current model only (default), 2=include sub-models
-     */
-    settingsMenuLevel?: number;
-    /**
-     * Extra toolbar items to add to this context menu instance
-     */
-    extraToolbarItems?: ToolbarItemConfig[];
+    showDynamicFlowsEditor?: boolean;
     /**
      * @default 'inside'
      */
-    toolbarPosition?: 'inside' | 'above' | 'below';
+    toolbarPosition?: ToolbarPosition;
+}
+interface ModelProvidedProps extends BaseFloatContextMenuProps {
+    model: FlowModel<any>;
+}
+interface ModelByIdProps extends BaseFloatContextMenuProps {
+    uid: string;
+    modelClassName: string;
 }
 type FlowsFloatContextMenuProps = ModelProvidedProps | ModelByIdProps;
 /**
- * FlowsFloatContextMenu组件 - 悬浮配置图标组件
+ * FlowsFloatContextMenu组件 - 悬浮配置工具栏组件
  *
  * 功能特性：
  * - 鼠标悬浮显示右上角配置图标
  * - 点击图标显示配置菜单
  * - 支持删除功能
  * - Wrapper 模式支持
- * - 使用与 NocoBase x-settings 一致的样式
- * - 按flow分组显示steps
+ * - 使用 portal overlay 避免被宿主或祖先裁剪
+ * - 设置菜单与工具栏共享同一个 popup 容器
  *
  * 支持两种使用方式：
- * 1. 直接提供model: <FlowsFloatContextMenu model={myModel}>{children}</FlowsFloatContextMenu>
- * 2. 通过uid和modelClassName获取model: <FlowsFloatContextMenu uid="model1" modelClassName="MyModel">{children}</FlowsFloatContextMenu>
+ * 1. 直接提供 model: `<FlowsFloatContextMenu model={myModel}>{children}</FlowsFloatContextMenu>`
+ * 2. 通过 uid 和 modelClassName 获取 model:
+ *    `<FlowsFloatContextMenu uid="model1" modelClassName="MyModel">{children}</FlowsFloatContextMenu>`
  *
  * @param props.children 子组件，必须提供
- * @param props.enabled 是否启用悬浮菜单，默认为true
- * @param props.showDeleteButton 是否显示删除按钮，默认为true
- * @param props.showCopyUidButton 是否显示复制UID按钮，默认为true
+ * @param props.enabled 是否启用悬浮菜单，默认为 true
+ * @param props.showDeleteButton 是否显示删除按钮，默认为 true
+ * @param props.showCopyUidButton 是否显示复制 UID 按钮，默认为 true
  * @param props.containerStyle 容器自定义样式
+ * @param props.toolbarStyle 工具栏自定义样式；`top/left/right/bottom` 会作为 portal overlay 的 inset 使用
  * @param props.className 容器自定义类名
- * @param props.showTitle 是否在边框左上角显示模型title，默认为false
+ * @param props.showTitle 是否在边框左上角显示模型 title，默认为 false
  * @param props.settingsMenuLevel 设置菜单层级：1=仅当前模型(默认)，2=包含子模型
  * @param props.extraToolbarItems 额外的工具栏项目，仅应用于此实例
  */