@dwelle/excalidraw 0.4.0-d8d86cf → 0.4.0-da7ef3e

package/types/actions/actionToggleStats.d.ts

@@ -1,15 +1,24 @@
-/// <reference types="react" />
 export declare const actionToggleStats: {
     name: "stats";
+    viewMode: true;
     trackEvent: {
         category: "menu";
     };
     perform(elements: readonly import("../element/types").ExcalidrawElement[], appState: Readonly<import("../types").AppState>): {
         appState: {
             showStats: boolean;
+            contextMenu: {
+                items: import("../components/ContextMenu").ContextMenuItems;
+                top: number;
+                left: number;
+            } | null;
             showWelcomeScreen: boolean;
             isLoading: boolean;
-            errorMessage: string | null;
+            errorMessage: import("react").ReactNode;
+            activeEmbeddable: {
+                element: import("../element/types").NonDeletedExcalidrawElement;
+                state: "active" | "hover";
+            } | null;
             draggingElement: import("../element/types").NonDeletedExcalidrawElement | null;
             resizingElement: import("../element/types").NonDeletedExcalidrawElement | null;
             multiElement: import("../element/types").NonDeleted<import("../element/types").ExcalidrawLinearElement> | null;
@@ -17,19 +26,27 @@ export declare const actionToggleStats: {
             isBindingEnabled: boolean;
             startBoundElement: import("../element/types").NonDeleted<import("../element/types").ExcalidrawBindableElement> | null;
             suggestedBindings: import("../element/binding").SuggestedBinding[];
+            frameToHighlight: import("../element/types").NonDeleted<import("../element/types").ExcalidrawFrameElement> | null;
+            frameRendering: {
+                enabled: boolean;
+                name: boolean;
+                outline: boolean;
+                clip: boolean;
+            };
+            editingFrame: string | null;
+            elementsToHighlight: import("../element/types").NonDeleted<import("../element/types").ExcalidrawElement>[] | null;
             editingElement: import("../element/types").NonDeletedExcalidrawElement | null;
             editingLinearElement: import("../element/linearElementEditor").LinearElementEditor | null;
             activeTool: {
-                type: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw" | "eraser";
-                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                lastActiveTool: import("../types").LastActiveTool;
                 locked: boolean;
+            } & ({
+                type: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "embeddable" | "image" | "frame" | "freedraw" | "eraser" | "hand";
                 customType: null;
             } | {
                 type: "custom";
                 customType: string;
-                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
-                locked: boolean;
-            };
+            });
             penMode: boolean;
             penDetected: boolean;
             exportBackground: boolean;
@@ -46,10 +63,9 @@ export declare const actionToggleStats: {
             currentItemFontFamily: number;
             currentItemFontSize: number;
             currentItemTextAlign: string;
-            currentItemStrokeSharpness: import("../element/types").StrokeSharpness;
             currentItemStartArrowhead: import("../element/types").Arrowhead | null;
             currentItemEndArrowhead: import("../element/types").Arrowhead | null;
-            currentItemLinearStrokeSharpness: import("../element/types").StrokeSharpness;
+            currentItemRoundness: import("../element/types").StrokeRoundness;
             viewBackgroundColor: string;
             scrollX: number;
             scrollY: number;
@@ -62,17 +78,21 @@ export declare const actionToggleStats: {
                 value: import("../types").NormalizedZoomValue;
             }>;
             openMenu: "canvas" | "shape" | null;
-            openPopup: "canvasColorPicker" | "backgroundColorPicker" | "strokeColorPicker" | null;
-            openSidebar: "library" | "customSidebar" | null;
-            openDialog: "imageExport" | "help" | null;
-            isSidebarDocked: boolean;
+            openPopup: "canvasBackground" | "elementBackground" | "elementStroke" | null;
+            openSidebar: {
+                name: string;
+                tab?: string | undefined;
+            } | null;
+            openDialog: "imageExport" | "help" | "jsonExport" | null;
+            defaultSidebarDockedPreference: boolean;
             lastPointerDownWith: import("../element/types").PointerType;
-            selectedElementIds: {
-                [id: string]: boolean;
-            };
+            selectedElementIds: Readonly<{
+                [id: string]: true;
+            }>;
             previousSelectedElementIds: {
-                [id: string]: boolean;
+                [id: string]: true;
             };
+            selectedElementsAreBeingDragged: boolean;
             shouldCacheIgnoreZoom: boolean;
             toast: {
                 message: string;
@@ -80,7 +100,7 @@ export declare const actionToggleStats: {
                 duration?: number | undefined;
             } | null;
             zenModeEnabled: boolean;
-            theme: string;
+            theme: import("../element/types").Theme;
             gridSize: number | null;
             viewModeEnabled: boolean;
             selectedGroupIds: {
@@ -102,8 +122,14 @@ export declare const actionToggleStats: {
                 data: import("../charts").Spreadsheet;
             };
             pendingImageElementId: string | null;
-            showHyperlinkPopup: false | "info" | "editor";
+            showHyperlinkPopup: false | "editor" | "info";
             selectedLinearElement: import("../element/linearElementEditor").LinearElementEditor | null;
+            snapLines: import("../snapping").SnapLine[];
+            originSnapOffset: {
+                x: number;
+                y: number;
+            } | null;
+            objectsSnapModeEnabled: boolean;
         };
         commitToHistory: false;
     };

package/types/actions/actionToggleViewMode.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="react" />
 export declare const actionToggleViewMode: {
     name: "viewMode";
+    viewMode: true;
     trackEvent: {
         category: "canvas";
         predicate: (appState: Readonly<import("../types").AppState>) => boolean;
@@ -8,9 +8,18 @@ export declare const actionToggleViewMode: {
     perform(elements: readonly import("../element/types").ExcalidrawElement[], appState: Readonly<import("../types").AppState>): {
         appState: {
             viewModeEnabled: boolean;
+            contextMenu: {
+                items: import("../components/ContextMenu").ContextMenuItems;
+                top: number;
+                left: number;
+            } | null;
             showWelcomeScreen: boolean;
             isLoading: boolean;
-            errorMessage: string | null;
+            errorMessage: import("react").ReactNode;
+            activeEmbeddable: {
+                element: import("../element/types").NonDeletedExcalidrawElement;
+                state: "active" | "hover";
+            } | null;
             draggingElement: import("../element/types").NonDeletedExcalidrawElement | null;
             resizingElement: import("../element/types").NonDeletedExcalidrawElement | null;
             multiElement: import("../element/types").NonDeleted<import("../element/types").ExcalidrawLinearElement> | null;
@@ -18,19 +27,27 @@ export declare const actionToggleViewMode: {
             isBindingEnabled: boolean;
             startBoundElement: import("../element/types").NonDeleted<import("../element/types").ExcalidrawBindableElement> | null;
             suggestedBindings: import("../element/binding").SuggestedBinding[];
+            frameToHighlight: import("../element/types").NonDeleted<import("../element/types").ExcalidrawFrameElement> | null;
+            frameRendering: {
+                enabled: boolean;
+                name: boolean;
+                outline: boolean;
+                clip: boolean;
+            };
+            editingFrame: string | null;
+            elementsToHighlight: import("../element/types").NonDeleted<import("../element/types").ExcalidrawElement>[] | null;
             editingElement: import("../element/types").NonDeletedExcalidrawElement | null;
             editingLinearElement: import("../element/linearElementEditor").LinearElementEditor | null;
             activeTool: {
-                type: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw" | "eraser";
-                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                lastActiveTool: import("../types").LastActiveTool;
                 locked: boolean;
+            } & ({
+                type: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "embeddable" | "image" | "frame" | "freedraw" | "eraser" | "hand";
                 customType: null;
             } | {
                 type: "custom";
                 customType: string;
-                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
-                locked: boolean;
-            };
+            });
             penMode: boolean;
             penDetected: boolean;
             exportBackground: boolean;
@@ -47,10 +64,9 @@ export declare const actionToggleViewMode: {
             currentItemFontFamily: number;
             currentItemFontSize: number;
             currentItemTextAlign: string;
-            currentItemStrokeSharpness: import("../element/types").StrokeSharpness;
             currentItemStartArrowhead: import("../element/types").Arrowhead | null;
             currentItemEndArrowhead: import("../element/types").Arrowhead | null;
-            currentItemLinearStrokeSharpness: import("../element/types").StrokeSharpness;
+            currentItemRoundness: import("../element/types").StrokeRoundness;
             viewBackgroundColor: string;
             scrollX: number;
             scrollY: number;
@@ -63,17 +79,21 @@ export declare const actionToggleViewMode: {
                 value: import("../types").NormalizedZoomValue;
             }>;
             openMenu: "canvas" | "shape" | null;
-            openPopup: "canvasColorPicker" | "backgroundColorPicker" | "strokeColorPicker" | null;
-            openSidebar: "library" | "customSidebar" | null;
-            openDialog: "imageExport" | "help" | null;
-            isSidebarDocked: boolean;
+            openPopup: "canvasBackground" | "elementBackground" | "elementStroke" | null;
+            openSidebar: {
+                name: string;
+                tab?: string | undefined;
+            } | null;
+            openDialog: "imageExport" | "help" | "jsonExport" | null;
+            defaultSidebarDockedPreference: boolean;
             lastPointerDownWith: import("../element/types").PointerType;
-            selectedElementIds: {
-                [id: string]: boolean;
-            };
+            selectedElementIds: Readonly<{
+                [id: string]: true;
+            }>;
             previousSelectedElementIds: {
-                [id: string]: boolean;
+                [id: string]: true;
             };
+            selectedElementsAreBeingDragged: boolean;
             shouldCacheIgnoreZoom: boolean;
             toast: {
                 message: string;
@@ -81,7 +101,7 @@ export declare const actionToggleViewMode: {
                 duration?: number | undefined;
             } | null;
             zenModeEnabled: boolean;
-            theme: string;
+            theme: import("../element/types").Theme;
             gridSize: number | null;
             selectedGroupIds: {
                 [groupId: string]: boolean;
@@ -103,12 +123,19 @@ export declare const actionToggleViewMode: {
                 data: import("../charts").Spreadsheet;
             };
             pendingImageElementId: string | null;
-            showHyperlinkPopup: false | "info" | "editor";
+            showHyperlinkPopup: false | "editor" | "info";
             selectedLinearElement: import("../element/linearElementEditor").LinearElementEditor | null;
+            snapLines: import("../snapping").SnapLine[];
+            originSnapOffset: {
+                x: number;
+                y: number;
+            } | null;
+            objectsSnapModeEnabled: boolean;
         };
         commitToHistory: false;
     };
     checked: (appState: Readonly<import("../types").AppState>) => boolean;
+    predicate: (elements: readonly import("../element/types").ExcalidrawElement[], appState: import("../types").AppState, appProps: import("../types").ExcalidrawProps) => boolean;
     contextItemLabel: string;
     keyTest: (event: KeyboardEvent | import("react").KeyboardEvent<Element>) => boolean;
 } & {

package/types/actions/actionToggleZenMode.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="react" />
 export declare const actionToggleZenMode: {
     name: "zenMode";
+    viewMode: true;
     trackEvent: {
         category: "canvas";
         predicate: (appState: Readonly<import("../types").AppState>) => boolean;
@@ -8,9 +8,18 @@ export declare const actionToggleZenMode: {
     perform(elements: readonly import("../element/types").ExcalidrawElement[], appState: Readonly<import("../types").AppState>): {
         appState: {
             zenModeEnabled: boolean;
+            contextMenu: {
+                items: import("../components/ContextMenu").ContextMenuItems;
+                top: number;
+                left: number;
+            } | null;
             showWelcomeScreen: boolean;
             isLoading: boolean;
-            errorMessage: string | null;
+            errorMessage: import("react").ReactNode;
+            activeEmbeddable: {
+                element: import("../element/types").NonDeletedExcalidrawElement;
+                state: "active" | "hover";
+            } | null;
             draggingElement: import("../element/types").NonDeletedExcalidrawElement | null;
             resizingElement: import("../element/types").NonDeletedExcalidrawElement | null;
             multiElement: import("../element/types").NonDeleted<import("../element/types").ExcalidrawLinearElement> | null;
@@ -18,19 +27,27 @@ export declare const actionToggleZenMode: {
             isBindingEnabled: boolean;
             startBoundElement: import("../element/types").NonDeleted<import("../element/types").ExcalidrawBindableElement> | null;
             suggestedBindings: import("../element/binding").SuggestedBinding[];
+            frameToHighlight: import("../element/types").NonDeleted<import("../element/types").ExcalidrawFrameElement> | null;
+            frameRendering: {
+                enabled: boolean;
+                name: boolean;
+                outline: boolean;
+                clip: boolean;
+            };
+            editingFrame: string | null;
+            elementsToHighlight: import("../element/types").NonDeleted<import("../element/types").ExcalidrawElement>[] | null;
             editingElement: import("../element/types").NonDeletedExcalidrawElement | null;
             editingLinearElement: import("../element/linearElementEditor").LinearElementEditor | null;
             activeTool: {
-                type: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "image" | "freedraw" | "eraser";
-                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
+                lastActiveTool: import("../types").LastActiveTool;
                 locked: boolean;
+            } & ({
+                type: "line" | "arrow" | "text" | "selection" | "rectangle" | "diamond" | "ellipse" | "embeddable" | "image" | "frame" | "freedraw" | "eraser" | "hand";
                 customType: null;
             } | {
                 type: "custom";
                 customType: string;
-                lastActiveToolBeforeEraser: import("../types").LastActiveToolBeforeEraser;
-                locked: boolean;
-            };
+            });
             penMode: boolean;
             penDetected: boolean;
             exportBackground: boolean;
@@ -47,10 +64,9 @@ export declare const actionToggleZenMode: {
             currentItemFontFamily: number;
             currentItemFontSize: number;
             currentItemTextAlign: string;
-            currentItemStrokeSharpness: import("../element/types").StrokeSharpness;
             currentItemStartArrowhead: import("../element/types").Arrowhead | null;
             currentItemEndArrowhead: import("../element/types").Arrowhead | null;
-            currentItemLinearStrokeSharpness: import("../element/types").StrokeSharpness;
+            currentItemRoundness: import("../element/types").StrokeRoundness;
             viewBackgroundColor: string;
             scrollX: number;
             scrollY: number;
@@ -63,24 +79,28 @@ export declare const actionToggleZenMode: {
                 value: import("../types").NormalizedZoomValue;
             }>;
             openMenu: "canvas" | "shape" | null;
-            openPopup: "canvasColorPicker" | "backgroundColorPicker" | "strokeColorPicker" | null;
-            openSidebar: "library" | "customSidebar" | null;
-            openDialog: "imageExport" | "help" | null;
-            isSidebarDocked: boolean;
+            openPopup: "canvasBackground" | "elementBackground" | "elementStroke" | null;
+            openSidebar: {
+                name: string;
+                tab?: string | undefined;
+            } | null;
+            openDialog: "imageExport" | "help" | "jsonExport" | null;
+            defaultSidebarDockedPreference: boolean;
             lastPointerDownWith: import("../element/types").PointerType;
-            selectedElementIds: {
-                [id: string]: boolean;
-            };
+            selectedElementIds: Readonly<{
+                [id: string]: true;
+            }>;
             previousSelectedElementIds: {
-                [id: string]: boolean;
+                [id: string]: true;
             };
+            selectedElementsAreBeingDragged: boolean;
             shouldCacheIgnoreZoom: boolean;
             toast: {
                 message: string;
                 closable?: boolean | undefined;
                 duration?: number | undefined;
             } | null;
-            theme: string;
+            theme: import("../element/types").Theme;
             gridSize: number | null;
             viewModeEnabled: boolean;
             selectedGroupIds: {
@@ -103,12 +123,19 @@ export declare const actionToggleZenMode: {
                 data: import("../charts").Spreadsheet;
             };
             pendingImageElementId: string | null;
-            showHyperlinkPopup: false | "info" | "editor";
+            showHyperlinkPopup: false | "editor" | "info";
             selectedLinearElement: import("../element/linearElementEditor").LinearElementEditor | null;
+            snapLines: import("../snapping").SnapLine[];
+            originSnapOffset: {
+                x: number;
+                y: number;
+            } | null;
+            objectsSnapModeEnabled: boolean;
         };
         commitToHistory: false;
     };
     checked: (appState: Readonly<import("../types").AppState>) => boolean;
+    predicate: (elements: readonly import("../element/types").ExcalidrawElement[], appState: import("../types").AppState, appProps: import("../types").ExcalidrawProps) => boolean;
     contextItemLabel: string;
     keyTest: (event: KeyboardEvent | import("react").KeyboardEvent<Element>) => boolean;
 } & {

package/types/actions/actionZindex.d.ts

@@ -5,16 +5,14 @@ export declare const actionSendBackward: {
         category: "element";
     };
     perform: (elements: readonly import("../element/types").ExcalidrawElement[], appState: Readonly<import("../types").AppState>) => {
-        elements: (import("../element/types").ExcalidrawLinearElement | import("../element/types").ExcalidrawSelectionElement | import("../element/types").ExcalidrawRectangleElement | import("../element/types").ExcalidrawDiamondElement | import("../element/types").ExcalidrawEllipseElement | import("../element/types").ExcalidrawImageElement | import("../element/types").ExcalidrawTextElement | import("../element/types").ExcalidrawFreeDrawElement)[];
+        elements: import("../element/types").ExcalidrawElement[];
         appState: Readonly<import("../types").AppState>;
         commitToHistory: true;
     };
     contextItemLabel: string;
     keyPriority: number;
     keyTest: (event: KeyboardEvent | React.KeyboardEvent<Element>) => boolean;
-    PanelComponent: ({ updateData, appState }: import("./types").PanelComponentProps & {
-        isInHamburgerMenu: boolean;
-    }) => JSX.Element;
+    PanelComponent: ({ updateData, appState }: import("./types").PanelComponentProps) => JSX.Element;
 } & {
     keyTest?: ((event: KeyboardEvent | React.KeyboardEvent<Element>) => boolean) | undefined;
 };
@@ -24,16 +22,14 @@ export declare const actionBringForward: {
         category: "element";
     };
     perform: (elements: readonly import("../element/types").ExcalidrawElement[], appState: Readonly<import("../types").AppState>) => {
-        elements: (import("../element/types").ExcalidrawLinearElement | import("../element/types").ExcalidrawSelectionElement | import("../element/types").ExcalidrawRectangleElement | import("../element/types").ExcalidrawDiamondElement | import("../element/types").ExcalidrawEllipseElement | import("../element/types").ExcalidrawImageElement | import("../element/types").ExcalidrawTextElement | import("../element/types").ExcalidrawFreeDrawElement)[];
+        elements: import("../element/types").ExcalidrawElement[];
         appState: Readonly<import("../types").AppState>;
         commitToHistory: true;
     };
     contextItemLabel: string;
     keyPriority: number;
     keyTest: (event: KeyboardEvent | React.KeyboardEvent<Element>) => boolean;
-    PanelComponent: ({ updateData, appState }: import("./types").PanelComponentProps & {
-        isInHamburgerMenu: boolean;
-    }) => JSX.Element;
+    PanelComponent: ({ updateData, appState }: import("./types").PanelComponentProps) => JSX.Element;
 } & {
     keyTest?: ((event: KeyboardEvent | React.KeyboardEvent<Element>) => boolean) | undefined;
 };
@@ -43,15 +39,13 @@ export declare const actionSendToBack: {
         category: "element";
     };
     perform: (elements: readonly import("../element/types").ExcalidrawElement[], appState: Readonly<import("../types").AppState>) => {
-        elements: readonly import("../element/types").ExcalidrawElement[];
+        elements: import("../element/types").ExcalidrawElement[];
         appState: Readonly<import("../types").AppState>;
         commitToHistory: true;
     };
     contextItemLabel: string;
     keyTest: (event: KeyboardEvent | React.KeyboardEvent<Element>) => boolean;
-    PanelComponent: ({ updateData, appState }: import("./types").PanelComponentProps & {
-        isInHamburgerMenu: boolean;
-    }) => JSX.Element;
+    PanelComponent: ({ updateData, appState }: import("./types").PanelComponentProps) => JSX.Element;
 } & {
     keyTest?: ((event: KeyboardEvent | React.KeyboardEvent<Element>) => boolean) | undefined;
 };
@@ -61,15 +55,13 @@ export declare const actionBringToFront: {
         category: "element";
     };
     perform: (elements: readonly import("../element/types").ExcalidrawElement[], appState: Readonly<import("../types").AppState>) => {
-        elements: readonly import("../element/types").ExcalidrawElement[];
+        elements: import("../element/types").ExcalidrawElement[];
         appState: Readonly<import("../types").AppState>;
         commitToHistory: true;
     };
     contextItemLabel: string;
     keyTest: (event: KeyboardEvent | React.KeyboardEvent<Element>) => boolean;
-    PanelComponent: ({ updateData, appState }: import("./types").PanelComponentProps & {
-        isInHamburgerMenu: boolean;
-    }) => JSX.Element;
+    PanelComponent: ({ updateData, appState }: import("./types").PanelComponentProps) => JSX.Element;
 } & {
     keyTest?: ((event: KeyboardEvent | React.KeyboardEvent<Element>) => boolean) | undefined;
 };

package/types/actions/index.d.ts

@@ -17,8 +17,9 @@ export { actionFlipHorizontal, actionFlipVertical } from "./actionFlip";
 export { actionCopy, actionCut, actionCopyAsPng, actionCopyAsSvg, copyText, } from "./actionClipboard";
 export { actionToggleGridMode } from "./actionToggleGridMode";
 export { actionToggleZenMode } from "./actionToggleZenMode";
+export { actionToggleObjectsSnapMode } from "./actionToggleObjectsSnapMode";
 export { actionToggleStats } from "./actionToggleStats";
 export { actionUnbindText, actionBindText } from "./actionBoundText";
 export { actionLink } from "../element/Hyperlink";
-export { actionToggleLock } from "./actionToggleLock";
+export { actionToggleElementLock } from "./actionElementLock";
 export { actionToggleLinearEditor } from "./actionLinearEditor";

package/types/actions/manager.d.ts

@@ -12,9 +12,10 @@ export declare class ActionManager {
     registerAction(action: Action): void;
     registerAll(actions: readonly Action[]): void;
     handleKeyDown(event: React.KeyboardEvent | KeyboardEvent): boolean;
-    executeAction(action: Action, source?: ActionSource): void;
+    executeAction(action: Action, source?: ActionSource, value?: any): void;
     /**
      * @param data additional data sent to the PanelComponent
      */
-    renderAction: (name: ActionName, data?: PanelComponentProps["data"], isInHamburgerMenu?: boolean) => JSX.Element | null;
+    renderAction: (name: ActionName, data?: PanelComponentProps["data"]) => JSX.Element | null;
+    isActionEnabled: (action: Action) => boolean;
 }

package/types/actions/shortcuts.d.ts

@@ -1,3 +1,4 @@
+import { SubtypeOf } from "../utility-types";
 import { ActionName } from "./types";
-export declare type ShortcutName = SubtypeOf<ActionName, "toggleTheme" | "loadScene" | "cut" | "copy" | "paste" | "copyStyles" | "pasteStyles" | "selectAll" | "deleteSelectedElements" | "duplicateSelection" | "sendBackward" | "bringForward" | "sendToBack" | "bringToFront" | "copyAsPng" | "copyAsSvg" | "group" | "ungroup" | "gridMode" | "zenMode" | "stats" | "addToLibrary" | "viewMode" | "flipHorizontal" | "flipVertical" | "hyperlink" | "toggleLock"> | "saveScene" | "imageExport";
+export type ShortcutName = SubtypeOf<ActionName, "toggleTheme" | "loadScene" | "clearCanvas" | "cut" | "copy" | "paste" | "copyStyles" | "pasteStyles" | "selectAll" | "deleteSelectedElements" | "duplicateSelection" | "sendBackward" | "bringForward" | "sendToBack" | "bringToFront" | "copyAsPng" | "copyAsSvg" | "group" | "ungroup" | "gridMode" | "zenMode" | "objectsSnapMode" | "stats" | "addToLibrary" | "viewMode" | "flipHorizontal" | "flipVertical" | "hyperlink" | "toggleElementLock"> | "saveScene" | "imageExport";
 export declare const getShortcutFromShortcutName: (name: ShortcutName) => string;

package/types/actions/types.d.ts

@@ -1,9 +1,10 @@
 import React from "react";
 import { ExcalidrawElement } from "../element/types";
 import { AppClassProperties, AppState, ExcalidrawProps, BinaryFiles } from "../types";
-export declare type ActionSource = "ui" | "keyboard" | "contextMenu" | "api";
+import { MarkOptional } from "../utility-types";
+export type ActionSource = "ui" | "keyboard" | "contextMenu" | "api";
 /** if false, the action should be prevented */
-export declare type ActionResult = {
+export type ActionResult = {
     elements?: readonly ExcalidrawElement[] | null;
     appState?: MarkOptional<AppState, "offsetTop" | "offsetLeft" | "width" | "height"> | null;
     files?: BinaryFiles | null;
@@ -11,32 +12,34 @@ export declare type ActionResult = {
     syncHistory?: boolean;
     replaceFiles?: boolean;
 } | false;
-declare type ActionFn = (elements: readonly ExcalidrawElement[], appState: Readonly<AppState>, formData: any, app: AppClassProperties) => ActionResult | Promise<ActionResult>;
-export declare type UpdaterFn = (res: ActionResult) => void;
-export declare type ActionFilterFn = (action: Action) => void;
-export declare type ActionName = "copy" | "cut" | "paste" | "copyAsPng" | "copyAsSvg" | "copyText" | "sendBackward" | "bringForward" | "sendToBack" | "bringToFront" | "copyStyles" | "selectAll" | "pasteStyles" | "gridMode" | "zenMode" | "stats" | "changeStrokeColor" | "changeBackgroundColor" | "changeFillStyle" | "changeStrokeWidth" | "changeStrokeShape" | "changeSloppiness" | "changeStrokeStyle" | "changeArrowhead" | "changeOpacity" | "changeFontSize" | "toggleCanvasMenu" | "toggleEditMenu" | "undo" | "redo" | "finalize" | "changeProjectName" | "changeExportBackground" | "changeExportEmbedScene" | "changeExportScale" | "saveToActiveFile" | "saveFileToDisk" | "loadScene" | "duplicateSelection" | "deleteSelectedElements" | "changeViewBackgroundColor" | "clearCanvas" | "zoomIn" | "zoomOut" | "resetZoom" | "zoomToFit" | "zoomToSelection" | "changeFontFamily" | "changeTextAlign" | "changeVerticalAlign" | "toggleFullScreen" | "toggleShortcuts" | "group" | "ungroup" | "goToCollaborator" | "addToLibrary" | "changeSharpness" | "alignTop" | "alignBottom" | "alignLeft" | "alignRight" | "alignVerticallyCentered" | "alignHorizontallyCentered" | "distributeHorizontally" | "distributeVertically" | "flipHorizontal" | "flipVertical" | "viewMode" | "exportWithDarkMode" | "toggleTheme" | "increaseFontSize" | "decreaseFontSize" | "unbindText" | "hyperlink" | "eraser" | "bindText" | "toggleLock" | "toggleLinearEditor";
-export declare type PanelComponentProps = {
+type ActionFn = (elements: readonly ExcalidrawElement[], appState: Readonly<AppState>, formData: any, app: AppClassProperties) => ActionResult | Promise<ActionResult>;
+export type UpdaterFn = (res: ActionResult) => void;
+export type ActionFilterFn = (action: Action) => void;
+export type ActionName = "copy" | "cut" | "paste" | "copyAsPng" | "copyAsSvg" | "copyText" | "sendBackward" | "bringForward" | "sendToBack" | "bringToFront" | "copyStyles" | "selectAll" | "pasteStyles" | "gridMode" | "zenMode" | "objectsSnapMode" | "stats" | "changeStrokeColor" | "changeBackgroundColor" | "changeFillStyle" | "changeStrokeWidth" | "changeStrokeShape" | "changeSloppiness" | "changeStrokeStyle" | "changeArrowhead" | "changeOpacity" | "changeFontSize" | "toggleCanvasMenu" | "toggleEditMenu" | "undo" | "redo" | "finalize" | "changeProjectName" | "changeExportBackground" | "changeExportEmbedScene" | "changeExportScale" | "saveToActiveFile" | "saveFileToDisk" | "loadScene" | "duplicateSelection" | "deleteSelectedElements" | "changeViewBackgroundColor" | "clearCanvas" | "zoomIn" | "zoomOut" | "resetZoom" | "zoomToFit" | "zoomToFitSelection" | "zoomToFitSelectionInViewport" | "changeFontFamily" | "changeTextAlign" | "changeVerticalAlign" | "toggleFullScreen" | "toggleShortcuts" | "group" | "ungroup" | "goToCollaborator" | "addToLibrary" | "changeRoundness" | "alignTop" | "alignBottom" | "alignLeft" | "alignRight" | "alignVerticallyCentered" | "alignHorizontallyCentered" | "distributeHorizontally" | "distributeVertically" | "flipHorizontal" | "flipVertical" | "viewMode" | "exportWithDarkMode" | "toggleTheme" | "increaseFontSize" | "decreaseFontSize" | "unbindText" | "hyperlink" | "bindText" | "unlockAllElements" | "toggleElementLock" | "toggleLinearEditor" | "toggleEraserTool" | "toggleHandTool" | "selectAllElementsInFrame" | "removeAllElementsFromFrame" | "updateFrameRendering" | "setFrameAsActiveTool" | "setEmbeddableAsActiveTool" | "createContainerFromText" | "wrapTextInContainer";
+export type PanelComponentProps = {
     elements: readonly ExcalidrawElement[];
     appState: AppState;
     updateData: (formData?: any) => void;
     appProps: ExcalidrawProps;
     data?: Record<string, any>;
+    app: AppClassProperties;
 };
 export interface Action {
     name: ActionName;
-    PanelComponent?: React.FC<PanelComponentProps & {
-        isInHamburgerMenu: boolean;
-    }>;
+    PanelComponent?: React.FC<PanelComponentProps>;
     perform: ActionFn;
     keyPriority?: number;
-    keyTest?: (event: React.KeyboardEvent | KeyboardEvent, appState: AppState, elements: readonly ExcalidrawElement[]) => boolean;
-    contextItemLabel?: string | ((elements: readonly ExcalidrawElement[], appState: Readonly<AppState>) => string);
-    contextItemPredicate?: (elements: readonly ExcalidrawElement[], appState: AppState) => boolean;
+    keyTest?: (event: React.KeyboardEvent | KeyboardEvent, appState: AppState, elements: readonly ExcalidrawElement[], app: AppClassProperties) => boolean;
+    contextItemLabel?: string | ((elements: readonly ExcalidrawElement[], appState: Readonly<AppState>, app: AppClassProperties) => string);
+    predicate?: (elements: readonly ExcalidrawElement[], appState: AppState, appProps: ExcalidrawProps, app: AppClassProperties) => boolean;
     checked?: (appState: Readonly<AppState>) => boolean;
     trackEvent: false | {
         category: "toolbar" | "element" | "canvas" | "export" | "history" | "menu" | "collab" | "hyperlink";
         action?: string;
         predicate?: (appState: Readonly<AppState>, elements: readonly ExcalidrawElement[], value: any) => boolean;
     };
+    /** if set to `true`, allow action to be performed in viewMode.
+     *  Defaults to `false` */
+    viewMode?: boolean;
 }
 export {};