@nextcloud/excalidraw-common 0.18.0-8fb6b24 → 0.18.0-nc.2

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

@@ -1,34 +1,26 @@
-import type { ExcalidrawElement, ExcalidrawLinearElement, ExcalidrawTextElement } from "@nextcloud/excalidraw-element/types";
-import type { Mutable } from "@nextcloud/excalidraw-common/utility-types";
-import type { AppState } from "../types";
+import type { Scene } from "@nextcloud/excalidraw-element";
+import type { ExcalidrawElement, ExcalidrawLinearElement, ExcalidrawTextContainer, ExcalidrawTextElement, ExcalidrawTextElementWithContainer, NonDeleted, NonDeletedExcalidrawElement } from "@nextcloud/excalidraw-element/types";
+import type { ActionResult } from "./types";
+import type { AppClassProperties, AppState } from "../types";
+/**
+ * Frees the container's text as it rendered: wrapped the same, at a fixed
+ * width.
+ */
+export declare const unbindTextFromContainer: (container: ExcalidrawElement, boundTextElement: ExcalidrawTextElementWithContainer, scene: Scene) => void;
 export declare const actionUnbindText: {
     name: "unbindText";
     label: string;
     trackEvent: {
         category: "element";
     };
-    predicate: (elements: readonly ExcalidrawElement[], appState: AppState, _: import("../types").ExcalidrawProps, app: import("../types").AppClassProperties) => boolean;
-    perform: (elements: readonly import("@nextcloud/excalidraw-element/types").OrderedExcalidrawElement[], appState: Readonly<AppState>, _: unknown, app: import("../types").AppClassProperties) => {
+    predicate: (elements: readonly ExcalidrawElement[], appState: AppState, _: import("../types").ExcalidrawProps, app: AppClassProperties) => boolean;
+    perform: (elements: readonly import("@nextcloud/excalidraw-element/types").OrderedExcalidrawElement[], appState: Readonly<AppState>, _: unknown, app: AppClassProperties) => {
         elements: readonly import("@nextcloud/excalidraw-element/types").OrderedExcalidrawElement[];
-        appState: Readonly<AppState>;
-        captureUpdate: "IMMEDIATELY";
-    };
-} & {
-    keyTest?: undefined;
-};
-export declare const actionBindText: {
-    name: "bindText";
-    label: string;
-    trackEvent: {
-        category: "element";
-    };
-    predicate: (elements: readonly ExcalidrawElement[], appState: AppState, _: import("../types").ExcalidrawProps, app: import("../types").AppClassProperties) => boolean;
-    perform: (elements: readonly import("@nextcloud/excalidraw-element/types").OrderedExcalidrawElement[], appState: Readonly<AppState>, _: unknown, app: import("../types").AppClassProperties) => {
-        elements: ExcalidrawElement[];
         appState: {
-            selectedElementIds: {
-                [x: string]: true;
-            };
+            selectedElementIds: AppState["selectedElementIds"];
+            selectedGroupIds: AppState["selectedGroupIds"];
+            editingGroupId: AppState["editingGroupId"];
+            selectedLinearElement: import("@nextcloud/excalidraw-element").LinearElementEditor | null;
             contextMenu: {
                 items: import("../components/ContextMenu").ContextMenuItems;
                 top: number;
@@ -38,30 +30,43 @@ export declare const actionBindText: {
             isLoading: boolean;
             errorMessage: React.ReactNode;
             activeEmbeddable: {
-                element: import("@nextcloud/excalidraw-element/types").NonDeletedExcalidrawElement;
+                element: NonDeletedExcalidrawElement;
                 state: "hover" | "active";
             } | null;
-            newElement: import("@nextcloud/excalidraw-element/types").NonDeleted<import("@nextcloud/excalidraw-element/types").ExcalidrawNonSelectionElement> | null;
-            resizingElement: import("@nextcloud/excalidraw-element/types").NonDeletedExcalidrawElement | null;
-            multiElement: import("@nextcloud/excalidraw-element/types").NonDeleted<ExcalidrawLinearElement> | null;
-            selectionElement: import("@nextcloud/excalidraw-element/types").NonDeletedExcalidrawElement | null;
+            newElement: NonDeleted<import("@nextcloud/excalidraw-element/types").ExcalidrawNonSelectionElement> | null;
+            resizingElement: NonDeletedExcalidrawElement | null;
+            multiElement: NonDeleted<ExcalidrawLinearElement> | null;
+            selectionElement: NonDeletedExcalidrawElement | null;
             isBindingEnabled: boolean;
+            boxSelectionMode: import("../types").BoxSelectionMode;
             bindingPreference: "enabled" | "disabled";
             isMidpointSnappingEnabled: boolean;
-            startBoundElement: import("@nextcloud/excalidraw-element/types").NonDeleted<import("@nextcloud/excalidraw-element/types").ExcalidrawBindableElement> | null;
+            showHints: boolean;
+            inputDevice: import("../types").InputDevice;
             suggestedBinding: {
-                element: import("@nextcloud/excalidraw-element/types").NonDeleted<import("@nextcloud/excalidraw-element/types").ExcalidrawBindableElement>;
+                element: NonDeleted<import("@nextcloud/excalidraw-element/types").ExcalidrawBindableElement>;
                 midPoint?: import("@nextcloud/excalidraw-math").GlobalPoint;
             } | null;
-            frameToHighlight: import("@nextcloud/excalidraw-element/types").NonDeleted<import("@nextcloud/excalidraw-element/types").ExcalidrawFrameLikeElement> | null;
+            textToolHover: {
+                type: "text";
+                elementId: ExcalidrawElement["id"];
+            } | {
+                type: "container";
+                elementId: ExcalidrawElement["id"];
+            } | {
+                type: "arrow";
+                elementId: import("@nextcloud/excalidraw-element/types").ExcalidrawArrowElement["id"];
+                anchor: "start" | "end" | "label";
+            } | null;
+            frameToHighlight: NonDeleted<import("@nextcloud/excalidraw-element/types").ExcalidrawFrameLikeElement> | null;
             frameRendering: {
                 enabled: boolean;
                 name: boolean;
                 outline: boolean;
                 clip: boolean;
             };
-            editingFrame: string | null;
-            elementsToHighlight: import("@nextcloud/excalidraw-element/types").NonDeleted<ExcalidrawElement>[] | null;
+            editingFrame: import("@nextcloud/excalidraw-element/types").ExcalidrawFrameLikeElement["id"] | null;
+            elementsToHighlight: readonly NonDeletedExcalidrawElement[] | null;
             editingTextElement: ExcalidrawTextElement | null;
             activeTool: {
                 lastActiveTool: import("../types").ActiveTool | null;
@@ -79,11 +84,14 @@ export declare const actionBindText: {
             exportWithDarkMode: boolean;
             exportScale: number;
             currentItemStrokeColor: string;
+            currentItemStickynoteStrokeColor: string;
+            currentItemStickynoteBackgroundColor: string;
             currentItemBackgroundColor: string;
             currentItemFillStyle: ExcalidrawElement["fillStyle"];
-            currentItemStrokeWidth: number;
+            currentItemStrokeWidthKey: import("@nextcloud/excalidraw-common").StrokeWidthKey;
             currentItemStrokeStyle: ExcalidrawElement["strokeStyle"];
             currentItemRoughness: number;
+            currentItemStrokeVariability: import("@nextcloud/excalidraw-element/types").StrokeVariability;
             currentItemOpacity: number;
             currentItemFontFamily: import("@nextcloud/excalidraw-element/types").FontFamilyValues;
             currentItemFontSize: number;
@@ -96,6 +104,7 @@ export declare const actionBindText: {
             viewBackgroundColor: string;
             scrollX: number;
             scrollY: number;
+            scrollConstraints: import("../types").ScrollConstraints | null;
             cursorButton: "up" | "down";
             scrolledOutside: boolean;
             name: string | null;
@@ -146,10 +155,6 @@ export declare const actionBindText: {
             gridStep: number;
             gridModeEnabled: boolean;
             viewModeEnabled: boolean;
-            selectedGroupIds: {
-                [groupId: string]: boolean;
-            };
-            editingGroupId: import("@nextcloud/excalidraw-element/types").GroupId | null;
             width: number;
             height: number;
             offsetTop: number;
@@ -161,15 +166,12 @@ export declare const actionBindText: {
                 panels: number;
             };
             showHyperlinkPopup: false | "info" | "editor";
-            selectedLinearElement: import("@nextcloud/excalidraw-element").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>;
             isCropping: boolean;
             croppingElementId: ExcalidrawElement["id"] | null;
             searchMatches: Readonly<{
@@ -181,180 +183,49 @@ export declare const actionBindText: {
                 [groupId: string]: true;
             };
             bindMode: import("@nextcloud/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("@nextcloud/excalidraw-element/types").FontFamilyValues[] | null;
         };
         captureUpdate: "IMMEDIATELY";
     };
 } & {
     keyTest?: undefined;
 };
+export declare const actionBindText: {
+    name: "bindText";
+    label: string;
+    trackEvent: {
+        category: "element";
+    };
+    predicate: (elements: readonly ExcalidrawElement[], appState: AppState, _: import("../types").ExcalidrawProps, app: AppClassProperties) => boolean;
+    perform: (elements: readonly import("@nextcloud/excalidraw-element/types").OrderedExcalidrawElement[], appState: Readonly<AppState>, _: unknown, app: AppClassProperties) => ActionResult;
+} & {
+    keyTest?: undefined;
+};
+/**
+ * A note and its label share one ink: the text the user styled wins, unless it
+ * is transparent (a note's label never is).
+ */
+export declare const getStickyNoteInk: (textElement: ExcalidrawTextElement, container: ExcalidrawElement) => string | null;
+/** binds the text to the (label-less) container, selecting the container */
+export declare const bindTextToContainer: (elements: readonly ExcalidrawElement[], appState: Readonly<AppState>, textElement: ExcalidrawTextElement, container: NonDeleted<ExcalidrawTextContainer>, app: AppClassProperties) => ActionResult;
+export declare const pushContainerBelowText: (elements: readonly ExcalidrawElement[], container: ExcalidrawElement, textElement: ExcalidrawTextElement) => ExcalidrawElement[];
 export declare const actionWrapTextInContainer: {
     name: "wrapTextInContainer";
     label: string;
     trackEvent: {
         category: "element";
     };
-    predicate: (elements: readonly ExcalidrawElement[], appState: AppState, _: import("../types").ExcalidrawProps, app: import("../types").AppClassProperties) => boolean;
-    perform: (elements: readonly import("@nextcloud/excalidraw-element/types").OrderedExcalidrawElement[], appState: Readonly<AppState>, _: unknown, app: import("../types").AppClassProperties) => {
-        elements: readonly ExcalidrawElement[];
-        appState: {
-            selectedElementIds: Mutable<Readonly<{
-                [id: string]: true;
-            }>>;
-            contextMenu: {
-                items: import("../components/ContextMenu").ContextMenuItems;
-                top: number;
-                left: number;
-            } | null;
-            showWelcomeScreen: boolean;
-            isLoading: boolean;
-            errorMessage: React.ReactNode;
-            activeEmbeddable: {
-                element: import("@nextcloud/excalidraw-element/types").NonDeletedExcalidrawElement;
-                state: "hover" | "active";
-            } | null;
-            newElement: import("@nextcloud/excalidraw-element/types").NonDeleted<import("@nextcloud/excalidraw-element/types").ExcalidrawNonSelectionElement> | null;
-            resizingElement: import("@nextcloud/excalidraw-element/types").NonDeletedExcalidrawElement | null;
-            multiElement: import("@nextcloud/excalidraw-element/types").NonDeleted<ExcalidrawLinearElement> | null;
-            selectionElement: import("@nextcloud/excalidraw-element/types").NonDeletedExcalidrawElement | null;
-            isBindingEnabled: boolean;
-            bindingPreference: "enabled" | "disabled";
-            isMidpointSnappingEnabled: boolean;
-            startBoundElement: import("@nextcloud/excalidraw-element/types").NonDeleted<import("@nextcloud/excalidraw-element/types").ExcalidrawBindableElement> | null;
-            suggestedBinding: {
-                element: import("@nextcloud/excalidraw-element/types").NonDeleted<import("@nextcloud/excalidraw-element/types").ExcalidrawBindableElement>;
-                midPoint?: import("@nextcloud/excalidraw-math").GlobalPoint;
-            } | null;
-            frameToHighlight: import("@nextcloud/excalidraw-element/types").NonDeleted<import("@nextcloud/excalidraw-element/types").ExcalidrawFrameLikeElement> | null;
-            frameRendering: {
-                enabled: boolean;
-                name: boolean;
-                outline: boolean;
-                clip: boolean;
-            };
-            editingFrame: string | null;
-            elementsToHighlight: import("@nextcloud/excalidraw-element/types").NonDeleted<ExcalidrawElement>[] | null;
-            editingTextElement: ExcalidrawTextElement | null;
-            activeTool: {
-                lastActiveTool: import("../types").ActiveTool | null;
-                locked: boolean;
-                fromSelection: boolean;
-            } & import("../types").ActiveTool;
-            preferredSelectionTool: {
-                type: "selection" | "lasso";
-                initialized: boolean;
-            };
-            penMode: boolean;
-            penDetected: boolean;
-            exportBackground: boolean;
-            exportEmbedScene: boolean;
-            exportWithDarkMode: boolean;
-            exportScale: number;
-            currentItemStrokeColor: string;
-            currentItemBackgroundColor: string;
-            currentItemFillStyle: ExcalidrawElement["fillStyle"];
-            currentItemStrokeWidth: number;
-            currentItemStrokeStyle: ExcalidrawElement["strokeStyle"];
-            currentItemRoughness: number;
-            currentItemOpacity: number;
-            currentItemFontFamily: import("@nextcloud/excalidraw-element/types").FontFamilyValues;
-            currentItemFontSize: number;
-            currentItemTextAlign: import("@nextcloud/excalidraw-element/types").TextAlign;
-            currentItemStartArrowhead: import("@nextcloud/excalidraw-element/types").Arrowhead | null;
-            currentItemEndArrowhead: import("@nextcloud/excalidraw-element/types").Arrowhead | null;
-            currentHoveredFontFamily: import("@nextcloud/excalidraw-element/types").FontFamilyValues | null;
-            currentItemRoundness: import("@nextcloud/excalidraw-element/types").StrokeRoundness;
-            currentItemArrowType: "sharp" | "round" | "elbow";
-            viewBackgroundColor: string;
-            scrollX: number;
-            scrollY: number;
-            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: ExcalidrawElement["id"];
-            } | {
-                name: "charts";
-                data: import("../charts").Spreadsheet;
-                rawText: string;
-            };
-            defaultSidebarDockedPreference: boolean;
-            lastPointerDownWith: import("@nextcloud/excalidraw-element/types").PointerType;
-            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("@nextcloud/excalidraw-element/types").Theme;
-            gridSize: number;
-            gridStep: number;
-            gridModeEnabled: boolean;
-            viewModeEnabled: boolean;
-            selectedGroupIds: {
-                [groupId: string]: boolean;
-            };
-            editingGroupId: import("@nextcloud/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("@nextcloud/excalidraw-element").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>;
-            isCropping: boolean;
-            croppingElementId: ExcalidrawElement["id"] | null;
-            searchMatches: Readonly<{
-                focusedId: ExcalidrawElement["id"] | null;
-                matches: readonly import("../types").SearchMatch[];
-            }> | null;
-            activeLockedId: string | null;
-            lockedMultiSelections: {
-                [groupId: string]: true;
-            };
-            bindMode: import("@nextcloud/excalidraw-element/types").BindMode;
-        };
-        captureUpdate: "IMMEDIATELY";
-    };
+    predicate: (elements: readonly ExcalidrawElement[], appState: AppState, _: import("../types").ExcalidrawProps, app: AppClassProperties) => boolean;
+    perform: (elements: readonly import("@nextcloud/excalidraw-element/types").OrderedExcalidrawElement[], appState: Readonly<AppState>, _: unknown, app: AppClassProperties) => ActionResult;
 } & {
     keyTest?: undefined;
 };
+/** wraps each (unbound) text in a new container, selecting the containers */
+export declare const wrapTextsInContainers: (elements: readonly ExcalidrawElement[], appState: Readonly<AppState>, textElements: readonly ExcalidrawTextElement[], app: AppClassProperties) => ActionResult;