npm - @excalidraw/excalidraw - Versions diffs - 0.11.0 → 0.12.0 - Mend

@excalidraw/excalidraw 0.11.0 → 0.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (648) hide show

package/types/actions/actionCanvas.d.ts CHANGED Viewed

@@ -3,22 +3,25 @@ import { ExcalidrawElement } from "../element/types";
 import { AppState, NormalizedZoomValue } from "../types";
 export declare const actionChangeViewBackgroundColor: {
     name: "changeViewBackgroundColor";
+    trackEvent: false;
     perform: (_: readonly ExcalidrawElement[], appState: Readonly<AppState>, value: any) => {
         appState: any;
         commitToHistory: boolean;
     };
-    PanelComponent: ({ appState, updateData }: import("react").PropsWithChildren<import("./types").PanelComponentProps>) => JSX.Element;
+    PanelComponent: ({ elements, appState, updateData }: import("react").PropsWithChildren<import("./types").PanelComponentProps>) => JSX.Element;
 } & {
     keyTest?: undefined;
 };
 export declare const actionClearCanvas: {
     name: "clearCanvas";
+    trackEvent: {
+        category: "canvas";
+    };
     perform: (elements: readonly ExcalidrawElement[], appState: Readonly<AppState>, _: any, app: import("../types").AppClassProperties) => {
         elements: ExcalidrawElement[];
         appState: {
             files: {};
             theme: string;
-            elementLocked: boolean;
             penMode: boolean;
             penDetected: boolean;
             exportBackground: boolean;
@@ -32,7 +35,17 @@ export declare const actionClearCanvas: {
                 shown: true;
                 data: import("../charts").Spreadsheet;
             };
-            elementType: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "freedraw";
+            activeTool: {
+                type: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw" | "eraser";
+                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                locked: boolean;
+                customType: null;
+            } | {
+                type: "custom";
+                customType: string;
+                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                locked: boolean;
+            };
             scrollX: number;
             scrollY: number;
             viewBackgroundColor: string;
@@ -40,7 +53,6 @@ export declare const actionClearCanvas: {
                 value: NormalizedZoomValue;
             }>;
             shouldCacheIgnoreZoom: boolean;
-            name: string;
             isLoading: boolean;
             errorMessage: string | null;
             draggingElement: import("../element/types").NonDeletedExcalidrawElement | null;
@@ -70,6 +82,7 @@ export declare const actionClearCanvas: {
             currentItemLinearStrokeSharpness: import("../element/types").StrokeSharpness;
             cursorButton: "up" | "down";
             scrolledOutside: boolean;
+            name: string;
             isResizing: boolean;
             isRotating: boolean;
             openMenu: "canvas" | "shape" | null;
@@ -90,10 +103,11 @@ export declare const actionClearCanvas: {
             };
             editingGroupId: string | null;
             isLibraryOpen: boolean;
+            isLibraryMenuDocked: boolean;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
             collaborators: Map<string, import("../types").Collaborator>;
             currentChartType: import("../element/types").ChartType;
-            pendingImageElement: import("../element/types").NonDeleted<import("../element/types").ExcalidrawImageElement> | null;
+            pendingImageElementId: string | null;
             showHyperlinkPopup: false | "info" | "editor";
         };
         commitToHistory: true;
@@ -104,6 +118,9 @@ export declare const actionClearCanvas: {
 };
 export declare const actionZoomIn: {
     name: "zoomIn";
+    trackEvent: {
+        category: "canvas";
+    };
     perform: (_elements: readonly ExcalidrawElement[], appState: Readonly<AppState>, _: any, app: import("../types").AppClassProperties) => {
         appState: {
             scrollX: number;
@@ -122,8 +139,17 @@ export declare const actionZoomIn: {
             suggestedBindings: import("../element/binding").SuggestedBinding[];
             editingElement: import("../element/types").NonDeletedExcalidrawElement | null;
             editingLinearElement: import("../element/linearElementEditor").LinearElementEditor | null;
-            elementType: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw";
-            elementLocked: boolean;
+            activeTool: {
+                type: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw" | "eraser";
+                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                locked: boolean;
+                customType: null;
+            } | {
+                type: "custom";
+                customType: string;
+                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                locked: boolean;
+            };
             penMode: boolean;
             penDetected: boolean;
             exportBackground: boolean;
@@ -175,6 +201,7 @@ export declare const actionZoomIn: {
             offsetTop: number;
             offsetLeft: number;
             isLibraryOpen: boolean;
+            isLibraryMenuDocked: boolean;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
             collaborators: Map<string, import("../types").Collaborator>;
             showStats: boolean;
@@ -186,7 +213,7 @@ export declare const actionZoomIn: {
                 shown: true;
                 data: import("../charts").Spreadsheet;
             };
-            pendingImageElement: import("../element/types").NonDeleted<import("../element/types").ExcalidrawImageElement> | null;
+            pendingImageElementId: string | null;
             showHyperlinkPopup: false | "info" | "editor";
         };
         commitToHistory: false;
@@ -198,6 +225,9 @@ export declare const actionZoomIn: {
 };
 export declare const actionZoomOut: {
     name: "zoomOut";
+    trackEvent: {
+        category: "canvas";
+    };
     perform: (_elements: readonly ExcalidrawElement[], appState: Readonly<AppState>, _: any, app: import("../types").AppClassProperties) => {
         appState: {
             scrollX: number;
@@ -216,8 +246,17 @@ export declare const actionZoomOut: {
             suggestedBindings: import("../element/binding").SuggestedBinding[];
             editingElement: import("../element/types").NonDeletedExcalidrawElement | null;
             editingLinearElement: import("../element/linearElementEditor").LinearElementEditor | null;
-            elementType: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw";
-            elementLocked: boolean;
+            activeTool: {
+                type: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw" | "eraser";
+                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                locked: boolean;
+                customType: null;
+            } | {
+                type: "custom";
+                customType: string;
+                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                locked: boolean;
+            };
             penMode: boolean;
             penDetected: boolean;
             exportBackground: boolean;
@@ -269,6 +308,7 @@ export declare const actionZoomOut: {
             offsetTop: number;
             offsetLeft: number;
             isLibraryOpen: boolean;
+            isLibraryMenuDocked: boolean;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
             collaborators: Map<string, import("../types").Collaborator>;
             showStats: boolean;
@@ -280,7 +320,7 @@ export declare const actionZoomOut: {
                 shown: true;
                 data: import("../charts").Spreadsheet;
             };
-            pendingImageElement: import("../element/types").NonDeleted<import("../element/types").ExcalidrawImageElement> | null;
+            pendingImageElementId: string | null;
             showHyperlinkPopup: false | "info" | "editor";
         };
         commitToHistory: false;
@@ -292,6 +332,9 @@ export declare const actionZoomOut: {
 };
 export declare const actionResetZoom: {
     name: "resetZoom";
+    trackEvent: {
+        category: "canvas";
+    };
     perform: (_elements: readonly ExcalidrawElement[], appState: Readonly<AppState>, _: any, app: import("../types").AppClassProperties) => {
         appState: {
             scrollX: number;
@@ -310,8 +353,17 @@ export declare const actionResetZoom: {
             suggestedBindings: import("../element/binding").SuggestedBinding[];
             editingElement: import("../element/types").NonDeletedExcalidrawElement | null;
             editingLinearElement: import("../element/linearElementEditor").LinearElementEditor | null;
-            elementType: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw";
-            elementLocked: boolean;
+            activeTool: {
+                type: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw" | "eraser";
+                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                locked: boolean;
+                customType: null;
+            } | {
+                type: "custom";
+                customType: string;
+                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                locked: boolean;
+            };
             penMode: boolean;
             penDetected: boolean;
             exportBackground: boolean;
@@ -363,6 +415,7 @@ export declare const actionResetZoom: {
             offsetTop: number;
             offsetLeft: number;
             isLibraryOpen: boolean;
+            isLibraryMenuDocked: boolean;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
             collaborators: Map<string, import("../types").Collaborator>;
             showStats: boolean;
@@ -374,7 +427,7 @@ export declare const actionResetZoom: {
                 shown: true;
                 data: import("../charts").Spreadsheet;
             };
-            pendingImageElement: import("../element/types").NonDeleted<import("../element/types").ExcalidrawImageElement> | null;
+            pendingImageElementId: string | null;
             showHyperlinkPopup: false | "info" | "editor";
         };
         commitToHistory: false;
@@ -386,6 +439,9 @@ export declare const actionResetZoom: {
 };
 export declare const actionZoomToSelected: {
     name: "zoomToSelection";
+    trackEvent: {
+        category: "canvas";
+    };
     perform: (elements: readonly ExcalidrawElement[], appState: Readonly<AppState>) => {
         appState: {
             zoom: {
@@ -404,8 +460,17 @@ export declare const actionZoomToSelected: {
             suggestedBindings: import("../element/binding").SuggestedBinding[];
             editingElement: import("../element/types").NonDeletedExcalidrawElement | null;
             editingLinearElement: import("../element/linearElementEditor").LinearElementEditor | null;
-            elementType: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw";
-            elementLocked: boolean;
+            activeTool: {
+                type: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw" | "eraser";
+                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                locked: boolean;
+                customType: null;
+            } | {
+                type: "custom";
+                customType: string;
+                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                locked: boolean;
+            };
             penMode: boolean;
             penDetected: boolean;
             exportBackground: boolean;
@@ -457,6 +522,7 @@ export declare const actionZoomToSelected: {
             offsetTop: number;
             offsetLeft: number;
             isLibraryOpen: boolean;
+            isLibraryMenuDocked: boolean;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
             collaborators: Map<string, import("../types").Collaborator>;
             showStats: boolean;
@@ -468,7 +534,7 @@ export declare const actionZoomToSelected: {
                 shown: true;
                 data: import("../charts").Spreadsheet;
             };
-            pendingImageElement: import("../element/types").NonDeleted<import("../element/types").ExcalidrawImageElement> | null;
+            pendingImageElementId: string | null;
             showHyperlinkPopup: false | "info" | "editor";
         };
         commitToHistory: boolean;
@@ -479,6 +545,9 @@ export declare const actionZoomToSelected: {
 };
 export declare const actionZoomToFit: {
     name: "zoomToFit";
+    trackEvent: {
+        category: "canvas";
+    };
     perform: (elements: readonly ExcalidrawElement[], appState: Readonly<AppState>) => {
         appState: {
             zoom: {
@@ -497,8 +566,17 @@ export declare const actionZoomToFit: {
             suggestedBindings: import("../element/binding").SuggestedBinding[];
             editingElement: import("../element/types").NonDeletedExcalidrawElement | null;
             editingLinearElement: import("../element/linearElementEditor").LinearElementEditor | null;
-            elementType: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw";
-            elementLocked: boolean;
+            activeTool: {
+                type: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw" | "eraser";
+                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                locked: boolean;
+                customType: null;
+            } | {
+                type: "custom";
+                customType: string;
+                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                locked: boolean;
+            };
             penMode: boolean;
             penDetected: boolean;
             exportBackground: boolean;
@@ -550,6 +628,7 @@ export declare const actionZoomToFit: {
             offsetTop: number;
             offsetLeft: number;
             isLibraryOpen: boolean;
+            isLibraryMenuDocked: boolean;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
             collaborators: Map<string, import("../types").Collaborator>;
             showStats: boolean;
@@ -561,7 +640,7 @@ export declare const actionZoomToFit: {
                 shown: true;
                 data: import("../charts").Spreadsheet;
             };
-            pendingImageElement: import("../element/types").NonDeleted<import("../element/types").ExcalidrawImageElement> | null;
+            pendingImageElementId: string | null;
             showHyperlinkPopup: false | "info" | "editor";
         };
         commitToHistory: boolean;
@@ -572,6 +651,9 @@ export declare const actionZoomToFit: {
 };
 export declare const actionToggleTheme: {
     name: "toggleTheme";
+    trackEvent: {
+        category: "canvas";
+    };
     perform: (_: readonly ExcalidrawElement[], appState: Readonly<AppState>, value: any) => {
         appState: {
             theme: any;
@@ -586,8 +668,17 @@ export declare const actionToggleTheme: {
             suggestedBindings: import("../element/binding").SuggestedBinding[];
             editingElement: import("../element/types").NonDeletedExcalidrawElement | null;
             editingLinearElement: import("../element/linearElementEditor").LinearElementEditor | null;
-            elementType: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw";
-            elementLocked: boolean;
+            activeTool: {
+                type: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw" | "eraser";
+                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                locked: boolean;
+                customType: null;
+            } | {
+                type: "custom";
+                customType: string;
+                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                locked: boolean;
+            };
             penMode: boolean;
             penDetected: boolean;
             exportBackground: boolean;
@@ -643,6 +734,7 @@ export declare const actionToggleTheme: {
             offsetTop: number;
             offsetLeft: number;
             isLibraryOpen: boolean;
+            isLibraryMenuDocked: boolean;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
             collaborators: Map<string, import("../types").Collaborator>;
             showStats: boolean;
@@ -654,7 +746,7 @@ export declare const actionToggleTheme: {
                 shown: true;
                 data: import("../charts").Spreadsheet;
             };
-            pendingImageElement: import("../element/types").NonDeleted<import("../element/types").ExcalidrawImageElement> | null;
+            pendingImageElementId: string | null;
             showHyperlinkPopup: false | "info" | "editor";
         };
         commitToHistory: false;
@@ -664,3 +756,106 @@ export declare const actionToggleTheme: {
 } & {
     keyTest?: ((event: KeyboardEvent | import("react").KeyboardEvent<Element>) => boolean) | undefined;
 };
+export declare const actionErase: {
+    name: "eraser";
+    trackEvent: {
+        category: "toolbar";
+    };
+    perform: (elements: readonly ExcalidrawElement[], appState: Readonly<AppState>) => {
+        appState: {
+            selectedElementIds: {};
+            selectedGroupIds: {};
+            activeTool: {
+                type: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw" | "eraser";
+                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                locked: boolean;
+                customType: null;
+            } | {
+                type: "custom";
+                customType: string;
+                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                locked: boolean;
+            };
+            isLoading: boolean;
+            errorMessage: string | null;
+            draggingElement: import("../element/types").NonDeletedExcalidrawElement | null;
+            resizingElement: import("../element/types").NonDeletedExcalidrawElement | null;
+            multiElement: import("../element/types").NonDeleted<import("../element/types").ExcalidrawLinearElement> | null;
+            selectionElement: import("../element/types").NonDeletedExcalidrawElement | null;
+            isBindingEnabled: boolean;
+            startBoundElement: import("../element/types").NonDeleted<import("../element/types").ExcalidrawBindableElement> | null;
+            suggestedBindings: import("../element/binding").SuggestedBinding[];
+            editingElement: import("../element/types").NonDeletedExcalidrawElement | null;
+            editingLinearElement: import("../element/linearElementEditor").LinearElementEditor | null;
+            penMode: boolean;
+            penDetected: boolean;
+            exportBackground: boolean;
+            exportEmbedScene: boolean;
+            exportWithDarkMode: boolean;
+            exportScale: number;
+            currentItemStrokeColor: string;
+            currentItemBackgroundColor: string;
+            currentItemFillStyle: import("../element/types").FillStyle;
+            currentItemStrokeWidth: number;
+            currentItemStrokeStyle: import("../element/types").StrokeStyle;
+            currentItemRoughness: number;
+            currentItemOpacity: number;
+            currentItemFontFamily: number;
+            currentItemFontSize: number;
+            currentItemTextAlign: import("../element/types").TextAlign;
+            currentItemStrokeSharpness: import("../element/types").StrokeSharpness;
+            currentItemStartArrowhead: import("../element/types").Arrowhead | null;
+            currentItemEndArrowhead: import("../element/types").Arrowhead | null;
+            currentItemLinearStrokeSharpness: import("../element/types").StrokeSharpness;
+            viewBackgroundColor: string;
+            scrollX: number;
+            scrollY: number;
+            cursorButton: "up" | "down";
+            scrolledOutside: boolean;
+            name: string;
+            isResizing: boolean;
+            isRotating: boolean;
+            zoom: Readonly<{
+                value: NormalizedZoomValue;
+            }>;
+            openMenu: "canvas" | "shape" | null;
+            openPopup: "canvasColorPicker" | "backgroundColorPicker" | "strokeColorPicker" | null;
+            lastPointerDownWith: import("../element/types").PointerType;
+            previousSelectedElementIds: {
+                [id: string]: boolean;
+            };
+            shouldCacheIgnoreZoom: boolean;
+            showHelpDialog: boolean;
+            toastMessage: string | null;
+            zenModeEnabled: boolean;
+            theme: string;
+            gridSize: number | null;
+            viewModeEnabled: boolean;
+            editingGroupId: string | null;
+            width: number;
+            height: number;
+            offsetTop: number;
+            offsetLeft: number;
+            isLibraryOpen: boolean;
+            isLibraryMenuDocked: boolean;
+            fileHandle: import("browser-fs-access").FileSystemHandle | null;
+            collaborators: Map<string, import("../types").Collaborator>;
+            showStats: boolean;
+            currentChartType: import("../element/types").ChartType;
+            pasteDialog: {
+                shown: false;
+                data: null;
+            } | {
+                shown: true;
+                data: import("../charts").Spreadsheet;
+            };
+            pendingImageElementId: string | null;
+            showHyperlinkPopup: false | "info" | "editor";
+        };
+        commitToHistory: true;
+    };
+    keyTest: (event: KeyboardEvent | import("react").KeyboardEvent<Element>) => boolean;
+    PanelComponent: ({ elements, appState, updateData, data }: import("react").PropsWithChildren<import("./types").PanelComponentProps>) => JSX.Element;
+} & {
+    keyTest?: ((event: KeyboardEvent | import("react").KeyboardEvent<Element>) => boolean) | undefined;
+};