@excalidraw/math 0.18.0-4e758db → 0.18.0-4f68076

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

@@ -0,0 +1,197 @@
+export declare const actionToggleShowHints: {
+    name: "showHints";
+    label: string;
+    icon: import("react/jsx-runtime").JSX.Element;
+    keywords: string[];
+    viewMode: false;
+    trackEvent: {
+        category: "canvas";
+        predicate: (appState: Readonly<import("../types").AppState>) => boolean;
+    };
+    perform(elements: readonly import("@excalidraw/element/types").OrderedExcalidrawElement[], appState: Readonly<import("../types").AppState>): {
+        appState: {
+            showHints: boolean;
+            contextMenu: {
+                items: import("../components/ContextMenu").ContextMenuItems;
+                top: number;
+                left: number;
+            } | null;
+            showWelcomeScreen: boolean;
+            isLoading: boolean;
+            errorMessage: React.ReactNode;
+            activeEmbeddable: {
+                element: import("@excalidraw/element/types").NonDeletedExcalidrawElement;
+                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;
+            boxSelectionMode: import("../types").BoxSelectionMode;
+            bindingPreference: "enabled" | "disabled";
+            isMidpointSnappingEnabled: 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: import("@excalidraw/element/types").ExcalidrawElement["id"];
+            } | {
+                type: "container";
+                elementId: import("@excalidraw/element/types").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;
+                name: boolean;
+                outline: boolean;
+                clip: boolean;
+            };
+            editingFrame: import("@excalidraw/element/types").ExcalidrawFrameLikeElement["id"] | null;
+            elementsToHighlight: readonly import("@excalidraw/element/types").NonDeletedExcalidrawElement[] | null;
+            editingTextElement: import("@excalidraw/element/types").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;
+            exportEmbedScene: boolean;
+            exportWithDarkMode: boolean;
+            exportScale: number;
+            currentItemStrokeColor: string;
+            currentItemStickynoteStrokeColor: string;
+            currentItemStickynoteBackgroundColor: string;
+            currentItemBackgroundColor: string;
+            currentItemFillStyle: import("@excalidraw/element/types").ExcalidrawElement["fillStyle"];
+            currentItemStrokeWidthKey: import("@excalidraw/common").StrokeWidthKey;
+            currentItemStrokeStyle: import("@excalidraw/element/types").ExcalidrawElement["strokeStyle"];
+            currentItemRoughness: number;
+            currentItemStrokeVariability: import("@excalidraw/element/types").StrokeVariability;
+            currentItemOpacity: number;
+            currentItemFontFamily: import("@excalidraw/element/types").FontFamilyValues;
+            currentItemFontSize: number;
+            currentItemTextAlign: import("@excalidraw/element/types").TextAlign;
+            currentItemStartArrowhead: import("@excalidraw/element/types").Arrowhead | null;
+            currentItemEndArrowhead: import("@excalidraw/element/types").Arrowhead | null;
+            currentHoveredFontFamily: import("@excalidraw/element/types").FontFamilyValues | null;
+            currentItemRoundness: import("@excalidraw/element/types").StrokeRoundness;
+            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: import("../types").Zoom;
+            openMenu: "canvas" | null;
+            openPopup: "canvasBackground" | "elementBackground" | "elementStroke" | "fontFamily" | "compactTextProperties" | "compactStrokeStyles" | "compactOtherProperties" | "compactArrowProperties" | null;
+            openSidebar: {
+                name: import("../types").SidebarName;
+                tab?: import("../types").SidebarTabName;
+            } | null;
+            openDialog: null | {
+                name: "imageExport" | "help" | "jsonExport";
+            } | {
+                name: "ttd";
+                tab: "text-to-diagram" | "mermaid";
+            } | {
+                name: "commandPalette";
+            } | {
+                name: "settings";
+            } | {
+                name: "elementLinkSelector";
+                sourceElementId: import("@excalidraw/element/types").ExcalidrawElement["id"];
+            } | {
+                name: "charts";
+                data: import("../charts").Spreadsheet;
+                rawText: string;
+            };
+            defaultSidebarDockedPreference: boolean;
+            lastPointerDownWith: import("@excalidraw/element/types").PointerType;
+            selectedElementIds: Readonly<{
+                [id: string]: true;
+            }>;
+            hoveredElementIds: Readonly<{
+                [id: string]: true;
+            }>;
+            previousSelectedElementIds: {
+                [id: string]: true;
+            };
+            selectedElementsAreBeingDragged: boolean;
+            shouldCacheIgnoreZoom: boolean;
+            toast: {
+                message: React.ReactNode;
+                closable?: boolean;
+                duration?: number;
+            } | null;
+            zenModeEnabled: boolean;
+            theme: import("@excalidraw/element/types").Theme;
+            gridSize: number;
+            gridStep: number;
+            gridModeEnabled: boolean;
+            viewModeEnabled: boolean;
+            selectedGroupIds: {
+                [groupId: string]: boolean;
+            };
+            editingGroupId: import("@excalidraw/element/types").GroupId | null;
+            width: number;
+            height: number;
+            offsetTop: number;
+            offsetLeft: number;
+            fileHandle: FileSystemFileHandle | null;
+            collaborators: Map<import("../types").SocketId, import("../types").Collaborator>;
+            stats: {
+                open: boolean;
+                panels: number;
+            };
+            showHyperlinkPopup: false | "info" | "editor";
+            selectedLinearElement: import("@excalidraw/element").LinearElementEditor | null;
+            snapLines: readonly import("../snapping").SnapLine[];
+            originSnapOffset: {
+                x: number;
+                y: number;
+            } | null;
+            objectsSnapModeEnabled: boolean;
+            isCropping: boolean;
+            croppingElementId: import("@excalidraw/element/types").ExcalidrawElement["id"] | null;
+            searchMatches: Readonly<{
+                focusedId: import("@excalidraw/element/types").ExcalidrawElement["id"] | null;
+                matches: readonly import("../types").SearchMatch[];
+            }> | null;
+            activeLockedId: string | null;
+            lockedMultiSelections: {
+                [groupId: string]: true;
+            };
+            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;
+        };
+        captureUpdate: "NEVER";
+    };
+    checked: (appState: Readonly<import("../types").UIAppState>) => boolean;
+} & {
+    keyTest?: undefined;
+};

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

