@excalidraw/common 0.18.0-4872083 → 0.18.0-4ce38fb
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/dev/index.js +145 -14
- package/dist/dev/index.js.map +2 -2
- package/dist/prod/index.js +3 -3
- package/dist/types/common/src/colors.d.ts +13 -7
- package/dist/types/common/src/constants.d.ts +54 -0
- package/dist/types/common/src/keys.d.ts +2 -0
- package/dist/types/common/src/random.d.ts +7 -0
- package/dist/types/common/src/utils.d.ts +5 -0
- package/dist/types/element/src/Scene.d.ts +1 -1
- package/dist/types/element/src/binding.d.ts +13 -7
- package/dist/types/element/src/collision.d.ts +14 -5
- package/dist/types/element/src/comparisons.d.ts +5 -3
- package/dist/types/element/src/delta.d.ts +23 -1
- package/dist/types/element/src/duplicate.d.ts +60 -0
- package/dist/types/element/src/flowchart.d.ts +5 -1
- package/dist/types/element/src/frame.d.ts +2 -2
- package/dist/types/element/src/index.d.ts +2 -0
- package/dist/types/element/src/linearElementEditor.d.ts +10 -0
- package/dist/types/element/src/listMarker.d.ts +34 -0
- package/dist/types/element/src/mutateElement.d.ts +1 -1
- package/dist/types/element/src/newElement.d.ts +39 -3
- package/dist/types/element/src/renderElement.d.ts +21 -4
- package/dist/types/element/src/shape.d.ts +15 -1
- package/dist/types/element/src/sizeHelpers.d.ts +6 -0
- package/dist/types/element/src/stickyNote.d.ts +183 -0
- package/dist/types/element/src/textElement.d.ts +9 -1
- package/dist/types/element/src/transform.d.ts +25 -6
- package/dist/types/element/src/typeChecks.d.ts +3 -2
- package/dist/types/element/src/types.d.ts +35 -6
- package/dist/types/element/src/utils.d.ts +15 -4
- package/dist/types/element/src/zindex.d.ts +1 -1
- package/dist/types/excalidraw/actions/actionAddToLibrary.d.ts +60 -3
- package/dist/types/excalidraw/actions/actionAlign.d.ts +6 -6
- package/dist/types/excalidraw/actions/actionBoundText.d.ts +40 -2
- package/dist/types/excalidraw/actions/actionCanvas.d.ts +147 -14
- package/dist/types/excalidraw/actions/actionClipboard.d.ts +40 -2
- package/dist/types/excalidraw/actions/actionCropEditor.d.ts +20 -1
- package/dist/types/excalidraw/actions/actionDeleteSelected.d.ts +61 -4
- package/dist/types/excalidraw/actions/actionDeselect.d.ts +23 -1
- package/dist/types/excalidraw/actions/actionDistribute.d.ts +2 -2
- package/dist/types/excalidraw/actions/actionElementLink.d.ts +20 -1
- package/dist/types/excalidraw/actions/actionElementLock.d.ts +40 -2
- package/dist/types/excalidraw/actions/actionExport.d.ts +41 -3
- package/dist/types/excalidraw/actions/actionFinalize.d.ts +1 -0
- package/dist/types/excalidraw/actions/actionFrame.d.ts +111 -4
- package/dist/types/excalidraw/actions/actionGroup.d.ts +40 -2
- package/dist/types/excalidraw/actions/actionLinearEditor.d.ts +71 -2
- package/dist/types/excalidraw/actions/actionLink.d.ts +20 -1
- package/dist/types/excalidraw/actions/actionMenu.d.ts +20 -1
- package/dist/types/excalidraw/actions/actionProperties.d.ts +50 -8
- package/dist/types/excalidraw/actions/actionSelectAll.d.ts +20 -1
- package/dist/types/excalidraw/actions/actionStyles.d.ts +21 -2
- package/dist/types/excalidraw/actions/actionToggleArrowBinding.d.ts +20 -1
- package/dist/types/excalidraw/actions/actionToggleGridMode.d.ts +20 -1
- package/dist/types/excalidraw/actions/actionToggleMidpointSnapping.d.ts +20 -1
- package/dist/types/excalidraw/actions/actionToggleObjectsSnapMode.d.ts +20 -1
- package/dist/types/excalidraw/actions/actionToggleSearchMenu.d.ts +20 -1
- package/dist/types/excalidraw/actions/actionToggleShowHints.d.ts +197 -0
- package/dist/types/excalidraw/actions/actionToggleStats.d.ts +20 -1
- package/dist/types/excalidraw/actions/actionToggleViewMode.d.ts +20 -1
- package/dist/types/excalidraw/actions/actionToggleZenMode.d.ts +20 -1
- package/dist/types/excalidraw/actions/colorTargets.d.ts +39 -0
- package/dist/types/excalidraw/actions/index.d.ts +1 -0
- package/dist/types/excalidraw/actions/types.d.ts +1 -1
- package/dist/types/excalidraw/appState.d.ts +26 -4
- package/dist/types/excalidraw/components/App.arrowText.d.ts +28 -30
- package/dist/types/excalidraw/components/App.bucketFill.d.ts +10 -0
- package/dist/types/excalidraw/components/App.clipboard.d.ts +31 -0
- package/dist/types/excalidraw/components/App.cursor.d.ts +8 -0
- package/dist/types/excalidraw/components/App.d.ts +110 -199
- package/dist/types/excalidraw/components/App.duplicate.d.ts +101 -0
- package/dist/types/excalidraw/components/App.pan.d.ts +62 -0
- package/dist/types/excalidraw/components/App.text.d.ts +146 -0
- package/dist/types/excalidraw/components/App.textTool.d.ts +140 -0
- package/dist/types/excalidraw/components/App.toolDrag.d.ts +63 -0
- package/dist/types/excalidraw/components/App.viewport.d.ts +41 -1
- package/dist/types/excalidraw/components/App.wheel.d.ts +26 -0
- package/dist/types/excalidraw/components/ColorPicker/ColorPicker.d.ts +6 -2
- package/dist/types/excalidraw/components/ColorPicker/CustomColorList.d.ts +3 -1
- package/dist/types/excalidraw/components/ColorPicker/Picker.d.ts +4 -1
- package/dist/types/excalidraw/components/ColorPicker/PickerColorList.d.ts +4 -2
- package/dist/types/excalidraw/components/ColorPicker/ShadeList.d.ts +4 -2
- package/dist/types/excalidraw/components/ColorPicker/TopPicks.d.ts +8 -1
- package/dist/types/excalidraw/components/ColorPicker/colorTopPicksDnD.d.ts +11 -0
- package/dist/types/excalidraw/components/FileDropOverlay.d.ts +2 -0
- package/dist/types/excalidraw/components/FontPicker/FontPicker.d.ts +4 -1
- package/dist/types/excalidraw/components/FontPicker/FontPickerList.d.ts +6 -1
- package/dist/types/excalidraw/components/FontPicker/fontTopPicksDnD.d.ts +12 -0
- package/dist/types/excalidraw/components/IconButton.d.ts +2 -0
- package/dist/types/excalidraw/components/LibraryMenuSection.d.ts +6 -2
- package/dist/types/excalidraw/components/LibraryUnit.d.ts +7 -2
- package/dist/types/excalidraw/components/Tools.d.ts +7 -2
- package/dist/types/excalidraw/components/Tooltip.d.ts +15 -1
- package/dist/types/excalidraw/components/TopPicksDnD/TopPicksContextMenu.d.ts +14 -0
- package/dist/types/excalidraw/components/TopPicksDnD/TopPicksTip.d.ts +11 -0
- package/dist/types/excalidraw/components/TopPicksDnD/topPicksDnD.d.ts +58 -0
- package/dist/types/excalidraw/components/canvases/NewElementCanvas.d.ts +2 -0
- package/dist/types/excalidraw/components/icons.d.ts +2 -0
- package/dist/types/excalidraw/components/main-menu/DefaultItems.d.ts +2 -0
- package/dist/types/excalidraw/components/shapeActionPredicates.d.ts +2 -2
- package/dist/types/excalidraw/data/blob.d.ts +42 -4
- package/dist/types/excalidraw/data/json.d.ts +21 -2
- package/dist/types/excalidraw/fonts/Fonts.d.ts +3 -2
- package/dist/types/excalidraw/hooks/useTextEditorFocus.d.ts +5 -5
- package/dist/types/excalidraw/lasso/utils.d.ts +2 -0
- package/dist/types/excalidraw/renderOverrides.d.ts +9 -0
- package/dist/types/excalidraw/renderer/helpers.d.ts +25 -0
- package/dist/types/excalidraw/renderer/interactiveScene.d.ts +1 -1
- package/dist/types/excalidraw/scene/Renderer.d.ts +64 -2
- package/dist/types/excalidraw/scene/index.d.ts +1 -1
- package/dist/types/excalidraw/scene/types.d.ts +3 -1
- package/dist/types/excalidraw/types.d.ts +140 -18
- package/dist/types/excalidraw/viewport.d.ts +33 -1
- package/dist/types/excalidraw/wysiwyg/textWysiwyg.d.ts +12 -1
- package/dist/types/math/src/curve.d.ts +19 -12
- package/dist/types/math/src/segment.d.ts +6 -0
- package/dist/types/utils/src/export.d.ts +1 -0
- package/dist/types/utils/src/shape.d.ts +2 -2
- package/package.json +1 -1
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
import type { ElementOrToolType } from "@excalidraw/excalidraw/types";
|
|
2
|
-
export declare const hasBackground: (type: ElementOrToolType) => type is "line" | "rectangle" | "diamond" | "ellipse" | "embeddable" | "iframe" | "freedraw" | "autoshape" | "bucketfill";
|
|
3
|
-
export declare const
|
|
2
|
+
export declare const hasBackground: (type: ElementOrToolType) => type is "line" | "rectangle" | "stickynote" | "diamond" | "ellipse" | "embeddable" | "iframe" | "freedraw" | "autoshape" | "bucketfill";
|
|
3
|
+
export declare const hasFillStyle: (type: ElementOrToolType) => type is "line" | "rectangle" | "diamond" | "ellipse" | "embeddable" | "iframe" | "freedraw" | "autoshape" | "bucketfill";
|
|
4
|
+
export declare const hasStrokeColor: (type: ElementOrToolType) => type is "line" | "arrow" | "text" | "rectangle" | "stickynote" | "diamond" | "ellipse" | "embeddable" | "freedraw" | "autoshape";
|
|
4
5
|
export declare const hasStrokeWidth: (type: ElementOrToolType) => type is "line" | "arrow" | "rectangle" | "diamond" | "ellipse" | "embeddable" | "iframe" | "freedraw" | "autoshape";
|
|
5
6
|
export declare const hasStrokeStyle: (type: ElementOrToolType) => type is "line" | "arrow" | "rectangle" | "diamond" | "ellipse" | "embeddable" | "iframe" | "autoshape";
|
|
7
|
+
export declare const hasRoughness: (type: ElementOrToolType) => type is "line" | "arrow" | "rectangle" | "stickynote" | "diamond" | "ellipse" | "embeddable" | "iframe" | "autoshape";
|
|
6
8
|
export declare const hasFreedrawMode: (type: ElementOrToolType) => type is "freedraw";
|
|
7
|
-
export declare const canChangeRoundness: (type: ElementOrToolType) => type is "line" | "rectangle" | "diamond" | "embeddable" | "iframe" | "image";
|
|
9
|
+
export declare const canChangeRoundness: (type: ElementOrToolType) => type is "line" | "rectangle" | "stickynote" | "diamond" | "embeddable" | "iframe" | "image";
|
|
8
10
|
export declare const toolIsArrow: (type: ElementOrToolType) => type is "arrow";
|
|
9
11
|
export declare const canHaveArrowheads: (type: ElementOrToolType) => type is "arrow";
|
|
@@ -192,7 +192,29 @@ export declare class ElementsDelta implements DeltaContainer<SceneElementsMap> {
|
|
|
192
192
|
private static createGetter;
|
|
193
193
|
private static applyDelta;
|
|
194
194
|
/**
|
|
195
|
-
*
|
|
195
|
+
* Whether an element looks different after the delta — and the layout that
|
|
196
|
+
* followed it — was applied. The input to history's "skip entries with no
|
|
197
|
+
* visible change" loop.
|
|
198
|
+
*
|
|
199
|
+
* Both sides are first reduced to what actually paints:
|
|
200
|
+
* - a missing or deleted element paints nothing;
|
|
201
|
+
* - an empty text element paints nothing either — unless it carries arrow
|
|
202
|
+
* bindings (an arrow may end at it) or sits on an arrow (an empty label
|
|
203
|
+
* still cuts the arrow's gap);
|
|
204
|
+
* so an empty label's deletion or restoration compares as nothing against
|
|
205
|
+
* nothing. Two painting elements are then compared property by property:
|
|
206
|
+
* - `version`, `versionNonce`, `updated`, `created` are metadata, and
|
|
207
|
+
* `index` is covered by the separate z-order check (`reorderElements`);
|
|
208
|
+
* - `boundElements` is compared as `type:id` references with references to
|
|
209
|
+
* empty labels dropped, so adding or removing an empty label's reference
|
|
210
|
+
* is not visible on its own, and binding repair that rebuilt equal
|
|
211
|
+
* objects is not either;
|
|
212
|
+
* - everything else counts. Nested arrays (`points`, binding fixed points)
|
|
213
|
+
* compare by reference, which can only over-report a change — the safe
|
|
214
|
+
* direction, where undo stops one entry early.
|
|
215
|
+
*
|
|
216
|
+
* `previousElements` holds only `idsToCheck` (see `applyTo`); the label
|
|
217
|
+
* lookups it serves are for elements whose labels are in that set.
|
|
196
218
|
*/
|
|
197
219
|
private static checkForVisibleDifference;
|
|
198
220
|
/**
|
|
@@ -1,6 +1,32 @@
|
|
|
1
1
|
import type { Mutable } from "@excalidraw/common/utility-types";
|
|
2
2
|
import type { AppState } from "@excalidraw/excalidraw/types";
|
|
3
3
|
import type { ExcalidrawElement, GroupId, NonDeletedExcalidrawElement } from "./types";
|
|
4
|
+
/**
|
|
5
|
+
* Lookups supplied to the host's `props.onDuplicate`, covering just the
|
|
6
|
+
* elements taking part in the duplication.
|
|
7
|
+
*/
|
|
8
|
+
export type OnDuplicateData = {
|
|
9
|
+
/** the duplicates, by their id */
|
|
10
|
+
duplicateElements: ReadonlyMap<ExcalidrawElement["id"], ExcalidrawElement>;
|
|
11
|
+
/**
|
|
12
|
+
* The elements the duplicates were made from, by their id.
|
|
13
|
+
*
|
|
14
|
+
* On paste and library insert these are the inserted elements, which aren't
|
|
15
|
+
* part of the scene (though they may share ids with the scene elements they
|
|
16
|
+
* were copied from).
|
|
17
|
+
*/
|
|
18
|
+
originalElements: ReadonlyMap<ExcalidrawElement["id"], ExcalidrawElement>;
|
|
19
|
+
/**
|
|
20
|
+
* id of an original -> id of its duplicate (e.g. to remap element ids you
|
|
21
|
+
* keep in `customData`, which the duplicate copied from its original)
|
|
22
|
+
*/
|
|
23
|
+
origIdToDuplicateId: ReadonlyMap<ExcalidrawElement["id"], ExcalidrawElement["id"]>;
|
|
24
|
+
/**
|
|
25
|
+
* id of a duplicate -> id of its original (e.g. to look up the original in
|
|
26
|
+
* `originalElements` while modifying the duplicate)
|
|
27
|
+
*/
|
|
28
|
+
duplicateIdToOrigId: ReadonlyMap<ExcalidrawElement["id"], ExcalidrawElement["id"]>;
|
|
29
|
+
};
|
|
4
30
|
/**
|
|
5
31
|
* Duplicate an element, often used in the alt-drag operation.
|
|
6
32
|
* Note that this method has gotten a bit complicated since the
|
|
@@ -49,8 +75,42 @@ export declare const duplicateElements: (opts: {
|
|
|
49
75
|
})) => {
|
|
50
76
|
duplicatedElements: NonDeletedExcalidrawElement[];
|
|
51
77
|
duplicateElementsMap: Map<string, NonDeletedExcalidrawElement>;
|
|
78
|
+
origElementsMap: Map<string, ExcalidrawElement>;
|
|
52
79
|
elementsWithDuplicates: ExcalidrawElement[];
|
|
53
80
|
origIdToDuplicateId: Map<string, string>;
|
|
81
|
+
duplicateIdToOrigId: Map<string, string>;
|
|
82
|
+
};
|
|
83
|
+
/**
|
|
84
|
+
* Folds the elements returned by the host (`props.onDuplicate`) back into the
|
|
85
|
+
* duplicates the editor created, so that everything that follows (frame
|
|
86
|
+
* assignment, bound text redraw, selection, alt-drag handover) can keep
|
|
87
|
+
* working with the editor's own objects, whether the host mutated the
|
|
88
|
+
* duplicates or returned new objects for them.
|
|
89
|
+
*
|
|
90
|
+
* - A returned element with a duplicate's id is shallow-merged into that
|
|
91
|
+
* duplicate, which takes its place in the returned array. Properties the
|
|
92
|
+
* host omits are kept, so that a partial element can't invalidate the
|
|
93
|
+
* duplicate. Safe only because the duplicates are fresh (not in the scene or
|
|
94
|
+
* the store snapshot yet), which is why nothing but the passed duplicates is
|
|
95
|
+
* ever merged into. Since the merge goes around `mutateElement`, what may
|
|
96
|
+
* have been cached for the duplicate by then is invalidated here.
|
|
97
|
+
* - A duplicate missing from the returned array (or returned as deleted) is
|
|
98
|
+
* vetoed. So is the bound text of a vetoed container. What the remaining
|
|
99
|
+
* duplicates reference of the vetoed ones is cleared, as if those were never
|
|
100
|
+
* part of the duplication (see `fixDuplicatedBindingsAfterDuplication`).
|
|
101
|
+
* - Any other returned element is used as is (existing elements must not be
|
|
102
|
+
* mutated, so the host replaces them).
|
|
103
|
+
* - `false` vetoes all the duplicates.
|
|
104
|
+
*
|
|
105
|
+
* @returns next elements, and the duplicates that weren't vetoed
|
|
106
|
+
*/
|
|
107
|
+
export declare const reconcileDuplicatedElements: <TDuplicate extends ExcalidrawElement>(
|
|
108
|
+
/** what the host returned from `props.onDuplicate`, if anything */
|
|
109
|
+
hostElements: readonly ExcalidrawElement[] | void | false,
|
|
110
|
+
/** elements that were passed to the host */
|
|
111
|
+
nextElements: ExcalidrawElement[], duplicatedElements: TDuplicate[]) => {
|
|
112
|
+
elements: ExcalidrawElement[];
|
|
113
|
+
duplicatedElements: TDuplicate[];
|
|
54
114
|
};
|
|
55
115
|
/**
|
|
56
116
|
* Clones ExcalidrawElement data structure. Does not regenerate id, nonce, or
|
|
@@ -1,7 +1,11 @@
|
|
|
1
1
|
import type { AppState, PendingExcalidrawElements } from "@excalidraw/excalidraw/types";
|
|
2
|
-
import { type NonDeleted, type ElementsMap, type ExcalidrawElement, type ExcalidrawFlowchartNodeElement } from "./types";
|
|
2
|
+
import { type NonDeleted, type ElementsMap, type ExcalidrawElement, type ExcalidrawFlowchartNodeElement, type NonDeletedExcalidrawElement } from "./types";
|
|
3
3
|
import type { Scene } from "./Scene";
|
|
4
4
|
export type LinkDirection = "up" | "right" | "down" | "left";
|
|
5
|
+
export declare const addNewNodes: (startNode: NonDeleted<ExcalidrawFlowchartNodeElement>, appState: AppState, direction: LinkDirection, scene: Scene, numberOfNodes: number, stickyCrossStart?: number | null) => {
|
|
6
|
+
nodes: NonDeletedExcalidrawElement[];
|
|
7
|
+
crossStart: number;
|
|
8
|
+
};
|
|
5
9
|
export declare class FlowChartNavigator {
|
|
6
10
|
isExploring: boolean;
|
|
7
11
|
private sameLevelNodes;
|
|
@@ -31,8 +31,8 @@ export declare const getFrameLikeElements: (allElements: ExcalidrawElementsInclu
|
|
|
31
31
|
*/
|
|
32
32
|
export declare const getRootElements: <T extends ExcalidrawElement>(allElements: readonly T[]) => T[];
|
|
33
33
|
export declare const getElementsInResizingFrame: (allElements: ExcalidrawElementsIncludingDeleted, frame: ExcalidrawFrameLikeElement, appState: AppState, elementsMap: ElementsMap) => ExcalidrawElement[];
|
|
34
|
-
export declare const getElementsInNewFrame: (elements: ExcalidrawElementsIncludingDeleted, frame: ExcalidrawFrameLikeElement, elementsMap: ElementsMap) => (import("./types").ExcalidrawLinearElement | import("./types").ExcalidrawSelectionElement | import("./types").ExcalidrawRectangleElement | import("./types").ExcalidrawDiamondElement | import("./types").ExcalidrawEllipseElement | import("./types").ExcalidrawEmbeddableElement | import("./types").ExcalidrawIframeElement | import("./types").ExcalidrawImageElement | import("./types").ExcalidrawFrameElement | import("./types").ExcalidrawMagicFrameElement | import("./types").ExcalidrawTextElement | import("./types").ExcalidrawFreeDrawElement)[];
|
|
35
|
-
export declare const omitPartialGroups: (elements: ExcalidrawElement[], frame: ExcalidrawFrameLikeElement, allElementsMap: ElementsMap) => (import("./types").ExcalidrawLinearElement | import("./types").ExcalidrawSelectionElement | import("./types").ExcalidrawRectangleElement | import("./types").ExcalidrawDiamondElement | import("./types").ExcalidrawEllipseElement | import("./types").ExcalidrawEmbeddableElement | import("./types").ExcalidrawIframeElement | import("./types").ExcalidrawImageElement | import("./types").ExcalidrawFrameElement | import("./types").ExcalidrawMagicFrameElement | import("./types").ExcalidrawTextElement | import("./types").ExcalidrawFreeDrawElement)[];
|
|
34
|
+
export declare const getElementsInNewFrame: (elements: ExcalidrawElementsIncludingDeleted, frame: ExcalidrawFrameLikeElement, elementsMap: ElementsMap) => (import("./types").ExcalidrawLinearElement | import("./types").ExcalidrawSelectionElement | import("./types").ExcalidrawRectangleElement | import("./types").ExcalidrawStickyNoteElement | import("./types").ExcalidrawDiamondElement | import("./types").ExcalidrawEllipseElement | import("./types").ExcalidrawEmbeddableElement | import("./types").ExcalidrawIframeElement | import("./types").ExcalidrawImageElement | import("./types").ExcalidrawFrameElement | import("./types").ExcalidrawMagicFrameElement | import("./types").ExcalidrawTextElement | import("./types").ExcalidrawFreeDrawElement)[];
|
|
35
|
+
export declare const omitPartialGroups: (elements: ExcalidrawElement[], frame: ExcalidrawFrameLikeElement, allElementsMap: ElementsMap) => (import("./types").ExcalidrawLinearElement | import("./types").ExcalidrawSelectionElement | import("./types").ExcalidrawRectangleElement | import("./types").ExcalidrawStickyNoteElement | import("./types").ExcalidrawDiamondElement | import("./types").ExcalidrawEllipseElement | import("./types").ExcalidrawEmbeddableElement | import("./types").ExcalidrawIframeElement | import("./types").ExcalidrawImageElement | import("./types").ExcalidrawFrameElement | import("./types").ExcalidrawMagicFrameElement | import("./types").ExcalidrawTextElement | import("./types").ExcalidrawFreeDrawElement)[];
|
|
36
36
|
export declare const getContainingFrame: (element: ExcalidrawElement, elementsMap: ElementsMap) => ExcalidrawFrameLikeElement | null;
|
|
37
37
|
/** */
|
|
38
38
|
export declare const filterElementsEligibleAsFrameChildren: (elements: readonly ExcalidrawElement[], frame: ExcalidrawFrameLikeElement) => ExcalidrawElement[];
|
|
@@ -36,6 +36,7 @@ export * from "./groups";
|
|
|
36
36
|
export * from "./heading";
|
|
37
37
|
export * from "./image";
|
|
38
38
|
export * from "./linearElementEditor";
|
|
39
|
+
export * from "./listMarker";
|
|
39
40
|
export * from "./mutateElement";
|
|
40
41
|
export * from "./newElement";
|
|
41
42
|
export * from "./positionElementsOnGrid";
|
|
@@ -49,6 +50,7 @@ export * from "./showSelectedShapeActions";
|
|
|
49
50
|
export * from "./sizeHelpers";
|
|
50
51
|
export * from "./sortElements";
|
|
51
52
|
export * from "./store";
|
|
53
|
+
export * from "./stickyNote";
|
|
52
54
|
export * from "./textElement";
|
|
53
55
|
export * from "./textMeasurements";
|
|
54
56
|
export * from "./textWrapping";
|
|
@@ -65,6 +65,8 @@ export declare class LinearElementEditor {
|
|
|
65
65
|
}, linearElementEditor: LinearElementEditor, scene: Scene): {
|
|
66
66
|
didAddPoint: boolean;
|
|
67
67
|
hitElement: NonDeleted<ExcalidrawElement> | null;
|
|
68
|
+
/** the pointer went down on the arrow's label, grabbing it for a drag */
|
|
69
|
+
hitBoundText: boolean;
|
|
68
70
|
linearElementEditor: LinearElementEditor | null;
|
|
69
71
|
};
|
|
70
72
|
static arePointsEqual<Point extends LocalPoint | GlobalPoint>(point1: Point | null, point2: Point | null): boolean;
|
|
@@ -76,6 +78,11 @@ export declare class LinearElementEditor {
|
|
|
76
78
|
static getPointAtIndexGlobalCoordinates(element: ExcalidrawLinearElement, indexMaybeFromEnd: number, // -1 for last element
|
|
77
79
|
elementsMap: ElementsMap): GlobalPoint;
|
|
78
80
|
static pointFromAbsoluteCoords(element: ExcalidrawLinearElement, absoluteCoords: GlobalPoint, elementsMap: ElementsMap): LocalPoint;
|
|
81
|
+
/**
|
|
82
|
+
* Whether the point at `index` is an interactive handle. Elbow arrows only
|
|
83
|
+
* expose their endpoints; their intermediate route points are not draggable.
|
|
84
|
+
*/
|
|
85
|
+
static isPointHandle(element: ExcalidrawLinearElement, index: number): boolean;
|
|
79
86
|
static getPointIndexUnderCursor(element: ExcalidrawLinearElement, elementsMap: ElementsMap, zoom: AppState["zoom"], x: number, y: number): number;
|
|
80
87
|
static createPointAt(element: ExcalidrawLinearElement, elementsMap: ElementsMap, scenePointerX: number, scenePointerY: number, gridSize: NullableGridSize): LocalPoint;
|
|
81
88
|
/**
|
|
@@ -114,10 +121,13 @@ export declare class LinearElementEditor {
|
|
|
114
121
|
* segment.
|
|
115
122
|
*/
|
|
116
123
|
static getBoundTextElementCenter: (element: ExcalidrawLinearElement, elementsMap: ElementsMap) => GlobalPoint;
|
|
124
|
+
static handleBoundTextDragging(linearElementEditor: LinearElementEditor, scene: Scene, pointerX: number, pointerY: number): LinearElementEditor | null;
|
|
125
|
+
static getPointAtPathParameter(container: ExcalidrawLinearElement, pathParameter: number, elementsMap: ElementsMap): GlobalPoint | null;
|
|
117
126
|
static getBoundTextElementPosition: (element: ExcalidrawLinearElement, boundTextElement: ExcalidrawTextElementWithContainer, elementsMap: ElementsMap) => {
|
|
118
127
|
x: number;
|
|
119
128
|
y: number;
|
|
120
129
|
};
|
|
130
|
+
private static computeBoundTextElementPosition;
|
|
121
131
|
static getMinMaxXYWithBoundText: (element: ExcalidrawLinearElement, elementsMap: ElementsMap, elementBounds: Bounds, boundTextElement: ExcalidrawTextElementWithContainer) => [number, number, number, number, number, number];
|
|
122
132
|
static getElementAbsoluteCoords: (element: ExcalidrawLinearElement, elementsMap: ElementsMap, includeBoundText?: boolean) => [number, number, number, number, number, number];
|
|
123
133
|
static moveFixedSegment(linearElement: LinearElementEditor, index: number, x: number, y: number, scene: Scene): Pick<LinearElementEditor, "segmentMidPointHoveredCoords" | "initialState">;
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
import type { Scene } from "./Scene";
|
|
2
|
+
import type { ExcalidrawElement, ExcalidrawTextElement } from "./types";
|
|
3
|
+
/** a list marker advanced by duplication, to go back and forth */
|
|
4
|
+
export type ListMarkerAdvance = {
|
|
5
|
+
elementId: ExcalidrawTextElement["id"];
|
|
6
|
+
prevOriginalText: string;
|
|
7
|
+
nextOriginalText: string;
|
|
8
|
+
/**
|
|
9
|
+
* where the item's text (after the marker and whitespace) starts in
|
|
10
|
+
* `nextOriginalText` (its length if there's none)
|
|
11
|
+
*/
|
|
12
|
+
contentStart: number;
|
|
13
|
+
/** the label's container before the label (may have) grown it */
|
|
14
|
+
prevContainerSize: {
|
|
15
|
+
width: number;
|
|
16
|
+
height: number;
|
|
17
|
+
} | null;
|
|
18
|
+
};
|
|
19
|
+
/**
|
|
20
|
+
* Advances the list markers of the duplicated texts and labels, so that
|
|
21
|
+
* duplicating `1. foo` gives `2. foo` (and `1` gives `2`).
|
|
22
|
+
*
|
|
23
|
+
* Duplicating several list items at once continues the list from the
|
|
24
|
+
* highest of them: duplicating `1.`, `3.`, `5.` gives `6.`, `7.`, `8.` (only
|
|
25
|
+
* if they're just markers, i.e. without text).
|
|
26
|
+
*
|
|
27
|
+
* Only if nothing but list items (texts, or containers with list item labels)
|
|
28
|
+
* is duplicated.
|
|
29
|
+
*/
|
|
30
|
+
export declare const advanceDuplicatedListMarkers: (duplicatedElements: readonly ExcalidrawElement[], scene: Scene) => ListMarkerAdvance[];
|
|
31
|
+
/**
|
|
32
|
+
* Sets the advanced list markers back (`"prev"`), or forth again (`"next"`).
|
|
33
|
+
*/
|
|
34
|
+
export declare const applyListMarkerAdvances: (advances: readonly ListMarkerAdvance[], direction: "prev" | "next", scene: Scene) => void;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { Mutable } from "@excalidraw/common/utility-types";
|
|
2
2
|
import type { ElementsMap, ExcalidrawElement } from "./types";
|
|
3
|
-
export type ElementUpdate<TElement extends ExcalidrawElement> = Omit<Partial<TElement>, "id" | "updated">;
|
|
3
|
+
export type ElementUpdate<TElement extends ExcalidrawElement> = Omit<Partial<TElement>, "id" | "updated" | "created">;
|
|
4
4
|
/**
|
|
5
5
|
* This function tracks updates of text elements for the purposes for collaboration.
|
|
6
6
|
* The version is used to compare updates when more than one user is working in
|
|
@@ -1,9 +1,29 @@
|
|
|
1
1
|
import type { MarkOptional } from "@excalidraw/common/utility-types";
|
|
2
|
-
import type { ExcalidrawImageElement, ExcalidrawTextElement, ExcalidrawLinearElement, ExcalidrawGenericElement, NonDeleted, TextAlign, VerticalAlign, Arrowhead, ExcalidrawFreeDrawElement, FontFamilyValues, ExcalidrawTextContainer, ExcalidrawFrameElement, ExcalidrawEmbeddableElement, ExcalidrawMagicFrameElement, ExcalidrawIframeElement, ElementsMap, ExcalidrawArrowElement, ExcalidrawElbowArrowElement, ExcalidrawLineElement } from "./types";
|
|
3
|
-
export type ElementConstructorOpts = MarkOptional<Omit<ExcalidrawGenericElement, "id" | "type" | "isDeleted" | "updated">, "width" | "height" | "angle" | "groupIds" | "frameId" | "index" | "boundElements" | "seed" | "version" | "versionNonce" | "link" | "strokeStyle" | "fillStyle" | "strokeColor" | "backgroundColor" | "roughness" | "strokeWidth" | "roundness" | "locked" | "opacity" | "customData">;
|
|
2
|
+
import type { ExcalidrawImageElement, ExcalidrawTextElement, ExcalidrawLinearElement, ExcalidrawGenericElement, NonDeleted, TextAlign, VerticalAlign, Arrowhead, ExcalidrawFreeDrawElement, FontFamilyValues, ExcalidrawTextContainer, ExcalidrawFrameElement, ExcalidrawEmbeddableElement, ExcalidrawMagicFrameElement, ExcalidrawIframeElement, ElementsMap, ExcalidrawArrowElement, ExcalidrawElbowArrowElement, ExcalidrawLineElement, ExcalidrawStickyNoteElement } from "./types";
|
|
3
|
+
export type ElementConstructorOpts = MarkOptional<Omit<ExcalidrawGenericElement, "id" | "type" | "isDeleted" | "updated">, "width" | "height" | "angle" | "groupIds" | "frameId" | "index" | "boundElements" | "seed" | "version" | "versionNonce" | "link" | "strokeStyle" | "fillStyle" | "strokeColor" | "backgroundColor" | "roughness" | "strokeWidth" | "roundness" | "locked" | "opacity" | "customData" | "created">;
|
|
4
4
|
export declare const newElement: (opts: {
|
|
5
5
|
type: ExcalidrawGenericElement["type"];
|
|
6
6
|
} & ElementConstructorOpts) => NonDeleted<ExcalidrawGenericElement>;
|
|
7
|
+
/**
|
|
8
|
+
* Style invariants of a sticky note: never-transparent colors, solid fill.
|
|
9
|
+
* Applied by the constructor and by every normalization pass. Returns the
|
|
10
|
+
* same object when nothing needs fixing.
|
|
11
|
+
*/
|
|
12
|
+
export declare const normalizeStickyNoteStyle: <T extends ExcalidrawStickyNoteElement>(element: T) => T;
|
|
13
|
+
/**
|
|
14
|
+
* Geometry invariants of a *finalized* sticky note: minimum size and
|
|
15
|
+
* `baseHeight ≤ height`. Deliberately not part of the constructor — a
|
|
16
|
+
* pointer-down draft starts at 0×0 like every other tool and is previewed at
|
|
17
|
+
* its true dragged size; pointer-up, restore, the skeleton path and the
|
|
18
|
+
* action post-passes enforce this.
|
|
19
|
+
*/
|
|
20
|
+
export declare const normalizeStickyNoteGeometry: <T extends ExcalidrawStickyNoteElement>(element: T) => T;
|
|
21
|
+
/** all sticky note invariants (style + finalized geometry) */
|
|
22
|
+
export declare const normalizeStickyNote: <T extends ExcalidrawStickyNoteElement>(element: T) => T;
|
|
23
|
+
export declare const newStickyNoteElement: (opts: {
|
|
24
|
+
type: "stickynote";
|
|
25
|
+
baseHeight?: number;
|
|
26
|
+
} & ElementConstructorOpts) => NonDeleted<ExcalidrawStickyNoteElement>;
|
|
7
27
|
export declare const newEmbeddableElement: (opts: {
|
|
8
28
|
type: "embeddable";
|
|
9
29
|
} & ElementConstructorOpts) => NonDeleted<ExcalidrawEmbeddableElement>;
|
|
@@ -39,8 +59,24 @@ export declare const newTextElement: (opts: {
|
|
|
39
59
|
containerId?: ExcalidrawTextContainer["id"] | null;
|
|
40
60
|
lineHeight?: ExcalidrawTextElement["lineHeight"];
|
|
41
61
|
autoResize?: ExcalidrawTextElement["autoResize"];
|
|
62
|
+
labelPosition?: ExcalidrawTextElement["labelPosition"];
|
|
63
|
+
baseFontSize?: ExcalidrawTextElement["baseFontSize"];
|
|
42
64
|
} & ElementConstructorOpts) => NonDeleted<ExcalidrawTextElement>;
|
|
43
|
-
export declare const refreshTextDimensions: (textElement: ExcalidrawTextElement, container: ExcalidrawTextContainer | null, elementsMap: ElementsMap, text?: string
|
|
65
|
+
export declare const refreshTextDimensions: (textElement: ExcalidrawTextElement, container: ExcalidrawTextContainer | null, elementsMap: ElementsMap, text?: string,
|
|
66
|
+
/**
|
|
67
|
+
* For a free text that grows with its content (`autoResize`): the widest
|
|
68
|
+
* it may grow to. Crossing it, the text stops growing and wraps at this
|
|
69
|
+
* width from then on (`autoResize: false`), anchored as its growth was. A
|
|
70
|
+
* text that is already wider keeps growing.
|
|
71
|
+
*/
|
|
72
|
+
maxWidth?: number) => {
|
|
73
|
+
x: number;
|
|
74
|
+
y: number;
|
|
75
|
+
width: number;
|
|
76
|
+
height: number;
|
|
77
|
+
text: string;
|
|
78
|
+
autoResize: boolean;
|
|
79
|
+
} | {
|
|
44
80
|
x: number;
|
|
45
81
|
y: number;
|
|
46
82
|
width: number;
|
|
@@ -1,9 +1,22 @@
|
|
|
1
1
|
import { type GlobalPoint } from "@excalidraw/math";
|
|
2
|
-
import type { AppState, StaticCanvasAppState, InteractiveCanvasAppState,
|
|
2
|
+
import type { AppState, StaticCanvasAppState, InteractiveCanvasAppState, ElementRenderOverrides } from "@excalidraw/excalidraw/types";
|
|
3
3
|
import type { StaticCanvasRenderConfig, RenderableElementsMap, InteractiveCanvasRenderConfig } from "@excalidraw/excalidraw/scene/types";
|
|
4
|
-
import type { ExcalidrawElement, ExcalidrawTextElement, NonDeletedExcalidrawElement, ExcalidrawFreeDrawElement, ExcalidrawImageElement,
|
|
4
|
+
import type { ExcalidrawElement, ExcalidrawTextElement, NonDeletedExcalidrawElement, ExcalidrawFreeDrawElement, ExcalidrawImageElement, NonDeletedSceneElementsMap, ElementsMap } from "./types";
|
|
5
5
|
import type { RoughCanvas } from "roughjs/bin/canvas";
|
|
6
|
-
export
|
|
6
|
+
export type RenderPositionOffset = Readonly<{
|
|
7
|
+
x: number;
|
|
8
|
+
y: number;
|
|
9
|
+
}>;
|
|
10
|
+
/** Bound labels follow their container; a label's own offset is ignored. */
|
|
11
|
+
export declare const getElementRenderOffset: (element: ExcalidrawElement, elementsMap: ElementsMap, overrides: ElementRenderOverrides | undefined) => RenderPositionOffset | undefined;
|
|
12
|
+
export declare const getRenderElementWithPositionOverride: <TElement extends ExcalidrawElement>(element: TElement, positionOffset: RenderPositionOffset) => TElement;
|
|
13
|
+
export type ElementRenderState = Readonly<{
|
|
14
|
+
/** Alpha including frame opacity and pending erasure; selection dimming is separate. */
|
|
15
|
+
opacity: number;
|
|
16
|
+
offset: RenderPositionOffset;
|
|
17
|
+
}>;
|
|
18
|
+
/** Resolve visual state at the drawing boundary, preserving document cache keys. */
|
|
19
|
+
export declare const resolveElementRenderState: (element: ExcalidrawElement, elementsMap: ElementsMap, renderConfig: Pick<StaticCanvasRenderConfig, "elementRenderOverrides" | "elementsPendingErasure" | "pendingFlowchartNodes">, allElementsMap?: ElementsMap) => ElementRenderState;
|
|
7
20
|
export interface ExcalidrawElementWithCanvas {
|
|
8
21
|
element: ExcalidrawElement | ExcalidrawTextElement;
|
|
9
22
|
canvas: HTMLCanvasElement;
|
|
@@ -18,5 +31,9 @@ export interface ExcalidrawElementWithCanvas {
|
|
|
18
31
|
export declare const DEFAULT_LINK_SIZE = 14;
|
|
19
32
|
export declare const elementWithCanvasCache: WeakMap<ExcalidrawElement, ExcalidrawElementWithCanvas>;
|
|
20
33
|
export declare const renderSelectionElement: (element: NonDeletedExcalidrawElement, context: CanvasRenderingContext2D, appState: InteractiveCanvasAppState, selectionColor: InteractiveCanvasRenderConfig["selectionColor"]) => void;
|
|
21
|
-
export declare const renderElement: (element: NonDeletedExcalidrawElement, elementsMap: RenderableElementsMap, allElementsMap: NonDeletedSceneElementsMap, rc: RoughCanvas, context: CanvasRenderingContext2D, renderConfig: StaticCanvasRenderConfig, appState: StaticCanvasAppState | InteractiveCanvasAppState
|
|
34
|
+
export declare const renderElement: (element: NonDeletedExcalidrawElement, elementsMap: RenderableElementsMap, allElementsMap: NonDeletedSceneElementsMap, rc: RoughCanvas, context: CanvasRenderingContext2D, renderConfig: StaticCanvasRenderConfig, appState: StaticCanvasAppState | InteractiveCanvasAppState, renderState?: Readonly<{
|
|
35
|
+
/** Alpha including frame opacity and pending erasure; selection dimming is separate. */
|
|
36
|
+
opacity: number;
|
|
37
|
+
offset: RenderPositionOffset;
|
|
38
|
+
}>) => void;
|
|
22
39
|
export declare function getFreedrawOutlineAsSegments(element: ExcalidrawFreeDrawElement, points: [number, number][], elementsMap: ElementsMap): import("@excalidraw/math").LineSegment<GlobalPoint>[];
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { type GeometricShape } from "@excalidraw/utils/shape";
|
|
2
2
|
import { type LocalPoint } from "@excalidraw/math";
|
|
3
|
-
import type { GlobalPoint } from "@excalidraw/math";
|
|
3
|
+
import type { GlobalPoint, Polygon } from "@excalidraw/math";
|
|
4
4
|
import type { AppState, EmbedsValidationStatus } from "@excalidraw/excalidraw/types";
|
|
5
5
|
import type { ElementShape, ElementShapes } from "@excalidraw/excalidraw/scene/types";
|
|
6
6
|
import type { ExcalidrawElement, ExcalidrawSelectionElement, ExcalidrawLinearElement, ExcalidrawFreeDrawElement, ElementsMap, ExcalidrawLineElement } from "./types";
|
|
@@ -27,6 +27,11 @@ export declare class ShapeCache {
|
|
|
27
27
|
} | null) => ((T["type"] extends keyof ElementShapes ? ElementShapes[T["type"]] | undefined : ElementShape | undefined) & {}) | (T["type"] extends keyof ElementShapes ? ElementShapes[T["type"]] : Drawable | null);
|
|
28
28
|
}
|
|
29
29
|
export declare const generateRoughOptions: (element: ExcalidrawElement, continuousPath?: boolean, isDarkMode?: boolean) => Options;
|
|
30
|
+
/**
|
|
31
|
+
* Returns the flattened fill contour of a freedraw loop in local, unrotated
|
|
32
|
+
* coordinates, following the rendered fill rather than the stroke outline.
|
|
33
|
+
*/
|
|
34
|
+
export declare const getFreedrawFillPolygon: (element: ExcalidrawFreeDrawElement) => Polygon<LocalPoint>;
|
|
30
35
|
export declare const generateLinearCollisionShape: (element: ExcalidrawLinearElement | ExcalidrawFreeDrawElement, elementsMap: ElementsMap) => {
|
|
31
36
|
op: string;
|
|
32
37
|
data: number[];
|
|
@@ -41,6 +46,15 @@ export declare const toggleLinePolygonState: (element: ExcalidrawLineElement, ne
|
|
|
41
46
|
points: ExcalidrawLineElement["points"];
|
|
42
47
|
} | null;
|
|
43
48
|
export declare const getFreedrawOutlinePoints: (element: ExcalidrawFreeDrawElement) => [number, number][];
|
|
49
|
+
/**
|
|
50
|
+
* Upper bound on how far a freedraw stroke's ink reaches past its centerline
|
|
51
|
+
* points. Both stroke generators scale the stroke size by at most 1 (easing
|
|
52
|
+
* or pressure), so the size itself bounds the radius, except for
|
|
53
|
+
* perfect-freehand's short strokes: under 3px long, the start cap is drawn
|
|
54
|
+
* around the first point from an outline point of the last one (reaching
|
|
55
|
+
* sqrt(size² + 3²)), and a single point gets a synthetic neighbor 1px away.
|
|
56
|
+
*/
|
|
57
|
+
export declare const getFreedrawMaxStrokeRadius: (element: ExcalidrawFreeDrawElement) => number;
|
|
44
58
|
/**
|
|
45
59
|
* The streamline-smoothed centerline the freedraw stroke is rendered
|
|
46
60
|
* around, in element-local coordinates. Boundary-sensitive consumers (e.g.
|
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
import type { AppState, Offsets, Zoom } from "@excalidraw/excalidraw/types";
|
|
2
2
|
import type { ElementsMap, ExcalidrawElement } from "./types";
|
|
3
|
+
export type VerticalResizeAnchor = "top" | "bottom" | "center";
|
|
4
|
+
/** Keeps the chosen edge or center fixed when an element's height changes. */
|
|
5
|
+
export declare const getPositionAfterHeightChange: (element: Pick<ExcalidrawElement, "x" | "y" | "height" | "angle">, nextHeight: number, anchor?: VerticalResizeAnchor) => {
|
|
6
|
+
x: number;
|
|
7
|
+
y: number;
|
|
8
|
+
};
|
|
3
9
|
export declare const INVISIBLY_SMALL_ELEMENT_SIZE = 0.1;
|
|
4
10
|
export declare const isInvisiblySmallElement: (element: ExcalidrawElement) => boolean;
|
|
5
11
|
export declare const isElementInViewport: (element: ExcalidrawElement, width: number, height: number, viewTransformations: {
|
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
import type { Scene } from "./Scene";
|
|
2
|
+
import type { VerticalResizeAnchor } from "./sizeHelpers";
|
|
3
|
+
import type { TransformHandleDirection } from "./transformHandles";
|
|
4
|
+
import type { ElementsMap, ExcalidrawElement, ExcalidrawStickyNoteElement, ExcalidrawTextElement, NonDeletedExcalidrawElement } from "./types";
|
|
5
|
+
export type StickyNoteRenderPoint = {
|
|
6
|
+
x: number;
|
|
7
|
+
y: number;
|
|
8
|
+
};
|
|
9
|
+
export type StickyNotePathCommand = {
|
|
10
|
+
type: "move";
|
|
11
|
+
point: StickyNoteRenderPoint;
|
|
12
|
+
} | {
|
|
13
|
+
type: "line";
|
|
14
|
+
point: StickyNoteRenderPoint;
|
|
15
|
+
} | {
|
|
16
|
+
type: "quadratic";
|
|
17
|
+
control: StickyNoteRenderPoint;
|
|
18
|
+
point: StickyNoteRenderPoint;
|
|
19
|
+
};
|
|
20
|
+
export declare const normalizeStickyNoteStrokeColor: (strokeColor: string | null | undefined) => string;
|
|
21
|
+
export declare const normalizeStickyNoteBackgroundColor: (backgroundColor: string | null | undefined) => string;
|
|
22
|
+
/**
|
|
23
|
+
* The update that applies a picked color to an element under the sticky
|
|
24
|
+
* note policy: a note is always filled and its label — the visible text,
|
|
25
|
+
* which the note's own `strokeColor` seeds — never goes transparent. Every
|
|
26
|
+
* color surface (actions, both eyedroppers, paste styles, bind) routes
|
|
27
|
+
* through this instead of re-deriving the rule.
|
|
28
|
+
*/
|
|
29
|
+
/**
|
|
30
|
+
* The element a color pick on `element` lands on. A note's label has no fill
|
|
31
|
+
* of its own, so a background pick on the label — the styles panel while
|
|
32
|
+
* editing it — goes to the note; everything else colors itself.
|
|
33
|
+
*/
|
|
34
|
+
export declare const getColorTargetElement: (element: ExcalidrawElement, property: "strokeColor" | "backgroundColor", elementsMap: ElementsMap) => ExcalidrawElement;
|
|
35
|
+
export declare const getColorUpdate: (element: ExcalidrawElement, property: "strokeColor" | "backgroundColor", color: string, elementsMap: ElementsMap) => {
|
|
36
|
+
strokeColor: string;
|
|
37
|
+
} | {
|
|
38
|
+
backgroundColor: string;
|
|
39
|
+
};
|
|
40
|
+
/**
|
|
41
|
+
* A note's ink is one color: the container's `strokeColor` — the seed for a
|
|
42
|
+
* new label and what the creation-date footer paints with — and its label's.
|
|
43
|
+
* Run after a property write to copy the side that changed onto the other;
|
|
44
|
+
* when both changed, or neither (data that drifted), the label wins: it is
|
|
45
|
+
* the text the user styled. A transparent label always takes the note's
|
|
46
|
+
* color. Returns the same array when nothing needs to change.
|
|
47
|
+
*/
|
|
48
|
+
export declare const syncStickyNoteInk: <T extends ExcalidrawElement>(elements: readonly T[], prevElementsMap: ElementsMap) => readonly T[];
|
|
49
|
+
export declare const getStickyNoteCornerRadius: (element: ExcalidrawStickyNoteElement) => number;
|
|
50
|
+
export declare const getStickyNoteRenderPoints: (element: ExcalidrawStickyNoteElement, { offsetX, offsetY, seedOffset, }?: {
|
|
51
|
+
offsetX?: number;
|
|
52
|
+
offsetY?: number;
|
|
53
|
+
seedOffset?: number;
|
|
54
|
+
}) => StickyNoteRenderPoint[];
|
|
55
|
+
export declare const getStickyNotePathCommands: (element: ExcalidrawStickyNoteElement, { shadow }?: {
|
|
56
|
+
shadow?: boolean;
|
|
57
|
+
}) => StickyNotePathCommand[];
|
|
58
|
+
export declare const normalizeStickyNoteFontSize: (fontSize: number) => number;
|
|
59
|
+
/** whether the text element is the label of a sticky note */
|
|
60
|
+
export declare const isStickyNoteBoundText: (textElement: ExcalidrawTextElement, elementsMap: ElementsMap) => boolean;
|
|
61
|
+
/**
|
|
62
|
+
* The font size the user picked: the ceiling the auto-fit shrinks from for a
|
|
63
|
+
* sticky note label, plain `fontSize` for any other text.
|
|
64
|
+
*
|
|
65
|
+
* Container-aware on purpose — generic binding repair (duplication, history)
|
|
66
|
+
* rewrites `containerId` without touching the ceiling, so a numeric
|
|
67
|
+
* `baseFontSize` alone does not prove the text is still sticky-bound.
|
|
68
|
+
*/
|
|
69
|
+
export declare const getBaseFontSize: (textElement: ExcalidrawTextElement, elementsMap: ElementsMap) => number;
|
|
70
|
+
/** the update that applies a user-picked font size (see `getBaseFontSize`) */
|
|
71
|
+
export declare const getBaseFontSizeUpdate: (textElement: ExcalidrawTextElement, fontSize: number, elementsMap: ElementsMap) => {
|
|
72
|
+
fontSize: number;
|
|
73
|
+
} | {
|
|
74
|
+
baseFontSize: number;
|
|
75
|
+
};
|
|
76
|
+
/**
|
|
77
|
+
* The creation-date label: absolute, so painting needs no clock and exports
|
|
78
|
+
* don't go stale, and short ("7 Sep") while the year is the current one.
|
|
79
|
+
* `null` when the note has no usable timestamp (files restored without one).
|
|
80
|
+
* Fixed English in the viewer's local time zone — the element package has no
|
|
81
|
+
* locale, and the footer is chosen by width bucket rather than measured.
|
|
82
|
+
*/
|
|
83
|
+
export declare const getStickyNoteDateLabel: (created: ExcalidrawStickyNoteElement["created"], { short, now }?: {
|
|
84
|
+
short?: boolean;
|
|
85
|
+
now?: number;
|
|
86
|
+
}) => string | null;
|
|
87
|
+
/**
|
|
88
|
+
* What the footer paints and where, in note-local coordinates — shared by the
|
|
89
|
+
* canvas and SVG renderers, which take the font and opacity from
|
|
90
|
+
* `STICKY_NOTE_FOOTER`. `null` for the 0×0 creation draft and anything under
|
|
91
|
+
* the data floor, where the band would overlap the top padding.
|
|
92
|
+
*/
|
|
93
|
+
export declare const getStickyNoteFooter: (element: Pick<ExcalidrawStickyNoteElement, "created" | "width" | "height">, now?: number) => {
|
|
94
|
+
text: string;
|
|
95
|
+
x: number;
|
|
96
|
+
y: number;
|
|
97
|
+
} | null;
|
|
98
|
+
/**
|
|
99
|
+
* The smallest note the UI lets a user create or resize to: one line at the
|
|
100
|
+
* label's font ceiling plus padding (and, vertically, the footer), never below
|
|
101
|
+
* `STICKY_NOTE_MIN_SIZE`. Without the font term a fresh note would grow on
|
|
102
|
+
* the very first keystroke. Data-level passes (restore, action post-passes)
|
|
103
|
+
* only enforce the constant floor — the layout grows a note as needed.
|
|
104
|
+
*/
|
|
105
|
+
export declare const getStickyNoteMinSize: ({ fontSize, fontFamily, }: Pick<ExcalidrawTextElement, "fontSize" | "fontFamily">) => {
|
|
106
|
+
width: number;
|
|
107
|
+
height: number;
|
|
108
|
+
};
|
|
109
|
+
export type StickyNoteLayoutAnchor = VerticalResizeAnchor;
|
|
110
|
+
export type StickyNoteLayoutOpts = {
|
|
111
|
+
/** unwrapped text to lay out; defaults to the label's `originalText` */
|
|
112
|
+
originalText?: string;
|
|
113
|
+
/**
|
|
114
|
+
* absolute base-height intent — the gesture-start value to preserve, or the
|
|
115
|
+
* height a resize asked for. Omitted = keep the note's live `baseHeight`
|
|
116
|
+
* (typing, style changes, restore).
|
|
117
|
+
*/
|
|
118
|
+
baseHeight?: number;
|
|
119
|
+
/**
|
|
120
|
+
* absolute font-ceiling intent (a proportional resize passes
|
|
121
|
+
* `gesture-start ceiling × scale`). Omitted = keep the label's live ceiling.
|
|
122
|
+
* Never a multiplier on the live value — that compounds across pointer-moves.
|
|
123
|
+
*/
|
|
124
|
+
baseFontSize?: number;
|
|
125
|
+
/** the edge that stays put when the content correction changes the height */
|
|
126
|
+
anchor?: StickyNoteLayoutAnchor;
|
|
127
|
+
};
|
|
128
|
+
export type StickyNoteLayout = {
|
|
129
|
+
container: Pick<ExcalidrawStickyNoteElement, "x" | "y" | "width" | "height" | "baseHeight">;
|
|
130
|
+
text: Pick<ExcalidrawTextElement, "text" | "fontSize" | "baseFontSize" | "width" | "height" | "x" | "y" | "angle"> | null;
|
|
131
|
+
};
|
|
132
|
+
/**
|
|
133
|
+
* The single source of truth for a sticky note's geometry: wraps the label at
|
|
134
|
+
* the note's width, fits the font under the ceiling, grows the note past
|
|
135
|
+
* `baseHeight` only when the text still overflows at the minimum size, and
|
|
136
|
+
* positions the label inside. Pure — returns the updates for both elements.
|
|
137
|
+
*/
|
|
138
|
+
export declare const getStickyNoteLayout: (container: ExcalidrawStickyNoteElement, textElement: ExcalidrawTextElement | null, opts?: StickyNoteLayoutOpts) => StickyNoteLayout;
|
|
139
|
+
/**
|
|
140
|
+
* Resize intents for a sticky note — the §3.3 matrix of the plan. Every value
|
|
141
|
+
* is absolute and derived from the gesture-start snapshot on each pointer-move,
|
|
142
|
+
* so releasing Shift (or Alt) mid-gesture restores the original base height
|
|
143
|
+
* and ceiling instead of keeping values a previous move scaled.
|
|
144
|
+
*
|
|
145
|
+
* - width-only gestures (free E/W, Stats W) preserve the base height
|
|
146
|
+
* - height-changing gestures use the requested height as the new base
|
|
147
|
+
* - proportional gestures (Shift on any handle, aspect-locked multi-select,
|
|
148
|
+
* Stats group) additionally scale the font ceiling with the note
|
|
149
|
+
* - flips preserve everything
|
|
150
|
+
* - the content correction anchors at the edge the gesture holds still
|
|
151
|
+
*/
|
|
152
|
+
export declare const getStickyNoteResizeIntent: (
|
|
153
|
+
/** the note with the requested geometry already applied */
|
|
154
|
+
container: ExcalidrawStickyNoteElement, originalElementsMap: ElementsMap, handleDirection: TransformHandleDirection, { proportional, fromCenter, flip, }: {
|
|
155
|
+
proportional: boolean;
|
|
156
|
+
fromCenter: boolean;
|
|
157
|
+
flip?: boolean;
|
|
158
|
+
}) => Pick<StickyNoteLayoutOpts, "baseHeight" | "baseFontSize" | "anchor">;
|
|
159
|
+
/**
|
|
160
|
+
* Applies `getStickyNoteLayout` to a live scene, then runs the bound-arrow
|
|
161
|
+
* pass unless the caller already owns one (`bindings: false`) or needs to
|
|
162
|
+
* forward its context (`bindings: { simultaneouslyUpdated }` — arrows resized
|
|
163
|
+
* in the same gesture must not be moved by the pass, `updateBoundElements`
|
|
164
|
+
* skips them only when told).
|
|
165
|
+
*/
|
|
166
|
+
export declare const updateStickyNoteLayout: (container: ExcalidrawStickyNoteElement, scene: Scene, { text, bindings, ...layoutOpts }?: StickyNoteLayoutOpts & {
|
|
167
|
+
/** the label to lay out when it is an uncommitted clone (font actions clone before install) */
|
|
168
|
+
text?: ExcalidrawTextElement | null;
|
|
169
|
+
bindings?: {
|
|
170
|
+
simultaneouslyUpdated?: readonly NonDeletedExcalidrawElement[];
|
|
171
|
+
} | false;
|
|
172
|
+
}) => StickyNoteLayout;
|
|
173
|
+
/**
|
|
174
|
+
* Applies `getStickyNoteLayout` inside an immutable elements array (property
|
|
175
|
+
* actions, paste styles, restore): the notes among `affectedIds` — or the
|
|
176
|
+
* notes whose labels are — get both halves merged into their clones. Elements
|
|
177
|
+
* that need no change keep their identity and version; when `prevElementsMap`
|
|
178
|
+
* is given, notes whose layout inputs did not change skip the fit entirely.
|
|
179
|
+
* Bound arrows are the caller's job once the result is installed.
|
|
180
|
+
*/
|
|
181
|
+
export declare const relayoutStickyNotes: <T extends ExcalidrawElement>(elements: readonly T[], affectedIds: ReadonlySet<ExcalidrawElement["id"]>, opts?: {
|
|
182
|
+
prevElementsMap?: ElementsMap;
|
|
183
|
+
}) => readonly T[];
|
|
@@ -4,7 +4,7 @@ import type { Scene } from "./Scene";
|
|
|
4
4
|
import type { MaybeTransformHandleType } from "./transformHandles";
|
|
5
5
|
import type { ElementsMap, ExcalidrawElement, ExcalidrawElementType, ExcalidrawTextContainer, ExcalidrawTextElement, ExcalidrawTextElementWithContainer, NonDeleted } from "./types";
|
|
6
6
|
export declare const redrawTextBoundingBox: (textElement: ExcalidrawTextElement, container: ExcalidrawElement | null, scene: Scene) => void;
|
|
7
|
-
export declare const handleBindTextResize: (container: ExcalidrawElement, scene: Scene, transformHandleType: MaybeTransformHandleType, shouldMaintainAspectRatio?: boolean, shouldResizeFromCenter?: boolean) => void;
|
|
7
|
+
export declare const handleBindTextResize: (container: ExcalidrawElement, scene: Scene, transformHandleType: MaybeTransformHandleType, shouldMaintainAspectRatio?: boolean, shouldResizeFromCenter?: boolean, flipByY?: boolean) => void;
|
|
8
8
|
export declare const computeBoundTextPosition: (container: ExcalidrawElement, boundTextElement: ExcalidrawTextElementWithContainer, elementsMap: ElementsMap) => {
|
|
9
9
|
x: number;
|
|
10
10
|
y: number;
|
|
@@ -29,6 +29,13 @@ export declare const getBoundTextElementPosition: (container: ExcalidrawElement,
|
|
|
29
29
|
x: number;
|
|
30
30
|
y: number;
|
|
31
31
|
} | undefined;
|
|
32
|
+
/**
|
|
33
|
+
* Returns the text element with its accurate coords. An arrow label's
|
|
34
|
+
* position is derived from the arrow at render time rather than kept in
|
|
35
|
+
* sync on the element itself (see getBoundTextElementPosition), so
|
|
36
|
+
* consumers reading a label's coords directly must go through this helper.
|
|
37
|
+
*/
|
|
38
|
+
export declare const getTextElementWithAccuratePosition: <T extends ExcalidrawTextElement>(textElement: T, elementsMap: ElementsMap) => T;
|
|
32
39
|
export declare const shouldAllowVerticalAlign: (selectedElements: readonly ExcalidrawElement[], elementsMap: ElementsMap) => boolean;
|
|
33
40
|
export declare const suppportsHorizontalAlign: (selectedElements: readonly ExcalidrawElement[], elementsMap: ElementsMap) => boolean;
|
|
34
41
|
declare const VALID_CONTAINER_TYPES: Set<string>;
|
|
@@ -40,4 +47,5 @@ export declare const getBoundTextMaxWidth: (container: ExcalidrawElement, boundT
|
|
|
40
47
|
export declare const getBoundTextMaxHeight: (container: ExcalidrawElement, boundTextElement: ExcalidrawTextElementWithContainer) => number;
|
|
41
48
|
/** retrieves text from text elements and concatenates to a single string */
|
|
42
49
|
export declare const getTextFromElements: (elements: readonly ExcalidrawElement[], separator?: string) => string;
|
|
50
|
+
export declare const DEFAULT_BOUND_TEXT_LABEL_POSITION = 0.5;
|
|
43
51
|
export {};
|