@excalidraw/element 0.18.0-91c7748 → 0.18.0-a52cd20

package/dist/types/excalidraw/actions/actionGroup.d.ts

@@ -1,26 +1,21 @@
-/// <reference types="react" />
-import type { ExcalidrawElement, OrderedExcalidrawElement } from "@excalidraw/element/types";
-import type { AppClassProperties, AppState } from "../types";
+import type { ExcalidrawElement, ExcalidrawTextElement, OrderedExcalidrawElement } from "@excalidraw/element/types";
+import type { AppClassProperties, UIAppState } from "../types";
 export declare const actionGroup: {
     name: "group";
     label: string;
-    icon: (appState: import("../types").UIAppState) => import("react/jsx-runtime").JSX.Element;
+    icon: (appState: UIAppState) => import("react/jsx-runtime").JSX.Element;
     trackEvent: {
         category: "element";
     };
-    perform: (elements: readonly OrderedExcalidrawElement[], appState: Readonly<AppState>, _: any, app: AppClassProperties) => {
-        appState: Readonly<AppState>;
+    perform: (elements: readonly OrderedExcalidrawElement[], appState: Readonly<import("../types").AppState>, _: unknown, app: AppClassProperties) => false | {
+        appState: Readonly<import("../types").AppState>;
         elements: readonly OrderedExcalidrawElement[];
         captureUpdate: "EVENTUALLY";
     } | {
         appState: {
-            editingGroupId: string | null;
-            selectedElementIds: Readonly<{
-                [id: string]: true;
-            }>;
-            selectedGroupIds: {
-                [groupId: string]: boolean;
-            };
+            editingGroupId: import("../types").AppState["editingGroupId"];
+            selectedElementIds: import("../types").AppState["selectedElementIds"];
+            selectedGroupIds: import("../types").AppState["selectedGroupIds"];
             contextMenu: {
                 items: import("../components/ContextMenu").ContextMenuItems;
                 top: number;
@@ -28,18 +23,36 @@ export declare const actionGroup: {
             } | null;
             showWelcomeScreen: boolean;
             isLoading: boolean;
-            errorMessage: import("react").ReactNode;
+            errorMessage: React.ReactNode;
             activeEmbeddable: {
                 element: import("@excalidraw/element/types").NonDeletedExcalidrawElement;
-                state: "active" | "hover";
+                state: "hover" | "active";
             } | null;
             newElement: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawNonSelectionElement> | null;
             resizingElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
             multiElement: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawLinearElement> | null;
             selectionElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
             isBindingEnabled: boolean;
-            startBoundElement: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawBindableElement> | null;
-            suggestedBindings: import("@excalidraw/element").SuggestedBinding[];
+            boxSelectionMode: import("../types").BoxSelectionMode;
+            bindingPreference: "enabled" | "disabled";
+            isMidpointSnappingEnabled: boolean;
+            showHints: boolean;
+            inputDevice: import("../types").InputDevice;
+            suggestedBinding: {
+                element: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawBindableElement>;
+                midPoint?: import("@excalidraw/math").GlobalPoint;
+            } | null;
+            textToolHover: {
+                type: "text";
+                elementId: ExcalidrawElement["id"];
+            } | {
+                type: "container";
+                elementId: ExcalidrawElement["id"];
+            } | {
+                type: "arrow";
+                elementId: import("@excalidraw/element/types").ExcalidrawArrowElement["id"];
+                anchor: "start" | "end" | "label";
+            } | null;
             frameToHighlight: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawFrameLikeElement> | null;
             frameRendering: {
                 enabled: boolean;
@@ -47,14 +60,18 @@ export declare const actionGroup: {
                 outline: boolean;
                 clip: boolean;
             };
-            editingFrame: string | null;
-            elementsToHighlight: import("@excalidraw/element/types").NonDeleted<ExcalidrawElement>[] | null;
-            editingTextElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
+            editingFrame: import("@excalidraw/element/types").ExcalidrawFrameLikeElement["id"] | null;
+            elementsToHighlight: readonly import("@excalidraw/element/types").NonDeletedExcalidrawElement[] | null;
+            editingTextElement: ExcalidrawTextElement | null;
             activeTool: {
                 lastActiveTool: import("../types").ActiveTool | null;
                 locked: boolean;
                 fromSelection: boolean;
             } & import("../types").ActiveTool;
+            preferredSelectionTool: {
+                type: "selection" | "lasso";
+                initialized: boolean;
+            };
             penMode: boolean;
             penDetected: boolean;
             exportBackground: boolean;
@@ -62,48 +79,56 @@ export declare const actionGroup: {
             exportWithDarkMode: boolean;
             exportScale: number;
             currentItemStrokeColor: string;
+            currentItemStickynoteStrokeColor: string;
+            currentItemStickynoteBackgroundColor: string;
             currentItemBackgroundColor: string;
-            currentItemFillStyle: import("@excalidraw/element/types").FillStyle;
-            currentItemStrokeWidth: number;
-            currentItemStrokeStyle: import("@excalidraw/element/types").StrokeStyle;
+            currentItemFillStyle: ExcalidrawElement["fillStyle"];
+            currentItemStrokeWidthKey: import("@excalidraw/common").StrokeWidthKey;
+            currentItemStrokeStyle: ExcalidrawElement["strokeStyle"];
             currentItemRoughness: number;
+            currentItemStrokeVariability: import("@excalidraw/element/types").StrokeVariability;
             currentItemOpacity: number;
-            currentItemFontFamily: number;
+            currentItemFontFamily: import("@excalidraw/element/types").FontFamilyValues;
             currentItemFontSize: number;
-            currentItemTextAlign: string;
+            currentItemTextAlign: import("@excalidraw/element/types").TextAlign;
             currentItemStartArrowhead: import("@excalidraw/element/types").Arrowhead | null;
             currentItemEndArrowhead: import("@excalidraw/element/types").Arrowhead | null;
-            currentHoveredFontFamily: number | null;
+            currentHoveredFontFamily: import("@excalidraw/element/types").FontFamilyValues | null;
             currentItemRoundness: import("@excalidraw/element/types").StrokeRoundness;
-            currentItemArrowType: "round" | "sharp" | "elbow";
+            currentItemArrowType: "sharp" | "round" | "elbow";
             viewBackgroundColor: string;
             scrollX: number;
             scrollY: number;
+            scrollConstraints: import("../types").ScrollConstraints | null;
             cursorButton: "up" | "down";
             scrolledOutside: boolean;
             name: string | null;
             isResizing: boolean;
             isRotating: boolean;
-            zoom: Readonly<{
-                value: import("../types").NormalizedZoomValue;
-            }>;
-            openMenu: "canvas" | "shape" | null;
-            openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | "compactTextProperties" | "compactStrokeStyles" | "compactOtherProperties" | "compactArrowProperties" | null;
+            zoom: import("../types").Zoom;
+            openMenu: "canvas" | null;
+            openPopup: "canvasBackground" | "elementBackground" | "elementStroke" | "fontFamily" | "compactTextProperties" | "compactStrokeStyles" | "compactOtherProperties" | "compactArrowProperties" | null;
             openSidebar: {
-                name: string;
-                tab?: string | undefined;
+                name: import("../types").SidebarName;
+                tab?: import("../types").SidebarTabName;
             } | null;
-            openDialog: {
+            openDialog: null | {
                 name: "imageExport" | "help" | "jsonExport";
             } | {
                 name: "ttd";
-                tab: "mermaid" | "text-to-diagram";
+                tab: "text-to-diagram" | "mermaid";
             } | {
                 name: "commandPalette";
+            } | {
+                name: "settings";
             } | {
                 name: "elementLinkSelector";
-                sourceElementId: string;
-            } | null;
+                sourceElementId: ExcalidrawElement["id"];
+            } | {
+                name: "charts";
+                data: import("../charts").Spreadsheet;
+                rawText: string;
+            };
             defaultSidebarDockedPreference: boolean;
             lastPointerDownWith: import("@excalidraw/element/types").PointerType;
             hoveredElementIds: Readonly<{
@@ -115,9 +140,9 @@ export declare const actionGroup: {
             selectedElementsAreBeingDragged: boolean;
             shouldCacheIgnoreZoom: boolean;
             toast: {
-                message: string;
-                closable?: boolean | undefined;
-                duration?: number | undefined;
+                message: React.ReactNode;
+                closable?: boolean;
+                duration?: number;
             } | null;
             zenModeEnabled: boolean;
             theme: import("@excalidraw/element/types").Theme;
@@ -129,40 +154,13 @@ export declare const actionGroup: {
             height: number;
             offsetTop: number;
             offsetLeft: number;
-            fileHandle: import("browser-fs-access").FileSystemHandle | null;
-            collaborators: Map<import("../types").SocketId, Readonly<{
-                pointer?: import("../types").CollaboratorPointer | undefined;
-                button?: "up" | "down" | undefined;
-                selectedElementIds?: Readonly<{
-                    [id: string]: true;
-                }> | undefined;
-                username?: string | null | undefined;
-                userState?: import("@excalidraw/common").UserIdleState | undefined;
-                color?: {
-                    background: string;
-                    stroke: string;
-                } | undefined;
-                avatarUrl?: string | undefined;
-                id?: string | undefined;
-                socketId?: import("../types").SocketId | undefined;
-                isCurrentUser?: boolean | undefined;
-                isInCall?: boolean | undefined;
-                isSpeaking?: boolean | undefined;
-                isMuted?: boolean | undefined;
-            }>>;
+            fileHandle: FileSystemFileHandle | null;
+            collaborators: Map<import("../types").SocketId, import("../types").Collaborator>;
             stats: {
                 open: boolean;
                 panels: number;
             };
-            currentChartType: import("@excalidraw/element/types").ChartType;
-            pasteDialog: {
-                shown: false;
-                data: null;
-            } | {
-                shown: true;
-                data: import("../charts").Spreadsheet;
-            };
-            showHyperlinkPopup: false | "editor" | "info";
+            showHyperlinkPopup: false | "info" | "editor";
             selectedLinearElement: import("@excalidraw/element").LinearElementEditor | null;
             snapLines: readonly import("../snapping").SnapLine[];
             originSnapOffset: {
@@ -170,24 +168,30 @@ export declare const actionGroup: {
                 y: number;
             } | null;
             objectsSnapModeEnabled: boolean;
-            userToFollow: import("../types").UserToFollow | null;
-            followedBy: Set<import("../types").SocketId>;
             isCropping: boolean;
-            croppingElementId: string | null;
+            croppingElementId: ExcalidrawElement["id"] | null;
             searchMatches: Readonly<{
-                focusedId: string | null;
+                focusedId: ExcalidrawElement["id"] | null;
                 matches: readonly import("../types").SearchMatch[];
             }> | null;
             activeLockedId: string | null;
             lockedMultiSelections: {
                 [groupId: string]: true;
             };
-            stylesPanelMode: "compact" | "full";
+            bindMode: import("@excalidraw/element/types").BindMode;
+            colorTopPicks: {
+                elementStroke: readonly string[] | null;
+                elementBackground: readonly string[] | null;
+                bucketFill: readonly string[] | null;
+                stickyNoteStroke: readonly string[] | null;
+                stickyNoteBackground: readonly string[] | null;
+            };
+            fontTopPicks: readonly import("@excalidraw/element/types").FontFamilyValues[] | null;
         };
         elements: OrderedExcalidrawElement[];
         captureUpdate: "IMMEDIATELY";
     };
-    predicate: (elements: readonly ExcalidrawElement[], appState: AppState, _: import("../types").ExcalidrawProps, app: AppClassProperties) => boolean;
+    predicate: (elements: readonly ExcalidrawElement[], appState: import("../types").AppState, _: import("../types").ExcalidrawProps, app: AppClassProperties) => boolean;
     keyTest: (event: KeyboardEvent | import("react").KeyboardEvent<Element>) => boolean;
     PanelComponent: ({ elements, appState, updateData, app }: import("./types").PanelComponentProps) => import("react/jsx-runtime").JSX.Element;
 } & {
@@ -196,23 +200,19 @@ export declare const actionGroup: {
 export declare const actionUngroup: {
     name: "ungroup";
     label: string;
-    icon: (appState: import("../types").UIAppState) => import("react/jsx-runtime").JSX.Element;
+    icon: (appState: UIAppState) => import("react/jsx-runtime").JSX.Element;
     trackEvent: {
         category: "element";
     };
-    perform: (elements: readonly OrderedExcalidrawElement[], appState: Readonly<AppState>, _: any, app: AppClassProperties) => {
-        appState: Readonly<AppState>;
+    perform: (elements: readonly OrderedExcalidrawElement[], appState: Readonly<import("../types").AppState>, _: unknown, app: AppClassProperties) => {
+        appState: Readonly<import("../types").AppState>;
         elements: readonly OrderedExcalidrawElement[];
         captureUpdate: "EVENTUALLY";
     } | {
         appState: {
-            editingGroupId: string | null;
-            selectedElementIds: Readonly<{
-                [id: string]: true;
-            }>;
-            selectedGroupIds: {
-                [groupId: string]: boolean;
-            };
+            editingGroupId: import("../types").AppState["editingGroupId"];
+            selectedElementIds: import("../types").AppState["selectedElementIds"];
+            selectedGroupIds: import("../types").AppState["selectedGroupIds"];
             contextMenu: {
                 items: import("../components/ContextMenu").ContextMenuItems;
                 top: number;
@@ -220,18 +220,36 @@ export declare const actionUngroup: {
             } | null;
             showWelcomeScreen: boolean;
             isLoading: boolean;
-            errorMessage: import("react").ReactNode;
+            errorMessage: React.ReactNode;
             activeEmbeddable: {
                 element: import("@excalidraw/element/types").NonDeletedExcalidrawElement;
-                state: "active" | "hover";
+                state: "hover" | "active";
             } | null;
             newElement: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawNonSelectionElement> | null;
             resizingElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
             multiElement: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawLinearElement> | null;
             selectionElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
             isBindingEnabled: boolean;
-            startBoundElement: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawBindableElement> | null;
-            suggestedBindings: import("@excalidraw/element").SuggestedBinding[];
+            boxSelectionMode: import("../types").BoxSelectionMode;
+            bindingPreference: "enabled" | "disabled";
+            isMidpointSnappingEnabled: boolean;
+            showHints: boolean;
+            inputDevice: import("../types").InputDevice;
+            suggestedBinding: {
+                element: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawBindableElement>;
+                midPoint?: import("@excalidraw/math").GlobalPoint;
+            } | null;
+            textToolHover: {
+                type: "text";
+                elementId: ExcalidrawElement["id"];
+            } | {
+                type: "container";
+                elementId: ExcalidrawElement["id"];
+            } | {
+                type: "arrow";
+                elementId: import("@excalidraw/element/types").ExcalidrawArrowElement["id"];
+                anchor: "start" | "end" | "label";
+            } | null;
             frameToHighlight: import("@excalidraw/element/types").NonDeleted<import("@excalidraw/element/types").ExcalidrawFrameLikeElement> | null;
             frameRendering: {
                 enabled: boolean;
@@ -239,14 +257,18 @@ export declare const actionUngroup: {
                 outline: boolean;
                 clip: boolean;
             };
-            editingFrame: string | null;
-            elementsToHighlight: import("@excalidraw/element/types").NonDeleted<ExcalidrawElement>[] | null;
-            editingTextElement: import("@excalidraw/element/types").NonDeletedExcalidrawElement | null;
+            editingFrame: import("@excalidraw/element/types").ExcalidrawFrameLikeElement["id"] | null;
+            elementsToHighlight: readonly import("@excalidraw/element/types").NonDeletedExcalidrawElement[] | null;
+            editingTextElement: ExcalidrawTextElement | null;
             activeTool: {
                 lastActiveTool: import("../types").ActiveTool | null;
                 locked: boolean;
                 fromSelection: boolean;
             } & import("../types").ActiveTool;
+            preferredSelectionTool: {
+                type: "selection" | "lasso";
+                initialized: boolean;
+            };
             penMode: boolean;
             penDetected: boolean;
             exportBackground: boolean;
@@ -254,48 +276,56 @@ export declare const actionUngroup: {
             exportWithDarkMode: boolean;
             exportScale: number;
             currentItemStrokeColor: string;
+            currentItemStickynoteStrokeColor: string;
+            currentItemStickynoteBackgroundColor: string;
             currentItemBackgroundColor: string;
-            currentItemFillStyle: import("@excalidraw/element/types").FillStyle;
-            currentItemStrokeWidth: number;
-            currentItemStrokeStyle: import("@excalidraw/element/types").StrokeStyle;
+            currentItemFillStyle: ExcalidrawElement["fillStyle"];
+            currentItemStrokeWidthKey: import("@excalidraw/common").StrokeWidthKey;
+            currentItemStrokeStyle: ExcalidrawElement["strokeStyle"];
             currentItemRoughness: number;
+            currentItemStrokeVariability: import("@excalidraw/element/types").StrokeVariability;
             currentItemOpacity: number;
-            currentItemFontFamily: number;
+            currentItemFontFamily: import("@excalidraw/element/types").FontFamilyValues;
             currentItemFontSize: number;
-            currentItemTextAlign: string;
+            currentItemTextAlign: import("@excalidraw/element/types").TextAlign;
             currentItemStartArrowhead: import("@excalidraw/element/types").Arrowhead | null;
             currentItemEndArrowhead: import("@excalidraw/element/types").Arrowhead | null;
-            currentHoveredFontFamily: number | null;
+            currentHoveredFontFamily: import("@excalidraw/element/types").FontFamilyValues | null;
             currentItemRoundness: import("@excalidraw/element/types").StrokeRoundness;
-            currentItemArrowType: "round" | "sharp" | "elbow";
+            currentItemArrowType: "sharp" | "round" | "elbow";
             viewBackgroundColor: string;
             scrollX: number;
             scrollY: number;
+            scrollConstraints: import("../types").ScrollConstraints | null;
             cursorButton: "up" | "down";
             scrolledOutside: boolean;
             name: string | null;
             isResizing: boolean;
             isRotating: boolean;
-            zoom: Readonly<{
-                value: import("../types").NormalizedZoomValue;
-            }>;
-            openMenu: "canvas" | "shape" | null;
-            openPopup: "fontFamily" | "canvasBackground" | "elementBackground" | "elementStroke" | "compactTextProperties" | "compactStrokeStyles" | "compactOtherProperties" | "compactArrowProperties" | null;
+            zoom: import("../types").Zoom;
+            openMenu: "canvas" | null;
+            openPopup: "canvasBackground" | "elementBackground" | "elementStroke" | "fontFamily" | "compactTextProperties" | "compactStrokeStyles" | "compactOtherProperties" | "compactArrowProperties" | null;
             openSidebar: {
-                name: string;
-                tab?: string | undefined;
+                name: import("../types").SidebarName;
+                tab?: import("../types").SidebarTabName;
             } | null;
-            openDialog: {
+            openDialog: null | {
                 name: "imageExport" | "help" | "jsonExport";
             } | {
                 name: "ttd";
-                tab: "mermaid" | "text-to-diagram";
+                tab: "text-to-diagram" | "mermaid";
             } | {
                 name: "commandPalette";
+            } | {
+                name: "settings";
             } | {
                 name: "elementLinkSelector";
-                sourceElementId: string;
-            } | null;
+                sourceElementId: ExcalidrawElement["id"];
+            } | {
+                name: "charts";
+                data: import("../charts").Spreadsheet;
+                rawText: string;
+            };
             defaultSidebarDockedPreference: boolean;
             lastPointerDownWith: import("@excalidraw/element/types").PointerType;
             hoveredElementIds: Readonly<{
@@ -307,9 +337,9 @@ export declare const actionUngroup: {
             selectedElementsAreBeingDragged: boolean;
             shouldCacheIgnoreZoom: boolean;
             toast: {
-                message: string;
-                closable?: boolean | undefined;
-                duration?: number | undefined;
+                message: React.ReactNode;
+                closable?: boolean;
+                duration?: number;
             } | null;
             zenModeEnabled: boolean;
             theme: import("@excalidraw/element/types").Theme;
@@ -321,40 +351,13 @@ export declare const actionUngroup: {
             height: number;
             offsetTop: number;
             offsetLeft: number;
-            fileHandle: import("browser-fs-access").FileSystemHandle | null;
-            collaborators: Map<import("../types").SocketId, Readonly<{
-                pointer?: import("../types").CollaboratorPointer | undefined;
-                button?: "up" | "down" | undefined;
-                selectedElementIds?: Readonly<{
-                    [id: string]: true;
-                }> | undefined;
-                username?: string | null | undefined;
-                userState?: import("@excalidraw/common").UserIdleState | undefined;
-                color?: {
-                    background: string;
-                    stroke: string;
-                } | undefined;
-                avatarUrl?: string | undefined;
-                id?: string | undefined;
-                socketId?: import("../types").SocketId | undefined;
-                isCurrentUser?: boolean | undefined;
-                isInCall?: boolean | undefined;
-                isSpeaking?: boolean | undefined;
-                isMuted?: boolean | undefined;
-            }>>;
+            fileHandle: FileSystemFileHandle | null;
+            collaborators: Map<import("../types").SocketId, import("../types").Collaborator>;
             stats: {
                 open: boolean;
                 panels: number;
             };
-            currentChartType: import("@excalidraw/element/types").ChartType;
-            pasteDialog: {
-                shown: false;
-                data: null;
-            } | {
-                shown: true;
-                data: import("../charts").Spreadsheet;
-            };
-            showHyperlinkPopup: false | "editor" | "info";
+            showHyperlinkPopup: false | "info" | "editor";
             selectedLinearElement: import("@excalidraw/element").LinearElementEditor | null;
             snapLines: readonly import("../snapping").SnapLine[];
             originSnapOffset: {
@@ -362,25 +365,31 @@ export declare const actionUngroup: {
                 y: number;
             } | null;
             objectsSnapModeEnabled: boolean;
-            userToFollow: import("../types").UserToFollow | null;
-            followedBy: Set<import("../types").SocketId>;
             isCropping: boolean;
-            croppingElementId: string | null;
+            croppingElementId: ExcalidrawElement["id"] | null;
             searchMatches: Readonly<{
-                focusedId: string | null;
+                focusedId: ExcalidrawElement["id"] | null;
                 matches: readonly import("../types").SearchMatch[];
             }> | null;
             activeLockedId: string | null;
             lockedMultiSelections: {
                 [groupId: string]: true;
             };
-            stylesPanelMode: "compact" | "full";
+            bindMode: import("@excalidraw/element/types").BindMode;
+            colorTopPicks: {
+                elementStroke: readonly string[] | null;
+                elementBackground: readonly string[] | null;
+                bucketFill: readonly string[] | null;
+                stickyNoteStroke: readonly string[] | null;
+                stickyNoteBackground: readonly string[] | null;
+            };
+            fontTopPicks: readonly import("@excalidraw/element/types").FontFamilyValues[] | null;
         };
         elements: OrderedExcalidrawElement[];
         captureUpdate: "IMMEDIATELY";
     };
     keyTest: (event: KeyboardEvent | import("react").KeyboardEvent<Element>) => boolean;
-    predicate: (elements: readonly ExcalidrawElement[], appState: AppState) => boolean;
+    predicate: (elements: readonly ExcalidrawElement[], appState: import("../types").AppState) => boolean;
     PanelComponent: ({ elements, appState, updateData }: import("./types").PanelComponentProps) => import("react/jsx-runtime").JSX.Element;
 } & {
     keyTest?: ((event: KeyboardEvent | import("react").KeyboardEvent<Element>) => boolean) | undefined;