@@ -33,12 +33,20 @@ export declare const actionToggleStats: {
             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;
-            hoveredArrowTextAnchor: {
+            textToolHover: {
+                type: "text";
+                elementId: import("@excalidraw/element/types").ExcalidrawElement["id"];
+            } | {
+                type: "container";
+                elementId: import("@excalidraw/element/types").ExcalidrawElement["id"];
+            } | {
+                type: "arrow";
                 elementId: import("@excalidraw/element/types").ExcalidrawArrowElement["id"];
                 anchor: "start" | "end" | "label";
             } | null;
@@ -178,6 +186,7 @@ export declare const actionToggleStats: {
                 stickyNoteStroke: readonly string[] | null;
                 stickyNoteBackground: readonly string[] | null;
             };
+            fontTopPicks: readonly import("@excalidraw/element/types").FontFamilyValues[] | null;
         };
         captureUpdate: "EVENTUALLY";
     };

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

@@ -30,12 +30,20 @@ export declare const actionToggleViewMode: {
             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;
-            hoveredArrowTextAnchor: {
+            textToolHover: {
+                type: "text";
+                elementId: import("@excalidraw/element/types").ExcalidrawElement["id"];
+            } | {
+                type: "container";
+                elementId: import("@excalidraw/element/types").ExcalidrawElement["id"];
+            } | {
+                type: "arrow";
                 elementId: import("@excalidraw/element/types").ExcalidrawArrowElement["id"];
                 anchor: "start" | "end" | "label";
             } | null;
@@ -178,6 +186,7 @@ export declare const actionToggleViewMode: {
                 stickyNoteStroke: readonly string[] | null;
                 stickyNoteBackground: readonly string[] | null;
             };
+            fontTopPicks: readonly import("@excalidraw/element/types").FontFamilyValues[] | null;
         };
         captureUpdate: "EVENTUALLY";
     };

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

@@ -30,12 +30,20 @@ export declare const actionToggleZenMode: {
             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;
-            hoveredArrowTextAnchor: {
+            textToolHover: {
+                type: "text";
+                elementId: import("@excalidraw/element/types").ExcalidrawElement["id"];
+            } | {
+                type: "container";
+                elementId: import("@excalidraw/element/types").ExcalidrawElement["id"];
+            } | {
+                type: "arrow";
                 elementId: import("@excalidraw/element/types").ExcalidrawArrowElement["id"];
                 anchor: "start" | "end" | "label";
             } | null;
@@ -178,6 +186,7 @@ export declare const actionToggleZenMode: {
                 stickyNoteStroke: readonly string[] | null;
                 stickyNoteBackground: readonly string[] | null;
             };
+            fontTopPicks: readonly import("@excalidraw/element/types").FontFamilyValues[] | null;
         };
         captureUpdate: "EVENTUALLY";
     };

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

