@excalidraw/excalidraw 0.17.1-7441-cc6868c → 0.17.1-7441-0269e5a

package/types/excalidraw/actions/actionCanvas.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="react" />
 import { ExcalidrawElement } from "../element/types";
 import { AppState, NormalizedZoomValue } from "../types";
+import { SceneBounds } from "../element/bounds";
 export declare const actionChangeViewBackgroundColor: {
     name: "changeViewBackgroundColor";
     trackEvent: false;
@@ -135,7 +136,23 @@ export declare const actionClearCanvas: {
             };
             editingGroupId: string | null;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
-            collaborators: Map<string, import("../types").Collaborator>;
+            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("../types").UserIdleState | undefined;
+                color?: {
+                    background: string;
+                    stroke: string;
+                } | undefined;
+                avatarUrl?: string | undefined;
+                id?: string | undefined;
+                socketId?: import("../types").SocketId | undefined;
+                isCurrentUser?: boolean | undefined;
+            }>>;
             currentChartType: import("../element/types").ChartType;
             pendingImageElementId: string | null;
             showHyperlinkPopup: false | "editor" | "info";
@@ -146,6 +163,8 @@ export declare const actionClearCanvas: {
                 y: number;
             } | null;
             objectsSnapModeEnabled: boolean;
+            userToFollow: import("../types").UserToFollow | null;
+            followedBy: Set<import("../types").SocketId>;
         };
         commitToHistory: true;
     };