@@ -21,6 +21,7 @@ export { actionToggleZenMode } from "./actionToggleZenMode";
 export { actionToggleObjectsSnapMode } from "./actionToggleObjectsSnapMode";
 export { actionToggleArrowBinding } from "./actionToggleArrowBinding";
 export { actionToggleMidpointSnapping } from "./actionToggleMidpointSnapping";
+export { actionToggleShowHints } from "./actionToggleShowHints";
 export { actionToggleStats } from "./actionToggleStats";
 export { actionUnbindText, actionBindText } from "./actionBoundText";
 export { actionLink } from "./actionLink";

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

@@ -14,7 +14,7 @@ export type ActionResult = {
 type ActionFn<TData = any> = (elements: readonly OrderedExcalidrawElement[], appState: Readonly<AppState>, formData: TData | undefined, 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" | "arrowBinding" | "midpointSnapping" | "stats" | "changeStrokeColor" | "changeBackgroundColor" | "changeBucketFillBackgroundColor" | "changeFillStyle" | "changeStrokeWidth" | "changeSloppiness" | "changeFreedrawMode" | "changeStrokeStyle" | "changeArrowhead" | "changeArrowType" | "changeArrowProperties" | "changeOpacity" | "changeFontSize" | "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" | "deselect" | "viewMode" | "exportWithDarkMode" | "toggleTheme" | "increaseFontSize" | "decreaseFontSize" | "unbindText" | "hyperlink" | "bindText" | "unlockAllElements" | "toggleElementLock" | "toggleLinearEditor" | "selectAllElementsInFrame" | "removeAllElementsFromFrame" | "updateFrameRendering" | "createContainerFromText" | "wrapTextInContainer" | "commandPalette" | "autoResize" | "elementStats" | "searchMenu" | "copyElementLink" | "linkToElement" | "cropEditor" | "wrapSelectionInFrame" | "toggleShapeSwitch" | "togglePolygon";
+export type ActionName = "copy" | "cut" | "paste" | "copyAsPng" | "copyAsSvg" | "copyText" | "sendBackward" | "bringForward" | "sendToBack" | "bringToFront" | "copyStyles" | "selectAll" | "pasteStyles" | "gridMode" | "zenMode" | "objectsSnapMode" | "arrowBinding" | "midpointSnapping" | "showHints" | "stats" | "changeStrokeColor" | "changeBackgroundColor" | "changeBucketFillBackgroundColor" | "changeFillStyle" | "changeStrokeWidth" | "changeSloppiness" | "changeFreedrawMode" | "changeStrokeStyle" | "changeArrowhead" | "changeArrowType" | "changeArrowProperties" | "changeOpacity" | "changeFontSize" | "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" | "deselect" | "viewMode" | "exportWithDarkMode" | "toggleTheme" | "increaseFontSize" | "decreaseFontSize" | "unbindText" | "hyperlink" | "bindText" | "unlockAllElements" | "toggleElementLock" | "toggleLinearEditor" | "selectAllElementsInFrame" | "removeAllElementsFromFrame" | "updateFrameRendering" | "createContainerFromText" | "wrapTextInContainer" | "commandPalette" | "autoResize" | "elementStats" | "searchMenu" | "copyElementLink" | "linkToElement" | "cropEditor" | "wrapSelectionInFrame" | "toggleShapeSwitch" | "togglePolygon";
 export type PanelComponentProps = {
     elements: readonly ExcalidrawElement[];
     appState: UIAppState;

package/dist/types/excalidraw/appState.d.ts

@@ -34,6 +34,7 @@ export declare const clearAppStateForLocalStorage: (appState: Partial<AppState>)
     showWelcomeScreen?: boolean | undefined;
     boxSelectionMode?: import("./types").BoxSelectionMode | undefined;
     bindingPreference?: "enabled" | "disabled" | undefined;
+    showHints?: boolean | undefined;
     inputDevice?: InputDevice | undefined;
     preferredSelectionTool?: {
         type: "selection" | "lasso";
@@ -88,6 +89,7 @@ export declare const clearAppStateForLocalStorage: (appState: Partial<AppState>)
         stickyNoteStroke: readonly string[] | null;
         stickyNoteBackground: readonly string[] | null;
     } | undefined;
+    fontTopPicks?: readonly number[] | null | undefined;
 };
 export declare const cleanAppStateForExport: (appState: Partial<AppState>) => {
     viewBackgroundColor?: string | undefined;

package/dist/types/excalidraw/components/App.arrowText.d.ts

@@ -2,19 +2,16 @@ import { LinearElementEditor } from "@excalidraw/element";
 import type { ArrowEndpoint } from "@excalidraw/element";
 import type { ExcalidrawElement, ExcalidrawTextElement, FixedPoint, NonDeleted, NonDeletedExcalidrawElement } from "@excalidraw/element/types";
 import type App from "./App";
-import type { AppState, PointerDownState } from "../types";
+import type { PointerDownState } from "../types";
 /**
  * Text ↔ arrow interactions.
  *
- * With the text tool: the hover affordance showing where a click would attach
- * text to an arrow — a free endpoint (binds the arrow to a new text element
- * positioned against that endpoint) or the arrow's midpoint (adds a label
- * bound to the arrow) — and the endpoint-bound flavor of drag-sizing a new
- * text.
+ * With the text tool: the free endpoint a click would bind a new text to
+ * (`AppTextTool` resolves and shows it), the binding itself, and the
+ * endpoint-bound flavor of drag-sizing a new text.
  *
  * With the selection tool: dragging an arrow's existing label along the arrow
- * — the grab affordance, the drag itself, and where a double-click starts
- * editing a label the drag has moved.
+ * — the grab affordance and the drag itself.
  *
  * The scene-level logic lives in `@excalidraw/element`'s
  * `arrowEndpointText.ts` and `linearElementEditor.ts`.
@@ -22,34 +19,12 @@ import type { AppState, PointerDownState } from "../types";
 export declare class AppArrowText {
     private app;
     constructor(app: App);
-    /**
-     * With the text tool active, an arrow under the cursor is a target for
-     * attaching text. Returns where the text would land (if anywhere), and keeps
-     * `appState.hoveredArrowTextAnchor` — which drives the highlight — in sync.
-     */
-    updateHoveredAnchor: (scenePointer: {
-        x: number;
-        y: number;
-    }) => AppState["hoveredArrowTextAnchor"];
-    /**
-     * Re-evaluates the hovered anchor at the last known pointer position — for
-     * events that change what a click would do without the pointer moving,
-     * i.e. the ctrl/cmd binding toggle. (Events that invalidate the anchor
-     * wholesale — tool switches, finalize, deselect — clear it directly
-     * instead.)
-     */
-    refresh: () => void;
     /**
      * A free arrow endpoint a new text could be bound to. Binding an endpoint is
      * an arrow binding, so it follows the binding toggle (ctrl/cmd) like every
      * other one — holding it makes the text tool drop plain text instead.
      */
     getBindableEndpointAtPosition(x: number, y: number): ArrowEndpoint | null;
-    /**
-     * Mirrors what `handleTextOnPointerDown` would do at this position, so the
-     * highlight can't promise something the click won't deliver.
-     */
-    private getAnchorAtPosition;
     /**
      * How a text should be created to read as a label for this endpoint — the
      * side midpoint to bind, the alignment that pins it, and the scene position
@@ -92,13 +67,4 @@ export declare class AppArrowText {
         x: number;
         y: number;
     }): boolean;
-    /**
-     * Where a double-click on a labeled arrow should start text editing: the
-     * center of the label itself, which a label drag may have moved away from
-     * the arrow's midpoint. Null when the element is not a labeled arrow.
-     */
-    getLabelCenter(element: ExcalidrawElement): {
-        x: number;
-        y: number;
-    } | null;
 }

package/dist/types/excalidraw/components/App.clipboard.d.ts

@@ -0,0 +1,31 @@
+import type React from "react";
+import type App from "./App";
+type AppClipboardDependencies = {
+    getContainer: () => HTMLDivElement | null;
+};
+/**
+ * The clipboard: cut and copy (through their actions), and paste — the
+ * pasted data parsed (`pasteFromClipboard`) and inserted as whatever it is
+ * (`insertClipboardContent`): images or SVG code, elements, a Mermaid
+ * definition, embeddable URLs, a spreadsheet (as a chart), mixed content,
+ * or text. Pasted elements go in through `app.addElementsFromPasteOrLibrary`,
+ * as a library item or a drop does.
+ */
+export declare class AppClipboard {
+    private app;
+    private dependencies;
+    constructor(app: App, dependencies: AppClipboardDependencies);
+    onCut: (event: ClipboardEvent) => void;
+    onCopy: (event: ClipboardEvent) => void;
+    private insertClipboardContent;
+    /**
+     * Ctrl/Cmd+V: whether the paste event that follows is a plain one (with
+     * Shift)
+     */
+    onPasteShortcut: (event: React.KeyboardEvent | KeyboardEvent) => void;
+    clearPlainPaste: () => void;
+    pasteFromClipboard: (event: ClipboardEvent) => Promise<void>;
+    private addElementsFromMixedContentPaste;
+    private addTextFromPaste;
+}
+export {};