@@ -160,6 +179,7 @@ export declare const actionZoomIn: {
     };
     perform: (_elements: readonly ExcalidrawElement[], appState: Readonly<AppState>, _: any, app: import("../types").AppClassProperties) => {
         appState: {
+            userToFollow: null;
             scrollX: number;
             scrollY: number;
             zoom: {
@@ -268,7 +288,23 @@ export declare const actionZoomIn: {
             offsetTop: number;
             offsetLeft: number;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
-            collaborators: Map<string, import("../types").Collaborator>;
+            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("../types").UserIdleState | undefined;
+                color?: {
+                    background: string;
+                    stroke: string;
+                } | undefined;
+                avatarUrl?: string | undefined;
+                id?: string | undefined;
+                socketId?: import("../types").SocketId | undefined;
+                isCurrentUser?: boolean | undefined;
+            }>>;
             showStats: boolean;
             currentChartType: import("../element/types").ChartType;
             pasteDialog: {
@@ -287,6 +323,7 @@ export declare const actionZoomIn: {
                 y: number;
             } | null;
             objectsSnapModeEnabled: boolean;
+            followedBy: Set<import("../types").SocketId>;
         };
         commitToHistory: false;
     };
@@ -303,6 +340,7 @@ export declare const actionZoomOut: {
     };
     perform: (_elements: readonly ExcalidrawElement[], appState: Readonly<AppState>, _: any, app: import("../types").AppClassProperties) => {
         appState: {
+            userToFollow: null;
             scrollX: number;
             scrollY: number;
             zoom: {
@@ -411,7 +449,23 @@ export declare const actionZoomOut: {
             offsetTop: number;
             offsetLeft: number;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
-            collaborators: Map<string, import("../types").Collaborator>;
+            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("../types").UserIdleState | undefined;
+                color?: {
+                    background: string;
+                    stroke: string;
+                } | undefined;
+                avatarUrl?: string | undefined;
+                id?: string | undefined;
+                socketId?: import("../types").SocketId | undefined;
+                isCurrentUser?: boolean | undefined;
+            }>>;
             showStats: boolean;
             currentChartType: import("../element/types").ChartType;
             pasteDialog: {
@@ -430,6 +484,7 @@ export declare const actionZoomOut: {
                 y: number;
             } | null;
             objectsSnapModeEnabled: boolean;
+            followedBy: Set<import("../types").SocketId>;
         };
         commitToHistory: false;
     };
@@ -446,6 +501,7 @@ export declare const actionResetZoom: {
     };
     perform: (_elements: readonly ExcalidrawElement[], appState: Readonly<AppState>, _: any, app: import("../types").AppClassProperties) => {
         appState: {
+            userToFollow: null;
             scrollX: number;
             scrollY: number;
             zoom: {
@@ -554,7 +610,23 @@ export declare const actionResetZoom: {
             offsetTop: number;
             offsetLeft: number;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
-            collaborators: Map<string, import("../types").Collaborator>;
+            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("../types").UserIdleState | undefined;
+                color?: {
+                    background: string;
+                    stroke: string;
+                } | undefined;
+                avatarUrl?: string | undefined;
+                id?: string | undefined;
+                socketId?: import("../types").SocketId | undefined;
+                isCurrentUser?: boolean | undefined;
+            }>>;
             showStats: boolean;
             currentChartType: import("../element/types").ChartType;
             pasteDialog: {
@@ -573,6 +645,7 @@ export declare const actionResetZoom: {
                 y: number;
             } | null;
             objectsSnapModeEnabled: boolean;
+            followedBy: Set<import("../types").SocketId>;
         };
         commitToHistory: false;
     };
@@ -581,6 +654,163 @@ export declare const actionResetZoom: {
 } & {
     keyTest?: ((event: import("react").KeyboardEvent<Element> | KeyboardEvent) => boolean) | undefined;
 };
+export declare const zoomToFitBounds: ({ bounds, appState, fitToViewport, viewportZoomFactor, }: {
+    bounds: SceneBounds;
+    appState: Readonly<AppState>;
+    /** whether to fit content to viewport (beyond >100%) */
+    fitToViewport: boolean;
+    /** zoom content to cover X of the viewport, when fitToViewport=true */
+    viewportZoomFactor?: number | undefined;
+}) => {
+    appState: {
+        scrollX: number;
+        scrollY: number;
+        zoom: {
+            value: NormalizedZoomValue;
+        };
+        contextMenu: {
+            items: import("../components/ContextMenu").ContextMenuItems;
+            top: number;
+            left: number;
+        } | null;
+        showWelcomeScreen: boolean;
+        isLoading: boolean;
+        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;
+        selectionElement: import("../element/types").NonDeletedExcalidrawElement | null;
+        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").ExcalidrawFrameLikeElement> | null;
+        frameRendering: {
+            enabled: boolean;
+            name: boolean;
+            outline: boolean;
+            clip: boolean;
+        };
+        editingFrame: string | null;
+        elementsToHighlight: import("../element/types").NonDeleted<ExcalidrawElement>[] | null;
+        editingElement: import("../element/types").NonDeletedExcalidrawElement | null;
+        editingLinearElement: import("../element/linearElementEditor").LinearElementEditor | null;
+        activeTool: {
+            lastActiveTool: import("../types").ActiveTool | null;
+            locked: boolean;
+        } & import("../types").ActiveTool;
+        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: string;
+        currentItemStartArrowhead: import("../element/types").Arrowhead | null;
+        currentItemEndArrowhead: import("../element/types").Arrowhead | null;
+        currentItemRoundness: import("../element/types").StrokeRoundness;
+        viewBackgroundColor: string;
+        cursorButton: "up" | "down";
+        scrolledOutside: boolean;
+        name: string;
+        isResizing: boolean;
+        isRotating: boolean;
+        openMenu: "canvas" | "shape" | null;
+        openPopup: "canvasBackground" | "elementBackground" | "elementStroke" | null;
+        openSidebar: {
+            name: string;
+            tab?: string | undefined;
+        } | null;
+        openDialog: {
+            name: "imageExport" | "help" | "jsonExport";
+        } | {
+            name: "settings";
+            source: "settings" | "tool" | "generation";
+            tab: "text-to-diagram" | "diagram-to-code";
+        } | {
+            name: "ttd";
+            tab: "mermaid" | "text-to-diagram";
+        } | null;
+        defaultSidebarDockedPreference: boolean;
+        lastPointerDownWith: import("../element/types").PointerType;
+        selectedElementIds: Readonly<{
+            [id: string]: true;
+        }>;
+        previousSelectedElementIds: {
+            [id: string]: true;
+        };
+        selectedElementsAreBeingDragged: boolean;
+        shouldCacheIgnoreZoom: boolean;
+        toast: {
+            message: string;
+            closable?: boolean | undefined;
+            duration?: number | undefined;
+        } | null;
+        zenModeEnabled: boolean;
+        theme: import("../element/types").Theme;
+        gridSize: number | null;
+        viewModeEnabled: boolean;
+        selectedGroupIds: {
+            [groupId: string]: boolean;
+        };
+        editingGroupId: string | null;
+        width: number;
+        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("../types").UserIdleState | undefined;
+            color?: {
+                background: string;
+                stroke: string;
+            } | undefined;
+            avatarUrl?: string | undefined;
+            id?: string | undefined;
+            socketId?: import("../types").SocketId | undefined;
+            isCurrentUser?: boolean | undefined;
+        }>>;
+        showStats: boolean;
+        currentChartType: import("../element/types").ChartType;
+        pasteDialog: {
+            shown: false;
+            data: null;
+        } | {
+            shown: true;
+            data: import("../charts").Spreadsheet;
+        };
+        pendingImageElementId: string | null;
+        showHyperlinkPopup: false | "editor" | "info";
+        selectedLinearElement: import("../element/linearElementEditor").LinearElementEditor | null;
+        snapLines: readonly import("../snapping").SnapLine[];
+        originSnapOffset: {
+            x: number;
+            y: number;
+        } | null;
+        objectsSnapModeEnabled: boolean;
+        userToFollow: import("../types").UserToFollow | null;
+        followedBy: Set<import("../types").SocketId>;
+    };
+    commitToHistory: boolean;
+};
 export declare const zoomToFit: ({ targetElements, appState, fitToViewport, viewportZoomFactor, }: {
     targetElements: readonly ExcalidrawElement[];
     appState: Readonly<AppState>;
@@ -698,7 +928,23 @@ export declare const zoomToFit: ({ targetElements, appState, fitToViewport, view
         offsetTop: number;
         offsetLeft: number;
         fileHandle: import("browser-fs-access").FileSystemHandle | null;
-        collaborators: Map<string, import("../types").Collaborator>;
+        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("../types").UserIdleState | undefined;
+            color?: {
+                background: string;
+                stroke: string;
+            } | undefined;
+            avatarUrl?: string | undefined;
+            id?: string | undefined;
+            socketId?: import("../types").SocketId | undefined;
+            isCurrentUser?: boolean | undefined;
+        }>>;
         showStats: boolean;
         currentChartType: import("../element/types").ChartType;
         pasteDialog: {
@@ -717,6 +963,8 @@ export declare const zoomToFit: ({ targetElements, appState, fitToViewport, view
             y: number;
         } | null;
         objectsSnapModeEnabled: boolean;
+        userToFollow: import("../types").UserToFollow | null;
+        followedBy: Set<import("../types").SocketId>;
     };
     commitToHistory: boolean;
 };
@@ -835,7 +1083,23 @@ export declare const actionZoomToFitSelectionInViewport: {
             offsetTop: number;
             offsetLeft: number;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
-            collaborators: Map<string, import("../types").Collaborator>;
+            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("../types").UserIdleState | undefined;
+                color?: {
+                    background: string;
+                    stroke: string;
+                } | undefined;
+                avatarUrl?: string | undefined;
+                id?: string | undefined;
+                socketId?: import("../types").SocketId | undefined;
+                isCurrentUser?: boolean | undefined;
+            }>>;
             showStats: boolean;
             currentChartType: import("../element/types").ChartType;
             pasteDialog: {
@@ -854,6 +1118,8 @@ export declare const actionZoomToFitSelectionInViewport: {
                 y: number;
             } | null;
             objectsSnapModeEnabled: boolean;
+            userToFollow: import("../types").UserToFollow | null;
+            followedBy: Set<import("../types").SocketId>;
         };
         commitToHistory: boolean;
     };
@@ -976,7 +1242,23 @@ export declare const actionZoomToFitSelection: {
             offsetTop: number;
             offsetLeft: number;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
-            collaborators: Map<string, import("../types").Collaborator>;
+            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("../types").UserIdleState | undefined;
+                color?: {
+                    background: string;
+                    stroke: string;
+                } | undefined;
+                avatarUrl?: string | undefined;
+                id?: string | undefined;
+                socketId?: import("../types").SocketId | undefined;
+                isCurrentUser?: boolean | undefined;
+            }>>;
             showStats: boolean;
             currentChartType: import("../element/types").ChartType;
             pasteDialog: {
@@ -995,6 +1277,8 @@ export declare const actionZoomToFitSelection: {
                 y: number;
             } | null;
             objectsSnapModeEnabled: boolean;
+            userToFollow: import("../types").UserToFollow | null;
+            followedBy: Set<import("../types").SocketId>;
         };
         commitToHistory: boolean;
     };
@@ -1118,7 +1402,23 @@ export declare const actionZoomToFit: {
             offsetTop: number;
             offsetLeft: number;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
-            collaborators: Map<string, import("../types").Collaborator>;
+            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("../types").UserIdleState | undefined;
+                color?: {
+                    background: string;
+                    stroke: string;
+                } | undefined;
+                avatarUrl?: string | undefined;
+                id?: string | undefined;
+                socketId?: import("../types").SocketId | undefined;
+                isCurrentUser?: boolean | undefined;
+            }>>;
             showStats: boolean;
             currentChartType: import("../element/types").ChartType;
             pasteDialog: {
@@ -1137,6 +1437,8 @@ export declare const actionZoomToFit: {
                 y: number;
             } | null;
             objectsSnapModeEnabled: boolean;
+            userToFollow: import("../types").UserToFollow | null;
+            followedBy: Set<import("../types").SocketId>;
         };
         commitToHistory: boolean;
     };
@@ -1260,7 +1562,23 @@ export declare const actionToggleTheme: {
             offsetTop: number;
             offsetLeft: number;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
-            collaborators: Map<string, import("../types").Collaborator>;
+            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("../types").UserIdleState | undefined;
+                color?: {
+                    background: string;
+                    stroke: string;
+                } | undefined;
+                avatarUrl?: string | undefined;
+                id?: string | undefined;
+                socketId?: import("../types").SocketId | undefined;
+                isCurrentUser?: boolean | undefined;
+            }>>;
             showStats: boolean;
             currentChartType: import("../element/types").ChartType;
             pasteDialog: {
@@ -1279,6 +1597,8 @@ export declare const actionToggleTheme: {
                 y: number;
             } | null;
             objectsSnapModeEnabled: boolean;
+            userToFollow: import("../types").UserToFollow | null;
+            followedBy: Set<import("../types").SocketId>;
         };
         commitToHistory: false;
     };
@@ -1395,7 +1715,23 @@ export declare const actionToggleEraserTool: {
             offsetTop: number;
             offsetLeft: number;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
-            collaborators: Map<string, import("../types").Collaborator>;
+            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("../types").UserIdleState | undefined;
+                color?: {
+                    background: string;
+                    stroke: string;
+                } | undefined;
+                avatarUrl?: string | undefined;
+                id?: string | undefined;
+                socketId?: import("../types").SocketId | undefined;
+                isCurrentUser?: boolean | undefined;
+            }>>;
             showStats: boolean;
             currentChartType: import("../element/types").ChartType;
             pasteDialog: {
@@ -1414,6 +1750,8 @@ export declare const actionToggleEraserTool: {
                 y: number;
             } | null;
             objectsSnapModeEnabled: boolean;
+            userToFollow: import("../types").UserToFollow | null;
+            followedBy: Set<import("../types").SocketId>;
         };
         commitToHistory: true;
     };
@@ -1529,7 +1867,23 @@ export declare const actionToggleHandTool: {
             offsetTop: number;
             offsetLeft: number;
             fileHandle: import("browser-fs-access").FileSystemHandle | null;
-            collaborators: Map<string, import("../types").Collaborator>;
+            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("../types").UserIdleState | undefined;
+                color?: {
+                    background: string;
+                    stroke: string;
+                } | undefined;
+                avatarUrl?: string | undefined;
+                id?: string | undefined;
+                socketId?: import("../types").SocketId | undefined;
+                isCurrentUser?: boolean | undefined;
+            }>>;
             showStats: boolean;
             currentChartType: import("../element/types").ChartType;
             pasteDialog: {
@@ -1548,6 +1902,8 @@ export declare const actionToggleHandTool: {
                 y: number;
             } | null;
             objectsSnapModeEnabled: boolean;
+            userToFollow: import("../types").UserToFollow | null;
+            followedBy: Set<import("../types").SocketId>;
         };
         commitToHistory: true;
     };