Compare commits
12 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 7859531efe | |||
| 3b47fe2f87 | |||
| d73f700fa8 | |||
| ae1195a8f2 | |||
| 81ab857a6f | |||
| e8b4620a96 | |||
| 2b0e4c9623 | |||
| c9ba7f839c | |||
| b4ce7c713b | |||
| 816c81c12e | |||
| 92d25446d6 | |||
| e73a5b0116 |
@@ -172,7 +172,7 @@ convertToExcalidrawElements([
|
||||
type: "arrow",
|
||||
x: 450,
|
||||
y: 20,
|
||||
startArrowhead: "dot",
|
||||
startArrowhead: "circle",
|
||||
endArrowhead: "triangle",
|
||||
strokeColor: "#1971c2",
|
||||
strokeWidth: 2,
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import type { ExcalidrawElementSkeleton } from "@excalidraw/excalidraw/data/transform";
|
||||
import type { ExcalidrawElementSkeleton } from "@excalidraw/excalidraw/element/transform";
|
||||
import type { FileId } from "@excalidraw/excalidraw/element/types";
|
||||
|
||||
const elements: ExcalidrawElementSkeleton[] = [
|
||||
|
||||
@@ -3,24 +3,41 @@ import {
|
||||
CloseIcon,
|
||||
TrashIcon,
|
||||
} from "@excalidraw/excalidraw/components/icons";
|
||||
import { useExcalidrawAPI } from "@excalidraw/excalidraw/index";
|
||||
import {
|
||||
bootstrapCanvas,
|
||||
fillCircle,
|
||||
getNormalizedCanvasDimensions,
|
||||
} from "@excalidraw/excalidraw/renderer/helpers";
|
||||
import { type AppState } from "@excalidraw/excalidraw/types";
|
||||
import { arrayToMap, throttleRAF } from "@excalidraw/common";
|
||||
import { useCallback } from "react";
|
||||
import {
|
||||
arrayToMap,
|
||||
sceneCoordsToViewportCoords,
|
||||
throttleRAF,
|
||||
viewportCoordsToSceneCoords,
|
||||
} from "@excalidraw/common";
|
||||
import { useCallback, useEffect, useRef, useState } from "react";
|
||||
|
||||
import {
|
||||
CaptureUpdateAction,
|
||||
clearSimpleArrowTangentOverride,
|
||||
getGlobalFixedPointForBindableElement,
|
||||
getElementAbsoluteCoords,
|
||||
getSimpleArrowCurveDebugData,
|
||||
isArrowElement,
|
||||
isBindableElement,
|
||||
setSimpleArrowTangentOverride,
|
||||
ShapeCache,
|
||||
} from "@excalidraw/element";
|
||||
|
||||
import {
|
||||
isLineSegment,
|
||||
pointFrom,
|
||||
pointRotateRads,
|
||||
type GlobalPoint,
|
||||
type LocalPoint,
|
||||
type LineSegment,
|
||||
type Radians,
|
||||
} from "@excalidraw/math";
|
||||
import { isCurve } from "@excalidraw/math/curve";
|
||||
|
||||
@@ -36,11 +53,260 @@ import type {
|
||||
ExcalidrawArrowElement,
|
||||
ExcalidrawBindableElement,
|
||||
FixedPointBinding,
|
||||
Ordered,
|
||||
OrderedExcalidrawElement,
|
||||
} from "@excalidraw/element/types";
|
||||
import type { SimpleArrowCurveDebugData } from "@excalidraw/element";
|
||||
|
||||
import { STORAGE_KEYS } from "../app_constants";
|
||||
|
||||
type DebugCanvasOverlayState = Pick<
|
||||
AppState,
|
||||
| "width"
|
||||
| "height"
|
||||
| "zoom"
|
||||
| "scrollX"
|
||||
| "scrollY"
|
||||
| "offsetLeft"
|
||||
| "offsetTop"
|
||||
| "selectedElementIds"
|
||||
>;
|
||||
|
||||
type SimpleArrowHandleDirection = "incoming" | "outgoing";
|
||||
|
||||
type SimpleArrowHandleDescriptor = {
|
||||
key: string;
|
||||
elementId: string;
|
||||
pointIndex: number;
|
||||
direction: SimpleArrowHandleDirection;
|
||||
point: GlobalPoint;
|
||||
handle: GlobalPoint;
|
||||
isOverridden: boolean;
|
||||
title: string;
|
||||
};
|
||||
|
||||
type SelectedSimpleArrowDebugState = {
|
||||
element: ExcalidrawArrowElement;
|
||||
debugData: SimpleArrowCurveDebugData<GlobalPoint>;
|
||||
handles: SimpleArrowHandleDescriptor[];
|
||||
};
|
||||
|
||||
const areSimpleArrowTangentHandlesEnabled = () =>
|
||||
window.EXCALIDRAW_DEBUG_LINEAR_ARROW_TANGENTS !== false;
|
||||
|
||||
const pickOverlayState = (appState: AppState): DebugCanvasOverlayState => ({
|
||||
width: appState.width,
|
||||
height: appState.height,
|
||||
zoom: appState.zoom,
|
||||
scrollX: appState.scrollX,
|
||||
scrollY: appState.scrollY,
|
||||
offsetLeft: appState.offsetLeft,
|
||||
offsetTop: appState.offsetTop,
|
||||
selectedElementIds: appState.selectedElementIds,
|
||||
});
|
||||
|
||||
const getSimpleArrowTransform = (
|
||||
element: ExcalidrawArrowElement,
|
||||
elementsMap: ElementsMap,
|
||||
) => {
|
||||
const [, , , , cx, cy] = getElementAbsoluteCoords(element, elementsMap);
|
||||
const center = pointFrom<GlobalPoint>(cx, cy);
|
||||
|
||||
return {
|
||||
pointToGlobal: (point: LocalPoint): GlobalPoint => {
|
||||
const rotated = pointRotateRads(
|
||||
pointFrom<GlobalPoint>(element.x + point[0], element.y + point[1]),
|
||||
center,
|
||||
element.angle,
|
||||
);
|
||||
|
||||
return pointFrom<GlobalPoint>(rotated[0], rotated[1]);
|
||||
},
|
||||
vectorToGlobal: (vector: [number, number]): [number, number] => {
|
||||
const rotated = pointRotateRads(
|
||||
pointFrom<GlobalPoint>(vector[0], vector[1]),
|
||||
pointFrom<GlobalPoint>(0, 0),
|
||||
element.angle,
|
||||
);
|
||||
|
||||
return [rotated[0], rotated[1]];
|
||||
},
|
||||
vectorToLocal: (vector: [number, number]): [number, number] => {
|
||||
const rotated = pointRotateRads(
|
||||
pointFrom<GlobalPoint>(vector[0], vector[1]),
|
||||
pointFrom<GlobalPoint>(0, 0),
|
||||
-element.angle as Radians,
|
||||
);
|
||||
|
||||
return [rotated[0], rotated[1]];
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
const getSimpleArrowDebugStateForElement = (
|
||||
elements: readonly OrderedExcalidrawElement[],
|
||||
elementId: string,
|
||||
): SelectedSimpleArrowDebugState | null => {
|
||||
const element = elements.find(
|
||||
(candidate): candidate is Ordered<ExcalidrawArrowElement> =>
|
||||
candidate.id === elementId &&
|
||||
!candidate.isDeleted &&
|
||||
isArrowElement(candidate) &&
|
||||
!!candidate.roundness &&
|
||||
!candidate.elbowed,
|
||||
);
|
||||
|
||||
if (!element) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const elementsMap = arrayToMap(elements);
|
||||
const transform = getSimpleArrowTransform(element, elementsMap);
|
||||
const localDebugData = getSimpleArrowCurveDebugData(element.points, 0.5, {
|
||||
elementId: element.id,
|
||||
});
|
||||
const debugData: SimpleArrowCurveDebugData<GlobalPoint> = {
|
||||
...localDebugData,
|
||||
tangents: localDebugData.tangents.map((tangent) => ({
|
||||
...tangent,
|
||||
point: transform.pointToGlobal(tangent.point as LocalPoint),
|
||||
base: transform.vectorToGlobal(tangent.base),
|
||||
autoScaled: transform.vectorToGlobal(tangent.autoScaled),
|
||||
scaled: transform.vectorToGlobal(tangent.scaled),
|
||||
})),
|
||||
segments: localDebugData.segments.map((segment) => ({
|
||||
...segment,
|
||||
start: transform.pointToGlobal(segment.start as LocalPoint),
|
||||
end: transform.pointToGlobal(segment.end as LocalPoint),
|
||||
baseCp1: transform.pointToGlobal(segment.baseCp1 as LocalPoint),
|
||||
baseCp2: transform.pointToGlobal(segment.baseCp2 as LocalPoint),
|
||||
cp1: transform.pointToGlobal(segment.cp1 as LocalPoint),
|
||||
cp2: transform.pointToGlobal(segment.cp2 as LocalPoint),
|
||||
})),
|
||||
};
|
||||
const handles = debugData.tangents.flatMap((tangent, pointIndex) => {
|
||||
const descriptors: SimpleArrowHandleDescriptor[] = [];
|
||||
const lengthRatio =
|
||||
tangent.normalized.finalLengthVsMinNeighbor === null
|
||||
? "n/a"
|
||||
: tangent.normalized.finalLengthVsMinNeighbor.toFixed(3);
|
||||
const angleDelta = tangent.normalized.angleDelta.toFixed(3);
|
||||
const title = `point ${pointIndex} · len/min ${lengthRatio} · dAngle ${angleDelta} · dblclick resets`;
|
||||
|
||||
if (pointIndex < debugData.tangents.length - 1) {
|
||||
descriptors.push({
|
||||
key: `${element.id}:${pointIndex}:out`,
|
||||
elementId: element.id,
|
||||
pointIndex,
|
||||
direction: "outgoing",
|
||||
point: tangent.point,
|
||||
handle: pointFrom<GlobalPoint>(
|
||||
tangent.point[0] + tangent.scaled[0] / 3,
|
||||
tangent.point[1] + tangent.scaled[1] / 3,
|
||||
),
|
||||
isOverridden: tangent.isOverridden,
|
||||
title,
|
||||
});
|
||||
}
|
||||
|
||||
if (pointIndex > 0) {
|
||||
descriptors.push({
|
||||
key: `${element.id}:${pointIndex}:in`,
|
||||
elementId: element.id,
|
||||
pointIndex,
|
||||
direction: "incoming",
|
||||
point: tangent.point,
|
||||
handle: pointFrom<GlobalPoint>(
|
||||
tangent.point[0] - tangent.scaled[0] / 3,
|
||||
tangent.point[1] - tangent.scaled[1] / 3,
|
||||
),
|
||||
isOverridden: tangent.isOverridden,
|
||||
title,
|
||||
});
|
||||
}
|
||||
|
||||
return descriptors;
|
||||
});
|
||||
|
||||
return {
|
||||
element,
|
||||
debugData,
|
||||
handles,
|
||||
};
|
||||
};
|
||||
|
||||
const getSelectedSimpleArrowDebugState = (
|
||||
elements: readonly OrderedExcalidrawElement[],
|
||||
appState: Pick<AppState, "selectedElementIds">,
|
||||
) => {
|
||||
const selectedIds = Object.keys(appState.selectedElementIds);
|
||||
|
||||
if (selectedIds.length !== 1) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return getSimpleArrowDebugStateForElement(elements, selectedIds[0]);
|
||||
};
|
||||
|
||||
const renderSelectedSimpleArrowTangentOverlay = (
|
||||
context: CanvasRenderingContext2D,
|
||||
zoom: number,
|
||||
debugState: SelectedSimpleArrowDebugState,
|
||||
) => {
|
||||
context.save();
|
||||
context.lineWidth = 1;
|
||||
|
||||
context.setLineDash([6, 4]);
|
||||
context.strokeStyle = "rgba(134, 142, 150, 0.75)";
|
||||
|
||||
for (const segment of debugState.debugData.segments) {
|
||||
context.beginPath();
|
||||
context.moveTo(segment.start[0] * zoom, segment.start[1] * zoom);
|
||||
context.lineTo(segment.baseCp1[0] * zoom, segment.baseCp1[1] * zoom);
|
||||
context.lineTo(segment.baseCp2[0] * zoom, segment.baseCp2[1] * zoom);
|
||||
context.lineTo(segment.end[0] * zoom, segment.end[1] * zoom);
|
||||
context.stroke();
|
||||
}
|
||||
|
||||
context.setLineDash([]);
|
||||
|
||||
for (const segment of debugState.debugData.segments) {
|
||||
context.strokeStyle = segment.overshootsBaseline
|
||||
? "rgba(245, 159, 0, 0.9)"
|
||||
: "rgba(94, 90, 216, 0.85)";
|
||||
|
||||
context.beginPath();
|
||||
context.moveTo(segment.start[0] * zoom, segment.start[1] * zoom);
|
||||
context.lineTo(segment.cp1[0] * zoom, segment.cp1[1] * zoom);
|
||||
context.lineTo(segment.cp2[0] * zoom, segment.cp2[1] * zoom);
|
||||
context.lineTo(segment.end[0] * zoom, segment.end[1] * zoom);
|
||||
context.stroke();
|
||||
}
|
||||
|
||||
for (const tangent of debugState.debugData.tangents) {
|
||||
if (!tangent.isAdjusted) {
|
||||
continue;
|
||||
}
|
||||
|
||||
context.strokeStyle = tangent.isOverridden
|
||||
? "rgba(230, 73, 128, 0.95)"
|
||||
: "rgba(201, 42, 42, 0.85)";
|
||||
context.fillStyle = tangent.isOverridden
|
||||
? "rgba(230, 73, 128, 0.95)"
|
||||
: "rgba(201, 42, 42, 0.95)";
|
||||
|
||||
fillCircle(
|
||||
context,
|
||||
tangent.point[0] * zoom,
|
||||
tangent.point[1] * zoom,
|
||||
3,
|
||||
true,
|
||||
);
|
||||
}
|
||||
|
||||
context.restore();
|
||||
};
|
||||
|
||||
const renderLine = (
|
||||
context: CanvasRenderingContext2D,
|
||||
zoom: number,
|
||||
@@ -359,6 +625,13 @@ const _debugRenderer = (
|
||||
renderOrigin(context, appState.zoom.value);
|
||||
renderBindings(context, elements, appState.zoom.value);
|
||||
|
||||
const selectedSimpleArrowDebugState = areSimpleArrowTangentHandlesEnabled()
|
||||
? getSelectedSimpleArrowDebugState(elements, appState)
|
||||
: null;
|
||||
|
||||
window.EXCALIDRAW_DEBUG_SELECTED_LINEAR_ARROW =
|
||||
selectedSimpleArrowDebugState?.debugData;
|
||||
|
||||
if (
|
||||
window.visualDebug?.currentFrame &&
|
||||
window.visualDebug?.data &&
|
||||
@@ -375,6 +648,14 @@ const _debugRenderer = (
|
||||
});
|
||||
}
|
||||
|
||||
if (selectedSimpleArrowDebugState) {
|
||||
renderSelectedSimpleArrowTangentOverlay(
|
||||
context,
|
||||
appState.zoom.value,
|
||||
selectedSimpleArrowDebugState,
|
||||
);
|
||||
}
|
||||
|
||||
if (window.visualDebug) {
|
||||
window.visualDebug!.data =
|
||||
window.visualDebug?.data.map((frame) =>
|
||||
@@ -542,23 +823,324 @@ interface DebugCanvasProps {
|
||||
|
||||
const DebugCanvas = React.forwardRef<HTMLCanvasElement, DebugCanvasProps>(
|
||||
({ appState, scale }, ref) => {
|
||||
const { width, height } = appState;
|
||||
const excalidrawAPI = useExcalidrawAPI();
|
||||
const [overlayState, setOverlayState] = useState<DebugCanvasOverlayState>(
|
||||
() => pickOverlayState(appState),
|
||||
);
|
||||
const [selectedSimpleArrowDebugState, setSelectedSimpleArrowDebugState] =
|
||||
useState<SelectedSimpleArrowDebugState | null>(null);
|
||||
const dragStateRef = useRef<{
|
||||
elementId: string;
|
||||
pointIndex: number;
|
||||
direction: SimpleArrowHandleDirection;
|
||||
} | null>(null);
|
||||
|
||||
const syncSelectedSimpleArrowDebugState = useCallback(
|
||||
(
|
||||
nextAppState: AppState,
|
||||
nextElements?: readonly OrderedExcalidrawElement[],
|
||||
) => {
|
||||
if (!excalidrawAPI || excalidrawAPI.isDestroyed) {
|
||||
return;
|
||||
}
|
||||
|
||||
const elements =
|
||||
nextElements ??
|
||||
(excalidrawAPI.getSceneElements() as OrderedExcalidrawElement[]);
|
||||
|
||||
setOverlayState(pickOverlayState(nextAppState));
|
||||
|
||||
const nextDebugState = areSimpleArrowTangentHandlesEnabled()
|
||||
? getSelectedSimpleArrowDebugState(elements, nextAppState)
|
||||
: null;
|
||||
|
||||
window.EXCALIDRAW_DEBUG_SELECTED_LINEAR_ARROW =
|
||||
nextDebugState?.debugData;
|
||||
setSelectedSimpleArrowDebugState(nextDebugState);
|
||||
},
|
||||
[excalidrawAPI],
|
||||
);
|
||||
|
||||
useEffect(() => {
|
||||
if (!excalidrawAPI || excalidrawAPI.isDestroyed) {
|
||||
return;
|
||||
}
|
||||
|
||||
syncSelectedSimpleArrowDebugState(excalidrawAPI.getAppState());
|
||||
|
||||
const unsubscribeChange = excalidrawAPI.onChange(
|
||||
(elements, nextAppState) =>
|
||||
syncSelectedSimpleArrowDebugState(
|
||||
nextAppState,
|
||||
elements as readonly OrderedExcalidrawElement[],
|
||||
),
|
||||
);
|
||||
const unsubscribeState = excalidrawAPI.onStateChange(
|
||||
[
|
||||
"selectedElementIds",
|
||||
"zoom",
|
||||
"scrollX",
|
||||
"scrollY",
|
||||
"offsetLeft",
|
||||
"offsetTop",
|
||||
"width",
|
||||
"height",
|
||||
],
|
||||
(_value, nextAppState) =>
|
||||
syncSelectedSimpleArrowDebugState(nextAppState),
|
||||
);
|
||||
|
||||
return () => {
|
||||
unsubscribeChange();
|
||||
unsubscribeState();
|
||||
};
|
||||
}, [excalidrawAPI, syncSelectedSimpleArrowDebugState]);
|
||||
|
||||
const rerenderSceneForSimpleArrowOverride = useCallback(() => {
|
||||
if (!excalidrawAPI || excalidrawAPI.isDestroyed) {
|
||||
return;
|
||||
}
|
||||
|
||||
excalidrawAPI.updateScene({
|
||||
elements: excalidrawAPI.getSceneElementsIncludingDeleted(),
|
||||
captureUpdate: CaptureUpdateAction.NEVER,
|
||||
});
|
||||
}, [excalidrawAPI]);
|
||||
|
||||
const commitOverrideForHandle = useCallback(
|
||||
(
|
||||
handle: Pick<
|
||||
SimpleArrowHandleDescriptor,
|
||||
"elementId" | "pointIndex" | "direction"
|
||||
>,
|
||||
clientX: number,
|
||||
clientY: number,
|
||||
) => {
|
||||
if (!excalidrawAPI || excalidrawAPI.isDestroyed) {
|
||||
return;
|
||||
}
|
||||
|
||||
const nextAppState = excalidrawAPI.getAppState();
|
||||
const nextElements =
|
||||
excalidrawAPI.getSceneElements() as OrderedExcalidrawElement[];
|
||||
const debugState = getSimpleArrowDebugStateForElement(
|
||||
nextElements,
|
||||
handle.elementId,
|
||||
);
|
||||
|
||||
if (!debugState) {
|
||||
return;
|
||||
}
|
||||
|
||||
const scenePoint = viewportCoordsToSceneCoords(
|
||||
{ clientX, clientY },
|
||||
nextAppState,
|
||||
);
|
||||
const tangent =
|
||||
handle.direction === "outgoing"
|
||||
? ([
|
||||
(scenePoint.x -
|
||||
debugState.debugData.tangents[handle.pointIndex].point[0]) *
|
||||
3,
|
||||
(scenePoint.y -
|
||||
debugState.debugData.tangents[handle.pointIndex].point[1]) *
|
||||
3,
|
||||
] as [number, number])
|
||||
: ([
|
||||
(debugState.debugData.tangents[handle.pointIndex].point[0] -
|
||||
scenePoint.x) *
|
||||
3,
|
||||
(debugState.debugData.tangents[handle.pointIndex].point[1] -
|
||||
scenePoint.y) *
|
||||
3,
|
||||
] as [number, number]);
|
||||
const localTangent = getSimpleArrowTransform(
|
||||
debugState.element,
|
||||
arrayToMap(nextElements),
|
||||
).vectorToLocal(tangent);
|
||||
|
||||
setSimpleArrowTangentOverride(
|
||||
debugState.element.id,
|
||||
handle.pointIndex,
|
||||
localTangent,
|
||||
);
|
||||
ShapeCache.delete(debugState.element);
|
||||
rerenderSceneForSimpleArrowOverride();
|
||||
syncSelectedSimpleArrowDebugState(nextAppState, nextElements);
|
||||
},
|
||||
[
|
||||
excalidrawAPI,
|
||||
rerenderSceneForSimpleArrowOverride,
|
||||
syncSelectedSimpleArrowDebugState,
|
||||
],
|
||||
);
|
||||
|
||||
const onPointerMove = useCallback(
|
||||
(event: PointerEvent) => {
|
||||
if (!dragStateRef.current) {
|
||||
return;
|
||||
}
|
||||
|
||||
event.preventDefault();
|
||||
commitOverrideForHandle(
|
||||
dragStateRef.current,
|
||||
event.clientX,
|
||||
event.clientY,
|
||||
);
|
||||
},
|
||||
[commitOverrideForHandle],
|
||||
);
|
||||
|
||||
const onPointerUp = useCallback(
|
||||
(event: PointerEvent) => {
|
||||
if (!dragStateRef.current) {
|
||||
return;
|
||||
}
|
||||
|
||||
event.preventDefault();
|
||||
dragStateRef.current = null;
|
||||
window.removeEventListener("pointermove", onPointerMove);
|
||||
window.removeEventListener("pointerup", onPointerUp);
|
||||
window.removeEventListener("pointercancel", onPointerUp);
|
||||
},
|
||||
[onPointerMove],
|
||||
);
|
||||
|
||||
useEffect(() => {
|
||||
return () => {
|
||||
dragStateRef.current = null;
|
||||
window.removeEventListener("pointermove", onPointerMove);
|
||||
window.removeEventListener("pointerup", onPointerUp);
|
||||
window.removeEventListener("pointercancel", onPointerUp);
|
||||
};
|
||||
}, [onPointerMove, onPointerUp]);
|
||||
|
||||
const handlePointerDown = useCallback(
|
||||
(
|
||||
handle: SimpleArrowHandleDescriptor,
|
||||
event: React.PointerEvent<HTMLDivElement>,
|
||||
) => {
|
||||
event.preventDefault();
|
||||
event.stopPropagation();
|
||||
|
||||
dragStateRef.current = {
|
||||
elementId: handle.elementId,
|
||||
pointIndex: handle.pointIndex,
|
||||
direction: handle.direction,
|
||||
};
|
||||
|
||||
window.addEventListener("pointermove", onPointerMove, {
|
||||
passive: false,
|
||||
});
|
||||
window.addEventListener("pointerup", onPointerUp, {
|
||||
passive: false,
|
||||
});
|
||||
window.addEventListener("pointercancel", onPointerUp, {
|
||||
passive: false,
|
||||
});
|
||||
|
||||
commitOverrideForHandle(handle, event.clientX, event.clientY);
|
||||
},
|
||||
[commitOverrideForHandle, onPointerMove, onPointerUp],
|
||||
);
|
||||
|
||||
const resetHandleOverride = useCallback(
|
||||
(
|
||||
handle: SimpleArrowHandleDescriptor,
|
||||
event: React.MouseEvent<HTMLDivElement>,
|
||||
) => {
|
||||
event.preventDefault();
|
||||
event.stopPropagation();
|
||||
|
||||
if (!excalidrawAPI || excalidrawAPI.isDestroyed) {
|
||||
return;
|
||||
}
|
||||
|
||||
clearSimpleArrowTangentOverride(handle.elementId, handle.pointIndex);
|
||||
|
||||
const nextElements =
|
||||
excalidrawAPI.getSceneElements() as OrderedExcalidrawElement[];
|
||||
const element = nextElements.find(
|
||||
(candidate): candidate is Ordered<ExcalidrawArrowElement> =>
|
||||
candidate.id === handle.elementId &&
|
||||
!candidate.isDeleted &&
|
||||
isArrowElement(candidate),
|
||||
);
|
||||
|
||||
if (element) {
|
||||
ShapeCache.delete(element);
|
||||
rerenderSceneForSimpleArrowOverride();
|
||||
}
|
||||
|
||||
syncSelectedSimpleArrowDebugState(
|
||||
excalidrawAPI.getAppState(),
|
||||
nextElements,
|
||||
);
|
||||
},
|
||||
[
|
||||
excalidrawAPI,
|
||||
rerenderSceneForSimpleArrowOverride,
|
||||
syncSelectedSimpleArrowDebugState,
|
||||
],
|
||||
);
|
||||
|
||||
const { width, height } = overlayState;
|
||||
|
||||
return (
|
||||
<canvas
|
||||
style={{
|
||||
width,
|
||||
height,
|
||||
position: "absolute",
|
||||
zIndex: 2,
|
||||
pointerEvents: "none",
|
||||
}}
|
||||
width={width * scale}
|
||||
height={height * scale}
|
||||
ref={ref}
|
||||
>
|
||||
Debug Canvas
|
||||
</canvas>
|
||||
<>
|
||||
<canvas
|
||||
style={{
|
||||
width,
|
||||
height,
|
||||
position: "absolute",
|
||||
inset: 0,
|
||||
zIndex: 2,
|
||||
pointerEvents: "none",
|
||||
}}
|
||||
width={width * scale}
|
||||
height={height * scale}
|
||||
ref={ref}
|
||||
>
|
||||
Debug Canvas
|
||||
</canvas>
|
||||
{selectedSimpleArrowDebugState?.handles.map((handle) => {
|
||||
const { x, y } = sceneCoordsToViewportCoords(
|
||||
{
|
||||
sceneX: handle.handle[0],
|
||||
sceneY: handle.handle[1],
|
||||
},
|
||||
overlayState,
|
||||
);
|
||||
|
||||
return (
|
||||
<div
|
||||
key={handle.key}
|
||||
title={handle.title}
|
||||
onPointerDown={(event) => handlePointerDown(handle, event)}
|
||||
onDoubleClick={(event) => resetHandleOverride(handle, event)}
|
||||
style={{
|
||||
position: "absolute",
|
||||
left: x - overlayState.offsetLeft,
|
||||
top: y - overlayState.offsetTop,
|
||||
width: 12,
|
||||
height: 12,
|
||||
zIndex: 3,
|
||||
borderRadius: handle.direction === "outgoing" ? "999px" : 3,
|
||||
transform: "translate(-50%, -50%)",
|
||||
background: handle.isOverridden
|
||||
? "rgba(230, 73, 128, 0.95)"
|
||||
: handle.direction === "outgoing"
|
||||
? "rgba(94, 90, 216, 0.95)"
|
||||
: "rgba(245, 159, 0, 0.95)",
|
||||
border: "2px solid rgba(255,255,255,0.95)",
|
||||
boxShadow: "0 0 0 1px rgba(0, 0, 0, 0.18)",
|
||||
pointerEvents: "auto",
|
||||
cursor: "grab",
|
||||
}}
|
||||
/>
|
||||
);
|
||||
})}
|
||||
</>
|
||||
);
|
||||
},
|
||||
);
|
||||
|
||||
@@ -1822,7 +1822,7 @@ exports[`Test Transform > should transform the elements correctly when linear el
|
||||
"versionNonce": Any<Number>,
|
||||
"verticalAlign": "middle",
|
||||
"width": 120,
|
||||
"x": 187.75450000000004,
|
||||
"x": 187.7545,
|
||||
"y": 44.5,
|
||||
}
|
||||
`;
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
import type { Arrowhead, AnyArrowhead } from "./types";
|
||||
|
||||
export const normalizeArrowhead = (
|
||||
arrowhead: AnyArrowhead | null | undefined,
|
||||
): Arrowhead | null => {
|
||||
switch (arrowhead) {
|
||||
case undefined:
|
||||
case null:
|
||||
return null;
|
||||
case "dot":
|
||||
return "circle";
|
||||
case "crowfoot_one":
|
||||
return "cardinality_one";
|
||||
case "crowfoot_many":
|
||||
return "cardinality_many";
|
||||
case "crowfoot_one_or_many":
|
||||
return "cardinality_one_or_many";
|
||||
default:
|
||||
return arrowhead;
|
||||
}
|
||||
};
|
||||
|
||||
export const getArrowheadForPicker = (
|
||||
arrowhead: AnyArrowhead | null | undefined,
|
||||
): Arrowhead | null => {
|
||||
const normalizedArrowhead = normalizeArrowhead(arrowhead);
|
||||
if (normalizedArrowhead === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return normalizedArrowhead;
|
||||
};
|
||||
@@ -709,6 +709,9 @@ const getFreeDrawElementAbsoluteCoords = (
|
||||
return [x1, y1, x2, y2, (x1 + x2) / 2, (y1 + y2) / 2];
|
||||
};
|
||||
|
||||
const CARDINALITY_MARKER_SIZE = 20;
|
||||
const CROWFOOT_ARROWHEAD_SIZE = 15;
|
||||
|
||||
/** @returns number in pixels */
|
||||
export const getArrowheadSize = (arrowhead: Arrowhead): number => {
|
||||
switch (arrowhead) {
|
||||
@@ -717,10 +720,14 @@ export const getArrowheadSize = (arrowhead: Arrowhead): number => {
|
||||
case "diamond":
|
||||
case "diamond_outline":
|
||||
return 12;
|
||||
case "crowfoot_many":
|
||||
case "crowfoot_one":
|
||||
case "crowfoot_one_or_many":
|
||||
return 20;
|
||||
case "cardinality_many":
|
||||
case "cardinality_one_or_many":
|
||||
case "cardinality_zero_or_many":
|
||||
return CROWFOOT_ARROWHEAD_SIZE;
|
||||
case "cardinality_one":
|
||||
case "cardinality_exactly_one":
|
||||
case "cardinality_zero_or_one":
|
||||
return CARDINALITY_MARKER_SIZE;
|
||||
default:
|
||||
return 15;
|
||||
}
|
||||
@@ -743,7 +750,12 @@ export const getArrowheadPoints = (
|
||||
shape: Drawable[],
|
||||
position: "start" | "end",
|
||||
arrowhead: Arrowhead,
|
||||
offsetMultiplier = 0,
|
||||
) => {
|
||||
if (arrowhead === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (shape.length < 1) {
|
||||
return null;
|
||||
}
|
||||
@@ -777,27 +789,41 @@ export const getArrowheadPoints = (
|
||||
p0 = pointFrom(prevOp.data[4], prevOp.data[5]);
|
||||
}
|
||||
|
||||
// B(t) = p0 * (1-t)^3 + 3p1 * t * (1-t)^2 + 3p2 * t^2 * (1-t) + p3 * t^3
|
||||
const equation = (t: number, idx: number) =>
|
||||
Math.pow(1 - t, 3) * p3[idx] +
|
||||
3 * t * Math.pow(1 - t, 2) * p2[idx] +
|
||||
3 * Math.pow(t, 2) * (1 - t) * p1[idx] +
|
||||
p0[idx] * Math.pow(t, 3);
|
||||
|
||||
// Ee know the last point of the arrow (or the first, if start arrowhead).
|
||||
// We know the last point of the arrow (or the first, if start arrowhead).
|
||||
const [x2, y2] = position === "start" ? p0 : p3;
|
||||
|
||||
// By using cubic bezier equation (B(t)) and the given parameters,
|
||||
// we calculate a point that is closer to the last point.
|
||||
// The value 0.3 is chosen arbitrarily and it works best for all
|
||||
// the tested cases.
|
||||
const [x1, y1] = [equation(0.3, 0), equation(0.3, 1)];
|
||||
|
||||
// Find the normalized direction vector based on the
|
||||
// previously calculated points.
|
||||
const distance = Math.hypot(x2 - x1, y2 - y1);
|
||||
const nx = (x2 - x1) / distance;
|
||||
const ny = (y2 - y1) / distance;
|
||||
// Use the analytic tangent at the Bézier endpoint for a precise arrowhead
|
||||
// direction. For a cubic Bézier B(t) with control points p0p3:
|
||||
// B'(1): (p3 − p2) tangent at the end
|
||||
// B'(0): (p1 − p0) for start arrowhead, arrow points away: (p0 − p1)
|
||||
let dx: number;
|
||||
let dy: number;
|
||||
if (position === "end") {
|
||||
dx = p3[0] - p2[0];
|
||||
dy = p3[1] - p2[1];
|
||||
if (Math.hypot(dx, dy) < 1e-6) {
|
||||
dx = p3[0] - p1[0];
|
||||
dy = p3[1] - p1[1];
|
||||
}
|
||||
if (Math.hypot(dx, dy) < 1e-6) {
|
||||
dx = p3[0] - p0[0];
|
||||
dy = p3[1] - p0[1];
|
||||
}
|
||||
} else {
|
||||
dx = p0[0] - p1[0];
|
||||
dy = p0[1] - p1[1];
|
||||
if (Math.hypot(dx, dy) < 1e-6) {
|
||||
dx = p0[0] - p2[0];
|
||||
dy = p0[1] - p2[1];
|
||||
}
|
||||
if (Math.hypot(dx, dy) < 1e-6) {
|
||||
dx = p0[0] - p3[0];
|
||||
dy = p0[1] - p3[1];
|
||||
}
|
||||
}
|
||||
const distance = Math.hypot(dx, dy);
|
||||
const nx = dx / distance;
|
||||
const ny = dy / distance;
|
||||
|
||||
const size = getArrowheadSize(arrowhead);
|
||||
|
||||
@@ -824,29 +850,30 @@ export const getArrowheadPoints = (
|
||||
const lengthMultiplier =
|
||||
arrowhead === "diamond" || arrowhead === "diamond_outline" ? 0.25 : 0.5;
|
||||
const minSize = Math.min(size, length * lengthMultiplier);
|
||||
const xs = x2 - nx * minSize;
|
||||
const ys = y2 - ny * minSize;
|
||||
const tx = x2 - nx * minSize * offsetMultiplier;
|
||||
const ty = y2 - ny * minSize * offsetMultiplier;
|
||||
const xs = tx - nx * minSize;
|
||||
const ys = ty - ny * minSize;
|
||||
|
||||
if (
|
||||
arrowhead === "dot" ||
|
||||
arrowhead === "circle" ||
|
||||
arrowhead === "circle_outline"
|
||||
) {
|
||||
const diameter = Math.hypot(ys - y2, xs - x2) + element.strokeWidth - 2;
|
||||
return [x2, y2, diameter];
|
||||
if (arrowhead === "circle" || arrowhead === "circle_outline") {
|
||||
const diameter = Math.hypot(ys - ty, xs - tx) + element.strokeWidth - 2;
|
||||
return [tx, ty, diameter];
|
||||
}
|
||||
|
||||
const angle = getArrowheadAngle(arrowhead);
|
||||
|
||||
if (arrowhead === "crowfoot_many" || arrowhead === "crowfoot_one_or_many") {
|
||||
if (
|
||||
arrowhead === "cardinality_many" ||
|
||||
arrowhead === "cardinality_one_or_many"
|
||||
) {
|
||||
// swap (xs, ys) with (x2, y2)
|
||||
const [x3, y3] = pointRotateRads(
|
||||
pointFrom(x2, y2),
|
||||
pointFrom(tx, ty),
|
||||
pointFrom(xs, ys),
|
||||
degreesToRadians(-angle as Degrees),
|
||||
);
|
||||
const [x4, y4] = pointRotateRads(
|
||||
pointFrom(x2, y2),
|
||||
pointFrom(tx, ty),
|
||||
pointFrom(xs, ys),
|
||||
degreesToRadians(angle),
|
||||
);
|
||||
@@ -856,12 +883,12 @@ export const getArrowheadPoints = (
|
||||
// Return points
|
||||
const [x3, y3] = pointRotateRads(
|
||||
pointFrom(xs, ys),
|
||||
pointFrom(x2, y2),
|
||||
pointFrom(tx, ty),
|
||||
((-angle * Math.PI) / 180) as Radians,
|
||||
);
|
||||
const [x4, y4] = pointRotateRads(
|
||||
pointFrom(xs, ys),
|
||||
pointFrom(x2, y2),
|
||||
pointFrom(tx, ty),
|
||||
degreesToRadians(angle),
|
||||
);
|
||||
|
||||
@@ -874,9 +901,9 @@ export const getArrowheadPoints = (
|
||||
const [px, py] = element.points.length > 1 ? element.points[1] : [0, 0];
|
||||
|
||||
[ox, oy] = pointRotateRads(
|
||||
pointFrom(x2 + minSize * 2, y2),
|
||||
pointFrom(x2, y2),
|
||||
Math.atan2(py - y2, px - x2) as Radians,
|
||||
pointFrom(tx + minSize * 2, ty),
|
||||
pointFrom(tx, ty),
|
||||
Math.atan2(py - ty, px - tx) as Radians,
|
||||
);
|
||||
} else {
|
||||
const [px, py] =
|
||||
@@ -885,16 +912,16 @@ export const getArrowheadPoints = (
|
||||
: [0, 0];
|
||||
|
||||
[ox, oy] = pointRotateRads(
|
||||
pointFrom(x2 - minSize * 2, y2),
|
||||
pointFrom(x2, y2),
|
||||
Math.atan2(y2 - py, x2 - px) as Radians,
|
||||
pointFrom(tx - minSize * 2, ty),
|
||||
pointFrom(tx, ty),
|
||||
Math.atan2(ty - py, tx - px) as Radians,
|
||||
);
|
||||
}
|
||||
|
||||
return [x2, y2, x3, y3, ox, oy, x4, y4];
|
||||
return [tx, ty, x3, y3, ox, oy, x4, y4];
|
||||
}
|
||||
|
||||
return [x2, y2, x3, y3, x4, y4];
|
||||
return [tx, ty, x3, y3, x4, y4];
|
||||
};
|
||||
|
||||
// TODO reuse shape.ts
|
||||
|
||||
@@ -99,3 +99,4 @@ export * from "./typeChecks";
|
||||
export * from "./utils";
|
||||
export * from "./zindex";
|
||||
export * from "./arrows/helpers";
|
||||
export * from "./arrowheads";
|
||||
|
||||
@@ -784,9 +784,20 @@ export class LinearElementEditor {
|
||||
elementsMap,
|
||||
);
|
||||
|
||||
// For curved (non-elbow) arrows the quadratic spline produces N-2 arcs
|
||||
// for N anchor points. Cap the loop to the actual segment count so we
|
||||
// don't request a midpoint for a segment that doesn't exist.
|
||||
const [lines, segCurves] = deconstructLinearOrFreeDrawElement(element);
|
||||
const segmentCount = lines.length + segCurves.length;
|
||||
|
||||
let index = 0;
|
||||
const midpoints: (GlobalPoint | null)[] = [];
|
||||
while (index < points.length - 1) {
|
||||
if (segmentCount > 0 && index >= segmentCount) {
|
||||
midpoints.push(null);
|
||||
index++;
|
||||
continue;
|
||||
}
|
||||
if (
|
||||
LinearElementEditor.isSegmentTooShort(
|
||||
element,
|
||||
|
||||
@@ -11,6 +11,7 @@ import {
|
||||
isBoundToContainer,
|
||||
isFrameLikeElement,
|
||||
isLinearElement,
|
||||
isTextElement,
|
||||
} from "./typeChecks";
|
||||
import {
|
||||
elementOverlapsWithFrame,
|
||||
@@ -25,6 +26,7 @@ import type {
|
||||
ElementsMap,
|
||||
ElementsMapOrArray,
|
||||
ExcalidrawElement,
|
||||
NonDeleted,
|
||||
NonDeletedExcalidrawElement,
|
||||
} from "./types";
|
||||
|
||||
@@ -288,3 +290,19 @@ export const getSelectionStateForElements = (
|
||||
),
|
||||
};
|
||||
};
|
||||
|
||||
/**
|
||||
* Returns editing or single-selected text element, if any.
|
||||
*/
|
||||
export const getActiveTextElement = (
|
||||
selectedElements: readonly NonDeleted<ExcalidrawElement>[],
|
||||
appState: Pick<AppState, "editingTextElement">,
|
||||
) => {
|
||||
const activeTextElement =
|
||||
appState.editingTextElement ||
|
||||
(selectedElements.length === 1 &&
|
||||
isTextElement(selectedElements[0]) &&
|
||||
selectedElements[0]);
|
||||
|
||||
return activeTextElement || null;
|
||||
};
|
||||
|
||||
+997
-137
File diff suppressed because it is too large
Load Diff
@@ -441,7 +441,8 @@ const VALID_CONTAINER_TYPES = new Set([
|
||||
|
||||
export const isValidTextContainer = (element: {
|
||||
type: ExcalidrawElementType;
|
||||
}) => VALID_CONTAINER_TYPES.has(element.type);
|
||||
}): element is ExcalidrawTextContainer =>
|
||||
VALID_CONTAINER_TYPES.has(element.type);
|
||||
|
||||
export const computeContainerDimensionForBoundText = (
|
||||
dimension: number,
|
||||
|
||||
@@ -4,6 +4,22 @@ import { charWidth, getLineWidth } from "./textMeasurements";
|
||||
|
||||
import type { FontString } from "./types";
|
||||
|
||||
/**
|
||||
* This module approximates browser-like soft wrapping for Excalidraw text.
|
||||
*
|
||||
* The flow is:
|
||||
* 1. `parseTokens()` splits a hard line into breakable tokens using a unicode-aware regex.
|
||||
* 2. `getWrappedTextLines()` reflows each hard line into one or more visual lines and
|
||||
* records where each visual line came from in the source text.
|
||||
* 3. `wrapLine()` assembles tokens into lines, and `wrapWord()` handles a single token
|
||||
* that is wider than the available width.
|
||||
* 4. `trimLine()` / `trimLineEndAtSoftBreak()` mirror browser behavior around trailing
|
||||
* whitespace so the rendered text stays consistent with what users see on canvas.
|
||||
*
|
||||
* Mostly, you'll want to use wrapText(). getWrappedTextLines() is for callers
|
||||
* that need metadata such as mapping visual lines back to `originalText`
|
||||
* for caret placement or future editor features.
|
||||
*/
|
||||
let cachedCjkRegex: RegExp | undefined;
|
||||
let cachedLineBreakRegex: RegExp | undefined;
|
||||
let cachedEmojiRegex: RegExp | undefined;
|
||||
@@ -358,6 +374,10 @@ const Break = {
|
||||
|
||||
/**
|
||||
* Breaks the line into the tokens based on the found line break opporutnities.
|
||||
*
|
||||
* Note: tokenization normalizes to NFC first so decomposed graphemes are treated as
|
||||
* their composed variants for wrapping. Any code that needs exact source offsets should
|
||||
* keep in mind that this assumes the input text is already NFC-normalized.
|
||||
*/
|
||||
export const parseTokens = (line: string) => {
|
||||
const breakLineRegex = getLineBreakRegex();
|
||||
@@ -370,56 +390,120 @@ export const parseTokens = (line: string) => {
|
||||
|
||||
/**
|
||||
* Wraps the original text into the lines based on the given width.
|
||||
*
|
||||
* This is a convenience adapter over `getWrappedTextLines()` for call sites
|
||||
* that only need the rendered wrapped string and not the source offsets.
|
||||
*/
|
||||
export const wrapText = (
|
||||
text: string,
|
||||
font: FontString,
|
||||
maxWidth: number,
|
||||
): string => {
|
||||
return getWrappedTextLines(text, font, maxWidth)
|
||||
.map((line) => line.text)
|
||||
.join("\n");
|
||||
};
|
||||
|
||||
/**
|
||||
* A single rendered visual line produced from the original text.
|
||||
*
|
||||
* `start` and `end` are end-exclusive code-unit offsets into the original text, and do
|
||||
* not include synthetic soft line breaks inserted by this module. If trailing whitespace
|
||||
* was trimmed away at a wrap boundary, `end` points to the last rendered character.
|
||||
*/
|
||||
export type WrappedTextLine = {
|
||||
text: string;
|
||||
start: number;
|
||||
end: number;
|
||||
};
|
||||
|
||||
/**
|
||||
* Splits only on existing hard line breaks and preserves original offsets.
|
||||
*/
|
||||
const getHardLineBreaks = (text: string): WrappedTextLine[] => {
|
||||
let offset = 0;
|
||||
|
||||
return text.split("\n").map((line) => {
|
||||
const start = offset;
|
||||
const end = start + line.length;
|
||||
|
||||
offset = end + 1;
|
||||
|
||||
return {
|
||||
text: line,
|
||||
start,
|
||||
end,
|
||||
};
|
||||
});
|
||||
};
|
||||
|
||||
/**
|
||||
* Returns the rendered visual lines together with their source offsets.
|
||||
*
|
||||
* This is the source-of-truth wrapping pipeline for callers that need more than the
|
||||
* final wrapped string, for example caret placement or future editor/rich-text mapping.
|
||||
*/
|
||||
export const getWrappedTextLines = (
|
||||
text: string,
|
||||
font: FontString,
|
||||
maxWidth: number,
|
||||
): WrappedTextLine[] => {
|
||||
// if maxWidth is not finite or NaN which can happen in case of bugs in
|
||||
// computation, we need to make sure we don't continue as we'll end up
|
||||
// in an infinite loop
|
||||
if (!Number.isFinite(maxWidth) || maxWidth < 0) {
|
||||
return text;
|
||||
return getHardLineBreaks(text);
|
||||
}
|
||||
|
||||
const lines: Array<string> = [];
|
||||
const originalLines = text.split("\n");
|
||||
const lines: WrappedTextLine[] = [];
|
||||
let offset = 0;
|
||||
|
||||
for (const originalLine of originalLines) {
|
||||
const currentLineWidth = getLineWidth(originalLine, font);
|
||||
for (const originalLine of text.split("\n")) {
|
||||
const originalLineWidth = getLineWidth(originalLine, font);
|
||||
|
||||
if (currentLineWidth <= maxWidth) {
|
||||
lines.push(originalLine);
|
||||
continue;
|
||||
if (originalLineWidth <= maxWidth) {
|
||||
lines.push({
|
||||
text: originalLine,
|
||||
start: offset,
|
||||
end: offset + originalLine.length,
|
||||
});
|
||||
} else {
|
||||
lines.push(...wrapLine(originalLine, font, maxWidth, offset));
|
||||
}
|
||||
|
||||
const wrappedLine = wrapLine(originalLine, font, maxWidth);
|
||||
lines.push(...wrappedLine);
|
||||
offset += originalLine.length + 1;
|
||||
}
|
||||
|
||||
return lines.join("\n");
|
||||
return lines;
|
||||
};
|
||||
|
||||
/**
|
||||
* Wraps the original line into the lines based on the given width.
|
||||
* Wraps a single hard line into one or more visual lines.
|
||||
*
|
||||
* The line-local offsets are tracked in original-text code units so
|
||||
* we can map the visual line back to the source.
|
||||
*/
|
||||
const wrapLine = (
|
||||
line: string,
|
||||
font: FontString,
|
||||
maxWidth: number,
|
||||
): string[] => {
|
||||
const lines: Array<string> = [];
|
||||
lineStart: number,
|
||||
): WrappedTextLine[] => {
|
||||
const lines: WrappedTextLine[] = [];
|
||||
const tokens = parseTokens(line);
|
||||
const tokenIterator = tokens[Symbol.iterator]();
|
||||
|
||||
let currentLine = "";
|
||||
let currentLineStart = lineStart;
|
||||
let currentLineEnd = lineStart;
|
||||
let currentLineWidth = 0;
|
||||
// Tracks the next token's code-unit position in the original source string.
|
||||
let tokenOffset = lineStart;
|
||||
let tokenIndex = 0;
|
||||
|
||||
let iterator = tokenIterator.next();
|
||||
|
||||
while (!iterator.done) {
|
||||
const token = iterator.value;
|
||||
while (tokenIndex < tokens.length) {
|
||||
const token = tokens[tokenIndex];
|
||||
const tokenStart = tokenOffset;
|
||||
const tokenEnd = tokenStart + token.length;
|
||||
const testLine = currentLine + token;
|
||||
|
||||
// cache single codepoint whitespace, CJK or emoji width calc. as kerning should not apply here
|
||||
@@ -429,37 +513,59 @@ const wrapLine = (
|
||||
|
||||
// build up the current line, skipping length check for possibly trailing whitespaces
|
||||
if (/\s/.test(token) || testLineWidth <= maxWidth) {
|
||||
if (!currentLine) {
|
||||
currentLineStart = tokenStart;
|
||||
}
|
||||
currentLine = testLine;
|
||||
currentLineEnd = tokenEnd;
|
||||
currentLineWidth = testLineWidth;
|
||||
iterator = tokenIterator.next();
|
||||
tokenOffset = tokenEnd;
|
||||
tokenIndex++;
|
||||
continue;
|
||||
}
|
||||
|
||||
// current line is empty => just the token (word) is longer than `maxWidth` and needs to be wrapped
|
||||
if (!currentLine) {
|
||||
const wrappedWord = wrapWord(token, font, maxWidth);
|
||||
const trailingLine = wrappedWord[wrappedWord.length - 1] ?? "";
|
||||
const wrappedWord = wrapWord(token, font, maxWidth, tokenStart);
|
||||
const trailingLine = wrappedWord[wrappedWord.length - 1] ?? {
|
||||
text: "",
|
||||
start: tokenStart,
|
||||
end: tokenStart,
|
||||
};
|
||||
const precedingLines = wrappedWord.slice(0, -1);
|
||||
|
||||
lines.push(...precedingLines);
|
||||
|
||||
// trailing line of the wrapped word might still be joined with next token/s
|
||||
currentLine = trailingLine;
|
||||
currentLineWidth = getLineWidth(trailingLine, font);
|
||||
iterator = tokenIterator.next();
|
||||
currentLine = trailingLine.text;
|
||||
currentLineStart = trailingLine.start;
|
||||
currentLineEnd = trailingLine.end;
|
||||
currentLineWidth = getLineWidth(trailingLine.text, font);
|
||||
tokenOffset = tokenEnd;
|
||||
tokenIndex++;
|
||||
} else {
|
||||
// push & reset, but don't iterate on the next token, as we didn't use it yet!
|
||||
lines.push(currentLine.trimEnd());
|
||||
lines.push(
|
||||
trimLineEndAtSoftBreak(currentLine, currentLineStart, currentLineEnd),
|
||||
);
|
||||
|
||||
// purposefully not iterating and not setting `currentLine` to `token`, so that we could use a simple !currentLine check above
|
||||
currentLine = "";
|
||||
currentLineStart = tokenStart;
|
||||
currentLineEnd = tokenStart;
|
||||
currentLineWidth = 0;
|
||||
}
|
||||
}
|
||||
|
||||
// iterator done, push the trailing line if exists
|
||||
if (currentLine) {
|
||||
const trailingLine = trimLine(currentLine, font, maxWidth);
|
||||
const trailingLine = trimLine(
|
||||
currentLine,
|
||||
currentLineStart,
|
||||
currentLineEnd,
|
||||
font,
|
||||
maxWidth,
|
||||
);
|
||||
lines.push(trailingLine);
|
||||
}
|
||||
|
||||
@@ -467,59 +573,100 @@ const wrapLine = (
|
||||
};
|
||||
|
||||
/**
|
||||
* Wraps the word into the lines based on the given width.
|
||||
* Wraps a single word that could not be placed on an empty line as-is.
|
||||
*/
|
||||
const wrapWord = (
|
||||
word: string,
|
||||
font: FontString,
|
||||
maxWidth: number,
|
||||
): Array<string> => {
|
||||
wordStart: number,
|
||||
): WrappedTextLine[] => {
|
||||
// multi-codepoint emojis are already broken apart and shouldn't be broken further
|
||||
if (getEmojiRegex().test(word)) {
|
||||
return [word];
|
||||
return [
|
||||
{
|
||||
text: word,
|
||||
start: wordStart,
|
||||
end: wordStart + word.length,
|
||||
},
|
||||
];
|
||||
}
|
||||
|
||||
satisfiesWordInvariant(word);
|
||||
|
||||
const lines: Array<string> = [];
|
||||
const lines: WrappedTextLine[] = [];
|
||||
const chars = Array.from(word);
|
||||
|
||||
let currentLine = "";
|
||||
let currentLineStart = wordStart;
|
||||
let currentLineEnd = wordStart;
|
||||
let currentLineWidth = 0;
|
||||
let offset = wordStart;
|
||||
|
||||
for (const char of chars) {
|
||||
const charStart = offset;
|
||||
const charEnd = charStart + char.length;
|
||||
const _charWidth = charWidth.calculate(char, font);
|
||||
const testLineWidth = currentLineWidth + _charWidth;
|
||||
|
||||
if (testLineWidth <= maxWidth) {
|
||||
if (!currentLine) {
|
||||
currentLineStart = charStart;
|
||||
}
|
||||
currentLine = currentLine + char;
|
||||
currentLineEnd = charEnd;
|
||||
currentLineWidth = testLineWidth;
|
||||
offset = charEnd;
|
||||
continue;
|
||||
}
|
||||
|
||||
if (currentLine) {
|
||||
lines.push(currentLine);
|
||||
lines.push({
|
||||
text: currentLine,
|
||||
start: currentLineStart,
|
||||
end: currentLineEnd,
|
||||
});
|
||||
}
|
||||
|
||||
currentLine = char;
|
||||
currentLineStart = charStart;
|
||||
currentLineEnd = charEnd;
|
||||
currentLineWidth = _charWidth;
|
||||
offset = charEnd;
|
||||
}
|
||||
|
||||
if (currentLine) {
|
||||
lines.push(currentLine);
|
||||
lines.push({
|
||||
text: currentLine,
|
||||
start: currentLineStart,
|
||||
end: currentLineEnd,
|
||||
});
|
||||
}
|
||||
|
||||
return lines;
|
||||
};
|
||||
|
||||
/**
|
||||
* Similarly to browsers, does not trim all trailing whitespaces, but only those exceeding the `maxWidth`.
|
||||
* Trims trailing whitespace that is exceeding the `maxWidth`.
|
||||
*
|
||||
* Used for the trailing visual line of a hard line, where some trailing
|
||||
* whitespace may still be visible if it fits into the available width.
|
||||
*/
|
||||
const trimLine = (line: string, font: FontString, maxWidth: number) => {
|
||||
const trimLine = (
|
||||
line: string,
|
||||
start: number,
|
||||
end: number,
|
||||
font: FontString,
|
||||
maxWidth: number,
|
||||
): WrappedTextLine => {
|
||||
const shouldTrimWhitespaces = getLineWidth(line, font) > maxWidth;
|
||||
|
||||
if (!shouldTrimWhitespaces) {
|
||||
return line;
|
||||
return {
|
||||
text: line,
|
||||
start,
|
||||
end,
|
||||
};
|
||||
}
|
||||
|
||||
// defensively default to `trimeEnd` in case the regex does not match
|
||||
@@ -543,7 +690,30 @@ const trimLine = (line: string, font: FontString, maxWidth: number) => {
|
||||
trimmedLineWidth = testLineWidth;
|
||||
}
|
||||
|
||||
return trimmedLine;
|
||||
return {
|
||||
text: trimmedLine,
|
||||
start,
|
||||
end: end - (line.length - trimmedLine.length),
|
||||
};
|
||||
};
|
||||
|
||||
/**
|
||||
* Used for internal soft-wrap boundaries, where trailing whitespace should not
|
||||
* survive into the rendered line even though it still exists in the original
|
||||
* text.
|
||||
*/
|
||||
const trimLineEndAtSoftBreak = (
|
||||
line: string,
|
||||
start: number,
|
||||
end: number,
|
||||
): WrappedTextLine => {
|
||||
const trimmedLine = line.trimEnd();
|
||||
|
||||
return {
|
||||
text: trimmedLine,
|
||||
start,
|
||||
end: end - (line.length - trimmedLine.length),
|
||||
};
|
||||
};
|
||||
|
||||
/**
|
||||
|
||||
@@ -303,19 +303,32 @@ export type PointsPositionUpdates = Map<
|
||||
{ point: LocalPoint; isDragging?: boolean }
|
||||
>;
|
||||
|
||||
export type CardinalityArrowhead =
|
||||
| "cardinality_one"
|
||||
| "cardinality_many"
|
||||
| "cardinality_one_or_many"
|
||||
| "cardinality_exactly_one"
|
||||
| "cardinality_zero_or_one"
|
||||
| "cardinality_zero_or_many";
|
||||
|
||||
export type ArrowheadLegacy =
|
||||
| "dot"
|
||||
| "crowfoot_one"
|
||||
| "crowfoot_many"
|
||||
| "crowfoot_one_or_many";
|
||||
|
||||
export type Arrowhead =
|
||||
| "arrow"
|
||||
| "bar"
|
||||
| "dot" // legacy. Do not use for new elements.
|
||||
| "circle"
|
||||
| "circle_outline"
|
||||
| "triangle"
|
||||
| "triangle_outline"
|
||||
| "diamond"
|
||||
| "diamond_outline"
|
||||
| "crowfoot_one"
|
||||
| "crowfoot_many"
|
||||
| "crowfoot_one_or_many";
|
||||
| CardinalityArrowhead;
|
||||
|
||||
export type AnyArrowhead = Arrowhead | ArrowheadLegacy;
|
||||
|
||||
export type ExcalidrawLinearElement = _ExcalidrawElementBase &
|
||||
Readonly<{
|
||||
|
||||
@@ -135,9 +135,9 @@ describe("getElementBounds", () => {
|
||||
} as ExcalidrawLinearElement;
|
||||
|
||||
const [x1, y1, x2, y2] = getElementBounds(element, arrayToMap([element]));
|
||||
expect(x1).toEqual(360.9291017525165);
|
||||
expect(y1).toEqual(185.24770129343722);
|
||||
expect(x2).toEqual(481.4815539037601);
|
||||
expect(y2).toEqual(319.8162855827246);
|
||||
expect(x1).toEqual(360.3176068760539);
|
||||
expect(y1).toEqual(185.90654264413516);
|
||||
expect(x2).toEqual(486.6924560404731);
|
||||
expect(y2).toEqual(320.391865303557);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -434,12 +434,12 @@ describe("Test Linear Elements", () => {
|
||||
expect(midPointsWithRoundEdge).toMatchInlineSnapshot(`
|
||||
[
|
||||
[
|
||||
"54.27552",
|
||||
"46.16120",
|
||||
"53.63967",
|
||||
"47.15774",
|
||||
],
|
||||
[
|
||||
"76.95494",
|
||||
"44.56052",
|
||||
"78.65236",
|
||||
"44.31886",
|
||||
],
|
||||
]
|
||||
`);
|
||||
@@ -499,12 +499,12 @@ describe("Test Linear Elements", () => {
|
||||
expect(newMidPoints).toMatchInlineSnapshot(`
|
||||
[
|
||||
[
|
||||
"104.27552",
|
||||
"66.16120",
|
||||
"103.63967",
|
||||
"67.15774",
|
||||
],
|
||||
[
|
||||
"126.95494",
|
||||
"64.56052",
|
||||
"128.65236",
|
||||
"64.31886",
|
||||
],
|
||||
]
|
||||
`);
|
||||
@@ -815,12 +815,12 @@ describe("Test Linear Elements", () => {
|
||||
expect(newMidPoints).toMatchInlineSnapshot(`
|
||||
[
|
||||
[
|
||||
"29.28349",
|
||||
"20.91105",
|
||||
"28.64089",
|
||||
"21.69997",
|
||||
],
|
||||
[
|
||||
"78.86048",
|
||||
"46.12277",
|
||||
"82.34322",
|
||||
"47.57759",
|
||||
],
|
||||
]
|
||||
`);
|
||||
@@ -904,12 +904,12 @@ describe("Test Linear Elements", () => {
|
||||
expect(newMidPoints).toMatchInlineSnapshot(`
|
||||
[
|
||||
[
|
||||
"54.27552",
|
||||
"46.16120",
|
||||
"53.63967",
|
||||
"47.15774",
|
||||
],
|
||||
[
|
||||
"76.95494",
|
||||
"44.56052",
|
||||
"78.65236",
|
||||
"44.31886",
|
||||
],
|
||||
]
|
||||
`);
|
||||
@@ -1191,7 +1191,7 @@ describe("Test Linear Elements", () => {
|
||||
20,
|
||||
105,
|
||||
80,
|
||||
"55.45894",
|
||||
"56.00000",
|
||||
45,
|
||||
]
|
||||
`);
|
||||
@@ -1202,7 +1202,7 @@ describe("Test Linear Elements", () => {
|
||||
.toMatchInlineSnapshot(`
|
||||
{
|
||||
"height": 130,
|
||||
"width": "366.11716",
|
||||
"width": "367.18528",
|
||||
}
|
||||
`);
|
||||
|
||||
@@ -1214,7 +1214,7 @@ describe("Test Linear Elements", () => {
|
||||
),
|
||||
).toMatchInlineSnapshot(`
|
||||
{
|
||||
"x": "271.11716",
|
||||
"x": "272.18528",
|
||||
"y": 45,
|
||||
}
|
||||
`);
|
||||
@@ -1231,9 +1231,9 @@ describe("Test Linear Elements", () => {
|
||||
[
|
||||
20,
|
||||
35,
|
||||
"501.11716",
|
||||
"502.18528",
|
||||
95,
|
||||
"205.45894",
|
||||
"208.69244",
|
||||
"52.50000",
|
||||
]
|
||||
`);
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
import { wrapText, parseTokens } from "../src/textWrapping";
|
||||
import {
|
||||
getWrappedTextLines,
|
||||
parseTokens,
|
||||
wrapText,
|
||||
} from "../src/textWrapping";
|
||||
|
||||
import type { FontString } from "../src/types";
|
||||
|
||||
@@ -102,6 +106,71 @@ describe("Test wrapText", () => {
|
||||
expect(res2).toBe(`\tA)\none\ntab\n- two\ntabs\n- 8\nspace\ns`);
|
||||
});
|
||||
|
||||
it("should retain original text offsets for wrapped lines", () => {
|
||||
expect(getWrappedTextLines("Hello World!", font, 60)).toEqual([
|
||||
{
|
||||
text: "Hello",
|
||||
start: 0,
|
||||
end: 5,
|
||||
},
|
||||
{
|
||||
text: "World!",
|
||||
start: 6,
|
||||
end: 12,
|
||||
},
|
||||
]);
|
||||
});
|
||||
|
||||
it("should exclude whitespace trimmed away at soft-wrap boundaries from line offsets", () => {
|
||||
expect(getWrappedTextLines(" Hello World", font, 90)).toEqual([
|
||||
{
|
||||
text: " Hello",
|
||||
start: 0,
|
||||
end: 7,
|
||||
},
|
||||
{
|
||||
text: "World",
|
||||
start: 9,
|
||||
end: 14,
|
||||
},
|
||||
]);
|
||||
});
|
||||
|
||||
it("should retain offsets when wrapping a single long token", () => {
|
||||
expect(getWrappedTextLines("Excalidraw", font, 50)).toEqual([
|
||||
{
|
||||
text: "Excal",
|
||||
start: 0,
|
||||
end: 5,
|
||||
},
|
||||
{
|
||||
text: "idraw",
|
||||
start: 5,
|
||||
end: 10,
|
||||
},
|
||||
]);
|
||||
});
|
||||
|
||||
it("should preserve empty hard lines in metadata", () => {
|
||||
expect(getWrappedTextLines("A\n\nB", font, 100)).toEqual([
|
||||
{
|
||||
text: "A",
|
||||
start: 0,
|
||||
end: 1,
|
||||
},
|
||||
{
|
||||
text: "",
|
||||
start: 2,
|
||||
end: 2,
|
||||
},
|
||||
{
|
||||
text: "B",
|
||||
start: 3,
|
||||
end: 4,
|
||||
},
|
||||
]);
|
||||
});
|
||||
|
||||
describe("When text is CJK", () => {
|
||||
it("should break each CJK character when width is very small", () => {
|
||||
// "안녕하세요" (Hangul) + "こんにちは世界" (Hiragana, Kanji) + "コンニチハ" (Katakana) + "你好" (Han) = "Hello Hello World Hello Hi"
|
||||
|
||||
@@ -18,22 +18,13 @@ Please add the latest change on the top under the correct section.
|
||||
### Breaking changes
|
||||
|
||||
- Renamed the `excalidrawAPI` prop to `onExcalidrawAPI`.
|
||||
- `onExcalidrawAPI` is now called on mount (instead of during constructor), and later on unmount (with `null` value). The API may be removed altogether in the future (you can use `onMount` & `onUmount` to manage the `ExcalidrawAPI` object (e.g. to cache it to a global state), already).
|
||||
|
||||
### Features
|
||||
|
||||
- Added `onMount` and `onInitialize` props. `onMount` receives `{ excalidrawAPI, container }` once the editor root is mounted, and `onInitialize` fires once the initial scene has loaded.
|
||||
- Added `ExcalidrawAPI.isDestroyed` flag. Set to `true` once the editor unmounts. Calling any `get*` method, `onStateChange`, or `onEvent` on a destroyed API instance will throw in development and `console.error` in production. The `ExcalidrawAPI` will be reset to `null` on umount, but to be extra safe, you should check `ExcalidrawAPI.isDestroyed` before calling these methods to guard against subtle race conditions in your code.
|
||||
|
||||
```tsx
|
||||
<Excalidraw
|
||||
onMount={({ excalidrawAPI, container }) => {
|
||||
console.log(container);
|
||||
excalidrawAPI.scrollToContent();
|
||||
}}
|
||||
onInitialize={(api) => {
|
||||
api.refresh();
|
||||
}}
|
||||
/>
|
||||
```
|
||||
- Added `onMount`, `onInitialize`, and `onUnmount` props. `onMount` receives `{ excalidrawAPI, container }` once the editor root is mounted. `onInitialize` fires once the initial scene has loaded. `onUnmount` fires just before unmounting.
|
||||
|
||||
- Same events are also accessible imperatively through `api.onEvent(...)`.
|
||||
|
||||
@@ -41,7 +32,6 @@ Please add the latest change on the top under the correct section.
|
||||
<Excalidraw
|
||||
onExcalidrawAPI={(api) => {
|
||||
api.onEvent("editor:mount", ({ excalidrawAPI, container }) => {
|
||||
excalidrawAPI.scrollToContent();
|
||||
console.log(container);
|
||||
});
|
||||
|
||||
@@ -54,7 +44,9 @@ Please add the latest change on the top under the correct section.
|
||||
|
||||
Note that in future releases, most, if not all, `excalidrawAPI.on*` subscriptions will be removed in favor of `excalidrawAPI.onEvent(name)`.
|
||||
|
||||
- Exported `ExcalidrawAPIProvider`, `useExcalidrawAPI`, and `useAppStateValue` from the package entrypoint. The imperative API also now exposes `onStateChange`.
|
||||
- Also added `"editor:unmount"` lifecycle event, only accessible via `api.onEvent("editor:unmount")`.
|
||||
|
||||
- Exported `<ExcalidrawAPIProvider/>`, `useExcalidrawAPI()`, `useAppStateValue(prop | props | selectorFunction)`, and `useOnExcalidrawStateChange(prop | props | selectorFunction, callback)` from the package. The imperative API also now exposes `onStateChange(prop | props | selectorFunction, callback?)`, and `onEvent(name, callback)`.
|
||||
|
||||
```tsx
|
||||
<ExcalidrawAPIProvider>
|
||||
@@ -63,6 +55,9 @@ Please add the latest change on the top under the correct section.
|
||||
</ExcalidrawAPIProvider>;
|
||||
|
||||
function Logger() {
|
||||
// initially null before the ExcalidrawAPIProvider initializes ater
|
||||
// <Excalidraw/> renders
|
||||
// When <Excalidraw/> unmounts, is reset back to null
|
||||
const api = useExcalidrawAPI();
|
||||
|
||||
useAppStateValue("viewModeEnabled", (viewModeEnabled) => {
|
||||
|
||||
+111
-14
@@ -1,10 +1,10 @@
|
||||
# Excalidraw
|
||||
|
||||
**Excalidraw** is exported as a component to be directly embedded in your project.
|
||||
**Excalidraw** is exported as a React component that you can embed directly in your app.
|
||||
|
||||
## Installation
|
||||
|
||||
Use `npm` or `yarn` to install the package.
|
||||
Install the package together with its React peer dependencies.
|
||||
|
||||
```bash
|
||||
npm install react react-dom @excalidraw/excalidraw
|
||||
@@ -12,34 +12,131 @@ npm install react react-dom @excalidraw/excalidraw
|
||||
yarn add react react-dom @excalidraw/excalidraw
|
||||
```
|
||||
|
||||
> **Note**: If you don't want to wait for the next stable release and try out the unreleased changes, use `@excalidraw/excalidraw@next`.
|
||||
> **Note**: If you want to try unreleased changes, use `@excalidraw/excalidraw@next`.
|
||||
|
||||
#### Self-hosting fonts
|
||||
## Quick start
|
||||
|
||||
By default, Excalidraw will try to download all the used fonts from the [CDN](https://esm.run/@excalidraw/excalidraw/dist/prod).
|
||||
The minimum working setup has two easy-to-miss requirements:
|
||||
|
||||
For self-hosting purposes, you'll have to copy the content of the folder `node_modules/@excalidraw/excalidraw/dist/prod/fonts` to the path where your assets should be served from (i.e. `public/` directory in your project). In that case, you should also set `window.EXCALIDRAW_ASSET_PATH` to the very same path, i.e. `/` in case it's in the root:
|
||||
1. Import the package CSS:
|
||||
|
||||
```js
|
||||
<script>window.EXCALIDRAW_ASSET_PATH = "/";</script>
|
||||
```ts
|
||||
import "@excalidraw/excalidraw/index.css";
|
||||
```
|
||||
|
||||
### Dimensions of Excalidraw
|
||||
2. Render Excalidraw inside a container with a non-zero height.
|
||||
|
||||
Excalidraw takes _100%_ of `width` and `height` of the containing block so make sure the container in which you render Excalidraw has non zero dimensions.
|
||||
```tsx
|
||||
import { Excalidraw } from "@excalidraw/excalidraw";
|
||||
import "@excalidraw/excalidraw/index.css";
|
||||
|
||||
export default function App() {
|
||||
return (
|
||||
<div style={{ height: "100vh" }}>
|
||||
<Excalidraw />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
Excalidraw fills `100%` of the width and height of its parent. If the parent has no height, the canvas will not be visible.
|
||||
|
||||
## Next.js / SSR frameworks
|
||||
|
||||
Excalidraw should be rendered on the client. In SSR frameworks such as Next.js, use a client component and load it dynamically with SSR disabled.
|
||||
|
||||
```tsx
|
||||
// app/components/ExcalidrawClient.tsx
|
||||
"use client";
|
||||
|
||||
import { Excalidraw } from "@excalidraw/excalidraw";
|
||||
import "@excalidraw/excalidraw/index.css";
|
||||
|
||||
export default function ExcalidrawClient() {
|
||||
return (
|
||||
<div style={{ height: "100vh" }}>
|
||||
<Excalidraw />
|
||||
</div>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
```tsx
|
||||
// app/page.tsx
|
||||
import dynamic from "next/dynamic";
|
||||
|
||||
const ExcalidrawClient = dynamic(
|
||||
() => import("./components/ExcalidrawClient"),
|
||||
{ ssr: false },
|
||||
);
|
||||
|
||||
export default function Page() {
|
||||
return <ExcalidrawClient />;
|
||||
}
|
||||
```
|
||||
|
||||
See the local examples for complete setups:
|
||||
|
||||
- [examples/with-nextjs](https://github.com/excalidraw/excalidraw/tree/master/examples/with-nextjs)
|
||||
- [examples/with-script-in-browser](https://github.com/excalidraw/excalidraw/tree/master/examples/with-script-in-browser)
|
||||
|
||||
## LLM / agent tips
|
||||
|
||||
If an LLM or coding agent is setting up Excalidraw, these shortcuts usually save more time than re-prompting:
|
||||
|
||||
- Start with a plain `<Excalidraw />` in a `100vh` container. Add refs, `initialData`, persistence, or custom UI only after the base embed works.
|
||||
- If the canvas is blank, check the CSS import and parent height first. Those are the two most common integration failures.
|
||||
- In Next.js or other SSR frameworks, assume client-only rendering first. Use `"use client"` and `dynamic(..., { ssr: false })` before debugging hydration or `window is not defined` errors.
|
||||
- If imports or entrypoints are unclear, inspect `node_modules/@excalidraw/excalidraw/package.json`. The installed package exports are the source of truth.
|
||||
- Do not set `window.EXCALIDRAW_ASSET_PATH` unless you are intentionally self-hosting fonts/assets.
|
||||
- When docs and generated code drift, copy the nearest working example from this repo, especially `examples/with-nextjs` or `examples/with-script-in-browser`.
|
||||
|
||||
## Migrating to `@excalidraw/excalidraw@0.18.x`
|
||||
|
||||
Version `0.18.x` removes the old `types/`-prefixed deep import paths. If you were importing types from `@excalidraw/excalidraw/types/...`, switch to the new type-only subpaths below.
|
||||
|
||||
| Old path | New path |
|
||||
| --- | --- |
|
||||
| `@excalidraw/excalidraw/types/data/transform.js` | `@excalidraw/excalidraw/element/transform` |
|
||||
| `@excalidraw/excalidraw/types/data/types.js` | `@excalidraw/excalidraw/data/types` |
|
||||
| `@excalidraw/excalidraw/types/element/types.js` | `@excalidraw/excalidraw/element/types` |
|
||||
| `@excalidraw/excalidraw/types/utility-types.js` | `@excalidraw/excalidraw/common/utility-types` |
|
||||
| `@excalidraw/excalidraw/types/types.js` | `@excalidraw/excalidraw/types` |
|
||||
|
||||
Drop the `.js` extension. The new package `exports` map resolves these paths without it.
|
||||
|
||||
These deep subpaths are for `import type` only. Runtime imports should come from the package root, plus `@excalidraw/excalidraw/index.css` for styles.
|
||||
|
||||
For example:
|
||||
|
||||
```ts
|
||||
import { exportToSvg } from "@excalidraw/excalidraw";
|
||||
```
|
||||
|
||||
## Self-hosting fonts
|
||||
|
||||
By default, Excalidraw downloads the fonts it needs from the [CDN](https://esm.run/@excalidraw/excalidraw/dist/prod).
|
||||
|
||||
For self-hosting, copy the contents of `node_modules/@excalidraw/excalidraw/dist/prod/fonts` into the path where your app serves static assets, for example `public/`. Then set `window.EXCALIDRAW_ASSET_PATH` to that same path:
|
||||
|
||||
```html
|
||||
<script>
|
||||
window.EXCALIDRAW_ASSET_PATH = "/";
|
||||
</script>
|
||||
```
|
||||
|
||||
## Demo
|
||||
|
||||
Go to [CodeSandbox](https://codesandbox.io/p/sandbox/github/excalidraw/excalidraw/tree/master/examples/with-script-in-browser) example.
|
||||
Try the [CodeSandbox example](https://codesandbox.io/p/sandbox/github/excalidraw/excalidraw/tree/master/examples/with-script-in-browser).
|
||||
|
||||
## Integration
|
||||
|
||||
Head over to the [docs](https://docs.excalidraw.com/docs/@excalidraw/excalidraw/integration).
|
||||
Read the [integration docs](https://docs.excalidraw.com/docs/@excalidraw/excalidraw/integration).
|
||||
|
||||
## API
|
||||
|
||||
Head over to the [docs](https://docs.excalidraw.com/docs/@excalidraw/excalidraw/api).
|
||||
Read the [API docs](https://docs.excalidraw.com/docs/@excalidraw/excalidraw/api).
|
||||
|
||||
## Contributing
|
||||
|
||||
Head over to the [docs](https://docs.excalidraw.com/docs/@excalidraw/excalidraw/contributing).
|
||||
Read the [contributing docs](https://docs.excalidraw.com/docs/@excalidraw/excalidraw/contributing).
|
||||
|
||||
@@ -399,7 +399,7 @@ export const actionSaveFileToDisk = register({
|
||||
appState: {
|
||||
openDialog: null,
|
||||
fileHandle: savedFileHandle,
|
||||
toast: { message: t("toast.fileSaved") },
|
||||
toast: { message: t("toast.fileSaved"), duration: 3000 },
|
||||
},
|
||||
};
|
||||
} catch (error: any) {
|
||||
|
||||
@@ -36,6 +36,7 @@ import {
|
||||
import { LinearElementEditor } from "@excalidraw/element";
|
||||
|
||||
import { newElementWith } from "@excalidraw/element";
|
||||
import { getArrowheadForPicker } from "@excalidraw/element";
|
||||
|
||||
import {
|
||||
getBoundTextElement,
|
||||
@@ -124,9 +125,12 @@ import {
|
||||
sharpArrowIcon,
|
||||
roundArrowIcon,
|
||||
elbowArrowIcon,
|
||||
ArrowheadCrowfootIcon,
|
||||
ArrowheadCrowfootOneIcon,
|
||||
ArrowheadCrowfootOneOrManyIcon,
|
||||
ArrowheadCardinalityExactlyOneIcon,
|
||||
ArrowheadCardinalityManyIcon,
|
||||
ArrowheadCardinalityOneIcon,
|
||||
ArrowheadCardinalityOneOrManyIcon,
|
||||
ArrowheadCardinalityZeroOrManyIcon,
|
||||
ArrowheadCardinalityZeroOrOneIcon,
|
||||
} from "../components/icons";
|
||||
|
||||
import { Fonts } from "../fonts";
|
||||
@@ -187,7 +191,7 @@ export const getFormValue = function <T extends Primitive>(
|
||||
elements: readonly ExcalidrawElement[],
|
||||
app: AppClassProperties,
|
||||
getAttribute: (element: ExcalidrawElement) => T,
|
||||
isRelevantElement: true | ((element: ExcalidrawElement) => boolean),
|
||||
elementPredicate: true | ((element: ExcalidrawElement) => boolean),
|
||||
defaultValue: T | ((isSomeElementSelected: boolean) => T),
|
||||
): T {
|
||||
const editingTextElement = app.state.editingTextElement;
|
||||
@@ -205,9 +209,9 @@ export const getFormValue = function <T extends Primitive>(
|
||||
if (hasSelection) {
|
||||
const selectedElements = app.scene.getSelectedElements(app.state);
|
||||
const targetElements =
|
||||
isRelevantElement === true
|
||||
elementPredicate === true
|
||||
? selectedElements
|
||||
: selectedElements.filter((el) => isRelevantElement(el));
|
||||
: selectedElements.filter((el) => elementPredicate(el));
|
||||
|
||||
ret =
|
||||
reduceToCommonValue(targetElements, getAttribute) ??
|
||||
@@ -726,9 +730,28 @@ export const actionChangeOpacity = register<ExcalidrawElement["opacity"]>({
|
||||
captureUpdate: CaptureUpdateAction.IMMEDIATELY,
|
||||
};
|
||||
},
|
||||
PanelComponent: ({ app, updateData }) => (
|
||||
<Range updateData={updateData} app={app} testId="opacity" />
|
||||
),
|
||||
PanelComponent: ({ elements, appState, app, updateData }) => {
|
||||
const opacity = getFormValue(
|
||||
elements,
|
||||
app,
|
||||
(element) => element.opacity,
|
||||
true,
|
||||
(hasSelection) => (hasSelection ? null : appState.currentItemOpacity),
|
||||
);
|
||||
|
||||
return (
|
||||
<Range
|
||||
label={t("labels.opacity")}
|
||||
value={opacity ?? appState.currentItemOpacity}
|
||||
hasCommonValue={opacity !== null}
|
||||
onChange={updateData}
|
||||
min={0}
|
||||
max={100}
|
||||
step={10}
|
||||
testId="opacity"
|
||||
/>
|
||||
);
|
||||
},
|
||||
});
|
||||
|
||||
export const actionChangeFontSize = register<ExcalidrawTextElement["fontSize"]>(
|
||||
@@ -1550,80 +1573,117 @@ export const actionChangeRoundness = register<"sharp" | "round">({
|
||||
});
|
||||
|
||||
const getArrowheadOptions = (flip: boolean) => {
|
||||
return [
|
||||
{
|
||||
value: null,
|
||||
text: t("labels.arrowhead_none"),
|
||||
keyBinding: "q",
|
||||
icon: <ArrowheadNoneIcon flip={flip} />,
|
||||
},
|
||||
{
|
||||
value: "arrow",
|
||||
text: t("labels.arrowhead_arrow"),
|
||||
keyBinding: "w",
|
||||
icon: <ArrowheadArrowIcon flip={flip} />,
|
||||
},
|
||||
{
|
||||
value: "triangle",
|
||||
text: t("labels.arrowhead_triangle"),
|
||||
icon: <ArrowheadTriangleIcon flip={flip} />,
|
||||
keyBinding: "e",
|
||||
},
|
||||
{
|
||||
value: "triangle_outline",
|
||||
text: t("labels.arrowhead_triangle_outline"),
|
||||
icon: <ArrowheadTriangleOutlineIcon flip={flip} />,
|
||||
keyBinding: "r",
|
||||
},
|
||||
{
|
||||
value: "circle",
|
||||
text: t("labels.arrowhead_circle"),
|
||||
keyBinding: "a",
|
||||
icon: <ArrowheadCircleIcon flip={flip} />,
|
||||
},
|
||||
{
|
||||
value: "circle_outline",
|
||||
text: t("labels.arrowhead_circle_outline"),
|
||||
keyBinding: "s",
|
||||
icon: <ArrowheadCircleOutlineIcon flip={flip} />,
|
||||
},
|
||||
{
|
||||
value: "diamond",
|
||||
text: t("labels.arrowhead_diamond"),
|
||||
icon: <ArrowheadDiamondIcon flip={flip} />,
|
||||
keyBinding: "d",
|
||||
},
|
||||
{
|
||||
value: "diamond_outline",
|
||||
text: t("labels.arrowhead_diamond_outline"),
|
||||
icon: <ArrowheadDiamondOutlineIcon flip={flip} />,
|
||||
keyBinding: "f",
|
||||
},
|
||||
{
|
||||
value: "bar",
|
||||
text: t("labels.arrowhead_bar"),
|
||||
keyBinding: "z",
|
||||
icon: <ArrowheadBarIcon flip={flip} />,
|
||||
},
|
||||
{
|
||||
value: "crowfoot_one",
|
||||
text: t("labels.arrowhead_crowfoot_one"),
|
||||
icon: <ArrowheadCrowfootOneIcon flip={flip} />,
|
||||
keyBinding: "x",
|
||||
},
|
||||
{
|
||||
value: "crowfoot_many",
|
||||
text: t("labels.arrowhead_crowfoot_many"),
|
||||
icon: <ArrowheadCrowfootIcon flip={flip} />,
|
||||
keyBinding: "c",
|
||||
},
|
||||
{
|
||||
value: "crowfoot_one_or_many",
|
||||
text: t("labels.arrowhead_crowfoot_one_or_many"),
|
||||
icon: <ArrowheadCrowfootOneOrManyIcon flip={flip} />,
|
||||
keyBinding: "v",
|
||||
},
|
||||
] as const;
|
||||
return {
|
||||
visibleSections: [
|
||||
{
|
||||
name: "default",
|
||||
options: [
|
||||
{
|
||||
value: null,
|
||||
text: t("labels.arrowhead_none"),
|
||||
keyBinding: "q",
|
||||
icon: <ArrowheadNoneIcon flip={flip} />,
|
||||
},
|
||||
{
|
||||
value: "arrow",
|
||||
text: t("labels.arrowhead_arrow"),
|
||||
keyBinding: "w",
|
||||
icon: <ArrowheadArrowIcon flip={flip} />,
|
||||
},
|
||||
{
|
||||
value: "triangle",
|
||||
text: t("labels.arrowhead_triangle"),
|
||||
icon: <ArrowheadTriangleIcon flip={flip} />,
|
||||
keyBinding: "e",
|
||||
},
|
||||
{
|
||||
value: "triangle_outline",
|
||||
text: t("labels.arrowhead_triangle_outline"),
|
||||
icon: <ArrowheadTriangleOutlineIcon flip={flip} />,
|
||||
keyBinding: "r",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
hiddenSections: [
|
||||
{
|
||||
name: "default",
|
||||
options: [
|
||||
{
|
||||
value: "circle",
|
||||
text: t("labels.arrowhead_circle"),
|
||||
keyBinding: "a",
|
||||
icon: <ArrowheadCircleIcon flip={flip} />,
|
||||
},
|
||||
{
|
||||
value: "circle_outline",
|
||||
text: t("labels.arrowhead_circle_outline"),
|
||||
keyBinding: "s",
|
||||
icon: <ArrowheadCircleOutlineIcon flip={flip} />,
|
||||
},
|
||||
{
|
||||
value: "diamond",
|
||||
text: t("labels.arrowhead_diamond"),
|
||||
icon: <ArrowheadDiamondIcon flip={flip} />,
|
||||
keyBinding: "d",
|
||||
},
|
||||
{
|
||||
value: "diamond_outline",
|
||||
text: t("labels.arrowhead_diamond_outline"),
|
||||
icon: <ArrowheadDiamondOutlineIcon flip={flip} />,
|
||||
keyBinding: "f",
|
||||
},
|
||||
{
|
||||
value: "bar",
|
||||
text: t("labels.arrowhead_bar"),
|
||||
keyBinding: "z",
|
||||
icon: <ArrowheadBarIcon flip={flip} />,
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
name: t("labels.cardinality"),
|
||||
options: [
|
||||
{
|
||||
value: "cardinality_one",
|
||||
text: t("labels.arrowhead_cardinality_one"),
|
||||
icon: <ArrowheadCardinalityOneIcon flip={flip} />,
|
||||
keyBinding: "x",
|
||||
},
|
||||
{
|
||||
value: "cardinality_many",
|
||||
text: t("labels.arrowhead_cardinality_many"),
|
||||
icon: <ArrowheadCardinalityManyIcon flip={flip} />,
|
||||
keyBinding: "c",
|
||||
},
|
||||
{
|
||||
value: "cardinality_one_or_many",
|
||||
text: t("labels.arrowhead_cardinality_one_or_many"),
|
||||
icon: <ArrowheadCardinalityOneOrManyIcon flip={flip} />,
|
||||
keyBinding: "v",
|
||||
},
|
||||
{
|
||||
value: "cardinality_exactly_one",
|
||||
text: t("labels.arrowhead_cardinality_exactly_one"),
|
||||
icon: <ArrowheadCardinalityExactlyOneIcon flip={flip} />,
|
||||
keyBinding: null,
|
||||
},
|
||||
{
|
||||
value: "cardinality_zero_or_one",
|
||||
text: t("labels.arrowhead_cardinality_zero_or_one"),
|
||||
icon: <ArrowheadCardinalityZeroOrOneIcon flip={flip} />,
|
||||
keyBinding: null,
|
||||
},
|
||||
{
|
||||
value: "cardinality_zero_or_many",
|
||||
text: t("labels.arrowhead_cardinality_zero_or_many"),
|
||||
icon: <ArrowheadCardinalityZeroOrManyIcon flip={flip} />,
|
||||
keyBinding: null,
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
} as const;
|
||||
};
|
||||
|
||||
export const actionChangeArrowhead = register<{
|
||||
@@ -1667,45 +1727,52 @@ export const actionChangeArrowhead = register<{
|
||||
},
|
||||
PanelComponent: ({ elements, appState, updateData, app }) => {
|
||||
const isRTL = getLanguage().rtl;
|
||||
const startArrowheadOptions = useMemo(
|
||||
() => getArrowheadOptions(!isRTL),
|
||||
[isRTL],
|
||||
);
|
||||
const endArrowheadOptions = useMemo(
|
||||
() => getArrowheadOptions(!!isRTL),
|
||||
[isRTL],
|
||||
);
|
||||
|
||||
return (
|
||||
<fieldset>
|
||||
<legend>{t("labels.arrowheads")}</legend>
|
||||
<div className="iconSelectList buttonList">
|
||||
<IconPicker
|
||||
visibleSections={startArrowheadOptions.visibleSections}
|
||||
hiddenSections={startArrowheadOptions.hiddenSections}
|
||||
label="arrowhead_start"
|
||||
options={getArrowheadOptions(!isRTL)}
|
||||
value={getFormValue<Arrowhead | null>(
|
||||
elements,
|
||||
app,
|
||||
(element) =>
|
||||
isLinearElement(element) && canHaveArrowheads(element.type)
|
||||
? element.startArrowhead
|
||||
? getArrowheadForPicker(element.startArrowhead)
|
||||
: appState.currentItemStartArrowhead,
|
||||
true,
|
||||
(hasSelection) =>
|
||||
hasSelection ? null : appState.currentItemStartArrowhead,
|
||||
)}
|
||||
onChange={(value) => updateData({ position: "start", type: value })}
|
||||
numberOfOptionsToAlwaysShow={4}
|
||||
/>
|
||||
<IconPicker
|
||||
visibleSections={endArrowheadOptions.visibleSections}
|
||||
hiddenSections={endArrowheadOptions.hiddenSections}
|
||||
label="arrowhead_end"
|
||||
group="arrowheads"
|
||||
options={getArrowheadOptions(!!isRTL)}
|
||||
value={getFormValue<Arrowhead | null>(
|
||||
elements,
|
||||
app,
|
||||
(element) =>
|
||||
isLinearElement(element) && canHaveArrowheads(element.type)
|
||||
? element.endArrowhead
|
||||
? getArrowheadForPicker(element.endArrowhead)
|
||||
: appState.currentItemEndArrowhead,
|
||||
true,
|
||||
(hasSelection) =>
|
||||
hasSelection ? null : appState.currentItemEndArrowhead,
|
||||
)}
|
||||
onChange={(value) => updateData({ position: "end", type: value })}
|
||||
numberOfOptionsToAlwaysShow={4}
|
||||
/>
|
||||
</div>
|
||||
</fieldset>
|
||||
|
||||
@@ -1,24 +1,24 @@
|
||||
import { getFontString } from "@excalidraw/common";
|
||||
|
||||
import { newElementWith } from "@excalidraw/element";
|
||||
import { isExcalidrawElement, newElementWith } from "@excalidraw/element";
|
||||
import { measureText } from "@excalidraw/element";
|
||||
|
||||
import { isTextElement } from "@excalidraw/element";
|
||||
|
||||
import { CaptureUpdateAction } from "@excalidraw/element";
|
||||
|
||||
import type { ExcalidrawElement } from "@excalidraw/element/types";
|
||||
|
||||
import { getSelectedElements } from "../scene";
|
||||
|
||||
import { register } from "./register";
|
||||
|
||||
import type { AppClassProperties } from "../types";
|
||||
|
||||
export const actionTextAutoResize = register({
|
||||
name: "autoResize",
|
||||
label: "labels.autoResize",
|
||||
icon: null,
|
||||
trackEvent: { category: "element" },
|
||||
predicate: (elements, appState, _: unknown, app: AppClassProperties) => {
|
||||
predicate: (elements, appState, _: unknown) => {
|
||||
const selectedElements = getSelectedElements(elements, appState);
|
||||
return (
|
||||
selectedElements.length === 1 &&
|
||||
@@ -26,13 +26,18 @@ export const actionTextAutoResize = register({
|
||||
!selectedElements[0].autoResize
|
||||
);
|
||||
},
|
||||
perform: (elements, appState, _, app) => {
|
||||
perform: (elements, appState, targetElement) => {
|
||||
const selectedElements = getSelectedElements(elements, appState);
|
||||
|
||||
const targetTextElement =
|
||||
isExcalidrawElement(targetElement) && isTextElement(targetElement)
|
||||
? targetElement
|
||||
: (selectedElements[0] as ExcalidrawElement | undefined);
|
||||
|
||||
return {
|
||||
appState,
|
||||
elements: elements.map((element) => {
|
||||
if (element.id === selectedElements[0].id && isTextElement(element)) {
|
||||
if (element.id === targetTextElement?.id && isTextElement(element)) {
|
||||
const metrics = measureText(
|
||||
element.originalText,
|
||||
getFontString(element),
|
||||
|
||||
@@ -257,6 +257,7 @@ import {
|
||||
handleFocusPointPointerUp,
|
||||
maybeHandleArrowPointlikeDrag,
|
||||
getUncroppedWidthAndHeight,
|
||||
getActiveTextElement,
|
||||
} from "@excalidraw/element";
|
||||
|
||||
import type { GlobalPoint, LocalPoint, Radians } from "@excalidraw/math";
|
||||
@@ -416,6 +417,7 @@ import {
|
||||
import { ElementCanvasButtons } from "../components/ElementCanvasButtons";
|
||||
import { LaserTrails } from "../laser-trails";
|
||||
import { withBatchedUpdates, withBatchedUpdatesThrottled } from "../reactUtils";
|
||||
import { isPointHittingTextAutoResizeHandle } from "../textAutoResizeHandle";
|
||||
import { textWysiwyg } from "../wysiwyg/textWysiwyg";
|
||||
import { isOverScrollBars } from "../scene/scrollbars";
|
||||
|
||||
@@ -517,6 +519,7 @@ EditorInterfaceContext.displayName = "EditorInterfaceContext";
|
||||
const editorLifecycleEventBehavior = {
|
||||
"editor:mount": { cardinality: "once", replay: "last" },
|
||||
"editor:initialize": { cardinality: "once", replay: "last" },
|
||||
"editor:unmount": { cardinality: "once", replay: "last" },
|
||||
} as const;
|
||||
|
||||
export const ExcalidrawContainerContext = React.createContext<{
|
||||
@@ -556,7 +559,7 @@ export const ExcalidrawAPIContext =
|
||||
ExcalidrawAPIContext.displayName = "ExcalidrawAPIContext";
|
||||
|
||||
export const ExcalidrawAPISetContext = React.createContext<
|
||||
((api: ExcalidrawImperativeAPI) => void) | null
|
||||
((api: ExcalidrawImperativeAPI | null) => void) | null
|
||||
>(null);
|
||||
ExcalidrawAPISetContext.displayName = "ExcalidrawAPISetContext";
|
||||
|
||||
@@ -683,9 +686,15 @@ class App extends React.Component<AppProps, AppState> {
|
||||
lastPointerDownEvent: React.PointerEvent<HTMLElement> | null = null;
|
||||
lastPointerUpEvent: React.PointerEvent<HTMLElement> | PointerEvent | null =
|
||||
null;
|
||||
// TODO this is a hack and we should ideally unify touch and pointer events
|
||||
// and implement our own double click handling end-to-end (currently we're
|
||||
// using a mix of native browser for click events and manual for touch -
|
||||
// and browser doubleClick sucks to begin with)
|
||||
lastPointerUpIsDoubleClick: boolean = false;
|
||||
lastPointerMoveEvent: PointerEvent | null = null;
|
||||
/** current frame pointer cords */
|
||||
lastPointerMoveCoords: { x: number; y: number } | null = null;
|
||||
private lastCompletedCanvasClicks: { x: number; y: number }[] = [];
|
||||
/** previous frame pointer coords */
|
||||
previousPointerMoveCoords: { x: number; y: number } | null = null;
|
||||
lastViewportPosition = { x: 0, y: 0 };
|
||||
@@ -731,6 +740,50 @@ class App extends React.Component<AppProps, AppState> {
|
||||
|
||||
api: ExcalidrawImperativeAPI;
|
||||
|
||||
private createExcalidrawAPI(): ExcalidrawImperativeAPI {
|
||||
const api: ExcalidrawImperativeAPI = {
|
||||
isDestroyed: false,
|
||||
updateScene: this.updateScene,
|
||||
applyDeltas: this.applyDeltas,
|
||||
mutateElement: this.mutateElement,
|
||||
updateLibrary: this.library.updateLibrary,
|
||||
addFiles: this.addFiles,
|
||||
resetScene: this.resetScene,
|
||||
getSceneElementsIncludingDeleted: this.getSceneElementsIncludingDeleted,
|
||||
getSceneElementsMapIncludingDeleted:
|
||||
this.getSceneElementsMapIncludingDeleted,
|
||||
history: {
|
||||
clear: this.resetHistory,
|
||||
},
|
||||
scrollToContent: this.scrollToContent,
|
||||
getSceneElements: this.getSceneElements,
|
||||
getAppState: () => this.state,
|
||||
getFiles: () => this.files,
|
||||
getName: this.getName,
|
||||
registerAction: (action: Action) => {
|
||||
this.actionManager.registerAction(action);
|
||||
},
|
||||
refresh: this.refresh,
|
||||
setToast: this.setToast,
|
||||
id: this.id,
|
||||
setActiveTool: this.setActiveTool,
|
||||
setCursor: this.setCursor,
|
||||
resetCursor: this.resetCursor,
|
||||
getEditorInterface: () => this.editorInterface,
|
||||
updateFrameRendering: this.updateFrameRendering,
|
||||
toggleSidebar: this.toggleSidebar,
|
||||
onChange: (cb) => this.onChangeEmitter.on(cb),
|
||||
onIncrement: (cb) => this.store.onStoreIncrementEmitter.on(cb),
|
||||
onPointerDown: (cb) => this.onPointerDownEmitter.on(cb),
|
||||
onPointerUp: (cb) => this.onPointerUpEmitter.on(cb),
|
||||
onScrollChange: (cb) => this.onScrollChangeEmitter.on(cb),
|
||||
onUserFollow: (cb) => this.onUserFollowEmitter.on(cb),
|
||||
onStateChange: this.onStateChange,
|
||||
onEvent: this.onEvent,
|
||||
};
|
||||
return api;
|
||||
}
|
||||
|
||||
constructor(props: AppProps) {
|
||||
super(props);
|
||||
const defaultAppState = getDefaultAppState();
|
||||
@@ -791,47 +844,11 @@ class App extends React.Component<AppProps, AppState> {
|
||||
this.actionManager.registerAction(createUndoAction(this.history));
|
||||
this.actionManager.registerAction(createRedoAction(this.history));
|
||||
|
||||
this.api = {
|
||||
updateScene: this.updateScene,
|
||||
applyDeltas: this.applyDeltas,
|
||||
mutateElement: this.mutateElement,
|
||||
updateLibrary: this.library.updateLibrary,
|
||||
addFiles: this.addFiles,
|
||||
resetScene: this.resetScene,
|
||||
getSceneElementsIncludingDeleted: this.getSceneElementsIncludingDeleted,
|
||||
getSceneElementsMapIncludingDeleted:
|
||||
this.getSceneElementsMapIncludingDeleted,
|
||||
history: {
|
||||
clear: this.resetHistory,
|
||||
},
|
||||
scrollToContent: this.scrollToContent,
|
||||
getSceneElements: this.getSceneElements,
|
||||
getAppState: () => this.state,
|
||||
getFiles: () => this.files,
|
||||
getName: this.getName,
|
||||
registerAction: (action: Action) => {
|
||||
this.actionManager.registerAction(action);
|
||||
},
|
||||
refresh: this.refresh,
|
||||
setToast: this.setToast,
|
||||
id: this.id,
|
||||
setActiveTool: this.setActiveTool,
|
||||
setCursor: this.setCursor,
|
||||
resetCursor: this.resetCursor,
|
||||
getEditorInterface: () => this.editorInterface,
|
||||
updateFrameRendering: this.updateFrameRendering,
|
||||
toggleSidebar: this.toggleSidebar,
|
||||
onChange: (cb) => this.onChangeEmitter.on(cb),
|
||||
onIncrement: (cb) => this.store.onStoreIncrementEmitter.on(cb),
|
||||
onPointerDown: (cb) => this.onPointerDownEmitter.on(cb),
|
||||
onPointerUp: (cb) => this.onPointerUpEmitter.on(cb),
|
||||
onScrollChange: (cb) => this.onScrollChangeEmitter.on(cb),
|
||||
onUserFollow: (cb) => this.onUserFollowEmitter.on(cb),
|
||||
onStateChange: this.onStateChange,
|
||||
onEvent: this.onEvent,
|
||||
} as const;
|
||||
|
||||
props.onExcalidrawAPI?.(this.api);
|
||||
// in case internal editor APIs call this early, otherwise we need
|
||||
// to construct this in componentDidMount because componentWillUnmount
|
||||
// will invalidate it (so in StrictMode, doing this in constructor alone
|
||||
// would be a problem)
|
||||
this.api = this.createExcalidrawAPI();
|
||||
}
|
||||
|
||||
updateEditorAtom = <Value, Args extends unknown[], Result>(
|
||||
@@ -1239,6 +1256,26 @@ class App extends React.Component<AppProps, AppState> {
|
||||
) as NullableGridSize;
|
||||
};
|
||||
|
||||
private getTextCreationGridPoint = (x: number, y: number) => {
|
||||
const effectiveGridSize = this.getEffectiveGridSize();
|
||||
|
||||
if (effectiveGridSize === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const getTextCreationGridCoordinate = (coordinate: number) => {
|
||||
const topLeftGridPoint =
|
||||
Math.floor(coordinate / effectiveGridSize) * effectiveGridSize;
|
||||
|
||||
return topLeftGridPoint;
|
||||
};
|
||||
|
||||
return {
|
||||
x: getTextCreationGridCoordinate(x),
|
||||
y: getTextCreationGridCoordinate(y),
|
||||
};
|
||||
};
|
||||
|
||||
private getHTMLIFrameElement(
|
||||
element: ExcalidrawIframeLikeElement,
|
||||
): HTMLIFrameElement | undefined {
|
||||
@@ -1429,6 +1466,21 @@ class App extends React.Component<AppProps, AppState> {
|
||||
return true;
|
||||
}
|
||||
|
||||
private isDoubleClick = (
|
||||
lastPointerEvent:
|
||||
| PointerEvent
|
||||
| React.PointerEvent<HTMLElement>
|
||||
| undefined
|
||||
| null,
|
||||
currentPointerEvent: PointerEvent | React.PointerEvent<HTMLElement>,
|
||||
) => {
|
||||
return (
|
||||
lastPointerEvent != null &&
|
||||
currentPointerEvent.timeStamp - lastPointerEvent.timeStamp <=
|
||||
TAP_TWICE_TIMEOUT
|
||||
);
|
||||
};
|
||||
|
||||
private isIframeLikeElementCenter(
|
||||
el: ExcalidrawIframeLikeElement | null,
|
||||
event: React.PointerEvent<HTMLElement> | PointerEvent,
|
||||
@@ -2312,6 +2364,7 @@ class App extends React.Component<AppProps, AppState> {
|
||||
}
|
||||
handleCanvasRef={this.handleInteractiveCanvasRef}
|
||||
onContextMenu={this.handleCanvasContextMenu}
|
||||
onClick={this.handleCanvasClick}
|
||||
onPointerMove={this.handleCanvasPointerMove}
|
||||
onPointerUp={this.handleCanvasPointerUp}
|
||||
onPointerCancel={this.removePointer}
|
||||
@@ -3003,6 +3056,8 @@ class App extends React.Component<AppProps, AppState> {
|
||||
|
||||
public async componentDidMount() {
|
||||
this.unmounted = false;
|
||||
this.api = this.createExcalidrawAPI();
|
||||
|
||||
this.excalidrawContainerValue.container =
|
||||
this.excalidrawContainerRef.current;
|
||||
|
||||
@@ -3089,10 +3144,35 @@ class App extends React.Component<AppProps, AppState> {
|
||||
|
||||
this.editorLifecycleEvents.emit("editor:mount", mountPayload);
|
||||
this.props.onMount?.(mountPayload);
|
||||
this.props.onExcalidrawAPI?.(this.api);
|
||||
}
|
||||
|
||||
public componentWillUnmount() {
|
||||
// we're recreating the api object reference so that the
|
||||
// <ExcalidrawAPIContext.Provider/> picks up on it
|
||||
this.api = { ...this.api, isDestroyed: true };
|
||||
|
||||
for (const key of Object.keys(this.api) as (keyof typeof this.api)[]) {
|
||||
if (
|
||||
(key.startsWith("get") ||
|
||||
key === "onStateChange" ||
|
||||
key === "onEvent") &&
|
||||
typeof this.api[key] === "function"
|
||||
) {
|
||||
(this.api as any)[key] = () => {
|
||||
throw new Error(
|
||||
"ExcalidrawAPI is no longer usable after the editor has been unmounted and will return invalid/empty data. You should check for `ExcalidrawAPI.isDestroyed` before calling get* methods on subscribing to state/event changes.",
|
||||
);
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
this.editorLifecycleEvents.emit("editor:unmount");
|
||||
this.props.onUnmount?.();
|
||||
this.props.onExcalidrawAPI?.(null);
|
||||
|
||||
(window as any).launchQueue?.setConsumer(() => {});
|
||||
|
||||
this.renderer.destroy();
|
||||
this.scene.destroy();
|
||||
this.scene = new Scene();
|
||||
@@ -3538,10 +3618,14 @@ class App extends React.Component<AppProps, AppState> {
|
||||
this.lassoTrail.endPath();
|
||||
this.deselectElements();
|
||||
|
||||
// @ts-ignore
|
||||
this.handleCanvasDoubleClick({
|
||||
clientX: touch.clientX,
|
||||
clientY: touch.clientY,
|
||||
type: "touch",
|
||||
altKey: false,
|
||||
ctrlKey: false,
|
||||
metaKey: false,
|
||||
shiftKey: false,
|
||||
});
|
||||
}
|
||||
didTapTwice = false;
|
||||
@@ -3667,7 +3751,7 @@ class App extends React.Component<AppProps, AppState> {
|
||||
if (!isPlainPaste && isMaybeMermaidDefinition(data.text)) {
|
||||
const api = await import("@excalidraw/mermaid-to-excalidraw");
|
||||
try {
|
||||
const { elements: skeletonElements, files } =
|
||||
const { elements: skeletonElements, files = {} } =
|
||||
await api.parseMermaidToExcalidraw(data.text);
|
||||
|
||||
const elements = convertToExcalidrawElements(skeletonElements, {
|
||||
@@ -5581,8 +5665,14 @@ class App extends React.Component<AppProps, AppState> {
|
||||
element: ExcalidrawTextElement,
|
||||
{
|
||||
isExistingElement = false,
|
||||
initialCaretSceneCoords = null,
|
||||
}: {
|
||||
isExistingElement?: boolean;
|
||||
/**
|
||||
* supply null if no caret positioning is desired, and instead
|
||||
* text should be auto-selected
|
||||
*/
|
||||
initialCaretSceneCoords?: { x: number; y: number } | null;
|
||||
},
|
||||
) {
|
||||
const elementsMap = this.scene.getElementsMapIncludingDeleted();
|
||||
@@ -5685,6 +5775,7 @@ class App extends React.Component<AppProps, AppState> {
|
||||
element,
|
||||
excalidrawContainer: this.excalidrawContainerRef.current,
|
||||
app: this,
|
||||
initialCaretSceneCoords,
|
||||
// when text is selected, it's hard (at least on iOS) to re-position the
|
||||
// caret (i.e. deselect). There's not much use for always selecting
|
||||
// the text on edit anyway (and users can select-all from contextmenu
|
||||
@@ -5708,6 +5799,68 @@ class App extends React.Component<AppProps, AppState> {
|
||||
});
|
||||
}
|
||||
|
||||
private getSelectedTextElement(
|
||||
container?: ExcalidrawTextContainer | null,
|
||||
): NonDeleted<ExcalidrawTextElement> | null {
|
||||
const selectedElements = this.scene.getSelectedElements(this.state);
|
||||
|
||||
if (selectedElements.length !== 1) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const selectedElement = selectedElements[0]!;
|
||||
|
||||
if (isTextElement(selectedElement)) {
|
||||
return selectedElement;
|
||||
}
|
||||
|
||||
if (!container) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return getBoundTextElement(
|
||||
selectedElement,
|
||||
this.scene.getNonDeletedElementsMap(),
|
||||
);
|
||||
}
|
||||
|
||||
private getSelectedTextEditingContainerAtPosition(
|
||||
hitElement: NonDeletedExcalidrawElement | null,
|
||||
sceneCoords: { x: number; y: number },
|
||||
): ExcalidrawTextContainer | null | undefined {
|
||||
const selectedElements = this.scene.getSelectedElements(this.state);
|
||||
|
||||
if (
|
||||
selectedElements.length !== 1 ||
|
||||
!hitElement ||
|
||||
hitElement.id !== selectedElements[0]!.id
|
||||
) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const selectedElement = selectedElements[0]!;
|
||||
|
||||
if (isTextElement(selectedElement)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
if (!isValidTextContainer(selectedElement)) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
const textElement = this.getSelectedTextElement(selectedElement);
|
||||
const hitTextElement = this.getTextElementAtPosition(
|
||||
sceneCoords.x,
|
||||
sceneCoords.y,
|
||||
);
|
||||
|
||||
if (!textElement || hitTextElement?.id !== textElement.id) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
return selectedElement;
|
||||
}
|
||||
|
||||
private getTextElementAtPosition(
|
||||
x: number,
|
||||
y: number,
|
||||
@@ -5721,6 +5874,58 @@ class App extends React.Component<AppProps, AppState> {
|
||||
return null;
|
||||
}
|
||||
|
||||
private isHittingTextAutoResizeHandle = (
|
||||
selectedElements: NonDeleted<ExcalidrawElement>[],
|
||||
point: Readonly<{ x: number; y: number }>,
|
||||
): boolean => {
|
||||
const activeTextElement = getActiveTextElement(
|
||||
selectedElements,
|
||||
this.state,
|
||||
);
|
||||
|
||||
if (
|
||||
activeTextElement &&
|
||||
!activeTextElement.isDeleted &&
|
||||
!activeTextElement.autoResize &&
|
||||
isPointHittingTextAutoResizeHandle(
|
||||
point,
|
||||
activeTextElement,
|
||||
this.state.zoom.value,
|
||||
this.editorInterface.formFactor,
|
||||
)
|
||||
) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
};
|
||||
|
||||
private handleTextAutoResizeHandlePointerDown = (
|
||||
selectedElements: NonDeleted<ExcalidrawElement>[],
|
||||
point: Readonly<{ x: number; y: number }>,
|
||||
) => {
|
||||
const activeTextElement = getActiveTextElement(
|
||||
selectedElements,
|
||||
this.state,
|
||||
);
|
||||
if (
|
||||
!activeTextElement ||
|
||||
!this.isHittingTextAutoResizeHandle(selectedElements, point)
|
||||
) {
|
||||
return false;
|
||||
}
|
||||
|
||||
this.actionManager.executeAction(
|
||||
actionTextAutoResize,
|
||||
"ui",
|
||||
// we need to pass down the element since it may already be deselected
|
||||
// due to the pointerdown
|
||||
activeTextElement,
|
||||
);
|
||||
this.resetCursor();
|
||||
return true;
|
||||
};
|
||||
|
||||
// NOTE: Hot path for hit testing, so avoid unnecessary computations
|
||||
private getElementAtPosition(
|
||||
x: number,
|
||||
@@ -5933,6 +6138,7 @@ class App extends React.Component<AppProps, AppState> {
|
||||
insertAtParentCenter = true,
|
||||
container,
|
||||
autoEdit = true,
|
||||
initialCaretSceneCoords,
|
||||
}: {
|
||||
/** X position to insert text at */
|
||||
sceneX: number;
|
||||
@@ -5942,6 +6148,7 @@ class App extends React.Component<AppProps, AppState> {
|
||||
insertAtParentCenter?: boolean;
|
||||
container?: ExcalidrawTextContainer | null;
|
||||
autoEdit?: boolean;
|
||||
initialCaretSceneCoords?: { x: number; y: number };
|
||||
}) => {
|
||||
let shouldBindToContainer = false;
|
||||
|
||||
@@ -5962,24 +6169,9 @@ class App extends React.Component<AppProps, AppState> {
|
||||
shouldBindToContainer = true;
|
||||
}
|
||||
}
|
||||
let existingTextElement: NonDeleted<ExcalidrawTextElement> | null = null;
|
||||
|
||||
const selectedElements = this.scene.getSelectedElements(this.state);
|
||||
|
||||
if (selectedElements.length === 1) {
|
||||
if (isTextElement(selectedElements[0])) {
|
||||
existingTextElement = selectedElements[0];
|
||||
} else if (container) {
|
||||
existingTextElement = getBoundTextElement(
|
||||
selectedElements[0],
|
||||
this.scene.getNonDeletedElementsMap(),
|
||||
);
|
||||
} else {
|
||||
existingTextElement = this.getTextElementAtPosition(sceneX, sceneY);
|
||||
}
|
||||
} else {
|
||||
existingTextElement = this.getTextElementAtPosition(sceneX, sceneY);
|
||||
}
|
||||
const existingTextElement =
|
||||
this.getSelectedTextElement(container) ||
|
||||
this.getTextElementAtPosition(sceneX, sceneY);
|
||||
|
||||
const fontFamily =
|
||||
existingTextElement?.fontFamily || this.state.currentItemFontFamily;
|
||||
@@ -6026,11 +6218,32 @@ class App extends React.Component<AppProps, AppState> {
|
||||
y: sceneY,
|
||||
});
|
||||
|
||||
const textCreationGridPoint = this.getTextCreationGridPoint(sceneX, sceneY);
|
||||
|
||||
const newTextElementPosition = parentCenterPosition
|
||||
? {
|
||||
x: parentCenterPosition.elementCenterX,
|
||||
y: parentCenterPosition.elementCenterY,
|
||||
}
|
||||
: !existingTextElement
|
||||
? {
|
||||
x: textCreationGridPoint?.x ?? sceneX,
|
||||
y:
|
||||
textCreationGridPoint === null
|
||||
? // Free text starts from a point cursor, so center the first line box on it.
|
||||
sceneY - getLineHeightInPx(fontSize, lineHeight) / 2
|
||||
: textCreationGridPoint.y,
|
||||
}
|
||||
: {
|
||||
x: sceneX,
|
||||
y: sceneY,
|
||||
};
|
||||
|
||||
const element =
|
||||
existingTextElement ||
|
||||
newTextElement({
|
||||
x: parentCenterPosition ? parentCenterPosition.elementCenterX : sceneX,
|
||||
y: parentCenterPosition ? parentCenterPosition.elementCenterY : sceneY,
|
||||
x: newTextElementPosition.x,
|
||||
y: newTextElementPosition.y,
|
||||
strokeColor: this.state.currentItemStrokeColor,
|
||||
backgroundColor: this.state.currentItemBackgroundColor,
|
||||
fillStyle: this.state.currentItemFillStyle,
|
||||
@@ -6080,6 +6293,9 @@ class App extends React.Component<AppProps, AppState> {
|
||||
if (autoEdit || existingTextElement || container) {
|
||||
this.handleTextWysiwyg(element, {
|
||||
isExistingElement: !!existingTextElement,
|
||||
initialCaretSceneCoords: existingTextElement
|
||||
? initialCaretSceneCoords
|
||||
: null,
|
||||
});
|
||||
} else {
|
||||
this.setState({
|
||||
@@ -6105,9 +6321,48 @@ class App extends React.Component<AppProps, AppState> {
|
||||
}
|
||||
};
|
||||
|
||||
private shouldHandleBrowserCanvasDoubleClick = (type: string) => {
|
||||
// TODO remove this once we consolidate double-click logic and handle
|
||||
// ourselves for all event types together
|
||||
if (type === "touch") {
|
||||
return true;
|
||||
}
|
||||
if (this.lastCompletedCanvasClicks.length === 0) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if (this.lastCompletedCanvasClicks.length < 2) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const [firstClick, secondClick] = this.lastCompletedCanvasClicks;
|
||||
|
||||
return (
|
||||
pointDistance(
|
||||
pointFrom(firstClick.x, firstClick.y),
|
||||
pointFrom(secondClick.x, secondClick.y),
|
||||
) <= DOUBLE_TAP_POSITION_THRESHOLD
|
||||
);
|
||||
};
|
||||
|
||||
private handleCanvasDoubleClick = (
|
||||
event: React.MouseEvent<HTMLCanvasElement>,
|
||||
event: Pick<
|
||||
React.MouseEvent<HTMLCanvasElement>,
|
||||
| "type"
|
||||
| "clientX"
|
||||
| "clientY"
|
||||
| "altKey"
|
||||
| "ctrlKey"
|
||||
| "metaKey"
|
||||
| "shiftKey"
|
||||
>,
|
||||
) => {
|
||||
if (
|
||||
this.state.editingTextElement ||
|
||||
!this.shouldHandleBrowserCanvasDoubleClick(event.type)
|
||||
) {
|
||||
return;
|
||||
}
|
||||
// case: double-clicking with arrow/line tool selected would both create
|
||||
// text and enter multiElement mode
|
||||
if (this.state.multiElement) {
|
||||
@@ -6295,6 +6550,21 @@ class App extends React.Component<AppProps, AppState> {
|
||||
}
|
||||
};
|
||||
|
||||
private handleCanvasClick = (event: React.MouseEvent<HTMLCanvasElement>) => {
|
||||
if (event.button !== POINTER_BUTTON.MAIN) {
|
||||
this.lastCompletedCanvasClicks = [];
|
||||
return;
|
||||
}
|
||||
|
||||
this.lastCompletedCanvasClicks = [
|
||||
...this.lastCompletedCanvasClicks.slice(-1),
|
||||
{
|
||||
x: event.clientX,
|
||||
y: event.clientY,
|
||||
},
|
||||
];
|
||||
};
|
||||
|
||||
private getElementLinkAtPosition = (
|
||||
scenePointer: Readonly<{ x: number; y: number }>,
|
||||
hitElementMightBeLocked: NonDeletedExcalidrawElement | null,
|
||||
@@ -6831,6 +7101,12 @@ class App extends React.Component<AppProps, AppState> {
|
||||
const elements = this.scene.getNonDeletedElements();
|
||||
|
||||
const selectedElements = this.scene.getSelectedElements(this.state);
|
||||
|
||||
if (this.isHittingTextAutoResizeHandle(selectedElements, scenePointer)) {
|
||||
setCursor(this.interactiveCanvas, CURSOR_TYPE.POINTER);
|
||||
return;
|
||||
}
|
||||
|
||||
if (
|
||||
selectedElements.length === 1 &&
|
||||
!isOverScrollBar &&
|
||||
@@ -6975,7 +7251,9 @@ class App extends React.Component<AppProps, AppState> {
|
||||
setCursor(this.interactiveCanvas, CURSOR_TYPE.AUTO);
|
||||
} else if (
|
||||
// if using cmd/ctrl, we're not dragging
|
||||
!event[KEYS.CTRL_OR_CMD]
|
||||
!event[KEYS.CTRL_OR_CMD] &&
|
||||
// editing text -> don't show move cursor when hovering over its bbox
|
||||
hitElement?.id !== this.state.editingTextElement?.id
|
||||
) {
|
||||
if (
|
||||
(hitElement ||
|
||||
@@ -7196,6 +7474,8 @@ class App extends React.Component<AppProps, AppState> {
|
||||
private handleCanvasPointerDown = (
|
||||
event: React.PointerEvent<HTMLElement>,
|
||||
) => {
|
||||
const selectedElements = this.scene.getSelectedElements(this.state);
|
||||
|
||||
// If Ctrl is not held, ensure isBindingEnabled reflects the user preference.
|
||||
if (!event.ctrlKey) {
|
||||
const preferenceEnabled = this.state.bindingPreference === "enabled";
|
||||
@@ -7419,6 +7699,15 @@ class App extends React.Component<AppProps, AppState> {
|
||||
selectedElementsAreBeingDragged: false,
|
||||
});
|
||||
|
||||
if (
|
||||
this.handleTextAutoResizeHandlePointerDown(
|
||||
selectedElements,
|
||||
pointerDownState.origin,
|
||||
)
|
||||
) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (this.handleDraggingScrollBar(event, pointerDownState)) {
|
||||
return;
|
||||
}
|
||||
@@ -7644,6 +7933,10 @@ class App extends React.Component<AppProps, AppState> {
|
||||
}
|
||||
|
||||
this.removePointer(event);
|
||||
this.lastPointerUpIsDoubleClick = this.isDoubleClick(
|
||||
this.lastPointerUpEvent,
|
||||
event,
|
||||
);
|
||||
this.lastPointerUpEvent = event;
|
||||
|
||||
if (!event.ctrlKey) {
|
||||
@@ -8480,6 +8773,7 @@ class App extends React.Component<AppProps, AppState> {
|
||||
insertAtParentCenter: !event.altKey,
|
||||
container,
|
||||
autoEdit: false,
|
||||
initialCaretSceneCoords: { x: sceneX, y: sceneY },
|
||||
});
|
||||
|
||||
resetCursor(this.interactiveCanvas);
|
||||
@@ -10965,6 +11259,35 @@ class App extends React.Component<AppProps, AppState> {
|
||||
return;
|
||||
}
|
||||
|
||||
const selectedTextEditingContainer =
|
||||
this.getSelectedTextEditingContainerAtPosition(hitElement, sceneCoords);
|
||||
|
||||
if (
|
||||
activeTool.type === this.state.preferredSelectionTool.type &&
|
||||
!this.state.editingTextElement &&
|
||||
!pointerDownState.drag.hasOccurred &&
|
||||
!pointerDownState.hit.wasAddedToSelection &&
|
||||
!childEvent.shiftKey &&
|
||||
!childEvent[KEYS.CTRL_OR_CMD] &&
|
||||
!childEvent.altKey &&
|
||||
childEvent.pointerType !== "touch" &&
|
||||
hitElement &&
|
||||
((isTextElement(hitElement) &&
|
||||
this.state.selectedElementIds[hitElement.id] &&
|
||||
this.scene.getSelectedElements(this.state).length === 1) ||
|
||||
selectedTextEditingContainer)
|
||||
) {
|
||||
this.startTextEditing({
|
||||
sceneX: sceneCoords.x,
|
||||
sceneY: sceneCoords.y,
|
||||
container: selectedTextEditingContainer,
|
||||
initialCaretSceneCoords: this.lastPointerUpIsDoubleClick
|
||||
? undefined
|
||||
: sceneCoords,
|
||||
});
|
||||
return;
|
||||
}
|
||||
|
||||
if (!activeTool.locked && activeTool.type !== "freedraw" && newElement) {
|
||||
this.setState((prevState) => ({
|
||||
selectedElementIds: makeNextSelectedElementIds(
|
||||
|
||||
@@ -6,14 +6,20 @@
|
||||
padding: 0.5rem;
|
||||
background: var(--popup-bg-color);
|
||||
border: 0 solid color.adjust(#fff, $alpha: -0.75);
|
||||
box-shadow: var(--shadow-island);
|
||||
box-shadow: var(--shadow-island-stronger);
|
||||
border-radius: 4px;
|
||||
position: absolute;
|
||||
:root[dir="rtl"] & {
|
||||
padding: 0.4rem;
|
||||
}
|
||||
}
|
||||
|
||||
.picker-sections,
|
||||
.picker-section {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
gap: 0.5rem;
|
||||
}
|
||||
|
||||
.picker-container button,
|
||||
.picker button {
|
||||
position: relative;
|
||||
@@ -62,7 +68,13 @@
|
||||
|
||||
.picker-collapsible {
|
||||
font-size: 0.75rem;
|
||||
padding: 0.5rem 0;
|
||||
padding: 0;
|
||||
color: var(--text-primary-color);
|
||||
}
|
||||
|
||||
.picker-section-label {
|
||||
font-size: 0.75rem;
|
||||
color: var(--text-primary-color);
|
||||
}
|
||||
|
||||
.picker-keybinding {
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
import { Popover } from "radix-ui";
|
||||
import clsx from "clsx";
|
||||
import React, { useEffect } from "react";
|
||||
import React, { useEffect, useMemo } from "react";
|
||||
|
||||
import { isArrowKey, KEYS } from "@excalidraw/common";
|
||||
|
||||
@@ -8,13 +8,15 @@ import { atom, useAtom } from "../editor-jotai";
|
||||
import { getLanguage, t } from "../i18n";
|
||||
|
||||
import Collapsible from "./Stats/Collapsible";
|
||||
import { useEditorInterface, useExcalidrawContainer } from "./App";
|
||||
import { useExcalidrawContainer } from "./App";
|
||||
|
||||
import "./IconPicker.scss";
|
||||
|
||||
import type { JSX } from "react";
|
||||
|
||||
const moreOptionsAtom = atom(false);
|
||||
const PICKER_COLUMNS = 4;
|
||||
const DEFAULT_SECTION_NAME = "default";
|
||||
|
||||
type Option<T> = {
|
||||
value: T;
|
||||
@@ -23,28 +25,73 @@ type Option<T> = {
|
||||
keyBinding: string | null;
|
||||
};
|
||||
|
||||
type PickerSection<T> = {
|
||||
name: string;
|
||||
options: readonly Option<T>[];
|
||||
};
|
||||
|
||||
const flattenOptions = <T,>(sections: readonly PickerSection<T>[]) =>
|
||||
sections.flatMap((section) => section.options);
|
||||
|
||||
const findOption = <T,>(
|
||||
sections: readonly PickerSection<T>[],
|
||||
predicate: (option: Option<T>) => boolean,
|
||||
) => {
|
||||
for (const section of sections) {
|
||||
const option = section.options.find(predicate);
|
||||
if (option) {
|
||||
return option;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
};
|
||||
|
||||
const hasOption = <T,>(
|
||||
sections: readonly PickerSection<T>[],
|
||||
predicate: (option: Option<T>) => boolean,
|
||||
) => sections.some((section) => section.options.some(predicate));
|
||||
|
||||
const getNavigationRows = <T,>(sections: readonly PickerSection<T>[]) =>
|
||||
sections.flatMap((section) =>
|
||||
Array.from(
|
||||
{ length: Math.ceil(section.options.length / PICKER_COLUMNS) },
|
||||
(_, index) =>
|
||||
section.options.slice(
|
||||
index * PICKER_COLUMNS,
|
||||
index * PICKER_COLUMNS + PICKER_COLUMNS,
|
||||
),
|
||||
),
|
||||
);
|
||||
|
||||
function Picker<T>({
|
||||
options,
|
||||
visibleSections,
|
||||
hiddenSections = [],
|
||||
value,
|
||||
label,
|
||||
onChange,
|
||||
onClose,
|
||||
numberOfOptionsToAlwaysShow = options.length,
|
||||
}: {
|
||||
label: string;
|
||||
value: T;
|
||||
options: readonly Option<T>[];
|
||||
visibleSections: readonly PickerSection<T>[];
|
||||
hiddenSections?: readonly PickerSection<T>[];
|
||||
onChange: (value: T) => void;
|
||||
onClose: () => void;
|
||||
numberOfOptionsToAlwaysShow?: number;
|
||||
}) {
|
||||
const editorInterface = useEditorInterface();
|
||||
const { container } = useExcalidrawContainer();
|
||||
const [showMoreOptions, setShowMoreOptions] = useAtom(moreOptionsAtom);
|
||||
const allSections = [...visibleSections, ...hiddenSections];
|
||||
const allOptions = flattenOptions(allSections);
|
||||
const navigationRows = getNavigationRows([
|
||||
...visibleSections,
|
||||
...(showMoreOptions ? hiddenSections : []),
|
||||
]);
|
||||
|
||||
const handleKeyDown = (event: React.KeyboardEvent) => {
|
||||
const pressedOption = options.find(
|
||||
const pressedOption = allOptions.find(
|
||||
(option) => option.keyBinding === event.key.toLowerCase(),
|
||||
)!;
|
||||
);
|
||||
|
||||
if (!(event.metaKey || event.altKey || event.ctrlKey) && pressedOption) {
|
||||
// Keybinding navigation
|
||||
@@ -52,17 +99,17 @@ function Picker<T>({
|
||||
|
||||
event.preventDefault();
|
||||
} else if (event.key === KEYS.TAB) {
|
||||
const index = options.findIndex((option) => option.value === value);
|
||||
const index = allOptions.findIndex((option) => option.value === value);
|
||||
const nextIndex = event.shiftKey
|
||||
? (options.length + index - 1) % options.length
|
||||
: (index + 1) % options.length;
|
||||
onChange(options[nextIndex].value);
|
||||
? (allOptions.length + index - 1) % allOptions.length
|
||||
: (index + 1) % allOptions.length;
|
||||
onChange(allOptions[nextIndex].value);
|
||||
} else if (isArrowKey(event.key)) {
|
||||
// Arrow navigation
|
||||
const isRTL = getLanguage().rtl;
|
||||
const index = options.findIndex((option) => option.value === value);
|
||||
const index = allOptions.findIndex((option) => option.value === value);
|
||||
if (index !== -1) {
|
||||
const length = options.length;
|
||||
const length = allOptions.length;
|
||||
let nextIndex = index;
|
||||
|
||||
switch (event.key) {
|
||||
@@ -76,18 +123,60 @@ function Picker<T>({
|
||||
break;
|
||||
// Go the next row
|
||||
case KEYS.ARROW_DOWN: {
|
||||
nextIndex = (index + (numberOfOptionsToAlwaysShow ?? 1)) % length;
|
||||
const currentRowIndex = navigationRows.findIndex((row) =>
|
||||
row.some((option) => option.value === value),
|
||||
);
|
||||
const currentRow = navigationRows[currentRowIndex];
|
||||
|
||||
if (currentRowIndex !== -1 && currentRow) {
|
||||
const column = currentRow.findIndex(
|
||||
(option) => option.value === value,
|
||||
);
|
||||
const nextRow =
|
||||
navigationRows[(currentRowIndex + 1) % navigationRows.length];
|
||||
const nextOption =
|
||||
nextRow[Math.min(column, nextRow.length - 1)] ??
|
||||
allOptions[index];
|
||||
|
||||
onChange(nextOption.value);
|
||||
event.preventDefault();
|
||||
event.nativeEvent.stopImmediatePropagation();
|
||||
event.stopPropagation();
|
||||
return;
|
||||
}
|
||||
break;
|
||||
}
|
||||
// Go the previous row
|
||||
case KEYS.ARROW_UP: {
|
||||
nextIndex =
|
||||
(length + index - (numberOfOptionsToAlwaysShow ?? 1)) % length;
|
||||
const currentRowIndex = navigationRows.findIndex((row) =>
|
||||
row.some((option) => option.value === value),
|
||||
);
|
||||
const currentRow = navigationRows[currentRowIndex];
|
||||
|
||||
if (currentRowIndex !== -1 && currentRow) {
|
||||
const column = currentRow.findIndex(
|
||||
(option) => option.value === value,
|
||||
);
|
||||
const previousRow =
|
||||
navigationRows[
|
||||
(navigationRows.length + currentRowIndex - 1) %
|
||||
navigationRows.length
|
||||
];
|
||||
const previousOption =
|
||||
previousRow[Math.min(column, previousRow.length - 1)] ??
|
||||
allOptions[index];
|
||||
|
||||
onChange(previousOption.value);
|
||||
event.preventDefault();
|
||||
event.nativeEvent.stopImmediatePropagation();
|
||||
event.stopPropagation();
|
||||
return;
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
onChange(options[nextIndex].value);
|
||||
onChange(allOptions[nextIndex].value);
|
||||
}
|
||||
event.preventDefault();
|
||||
} else if (event.key === KEYS.ESCAPE || event.key === KEYS.ENTER) {
|
||||
@@ -99,38 +188,29 @@ function Picker<T>({
|
||||
event.stopPropagation();
|
||||
};
|
||||
|
||||
const [showMoreOptions, setShowMoreOptions] = useAtom(moreOptionsAtom);
|
||||
|
||||
const alwaysVisibleOptions = React.useMemo(
|
||||
() => options.slice(0, numberOfOptionsToAlwaysShow),
|
||||
[options, numberOfOptionsToAlwaysShow],
|
||||
);
|
||||
const moreOptions = React.useMemo(
|
||||
() => options.slice(numberOfOptionsToAlwaysShow),
|
||||
[options, numberOfOptionsToAlwaysShow],
|
||||
);
|
||||
|
||||
useEffect(() => {
|
||||
if (!alwaysVisibleOptions.some((option) => option.value === value)) {
|
||||
if (hasOption(hiddenSections, (option) => option.value === value)) {
|
||||
setShowMoreOptions(true);
|
||||
}
|
||||
}, [value, alwaysVisibleOptions, setShowMoreOptions]);
|
||||
}, [value, hiddenSections, setShowMoreOptions]);
|
||||
|
||||
const renderOptions = (options: Option<T>[]) => {
|
||||
const renderOptions = (options: readonly Option<T>[]) => {
|
||||
return (
|
||||
<div className="picker-content">
|
||||
{options.map((option, i) => (
|
||||
{options.map((option) => (
|
||||
<button
|
||||
type="button"
|
||||
className={clsx("picker-option", {
|
||||
active: value === option.value,
|
||||
})}
|
||||
onClick={(event) => {
|
||||
onClick={() => {
|
||||
onChange(option.value);
|
||||
}}
|
||||
title={`${option.text} ${
|
||||
option.keyBinding && `— ${option.keyBinding.toUpperCase()}`
|
||||
}`}
|
||||
title={
|
||||
option.keyBinding
|
||||
? `${option.text} — ${option.keyBinding.toUpperCase()}`
|
||||
: option.text
|
||||
}
|
||||
aria-label={option.text || "none"}
|
||||
aria-keyshortcuts={option.keyBinding || undefined}
|
||||
key={option.text}
|
||||
@@ -153,26 +233,38 @@ function Picker<T>({
|
||||
);
|
||||
};
|
||||
|
||||
const isMobile = editorInterface.formFactor === "phone";
|
||||
const renderSections = (sections: readonly PickerSection<T>[]) =>
|
||||
sections.map((section, index) =>
|
||||
section.name === DEFAULT_SECTION_NAME ? (
|
||||
<React.Fragment key={`${section.name}-${index}`}>
|
||||
{renderOptions(section.options)}
|
||||
</React.Fragment>
|
||||
) : (
|
||||
<div className="picker-section" key={`${section.name}-${index}`}>
|
||||
<div className="picker-section-label">{section.name}</div>
|
||||
{renderOptions(section.options)}
|
||||
</div>
|
||||
),
|
||||
);
|
||||
|
||||
return (
|
||||
<Popover.Content
|
||||
side={isMobile ? "right" : "bottom"}
|
||||
className="picker"
|
||||
role="dialog"
|
||||
aria-modal="true"
|
||||
aria-label={label}
|
||||
side={"bottom"}
|
||||
align="start"
|
||||
sideOffset={isMobile ? 8 : 12}
|
||||
sideOffset={12}
|
||||
alignOffset={12}
|
||||
style={{ zIndex: "var(--zIndex-ui-styles-popup)" }}
|
||||
onKeyDown={handleKeyDown}
|
||||
collisionBoundary={container ?? undefined}
|
||||
>
|
||||
<div
|
||||
className={`picker`}
|
||||
role="dialog"
|
||||
aria-modal="true"
|
||||
aria-label={label}
|
||||
>
|
||||
{renderOptions(alwaysVisibleOptions)}
|
||||
<div className="picker-sections">
|
||||
{renderSections(visibleSections)}
|
||||
|
||||
{moreOptions.length > 0 && (
|
||||
{hiddenSections.length > 0 && (
|
||||
<Collapsible
|
||||
label={t("labels.more_options")}
|
||||
open={showMoreOptions}
|
||||
@@ -181,7 +273,9 @@ function Picker<T>({
|
||||
}}
|
||||
className="picker-collapsible"
|
||||
>
|
||||
{renderOptions(moreOptions)}
|
||||
<div className="picker-sections">
|
||||
{renderSections(hiddenSections)}
|
||||
</div>
|
||||
</Collapsible>
|
||||
)}
|
||||
</div>
|
||||
@@ -192,49 +286,45 @@ function Picker<T>({
|
||||
export function IconPicker<T>({
|
||||
value,
|
||||
label,
|
||||
options,
|
||||
visibleSections,
|
||||
hiddenSections,
|
||||
onChange,
|
||||
group = "",
|
||||
numberOfOptionsToAlwaysShow,
|
||||
}: {
|
||||
label: string;
|
||||
value: T;
|
||||
options: readonly {
|
||||
value: T;
|
||||
text: string;
|
||||
icon: JSX.Element;
|
||||
keyBinding: string | null;
|
||||
}[];
|
||||
visibleSections: readonly PickerSection<T>[];
|
||||
hiddenSections?: readonly PickerSection<T>[];
|
||||
onChange: (value: T) => void;
|
||||
numberOfOptionsToAlwaysShow?: number;
|
||||
group?: string;
|
||||
}) {
|
||||
const [isActive, setActive] = React.useState(false);
|
||||
const rPickerButton = React.useRef<any>(null);
|
||||
const selectedOption = useMemo(
|
||||
() =>
|
||||
findOption(visibleSections, (option) => option.value === value) ??
|
||||
findOption(hiddenSections ?? [], (option) => option.value === value),
|
||||
[visibleSections, hiddenSections, value],
|
||||
);
|
||||
|
||||
return (
|
||||
<div>
|
||||
<Popover.Root open={isActive} onOpenChange={(open) => setActive(open)}>
|
||||
<Popover.Trigger
|
||||
name={group}
|
||||
type="button"
|
||||
aria-label={label}
|
||||
onClick={() => setActive(!isActive)}
|
||||
ref={rPickerButton}
|
||||
className={isActive ? "active" : ""}
|
||||
>
|
||||
{options.find((option) => option.value === value)?.icon}
|
||||
{selectedOption?.icon}
|
||||
</Popover.Trigger>
|
||||
{isActive && (
|
||||
<Picker
|
||||
options={options}
|
||||
visibleSections={visibleSections}
|
||||
hiddenSections={hiddenSections}
|
||||
value={value}
|
||||
label={label}
|
||||
onChange={onChange}
|
||||
onClose={() => {
|
||||
setActive(false);
|
||||
}}
|
||||
numberOfOptionsToAlwaysShow={numberOfOptionsToAlwaysShow}
|
||||
/>
|
||||
)}
|
||||
</Popover.Root>
|
||||
|
||||
@@ -1,74 +1,78 @@
|
||||
import React, { useEffect } from "react";
|
||||
|
||||
import { t } from "../i18n";
|
||||
|
||||
import "./Range.scss";
|
||||
|
||||
import type { AppClassProperties } from "../types";
|
||||
|
||||
export type RangeProps = {
|
||||
updateData: (value: number) => void;
|
||||
app: AppClassProperties;
|
||||
label: React.ReactNode;
|
||||
value: number;
|
||||
onChange: (value: number) => void;
|
||||
min?: number;
|
||||
max?: number;
|
||||
step?: number;
|
||||
minLabel?: React.ReactNode;
|
||||
hasCommonValue?: boolean;
|
||||
testId?: string;
|
||||
};
|
||||
|
||||
export const Range = ({ updateData, app, testId }: RangeProps) => {
|
||||
export const Range = ({
|
||||
label,
|
||||
value,
|
||||
onChange,
|
||||
min = 0,
|
||||
max = 100,
|
||||
step = 10,
|
||||
minLabel = min,
|
||||
hasCommonValue = true,
|
||||
testId,
|
||||
}: RangeProps) => {
|
||||
const rangeRef = React.useRef<HTMLInputElement>(null);
|
||||
const valueRef = React.useRef<HTMLDivElement>(null);
|
||||
const selectedElements = app.scene.getSelectedElements(app.state);
|
||||
let hasCommonOpacity = true;
|
||||
const firstElement = selectedElements.at(0);
|
||||
const leastCommonOpacity = selectedElements.reduce((acc, element) => {
|
||||
if (acc != null && acc !== element.opacity) {
|
||||
hasCommonOpacity = false;
|
||||
}
|
||||
if (acc == null || acc > element.opacity) {
|
||||
return element.opacity;
|
||||
}
|
||||
return acc;
|
||||
}, firstElement?.opacity ?? null);
|
||||
|
||||
const value = leastCommonOpacity ?? app.state.currentItemOpacity;
|
||||
|
||||
useEffect(() => {
|
||||
if (rangeRef.current && valueRef.current) {
|
||||
const rangeElement = rangeRef.current;
|
||||
const valueElement = valueRef.current;
|
||||
const inputWidth = rangeElement.offsetWidth;
|
||||
const thumbWidth = 15; // 15 is the width of the thumb
|
||||
const thumbWidth =
|
||||
parseFloat(
|
||||
getComputedStyle(rangeElement).getPropertyValue(
|
||||
"--slider-thumb-size",
|
||||
),
|
||||
) || 16;
|
||||
const progress = ((value - min) / (max - min || 1)) * 100;
|
||||
const position =
|
||||
(value / 100) * (inputWidth - thumbWidth) + thumbWidth / 2;
|
||||
(progress / 100) * (inputWidth - thumbWidth) + thumbWidth / 2;
|
||||
valueElement.style.left = `${position}px`;
|
||||
rangeElement.style.background = `linear-gradient(to right, var(--color-slider-track) 0%, var(--color-slider-track) ${value}%, var(--button-bg) ${value}%, var(--button-bg) 100%)`;
|
||||
rangeElement.style.background = `linear-gradient(to right, var(--color-slider-track) 0%, var(--color-slider-track) ${progress}%, var(--button-bg) ${progress}%, var(--button-bg) 100%)`;
|
||||
}
|
||||
}, [value]);
|
||||
}, [max, min, value]);
|
||||
|
||||
return (
|
||||
<label className="control-label">
|
||||
{t("labels.opacity")}
|
||||
{label}
|
||||
<div className="range-wrapper">
|
||||
<input
|
||||
style={{
|
||||
["--color-slider-track" as string]: hasCommonOpacity
|
||||
["--color-slider-track" as string]: hasCommonValue
|
||||
? undefined
|
||||
: "var(--button-bg)",
|
||||
}}
|
||||
ref={rangeRef}
|
||||
type="range"
|
||||
min="0"
|
||||
max="100"
|
||||
step="10"
|
||||
min={min}
|
||||
max={max}
|
||||
step={step}
|
||||
onChange={(event) => {
|
||||
updateData(+event.target.value);
|
||||
onChange(+event.target.value);
|
||||
}}
|
||||
value={value}
|
||||
className="range-input"
|
||||
data-testid={testId}
|
||||
/>
|
||||
<div className="value-bubble" ref={valueRef}>
|
||||
{value !== 0 ? value : null}
|
||||
{value !== min ? value : null}
|
||||
</div>
|
||||
<div className="zero-label">0</div>
|
||||
<div className="zero-label">{minLabel}</div>
|
||||
</div>
|
||||
</label>
|
||||
);
|
||||
|
||||
@@ -361,12 +361,10 @@ describe("stats for a non-generic element", () => {
|
||||
mouse.clickAt(20, 30);
|
||||
const editor = await getTextEditor();
|
||||
updateTextEditor(editor, "Hello!");
|
||||
act(() => {
|
||||
editor.blur();
|
||||
});
|
||||
Keyboard.exitTextEditor(editor);
|
||||
|
||||
const text = h.elements[0] as ExcalidrawTextElement;
|
||||
mouse.clickOn(text);
|
||||
API.setSelectedElements([text]);
|
||||
|
||||
elementStats = stats?.querySelector("#elementStats");
|
||||
|
||||
|
||||
@@ -236,15 +236,40 @@ const MermaidToExcalidraw = ({
|
||||
<Trans
|
||||
i18nKey="mermaid.description"
|
||||
flowchartLink={(el) => (
|
||||
<a href="https://mermaid.js.org/syntax/flowchart.html">{el}</a>
|
||||
<a
|
||||
href="https://mermaid.js.org/syntax/flowchart.html"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
>
|
||||
{el}
|
||||
</a>
|
||||
)}
|
||||
sequenceLink={(el) => (
|
||||
<a href="https://mermaid.js.org/syntax/sequenceDiagram.html">
|
||||
<a
|
||||
href="https://mermaid.js.org/syntax/sequenceDiagram.html"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
>
|
||||
{el}
|
||||
</a>
|
||||
)}
|
||||
classLink={(el) => (
|
||||
<a href="https://mermaid.js.org/syntax/classDiagram.html">{el}</a>
|
||||
<a
|
||||
href="https://mermaid.js.org/syntax/classDiagram.html"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
>
|
||||
{el}
|
||||
</a>
|
||||
)}
|
||||
erdLink={(el) => (
|
||||
<a
|
||||
href="https://mermaid.js.org/syntax/entityRelationshipDiagram.html"
|
||||
target="_blank"
|
||||
rel="noreferrer"
|
||||
>
|
||||
{el}
|
||||
</a>
|
||||
)}
|
||||
/>
|
||||
</div>
|
||||
|
||||
@@ -94,7 +94,7 @@ export const convertMermaidToExcalidraw = async ({
|
||||
}
|
||||
}
|
||||
|
||||
const { elements, files } = ret;
|
||||
const { elements, files = {} } = ret;
|
||||
setError(null);
|
||||
|
||||
data.current = {
|
||||
|
||||
@@ -54,6 +54,7 @@ type InteractiveCanvasProps = {
|
||||
DOMAttributes<HTMLCanvasElement | HTMLDivElement>["onContextMenu"],
|
||||
undefined
|
||||
>;
|
||||
onClick: Exclude<DOMAttributes<HTMLCanvasElement>["onClick"], undefined>;
|
||||
onPointerMove: Exclude<
|
||||
DOMAttributes<HTMLCanvasElement>["onPointerMove"],
|
||||
undefined
|
||||
@@ -213,6 +214,7 @@ const InteractiveCanvas = (props: InteractiveCanvasProps) => {
|
||||
height={props.appState.height * props.scale}
|
||||
ref={props.handleCanvasRef}
|
||||
onContextMenu={props.onContextMenu}
|
||||
onClick={props.onClick}
|
||||
onPointerMove={props.onPointerMove}
|
||||
onPointerUp={props.onPointerUp}
|
||||
onPointerCancel={props.onPointerCancel}
|
||||
|
||||
@@ -69,6 +69,11 @@ const modifiedTablerIconProps: Opts = {
|
||||
strokeLinejoin: "round",
|
||||
} as const;
|
||||
|
||||
const arrowheadPreviewIconProps: Opts = {
|
||||
width: 40,
|
||||
height: 20,
|
||||
} as const;
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
// tabler-icons: present
|
||||
@@ -1291,16 +1296,17 @@ export const ArrowheadNoneIcon = React.memo(
|
||||
({ flip = false }: { flip?: boolean }) =>
|
||||
createIcon(
|
||||
<g
|
||||
transform={flip ? "translate(24, 0) scale(-1, 1)" : ""}
|
||||
transform={flip ? "translate(40, 0) scale(-1, 1)" : ""}
|
||||
stroke="currentColor"
|
||||
opacity={0.3}
|
||||
strokeWidth={2}
|
||||
fill="none"
|
||||
strokeLinecap="round"
|
||||
>
|
||||
<path d="M12 12l-9 0" />
|
||||
<path d="M21 9l-6 6" />
|
||||
<path d="M21 15l-6 -6" />
|
||||
<path d="M7,11 H19" />
|
||||
<path d="M25,6 L33,16 M33,6 L25,16" />
|
||||
</g>,
|
||||
tablerIconProps,
|
||||
arrowheadPreviewIconProps,
|
||||
),
|
||||
);
|
||||
|
||||
@@ -1312,57 +1318,12 @@ export const ArrowheadArrowIcon = React.memo(
|
||||
stroke="currentColor"
|
||||
strokeWidth={2}
|
||||
fill="none"
|
||||
strokeLinecap="round"
|
||||
strokeLinejoin="round"
|
||||
>
|
||||
<path d="M34 10H6M34 10L27 5M34 10L27 15" />
|
||||
<path d="M27.5 5L34.5 10L27.5 15" />
|
||||
<path d="M7,11 H33 M23,5 L33,11 L23,17" />
|
||||
</g>,
|
||||
{ width: 40, height: 20 },
|
||||
),
|
||||
);
|
||||
|
||||
export const ArrowheadCircleIcon = React.memo(
|
||||
({ flip = false }: { flip?: boolean }) =>
|
||||
createIcon(
|
||||
<g
|
||||
stroke="currentColor"
|
||||
fill="currentColor"
|
||||
transform={flip ? "translate(40, 0) scale(-1, 1)" : ""}
|
||||
>
|
||||
<path d="M32 10L6 10" strokeWidth={2} />
|
||||
<circle r="4" transform="matrix(-1 0 0 1 30 10)" />
|
||||
</g>,
|
||||
{ width: 40, height: 20 },
|
||||
),
|
||||
);
|
||||
|
||||
export const ArrowheadCircleOutlineIcon = React.memo(
|
||||
({ flip = false }: { flip?: boolean }) =>
|
||||
createIcon(
|
||||
<g
|
||||
stroke="currentColor"
|
||||
fill="none"
|
||||
transform={flip ? "translate(40, 0) scale(-1, 1)" : ""}
|
||||
strokeWidth={2}
|
||||
>
|
||||
<path d="M26 10L6 10" />
|
||||
<circle r="4" transform="matrix(-1 0 0 1 30 10)" />
|
||||
</g>,
|
||||
{ width: 40, height: 20 },
|
||||
),
|
||||
);
|
||||
|
||||
export const ArrowheadBarIcon = React.memo(
|
||||
({ flip = false }: { flip?: boolean }) =>
|
||||
createIcon(
|
||||
<g transform={flip ? "translate(40, 0) scale(-1, 1)" : ""}>
|
||||
<path
|
||||
d="M34 10H5.99996M34 10L34 5M34 10L34 15"
|
||||
stroke="currentColor"
|
||||
strokeWidth={2}
|
||||
fill="none"
|
||||
/>
|
||||
</g>,
|
||||
{ width: 40, height: 20 },
|
||||
arrowheadPreviewIconProps,
|
||||
),
|
||||
);
|
||||
|
||||
@@ -1373,11 +1334,12 @@ export const ArrowheadTriangleIcon = React.memo(
|
||||
stroke="currentColor"
|
||||
fill="currentColor"
|
||||
transform={flip ? "translate(40, 0) scale(-1, 1)" : ""}
|
||||
strokeLinejoin="round"
|
||||
>
|
||||
<path d="M32 10L6 10" strokeWidth={2} />
|
||||
<path d="M27.5 5.5L34.5 10L27.5 14.5L27.5 5.5" />
|
||||
<path d="M7,11 H23" strokeWidth={2} strokeLinecap="round" />
|
||||
<path d="M23,5 L35,11 L23,17 Z" />
|
||||
</g>,
|
||||
{ width: 40, height: 20 },
|
||||
arrowheadPreviewIconProps,
|
||||
),
|
||||
);
|
||||
|
||||
@@ -1390,12 +1352,43 @@ export const ArrowheadTriangleOutlineIcon = React.memo(
|
||||
transform={flip ? "translate(40, 0) scale(-1, 1)" : ""}
|
||||
strokeWidth={2}
|
||||
strokeLinejoin="round"
|
||||
strokeLinecap="round"
|
||||
>
|
||||
<path d="M6,9.5H27" />
|
||||
<path d="M27,5L34,10L27,14Z" fill="none" />
|
||||
<path d="M7,11 H23" />
|
||||
<path d="M23,5 L35,11 L23,17 Z" />
|
||||
</g>,
|
||||
arrowheadPreviewIconProps,
|
||||
),
|
||||
);
|
||||
|
||||
{ width: 40, height: 20 },
|
||||
export const ArrowheadCircleIcon = React.memo(
|
||||
({ flip = false }: { flip?: boolean }) =>
|
||||
createIcon(
|
||||
<g
|
||||
stroke="currentColor"
|
||||
fill="currentColor"
|
||||
transform={flip ? "translate(40, 0) scale(-1, 1)" : ""}
|
||||
>
|
||||
<path d="M7,11 H25" strokeWidth={2} strokeLinecap="round" />
|
||||
<circle cx="29" cy="11" r="4" />
|
||||
</g>,
|
||||
arrowheadPreviewIconProps,
|
||||
),
|
||||
);
|
||||
|
||||
export const ArrowheadCircleOutlineIcon = React.memo(
|
||||
({ flip = false }: { flip?: boolean }) =>
|
||||
createIcon(
|
||||
<g
|
||||
stroke="currentColor"
|
||||
fill="none"
|
||||
transform={flip ? "translate(40, 0) scale(-1, 1)" : ""}
|
||||
strokeWidth={2}
|
||||
>
|
||||
<path d="M7,11 H25" strokeLinecap="round" />
|
||||
<circle cx="29" cy="11" r="4" />
|
||||
</g>,
|
||||
arrowheadPreviewIconProps,
|
||||
),
|
||||
);
|
||||
|
||||
@@ -1407,12 +1400,11 @@ export const ArrowheadDiamondIcon = React.memo(
|
||||
fill="currentColor"
|
||||
transform={flip ? "translate(40, 0) scale(-1, 1)" : ""}
|
||||
strokeLinejoin="round"
|
||||
strokeWidth={2}
|
||||
>
|
||||
<path d="M6,9.5H20" />
|
||||
<path d="M27,5L34,10L27,14L20,9.5Z" />
|
||||
<path d="M7,11 H21" strokeWidth={2} strokeLinecap="round" />
|
||||
<path d="M21,11 L28,5 L35,11 L28,17 Z" />
|
||||
</g>,
|
||||
{ width: 40, height: 20 },
|
||||
arrowheadPreviewIconProps,
|
||||
),
|
||||
);
|
||||
|
||||
@@ -1425,15 +1417,32 @@ export const ArrowheadDiamondOutlineIcon = React.memo(
|
||||
transform={flip ? "translate(40, 0) scale(-1, 1)" : ""}
|
||||
strokeLinejoin="round"
|
||||
strokeWidth={2}
|
||||
strokeLinecap="round"
|
||||
>
|
||||
<path d="M6,9.5H20" />
|
||||
<path d="M27,5L34,10L27,14L20,9.5Z" />
|
||||
<path d="M7,11 H21" />
|
||||
<path d="M21,11 L28,5 L35,11 L28,17 Z" />
|
||||
</g>,
|
||||
{ width: 40, height: 20 },
|
||||
arrowheadPreviewIconProps,
|
||||
),
|
||||
);
|
||||
|
||||
export const ArrowheadCrowfootIcon = React.memo(
|
||||
export const ArrowheadBarIcon = React.memo(
|
||||
({ flip = false }: { flip?: boolean }) =>
|
||||
createIcon(
|
||||
<g
|
||||
transform={flip ? "translate(40, 0) scale(-1, 1)" : ""}
|
||||
stroke="currentColor"
|
||||
strokeWidth={2}
|
||||
fill="none"
|
||||
strokeLinecap="round"
|
||||
>
|
||||
<path d="M11,11 H31 M31,5 V17" />
|
||||
</g>,
|
||||
arrowheadPreviewIconProps,
|
||||
),
|
||||
);
|
||||
|
||||
export const ArrowheadCardinalityOneIcon = React.memo(
|
||||
({ flip = false }: { flip?: boolean }) =>
|
||||
createIcon(
|
||||
<g
|
||||
@@ -1443,13 +1452,13 @@ export const ArrowheadCrowfootIcon = React.memo(
|
||||
strokeLinejoin="round"
|
||||
strokeWidth={2}
|
||||
>
|
||||
<path d="M34,10 H6 M15,10 L7,5 M15,10 L7,15" />
|
||||
<path d="M35,11 H7 M15,5 V17" />
|
||||
</g>,
|
||||
{ width: 40, height: 20 },
|
||||
arrowheadPreviewIconProps,
|
||||
),
|
||||
);
|
||||
|
||||
export const ArrowheadCrowfootOneIcon = React.memo(
|
||||
export const ArrowheadCardinalityManyIcon = React.memo(
|
||||
({ flip = false }: { flip?: boolean }) =>
|
||||
createIcon(
|
||||
<g
|
||||
@@ -1459,13 +1468,13 @@ export const ArrowheadCrowfootOneIcon = React.memo(
|
||||
strokeLinejoin="round"
|
||||
strokeWidth={2}
|
||||
>
|
||||
<path d="M34,10 H6 M15,10 L15,15 L15,5" />
|
||||
<path d="M35,11 H7 M15,11 L7,5 M15,11 L7,17" />
|
||||
</g>,
|
||||
{ width: 40, height: 20 },
|
||||
arrowheadPreviewIconProps,
|
||||
),
|
||||
);
|
||||
|
||||
export const ArrowheadCrowfootOneOrManyIcon = React.memo(
|
||||
export const ArrowheadCardinalityOneOrManyIcon = React.memo(
|
||||
({ flip = false }: { flip?: boolean }) =>
|
||||
createIcon(
|
||||
<g
|
||||
@@ -1475,9 +1484,59 @@ export const ArrowheadCrowfootOneOrManyIcon = React.memo(
|
||||
strokeLinejoin="round"
|
||||
strokeWidth={2}
|
||||
>
|
||||
<path d="M34,10 H6 M15,10 L15,16 L15,4 M15,10 L7,5 M15,10 L7,15" />
|
||||
<path d="M35,11 H7 M23,5 V17 M15,11 L7,5 M15,11 L7,17" />
|
||||
</g>,
|
||||
{ width: 40, height: 20 },
|
||||
arrowheadPreviewIconProps,
|
||||
),
|
||||
);
|
||||
|
||||
export const ArrowheadCardinalityExactlyOneIcon = React.memo(
|
||||
({ flip = false }: { flip?: boolean }) =>
|
||||
createIcon(
|
||||
<g
|
||||
stroke="currentColor"
|
||||
fill="none"
|
||||
transform={flip ? "" : "translate(40, 0) scale(-1, 1)"}
|
||||
strokeLinejoin="round"
|
||||
strokeWidth={2}
|
||||
>
|
||||
<path d="M35,11 H7 M15,5 V17 M7,5 V17" />
|
||||
</g>,
|
||||
arrowheadPreviewIconProps,
|
||||
),
|
||||
);
|
||||
|
||||
export const ArrowheadCardinalityZeroOrOneIcon = React.memo(
|
||||
({ flip = false }: { flip?: boolean }) =>
|
||||
createIcon(
|
||||
<g
|
||||
stroke="currentColor"
|
||||
fill="none"
|
||||
transform={flip ? "" : "translate(40, 0) scale(-1, 1)"}
|
||||
strokeLinejoin="round"
|
||||
strokeWidth={2}
|
||||
>
|
||||
<path d="M35,11 H19 M11,11 H7 M7,5 V17" />
|
||||
<circle cx="15" cy="11" r="4" />
|
||||
</g>,
|
||||
arrowheadPreviewIconProps,
|
||||
),
|
||||
);
|
||||
|
||||
export const ArrowheadCardinalityZeroOrManyIcon = React.memo(
|
||||
({ flip = false }: { flip?: boolean }) =>
|
||||
createIcon(
|
||||
<g
|
||||
stroke="currentColor"
|
||||
fill="none"
|
||||
transform={flip ? "" : "translate(40, 0) scale(-1, 1)"}
|
||||
strokeLinejoin="round"
|
||||
strokeWidth={2}
|
||||
>
|
||||
<path d="M35,11 H27 M19,11 H7 M15,11 L7,5 M15,11 L7,17" />
|
||||
<circle cx="23" cy="11" r="4" />
|
||||
</g>,
|
||||
arrowheadPreviewIconProps,
|
||||
),
|
||||
);
|
||||
|
||||
|
||||
@@ -34,9 +34,10 @@
|
||||
--popup-text-color: #000;
|
||||
--popup-text-inverted-color: #fff;
|
||||
--select-highlight-color: #{$color-blue-5};
|
||||
--shadow-island: 0px 0px 0.9310142993927002px 0px rgba(0, 0, 0, 0.17),
|
||||
0px 0px 3.1270833015441895px 0px rgba(0, 0, 0, 0.08),
|
||||
0px 7px 14px 0px rgba(0, 0, 0, 0.05);
|
||||
--shadow-island: 0px 0px 1px 0px rgba(0, 0, 0, 0.17),
|
||||
0px 0px 3px 0px rgba(0, 0, 0, 0.08), 0px 7px 14px 0px rgba(0, 0, 0, 0.05);
|
||||
--shadow-island-stronger: 0px 0px 1px 0px rgba(0, 0, 0, 0.17),
|
||||
0px 0px 3px 0px rgba(0, 0, 0, 0.08), 0px 7px 14px 0px rgb(0 0 0 / 18%);
|
||||
|
||||
--button-hover-bg: var(--color-surface-high);
|
||||
--button-active-bg: var(--color-surface-high);
|
||||
@@ -210,9 +211,6 @@
|
||||
--popup-text-color: #{$color-gray-4};
|
||||
--popup-text-inverted-color: #2c2c2c;
|
||||
--select-highlight-color: #{$color-blue-4};
|
||||
--shadow-island: 0px 0px 0.9310142993927002px 0px rgba(0, 0, 0, 0.17),
|
||||
0px 0px 3.1270833015441895px 0px rgba(0, 0, 0, 0.08),
|
||||
0px 7px 14px 0px rgba(0, 0, 0, 0.05);
|
||||
|
||||
--modal-shadow: 0px 100px 80px rgba(0, 0, 0, 0.07),
|
||||
0px 41.7776px 33.4221px rgba(0, 0, 0, 0.0503198),
|
||||
|
||||
@@ -20,10 +20,6 @@ export const resaveAsImageWithScene = async (
|
||||
) => {
|
||||
const fileHandleType = getFileHandleType(fileHandle);
|
||||
|
||||
if (Math.random() < 1) {
|
||||
throw new Error("OLALALALA");
|
||||
}
|
||||
|
||||
if (!isImageFileHandleType(fileHandleType)) {
|
||||
throw new Error(
|
||||
"fileHandle should exist and should be of type svg or png when resaving",
|
||||
|
||||
@@ -22,6 +22,7 @@ import {
|
||||
import {
|
||||
calculateFixedPointForNonElbowArrowBinding,
|
||||
getNonDeletedElements,
|
||||
normalizeArrowhead,
|
||||
isPointInElement,
|
||||
isValidPolygon,
|
||||
projectFixedPointOntoDiagonal,
|
||||
@@ -426,7 +427,8 @@ export const restoreElement = (
|
||||
// @ts-ignore LEGACY type
|
||||
// eslint-disable-next-line no-fallthrough
|
||||
case "draw":
|
||||
const { startArrowhead = null, endArrowhead = null } = element;
|
||||
const startArrowhead = normalizeArrowhead(element.startArrowhead);
|
||||
const endArrowhead = normalizeArrowhead(element.endArrowhead);
|
||||
let x = element.x;
|
||||
let y = element.y;
|
||||
let points = // migrate old arrow model to new one
|
||||
@@ -458,7 +460,11 @@ export const restoreElement = (
|
||||
...getSizeFromPoints(points),
|
||||
});
|
||||
case "arrow": {
|
||||
const { startArrowhead = null, endArrowhead = "arrow" } = element;
|
||||
const startArrowhead = normalizeArrowhead(element.startArrowhead);
|
||||
const endArrowhead =
|
||||
element.endArrowhead === undefined
|
||||
? "arrow"
|
||||
: normalizeArrowhead(element.endArrowhead);
|
||||
const x: number | undefined = element.x;
|
||||
const y: number | undefined = element.y;
|
||||
const points: readonly LocalPoint[] | undefined = // migrate old arrow model to new one
|
||||
|
||||
Vendored
+2
@@ -4,6 +4,8 @@ interface Window {
|
||||
EXCALIDRAW_ASSET_PATH: string | string[] | undefined;
|
||||
EXCALIDRAW_THROTTLE_RENDER: boolean | undefined;
|
||||
DEBUG_FRACTIONAL_INDICES: boolean | undefined;
|
||||
EXCALIDRAW_DEBUG_LINEAR_ARROW_TANGENTS: boolean | undefined;
|
||||
EXCALIDRAW_DEBUG_SELECTED_LINEAR_ARROW: unknown;
|
||||
EXCALIDRAW_EXPORT_SOURCE: string;
|
||||
gtag: Function;
|
||||
sa_event: Function;
|
||||
|
||||
@@ -6,6 +6,51 @@ import { getDefaultAppState } from "../appState";
|
||||
|
||||
import type { AppState } from "../types";
|
||||
|
||||
type AppStateSelector =
|
||||
| keyof AppState
|
||||
| (keyof AppState)[]
|
||||
| ((appState: AppState) => unknown);
|
||||
|
||||
const getSelectedValue = (appState: AppState, selector: AppStateSelector) => {
|
||||
if (typeof selector === "function") {
|
||||
return selector(appState);
|
||||
}
|
||||
if (Array.isArray(selector)) {
|
||||
return appState;
|
||||
}
|
||||
return appState[selector];
|
||||
};
|
||||
|
||||
const getLatestValue = (
|
||||
api: ReturnType<typeof useExcalidrawAPI>,
|
||||
selector: AppStateSelector,
|
||||
_internal: boolean,
|
||||
) => {
|
||||
if (api?.isDestroyed) {
|
||||
return;
|
||||
}
|
||||
|
||||
let appState = api?.getAppState();
|
||||
if (!appState) {
|
||||
if (!_internal) {
|
||||
return undefined;
|
||||
}
|
||||
|
||||
console.warn(
|
||||
"useAppStateValue: excalidrawAPI not defined yet for internal component while it should always be defined. Are you sure you're rendering inside of <Excalidraw/> component tree?",
|
||||
);
|
||||
// fall back in case there's a bug so we don't break the app
|
||||
// (internal components using this internal useAppStateValue expect
|
||||
// non-undefined values on init)
|
||||
appState = Object.assign(
|
||||
{ width: 0, height: 0, offsetLeft: 0, offsetTop: 0 },
|
||||
getDefaultAppState(),
|
||||
);
|
||||
}
|
||||
|
||||
return getSelectedValue(appState, selector);
|
||||
};
|
||||
|
||||
/**
|
||||
* Subscribes to specific appState changes. The component re-renders
|
||||
* only when the specified prop(s) change — not on every appState update.
|
||||
@@ -19,92 +64,109 @@ import type { AppState } from "../types";
|
||||
* - `(keyof AppState)[]` → whole `AppState`
|
||||
* - selector function → selector's return type `T`
|
||||
*
|
||||
* Calls the optional callback with the latest value on every change (not called
|
||||
* on initial render).
|
||||
*
|
||||
* If excalidrawAPI is not ready yet (host apps), hook is rerendered with latest
|
||||
* value once available.
|
||||
*/
|
||||
export function useAppStateValue<K extends keyof AppState>(
|
||||
prop: K,
|
||||
callback?: (value: AppState[K], appState: AppState) => void,
|
||||
_internal?: boolean,
|
||||
): AppState[K];
|
||||
export function useAppStateValue(
|
||||
props: (keyof AppState)[],
|
||||
callback?: (props: AppState, appState: AppState) => void,
|
||||
_internal?: boolean,
|
||||
): AppState;
|
||||
export function useAppStateValue<T>(
|
||||
selector: (appState: AppState) => T,
|
||||
callback?: (value: T, appState: AppState) => void,
|
||||
_internal?: boolean,
|
||||
): T;
|
||||
export function useAppStateValue(
|
||||
selector:
|
||||
| keyof AppState
|
||||
| (keyof AppState)[]
|
||||
| ((appState: AppState) => unknown),
|
||||
callback?: (value: any, appState: AppState) => void,
|
||||
selector: AppStateSelector,
|
||||
_internal: boolean = true,
|
||||
): unknown {
|
||||
const api = useExcalidrawAPI();
|
||||
const [, rerender] = useState(0);
|
||||
|
||||
const getLatestValue = () => {
|
||||
let appState = api?.getAppState();
|
||||
if (!appState) {
|
||||
if (!_internal) {
|
||||
return undefined;
|
||||
}
|
||||
console.warn(
|
||||
"useAppStateValue: excalidrawAPI not defined yet for internal component in which case it should always be defined. Are you sure you're rendering inside of <Excalidraw/> component tree?",
|
||||
);
|
||||
// fall back in case there's a bug so we don't break the app
|
||||
// (internal components using this internal useAppStateValue expect
|
||||
// non-undefined values on init)
|
||||
appState = Object.assign(
|
||||
{ width: 0, height: 0, offsetLeft: 0, offsetTop: 0 },
|
||||
getDefaultAppState(),
|
||||
);
|
||||
}
|
||||
if (typeof selector === "function") {
|
||||
return selector(appState);
|
||||
}
|
||||
if (Array.isArray(selector)) {
|
||||
return appState;
|
||||
}
|
||||
return appState[selector];
|
||||
};
|
||||
|
||||
const [value, setValue] = useState<unknown>(getLatestValue);
|
||||
|
||||
const stateRef = useRef({
|
||||
selector,
|
||||
callback,
|
||||
isInitialized: !!api,
|
||||
latestValue: value,
|
||||
});
|
||||
const stateRef = useRef<{
|
||||
selector: AppStateSelector;
|
||||
isInitialized: boolean;
|
||||
latestValue: unknown;
|
||||
} | null>(null);
|
||||
if (!stateRef.current) {
|
||||
stateRef.current = {
|
||||
selector,
|
||||
isInitialized: !!api,
|
||||
latestValue: getLatestValue(api, selector, _internal),
|
||||
};
|
||||
}
|
||||
stateRef.current.selector = selector;
|
||||
stateRef.current.callback = callback;
|
||||
if (!stateRef.current.isInitialized && api) {
|
||||
if (!stateRef.current.isInitialized && api && !api.isDestroyed) {
|
||||
stateRef.current.isInitialized = true;
|
||||
stateRef.current.latestValue = getLatestValue();
|
||||
stateRef.current.latestValue = getLatestValue(api, selector, _internal);
|
||||
}
|
||||
|
||||
useEffect(() => {
|
||||
if (!api) {
|
||||
const currentStateRef = stateRef.current;
|
||||
if (!api || api.isDestroyed || !currentStateRef) {
|
||||
return;
|
||||
}
|
||||
|
||||
return api.onStateChange(
|
||||
stateRef.current.selector,
|
||||
(newValue: any, state: AppState) => {
|
||||
stateRef.current.latestValue = newValue;
|
||||
stateRef.current.callback?.(newValue, state);
|
||||
setValue(newValue);
|
||||
},
|
||||
);
|
||||
return api.onStateChange(currentStateRef.selector, (newValue: any) => {
|
||||
currentStateRef.latestValue = newValue;
|
||||
rerender((value) => value + 1);
|
||||
});
|
||||
}, [api]);
|
||||
|
||||
return stateRef.current.latestValue;
|
||||
}
|
||||
|
||||
/**
|
||||
* Subscribes to specific appState changes without causing component rerenders.
|
||||
*
|
||||
* The callback is called on every matching change, but also on initial render
|
||||
* so you can initialize your state.
|
||||
*/
|
||||
export function useOnAppStateChange<K extends keyof AppState>(
|
||||
prop: K,
|
||||
callback: (value: AppState[K], appState: AppState) => void,
|
||||
): undefined;
|
||||
export function useOnAppStateChange(
|
||||
props: (keyof AppState)[],
|
||||
callback: (props: AppState, appState: AppState) => void,
|
||||
): undefined;
|
||||
export function useOnAppStateChange<T>(
|
||||
selector: (appState: AppState) => T,
|
||||
callback: (value: T, appState: AppState) => void,
|
||||
): undefined;
|
||||
export function useOnAppStateChange(
|
||||
selector: AppStateSelector,
|
||||
callback: (value: any, appState: AppState) => void,
|
||||
): undefined {
|
||||
const api = useExcalidrawAPI();
|
||||
|
||||
const stateRef = useRef({
|
||||
selector,
|
||||
callback,
|
||||
});
|
||||
stateRef.current.selector = selector;
|
||||
stateRef.current.callback = callback;
|
||||
|
||||
useEffect(() => {
|
||||
if (!api || api.isDestroyed) {
|
||||
return;
|
||||
}
|
||||
|
||||
stateRef.current.callback(
|
||||
getLatestValue(api, stateRef.current.selector, true),
|
||||
api.getAppState(),
|
||||
);
|
||||
|
||||
return api.onStateChange(
|
||||
stateRef.current.selector,
|
||||
(newValue: any, state: AppState) => {
|
||||
stateRef.current.callback(newValue, state);
|
||||
},
|
||||
);
|
||||
}, [api]);
|
||||
|
||||
return undefined;
|
||||
}
|
||||
|
||||
@@ -1,4 +1,10 @@
|
||||
import React, { useCallback, useContext, useEffect, useState } from "react";
|
||||
import React, {
|
||||
useCallback,
|
||||
useContext,
|
||||
useEffect,
|
||||
useRef,
|
||||
useState,
|
||||
} from "react";
|
||||
|
||||
import { DEFAULT_UI_OPTIONS, isShallowEqual } from "@excalidraw/common";
|
||||
|
||||
@@ -12,7 +18,10 @@ import LiveCollaborationTrigger from "./components/live-collaboration/LiveCollab
|
||||
import MainMenu from "./components/main-menu/MainMenu";
|
||||
import WelcomeScreen from "./components/welcome-screen/WelcomeScreen";
|
||||
import { defaultLang } from "./i18n";
|
||||
import { useAppStateValue as _useAppStateValue } from "./hooks/useAppStateValue";
|
||||
import {
|
||||
useAppStateValue as _useAppStateValue,
|
||||
useOnAppStateChange as _useOnAppStateChange,
|
||||
} from "./hooks/useAppStateValue";
|
||||
import { EditorJotaiProvider, editorJotaiStore } from "./editor-jotai";
|
||||
import polyfill from "./polyfill";
|
||||
|
||||
@@ -31,8 +40,8 @@ polyfill();
|
||||
|
||||
/**
|
||||
* Stateless provider that allows `useExcalidrawAPI()` (and hooks built
|
||||
* on it, such as `useAppStateValue()`) to work outside the <Excalidraw>
|
||||
* component tree.
|
||||
* on it, such as `useAppStateValue()` and `useOnAppStateChange()`) to work
|
||||
* outside the <Excalidraw> component tree.
|
||||
*/
|
||||
export const ExcalidrawAPIProvider = ({
|
||||
children,
|
||||
@@ -57,6 +66,7 @@ const ExcalidrawBase = (props: ExcalidrawProps) => {
|
||||
initialData,
|
||||
onExcalidrawAPI,
|
||||
onMount,
|
||||
onUnmount,
|
||||
onInitialize,
|
||||
isCollaborating = false,
|
||||
onPointerUpdate,
|
||||
@@ -119,12 +129,16 @@ const ExcalidrawBase = (props: ExcalidrawProps) => {
|
||||
}
|
||||
|
||||
const setExcalidrawAPI = useContext(ExcalidrawAPISetContext);
|
||||
|
||||
const onExcalidrawAPIRef = useRef(onExcalidrawAPI);
|
||||
onExcalidrawAPIRef.current = onExcalidrawAPI;
|
||||
|
||||
const handleExcalidrawAPI = useCallback(
|
||||
(api: ExcalidrawImperativeAPI) => {
|
||||
(api: ExcalidrawImperativeAPI | null) => {
|
||||
setExcalidrawAPI?.(api);
|
||||
onExcalidrawAPI?.(api);
|
||||
onExcalidrawAPIRef.current?.(api);
|
||||
},
|
||||
[onExcalidrawAPI, setExcalidrawAPI],
|
||||
[setExcalidrawAPI],
|
||||
);
|
||||
|
||||
useEffect(() => {
|
||||
@@ -162,6 +176,7 @@ const ExcalidrawBase = (props: ExcalidrawProps) => {
|
||||
initialData={initialData}
|
||||
onExcalidrawAPI={handleExcalidrawAPI}
|
||||
onMount={onMount}
|
||||
onUnmount={onUnmount}
|
||||
onInitialize={onInitialize}
|
||||
isCollaborating={isCollaborating}
|
||||
onPointerUpdate={onPointerUpdate}
|
||||
@@ -378,7 +393,7 @@ export {
|
||||
} from "./charts";
|
||||
|
||||
// -----------------------------------------------------------------------------
|
||||
// useAppStateValue() wrapper for host apps for the return type to reflect the
|
||||
// useExcalidrawStateValue() wrapper for host apps for the return type to reflect the
|
||||
// the potentially `undefined` value for initial render before the excalidrawAPI
|
||||
// is ready.
|
||||
//
|
||||
@@ -388,25 +403,23 @@ export {
|
||||
* @param prop - appState prop(s) to subscribe to, or a selector function.
|
||||
* NOTE `prop/selector` is memoized and will not change after initial render
|
||||
*/
|
||||
export function useAppStateValue<K extends keyof AppState>(
|
||||
export function useExcalidrawStateValue<K extends keyof AppState>(
|
||||
prop: K,
|
||||
callback?: (value: AppState[K], appState: AppState) => void,
|
||||
): AppState[K] | undefined;
|
||||
export function useAppStateValue<T extends keyof AppState>(
|
||||
export function useExcalidrawStateValue<T extends keyof AppState>(
|
||||
props: T[],
|
||||
callback?: (values: AppState, appState: AppState) => void,
|
||||
): AppState | undefined;
|
||||
export function useAppStateValue<T>(
|
||||
export function useExcalidrawStateValue<T>(
|
||||
selector: (appState: AppState) => T,
|
||||
callback?: (value: T, appState: AppState) => void,
|
||||
): T | undefined;
|
||||
export function useAppStateValue(
|
||||
export function useExcalidrawStateValue(
|
||||
selector:
|
||||
| keyof AppState
|
||||
| (keyof AppState)[]
|
||||
| ((appState: AppState) => unknown),
|
||||
callback?: (value: any, appState: AppState) => void,
|
||||
) {
|
||||
return _useAppStateValue(selector as any, callback, false);
|
||||
return _useAppStateValue(selector as any, false);
|
||||
}
|
||||
// -----------------------------------------------------------------------------
|
||||
|
||||
export { _useOnAppStateChange as useOnExcalidrawStateChange };
|
||||
|
||||
@@ -53,7 +53,14 @@
|
||||
"arrowhead_crowfoot_many": "Crow's foot (many)",
|
||||
"arrowhead_crowfoot_one": "Crow's foot (one)",
|
||||
"arrowhead_crowfoot_one_or_many": "Crow's foot (one or many)",
|
||||
"arrowhead_cardinality_one": "Cardinality (one)",
|
||||
"arrowhead_cardinality_many": "Cardinality (many)",
|
||||
"arrowhead_cardinality_one_or_many": "Cardinality (one or many)",
|
||||
"arrowhead_cardinality_exactly_one": "Cardinality (exactly one)",
|
||||
"arrowhead_cardinality_zero_or_one": "Cardinality (zero or one)",
|
||||
"arrowhead_cardinality_zero_or_many": "Cardinality (zero or many)",
|
||||
"more_options": "More options",
|
||||
"cardinality": "Cardinality",
|
||||
"arrowtypes": "Arrow type",
|
||||
"arrowtype_sharp": "Sharp arrow",
|
||||
"arrowtype_round": "Curved arrow",
|
||||
@@ -624,7 +631,7 @@
|
||||
"mermaid": {
|
||||
"title": "Mermaid to Excalidraw",
|
||||
"button": "Insert",
|
||||
"description": "Currently only <flowchartLink>Flowchart</flowchartLink>,<sequenceLink> Sequence, </sequenceLink> and <classLink>Class </classLink>Diagrams are supported. The other types will be rendered as image in Excalidraw.",
|
||||
"description": "Currently only <flowchartLink>Flowchart</flowchartLink>, <sequenceLink>Sequence</sequenceLink>, <classLink>Class</classLink>, and <erdLink>Entity Relationship</erdLink> Diagrams are supported. The other types will be rendered as image in Excalidraw.",
|
||||
"syntax": "Mermaid Syntax",
|
||||
"preview": "Preview",
|
||||
"label": "Mermaid",
|
||||
@@ -654,7 +661,7 @@
|
||||
"placeholder": {
|
||||
"title": "Let's design your diagram",
|
||||
"description": "Describe the diagram you want to create, and we'll generate it for you.",
|
||||
"hint": "At the moment we know Flowchart, Sequence, and Class diagrams."
|
||||
"hint": "At the moment we know Flowchart, Sequence, Class, and Entity Relationship diagrams."
|
||||
},
|
||||
"preview": "Preview",
|
||||
"insert": "Insert",
|
||||
|
||||
@@ -88,7 +88,7 @@
|
||||
"@excalidraw/element": "0.18.0",
|
||||
"@excalidraw/laser-pointer": "1.3.1",
|
||||
"@excalidraw/math": "0.18.0",
|
||||
"@excalidraw/mermaid-to-excalidraw": "2.0.0-rc4",
|
||||
"@excalidraw/mermaid-to-excalidraw": "2.1.1",
|
||||
"@excalidraw/random-username": "1.1.0",
|
||||
"browser-fs-access": "0.38.0",
|
||||
"canvas-roundrect-polyfill": "0.0.1",
|
||||
|
||||
@@ -41,6 +41,8 @@ import {
|
||||
maxBindingDistance_simple,
|
||||
isTextElement,
|
||||
LinearElementEditor,
|
||||
getActiveTextElement,
|
||||
getSimpleArrowCurveDebugData,
|
||||
} from "@excalidraw/element";
|
||||
|
||||
import { renderSelectionElement } from "@excalidraw/element";
|
||||
@@ -58,6 +60,8 @@ import {
|
||||
isFocusPointVisible,
|
||||
} from "@excalidraw/element";
|
||||
|
||||
import type { EditorInterface } from "@excalidraw/common";
|
||||
|
||||
import type {
|
||||
TransformHandles,
|
||||
TransformHandleType,
|
||||
@@ -86,6 +90,10 @@ import {
|
||||
} from "../scene/scrollbars";
|
||||
|
||||
import { getClientColor, renderRemoteCursors } from "../clients";
|
||||
import {
|
||||
getTextAutoResizeHandle,
|
||||
getTextBoxPadding,
|
||||
} from "../textAutoResizeHandle";
|
||||
|
||||
import {
|
||||
bootstrapCanvas,
|
||||
@@ -1194,6 +1202,105 @@ const renderLinearPointHandles = (
|
||||
context.restore();
|
||||
};
|
||||
|
||||
const isSimpleArrowTangentDebugEnabled = () =>
|
||||
window.EXCALIDRAW_DEBUG_LINEAR_ARROW_TANGENTS === true;
|
||||
|
||||
const renderSimpleArrowTangentOverlay = (
|
||||
context: CanvasRenderingContext2D,
|
||||
appState: InteractiveCanvasAppState,
|
||||
element: NonDeleted<ExcalidrawArrowElement>,
|
||||
elementsMap: RenderableElementsMap,
|
||||
) => {
|
||||
const points = LinearElementEditor.getPointsGlobalCoordinates(
|
||||
element,
|
||||
elementsMap,
|
||||
);
|
||||
const debugData = getSimpleArrowCurveDebugData(points);
|
||||
|
||||
window.EXCALIDRAW_DEBUG_SELECTED_LINEAR_ARROW = debugData;
|
||||
|
||||
context.save();
|
||||
context.translate(appState.scrollX, appState.scrollY);
|
||||
context.lineWidth = 1 / appState.zoom.value;
|
||||
|
||||
context.setLineDash([6 / appState.zoom.value, 4 / appState.zoom.value]);
|
||||
context.strokeStyle = "rgba(134, 142, 150, 0.75)";
|
||||
|
||||
for (const segment of debugData.segments) {
|
||||
context.beginPath();
|
||||
context.moveTo(segment.start[0], segment.start[1]);
|
||||
context.lineTo(segment.baseCp1[0], segment.baseCp1[1]);
|
||||
context.lineTo(segment.baseCp2[0], segment.baseCp2[1]);
|
||||
context.lineTo(segment.end[0], segment.end[1]);
|
||||
context.stroke();
|
||||
}
|
||||
|
||||
context.setLineDash([]);
|
||||
|
||||
for (const segment of debugData.segments) {
|
||||
const strokeStyle = segment.overshootsBaseline
|
||||
? "rgba(245, 159, 0, 0.9)"
|
||||
: "rgba(94, 90, 216, 0.85)";
|
||||
|
||||
context.strokeStyle = strokeStyle;
|
||||
context.fillStyle = "rgba(255, 255, 255, 0.95)";
|
||||
|
||||
context.beginPath();
|
||||
context.moveTo(segment.start[0], segment.start[1]);
|
||||
context.lineTo(segment.cp1[0], segment.cp1[1]);
|
||||
context.lineTo(segment.cp2[0], segment.cp2[1]);
|
||||
context.lineTo(segment.end[0], segment.end[1]);
|
||||
context.stroke();
|
||||
|
||||
fillCircle(
|
||||
context,
|
||||
segment.cp1[0],
|
||||
segment.cp1[1],
|
||||
4 / appState.zoom.value,
|
||||
true,
|
||||
true,
|
||||
);
|
||||
fillCircle(
|
||||
context,
|
||||
segment.cp2[0],
|
||||
segment.cp2[1],
|
||||
4 / appState.zoom.value,
|
||||
true,
|
||||
true,
|
||||
);
|
||||
}
|
||||
|
||||
context.strokeStyle = "rgba(201, 42, 42, 0.85)";
|
||||
context.fillStyle = "rgba(201, 42, 42, 0.95)";
|
||||
|
||||
for (const tangent of debugData.tangents) {
|
||||
if (!tangent.isAdjusted) {
|
||||
continue;
|
||||
}
|
||||
|
||||
const handle = pointFrom<GlobalPoint>(
|
||||
tangent.point[0] + tangent.scaled[0] / 3,
|
||||
tangent.point[1] + tangent.scaled[1] / 3,
|
||||
);
|
||||
|
||||
context.beginPath();
|
||||
context.moveTo(tangent.point[0], tangent.point[1]);
|
||||
context.lineTo(handle[0], handle[1]);
|
||||
context.stroke();
|
||||
|
||||
fillCircle(
|
||||
context,
|
||||
tangent.point[0],
|
||||
tangent.point[1],
|
||||
3 / appState.zoom.value,
|
||||
true,
|
||||
true,
|
||||
);
|
||||
}
|
||||
|
||||
context.restore();
|
||||
};
|
||||
|
||||
const renderFocusPointConnectionLine = (
|
||||
context: CanvasRenderingContext2D,
|
||||
appState: InteractiveCanvasAppState,
|
||||
@@ -1489,21 +1596,58 @@ const renderTextBox = (
|
||||
selectionColor: InteractiveCanvasRenderConfig["selectionColor"],
|
||||
) => {
|
||||
context.save();
|
||||
const padding = (DEFAULT_TRANSFORM_HANDLE_SPACING * 2) / appState.zoom.value;
|
||||
const padding = getTextBoxPadding(appState.zoom.value);
|
||||
const width = text.width + padding * 2;
|
||||
const height = text.height + padding * 2;
|
||||
const cx = text.x + width / 2;
|
||||
const cy = text.y + height / 2;
|
||||
const shiftX = -(width / 2 + padding);
|
||||
const shiftY = -(height / 2 + padding);
|
||||
const cx = text.x + text.width / 2;
|
||||
const cy = text.y + text.height / 2;
|
||||
const shiftX = -(text.width / 2 + padding);
|
||||
const shiftY = -(text.height / 2 + padding);
|
||||
context.translate(cx + appState.scrollX, cy + appState.scrollY);
|
||||
context.rotate(text.angle);
|
||||
context.lineWidth = 1 / appState.zoom.value;
|
||||
context.strokeStyle = selectionColor;
|
||||
context.globalAlpha = 0.5;
|
||||
context.setLineDash([6 / appState.zoom.value, 4 / appState.zoom.value]);
|
||||
context.strokeRect(shiftX, shiftY, width, height);
|
||||
context.restore();
|
||||
};
|
||||
|
||||
const renderResetAutoResizeHandle = (
|
||||
text: NonDeleted<ExcalidrawTextElement>,
|
||||
context: CanvasRenderingContext2D,
|
||||
appState: InteractiveCanvasAppState,
|
||||
selectionColor: InteractiveCanvasRenderConfig["selectionColor"],
|
||||
formFactor: EditorInterface["formFactor"],
|
||||
) => {
|
||||
const autoResizeHandle = getTextAutoResizeHandle(
|
||||
text,
|
||||
appState.zoom.value,
|
||||
formFactor,
|
||||
);
|
||||
|
||||
if (!autoResizeHandle) {
|
||||
return;
|
||||
}
|
||||
|
||||
context.save();
|
||||
context.globalAlpha = 0.5;
|
||||
context.lineWidth = 1.5 / appState.zoom.value;
|
||||
context.lineCap = "round";
|
||||
context.strokeStyle = selectionColor;
|
||||
context.beginPath();
|
||||
context.moveTo(
|
||||
autoResizeHandle.start[0] + appState.scrollX,
|
||||
autoResizeHandle.start[1] + appState.scrollY,
|
||||
);
|
||||
context.lineTo(
|
||||
autoResizeHandle.end[0] + appState.scrollX,
|
||||
autoResizeHandle.end[1] + appState.scrollY,
|
||||
);
|
||||
context.stroke();
|
||||
context.restore();
|
||||
};
|
||||
|
||||
const _renderInteractiveScene = ({
|
||||
app,
|
||||
canvas,
|
||||
@@ -1584,10 +1728,19 @@ const _renderInteractiveScene = ({
|
||||
}
|
||||
}
|
||||
|
||||
if (
|
||||
appState.editingTextElement &&
|
||||
isTextElement(appState.editingTextElement)
|
||||
) {
|
||||
const activeTextElement = getActiveTextElement(selectedElements, appState);
|
||||
|
||||
if (activeTextElement && !activeTextElement.autoResize) {
|
||||
renderResetAutoResizeHandle(
|
||||
activeTextElement,
|
||||
context,
|
||||
appState,
|
||||
renderConfig.selectionColor,
|
||||
editorInterface.formFactor,
|
||||
);
|
||||
}
|
||||
|
||||
if (appState.editingTextElement) {
|
||||
const textElement = allElementsMap.get(appState.editingTextElement.id) as
|
||||
| ExcalidrawTextElement
|
||||
| undefined;
|
||||
@@ -1669,6 +1822,13 @@ const _renderInteractiveScene = ({
|
||||
const selectedLinearElement =
|
||||
linearState &&
|
||||
LinearElementEditor.getElement(linearState.elementId, allElementsMap);
|
||||
const selectedRoundedArrow =
|
||||
selectedElements.length === 1 &&
|
||||
isArrowElement(selectedElements[0]) &&
|
||||
!isElbowArrow(selectedElements[0]) &&
|
||||
!!selectedElements[0].roundness
|
||||
? (selectedElements[0] as NonDeleted<ExcalidrawArrowElement>)
|
||||
: null;
|
||||
// Arrows have a different highlight behavior when
|
||||
// they are the only selected element
|
||||
if (selectedLinearElement) {
|
||||
@@ -1705,6 +1865,17 @@ const _renderInteractiveScene = ({
|
||||
}
|
||||
}
|
||||
|
||||
if (selectedRoundedArrow && isSimpleArrowTangentDebugEnabled()) {
|
||||
renderSimpleArrowTangentOverlay(
|
||||
context,
|
||||
appState,
|
||||
selectedRoundedArrow,
|
||||
elementsMap,
|
||||
);
|
||||
} else {
|
||||
window.EXCALIDRAW_DEBUG_SELECTED_LINEAR_ARROW = undefined;
|
||||
}
|
||||
|
||||
// Paint selected elements
|
||||
if (
|
||||
!appState.multiElement &&
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
|
||||
|
||||
exports[`Test <MermaidToExcalidraw/> > should open mermaid popup when active tool is mermaid 1`] = `"<div class="Modal Dialog ttd-dialog" role="dialog" aria-modal="true" aria-labelledby="dialog-title"><div class="Modal__background"></div><div class="Modal__content" style="--max-width: 1520px;" tabindex="0"><div class="Island"><div class="Dialog__content"><div dir="ltr" data-orientation="horizontal" class="ttd-dialog-tabs-root"><p class="dialog-mermaid-title">Mermaid to Excalidraw</p><div data-state="active" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-:r4:-trigger-mermaid" id="radix-:r4:-content-mermaid" tabindex="0" class="ttd-dialog-content" style=""><div class="ttd-dialog-desc">Currently only <a href="https://mermaid.js.org/syntax/flowchart.html">Flowchart</a>,<a href="https://mermaid.js.org/syntax/sequenceDiagram.html"> Sequence, </a> and <a href="https://mermaid.js.org/syntax/classDiagram.html">Class </a>Diagrams are supported. The other types will be rendered as image in Excalidraw.</div><div class="ttd-dialog-panels"><div class="ttd-dialog-panel"><div class="ttd-dialog-panel-button-container invisible" style="justify-content: flex-start;"></div></div><div class="ttd-dialog-panel"><div class="ttd-dialog-output-wrapper "><div class="ttd-dialog-output-canvas-container"><div class="ttd-dialog-output-canvas-content"><canvas width="89" height="158" dir="ltr"></canvas></div></div></div><div class="ttd-dialog-panel-button-container" style="justify-content: flex-start;"><button type="button" class="excalidraw-button ttd-dialog-panel-button"><div class="">Insert<span><svg aria-hidden="true" focusable="false" role="img" viewBox="0 0 20 20" class="" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"><g stroke-width="1.25"><path d="M4.16602 10H15.8327"></path><path d="M12.5 13.3333L15.8333 10"></path><path d="M12.5 6.66666L15.8333 9.99999"></path></g></svg></span></div></button><div class="ttd-dialog-submit-shortcut"><div class="ttd-dialog-submit-shortcut__key">Ctrl</div><div class="ttd-dialog-submit-shortcut__key">Enter</div></div></div></div></div></div></div></div></div></div></div>"`;
|
||||
exports[`Test <MermaidToExcalidraw/> > should open mermaid popup when active tool is mermaid 1`] = `"<div class="Modal Dialog ttd-dialog" role="dialog" aria-modal="true" aria-labelledby="dialog-title"><div class="Modal__background"></div><div class="Modal__content" style="--max-width: 1520px;" tabindex="0"><div class="Island"><div class="Dialog__content"><div dir="ltr" data-orientation="horizontal" class="ttd-dialog-tabs-root"><p class="dialog-mermaid-title">Mermaid to Excalidraw</p><div data-state="active" data-orientation="horizontal" role="tabpanel" aria-labelledby="radix-:r4:-trigger-mermaid" id="radix-:r4:-content-mermaid" tabindex="0" class="ttd-dialog-content" style=""><div class="ttd-dialog-desc">Currently only <a href="https://mermaid.js.org/syntax/flowchart.html" target="_blank" rel="noreferrer">Flowchart</a>, <a href="https://mermaid.js.org/syntax/sequenceDiagram.html" target="_blank" rel="noreferrer">Sequence</a>, <a href="https://mermaid.js.org/syntax/classDiagram.html" target="_blank" rel="noreferrer">Class</a>, and <a href="https://mermaid.js.org/syntax/entityRelationshipDiagram.html" target="_blank" rel="noreferrer">Entity Relationship</a> Diagrams are supported. The other types will be rendered as image in Excalidraw.</div><div class="ttd-dialog-panels"><div class="ttd-dialog-panel"><div class="ttd-dialog-panel-button-container invisible" style="justify-content: flex-start;"></div></div><div class="ttd-dialog-panel"><div class="ttd-dialog-output-wrapper "><div class="ttd-dialog-output-canvas-container"><div class="ttd-dialog-output-canvas-content"><canvas width="89" height="158" dir="ltr"></canvas></div></div></div><div class="ttd-dialog-panel-button-container" style="justify-content: flex-start;"><button type="button" class="excalidraw-button ttd-dialog-panel-button"><div class="">Insert<span><svg aria-hidden="true" focusable="false" role="img" viewBox="0 0 20 20" class="" fill="none" stroke="currentColor" stroke-linecap="round" stroke-linejoin="round"><g stroke-width="1.25"><path d="M4.16602 10H15.8327"></path><path d="M12.5 13.3333L15.8333 10"></path><path d="M12.5 6.66666L15.8333 9.99999"></path></g></svg></span></div></button><div class="ttd-dialog-submit-shortcut"><div class="ttd-dialog-submit-shortcut__key">Ctrl</div><div class="ttd-dialog-submit-shortcut__key">Enter</div></div></div></div></div></div></div></div></div></div></div>"`;
|
||||
|
||||
exports[`Test <MermaidToExcalidraw/> > should show error in preview when mermaid library throws error 1`] = `
|
||||
"flowchart TD
|
||||
|
||||
@@ -224,7 +224,7 @@ exports[`history > multiplayer undo/redo > conflicts in arrows and their bindabl
|
||||
"strokeWidth": 2,
|
||||
"type": "arrow",
|
||||
"updated": 1,
|
||||
"version": 29,
|
||||
"version": 28,
|
||||
"width": "94.00000",
|
||||
"x": 0,
|
||||
"y": 0,
|
||||
@@ -350,7 +350,7 @@ exports[`history > multiplayer undo/redo > conflicts in arrows and their bindabl
|
||||
],
|
||||
"mode": "orbit",
|
||||
},
|
||||
"version": 28,
|
||||
"version": 27,
|
||||
"width": "88.00000",
|
||||
},
|
||||
"inserted": {
|
||||
@@ -381,7 +381,7 @@ exports[`history > multiplayer undo/redo > conflicts in arrows and their bindabl
|
||||
],
|
||||
"mode": "orbit",
|
||||
},
|
||||
"version": 25,
|
||||
"version": 24,
|
||||
"width": "88.00000",
|
||||
},
|
||||
},
|
||||
@@ -437,7 +437,7 @@ exports[`history > multiplayer undo/redo > conflicts in arrows and their bindabl
|
||||
],
|
||||
],
|
||||
"startBinding": null,
|
||||
"version": 29,
|
||||
"version": 28,
|
||||
"width": "94.00000",
|
||||
"x": 0,
|
||||
"y": 0,
|
||||
@@ -462,7 +462,7 @@ exports[`history > multiplayer undo/redo > conflicts in arrows and their bindabl
|
||||
],
|
||||
"mode": "orbit",
|
||||
},
|
||||
"version": 28,
|
||||
"version": 27,
|
||||
"width": "88.00000",
|
||||
"x": 6,
|
||||
"y": "7.20923",
|
||||
@@ -1360,9 +1360,9 @@ exports[`history > multiplayer undo/redo > conflicts in arrows and their bindabl
|
||||
"strokeWidth": 2,
|
||||
"type": "arrow",
|
||||
"updated": 1,
|
||||
"version": 8,
|
||||
"version": 7,
|
||||
"width": 88,
|
||||
"x": 6,
|
||||
"x": "6.00000",
|
||||
"y": "2.00947",
|
||||
}
|
||||
`;
|
||||
@@ -1537,12 +1537,12 @@ exports[`history > multiplayer undo/redo > conflicts in arrows and their bindabl
|
||||
],
|
||||
"mode": "orbit",
|
||||
},
|
||||
"version": 8,
|
||||
"version": 7,
|
||||
},
|
||||
"inserted": {
|
||||
"endBinding": null,
|
||||
"startBinding": null,
|
||||
"version": 7,
|
||||
"version": 6,
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -1722,7 +1722,7 @@ exports[`history > multiplayer undo/redo > conflicts in arrows and their bindabl
|
||||
"updated": 1,
|
||||
"version": 8,
|
||||
"width": 88,
|
||||
"x": 6,
|
||||
"x": "6.00000",
|
||||
"y": "38.80379",
|
||||
}
|
||||
`;
|
||||
@@ -1867,7 +1867,7 @@ exports[`history > multiplayer undo/redo > conflicts in arrows and their bindabl
|
||||
"type": "arrow",
|
||||
"version": 8,
|
||||
"width": 88,
|
||||
"x": 6,
|
||||
"x": "6.00000",
|
||||
"y": "38.80379",
|
||||
},
|
||||
"inserted": {
|
||||
@@ -2416,7 +2416,7 @@ exports[`history > multiplayer undo/redo > conflicts in arrows and their bindabl
|
||||
"strokeWidth": 2,
|
||||
"type": "arrow",
|
||||
"updated": 1,
|
||||
"version": 12,
|
||||
"version": 11,
|
||||
"width": 488,
|
||||
"x": 6,
|
||||
"y": "-5.39000",
|
||||
@@ -2581,7 +2581,7 @@ exports[`history > multiplayer undo/redo > conflicts in arrows and their bindabl
|
||||
"strokeStyle": "solid",
|
||||
"strokeWidth": 2,
|
||||
"type": "arrow",
|
||||
"version": 12,
|
||||
"version": 11,
|
||||
"width": 488,
|
||||
"x": 6,
|
||||
"y": "-5.39000",
|
||||
@@ -16254,7 +16254,7 @@ exports[`history > singleplayer undo/redo > should support bidirectional binding
|
||||
"strokeWidth": 2,
|
||||
"type": "arrow",
|
||||
"updated": 1,
|
||||
"version": 10,
|
||||
"version": 11,
|
||||
"width": "88.00000",
|
||||
"x": 6,
|
||||
"y": "0.01000",
|
||||
@@ -16307,7 +16307,7 @@ exports[`history > singleplayer undo/redo > should support bidirectional binding
|
||||
],
|
||||
"mode": "orbit",
|
||||
},
|
||||
"version": 10,
|
||||
"version": 11,
|
||||
},
|
||||
"inserted": {
|
||||
"endBinding": {
|
||||
@@ -16327,7 +16327,7 @@ exports[`history > singleplayer undo/redo > should support bidirectional binding
|
||||
],
|
||||
"mode": "orbit",
|
||||
},
|
||||
"version": 8,
|
||||
"version": 9,
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -16669,14 +16669,14 @@ exports[`history > singleplayer undo/redo > should support bidirectional binding
|
||||
"strokeStyle": "solid",
|
||||
"strokeWidth": 2,
|
||||
"type": "arrow",
|
||||
"version": 7,
|
||||
"version": 8,
|
||||
"width": "88.00000",
|
||||
"x": 6,
|
||||
"y": "0.00880",
|
||||
},
|
||||
"inserted": {
|
||||
"isDeleted": true,
|
||||
"version": 6,
|
||||
"version": 7,
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -17002,7 +17002,7 @@ exports[`history > singleplayer undo/redo > should support bidirectional binding
|
||||
"strokeWidth": 2,
|
||||
"type": "arrow",
|
||||
"updated": 1,
|
||||
"version": 10,
|
||||
"version": 11,
|
||||
"width": "88.00000",
|
||||
"x": 6,
|
||||
"y": "0.01000",
|
||||
@@ -17307,14 +17307,14 @@ exports[`history > singleplayer undo/redo > should support bidirectional binding
|
||||
"strokeStyle": "solid",
|
||||
"strokeWidth": 2,
|
||||
"type": "arrow",
|
||||
"version": 10,
|
||||
"version": 11,
|
||||
"width": "88.00000",
|
||||
"x": 6,
|
||||
"y": "0.01000",
|
||||
},
|
||||
"inserted": {
|
||||
"isDeleted": true,
|
||||
"version": 8,
|
||||
"version": 9,
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -17648,7 +17648,7 @@ exports[`history > singleplayer undo/redo > should support bidirectional binding
|
||||
"strokeWidth": 2,
|
||||
"type": "arrow",
|
||||
"updated": 1,
|
||||
"version": 10,
|
||||
"version": 11,
|
||||
"width": "88.00000",
|
||||
"x": 6,
|
||||
"y": "0.01000",
|
||||
@@ -17953,14 +17953,14 @@ exports[`history > singleplayer undo/redo > should support bidirectional binding
|
||||
"strokeStyle": "solid",
|
||||
"strokeWidth": 2,
|
||||
"type": "arrow",
|
||||
"version": 10,
|
||||
"version": 11,
|
||||
"width": "88.00000",
|
||||
"x": 6,
|
||||
"y": "0.01000",
|
||||
},
|
||||
"inserted": {
|
||||
"isDeleted": true,
|
||||
"version": 8,
|
||||
"version": 9,
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -18292,7 +18292,7 @@ exports[`history > singleplayer undo/redo > should support bidirectional binding
|
||||
"strokeWidth": 2,
|
||||
"type": "arrow",
|
||||
"updated": 1,
|
||||
"version": 10,
|
||||
"version": 11,
|
||||
"width": "88.00000",
|
||||
"x": 6,
|
||||
"y": "0.01000",
|
||||
@@ -18361,7 +18361,7 @@ exports[`history > singleplayer undo/redo > should support bidirectional binding
|
||||
],
|
||||
"mode": "orbit",
|
||||
},
|
||||
"version": 10,
|
||||
"version": 11,
|
||||
},
|
||||
"inserted": {
|
||||
"endBinding": {
|
||||
@@ -18373,7 +18373,7 @@ exports[`history > singleplayer undo/redo > should support bidirectional binding
|
||||
"mode": "orbit",
|
||||
},
|
||||
"startBinding": null,
|
||||
"version": 8,
|
||||
"version": 9,
|
||||
},
|
||||
},
|
||||
"id2": {
|
||||
@@ -18683,14 +18683,14 @@ exports[`history > singleplayer undo/redo > should support bidirectional binding
|
||||
"strokeStyle": "solid",
|
||||
"strokeWidth": 2,
|
||||
"type": "arrow",
|
||||
"version": 7,
|
||||
"version": 8,
|
||||
"width": "88.00000",
|
||||
"x": 6,
|
||||
"y": "0.00880",
|
||||
},
|
||||
"inserted": {
|
||||
"isDeleted": true,
|
||||
"version": 6,
|
||||
"version": 7,
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -19044,7 +19044,7 @@ exports[`history > singleplayer undo/redo > should support bidirectional binding
|
||||
"strokeWidth": 2,
|
||||
"type": "arrow",
|
||||
"updated": 1,
|
||||
"version": 11,
|
||||
"version": 12,
|
||||
"width": "88.00000",
|
||||
"x": 6,
|
||||
"y": "0.01000",
|
||||
@@ -19124,12 +19124,12 @@ exports[`history > singleplayer undo/redo > should support bidirectional binding
|
||||
],
|
||||
"mode": "orbit",
|
||||
},
|
||||
"version": 11,
|
||||
"version": 12,
|
||||
},
|
||||
"inserted": {
|
||||
"endBinding": null,
|
||||
"startBinding": null,
|
||||
"version": 9,
|
||||
"version": 10,
|
||||
},
|
||||
},
|
||||
},
|
||||
@@ -19431,14 +19431,14 @@ exports[`history > singleplayer undo/redo > should support bidirectional binding
|
||||
"strokeStyle": "solid",
|
||||
"strokeWidth": 2,
|
||||
"type": "arrow",
|
||||
"version": 7,
|
||||
"version": 8,
|
||||
"width": "88.00000",
|
||||
"x": 6,
|
||||
"y": "0.00880",
|
||||
},
|
||||
"inserted": {
|
||||
"isDeleted": true,
|
||||
"version": 6,
|
||||
"version": 7,
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
@@ -0,0 +1,111 @@
|
||||
import { act, cleanup, render, screen } from "@testing-library/react";
|
||||
import { vi } from "vitest";
|
||||
|
||||
import { getDefaultAppState } from "../appState";
|
||||
import { ExcalidrawAPIContext } from "../components/App";
|
||||
import { AppStateObserver } from "../components/AppStateObserver";
|
||||
import {
|
||||
useAppStateValue,
|
||||
useOnAppStateChange,
|
||||
} from "../hooks/useAppStateValue";
|
||||
|
||||
import type { AppState, ExcalidrawImperativeAPI } from "../types";
|
||||
|
||||
const createAppState = (): AppState => ({
|
||||
...getDefaultAppState(),
|
||||
width: 0,
|
||||
height: 0,
|
||||
offsetLeft: 0,
|
||||
offsetTop: 0,
|
||||
});
|
||||
|
||||
const createMockAPI = (initialState: AppState) => {
|
||||
let state = initialState;
|
||||
const observer = new AppStateObserver(() => state);
|
||||
|
||||
return {
|
||||
api: {
|
||||
isDestroyed: false,
|
||||
getAppState: () => state,
|
||||
onStateChange: observer.onStateChange,
|
||||
} as Pick<
|
||||
ExcalidrawImperativeAPI,
|
||||
"isDestroyed" | "getAppState" | "onStateChange"
|
||||
> as ExcalidrawImperativeAPI,
|
||||
updateAppState: (partial: Partial<AppState>) => {
|
||||
const prevState = state;
|
||||
state = { ...state, ...partial };
|
||||
observer.flush(prevState);
|
||||
},
|
||||
};
|
||||
};
|
||||
|
||||
describe("app state hooks", () => {
|
||||
afterEach(() => {
|
||||
cleanup();
|
||||
});
|
||||
|
||||
it("useAppStateValue rerenders when the selected value changes", () => {
|
||||
const renderSpy = vi.fn();
|
||||
const { api, updateAppState } = createMockAPI(createAppState());
|
||||
|
||||
const ValueConsumer = () => {
|
||||
const value = useAppStateValue("viewModeEnabled");
|
||||
renderSpy(value);
|
||||
return <div data-testid="value">{String(value)}</div>;
|
||||
};
|
||||
|
||||
render(
|
||||
<ExcalidrawAPIContext.Provider value={api}>
|
||||
<ValueConsumer />
|
||||
</ExcalidrawAPIContext.Provider>,
|
||||
);
|
||||
|
||||
expect(screen.getByTestId("value").textContent).toBe("false");
|
||||
expect(renderSpy).toHaveBeenCalledTimes(1);
|
||||
|
||||
act(() => {
|
||||
updateAppState({ viewModeEnabled: true });
|
||||
});
|
||||
|
||||
expect(screen.getByTestId("value").textContent).toBe("true");
|
||||
expect(renderSpy).toHaveBeenCalledTimes(2);
|
||||
});
|
||||
|
||||
it("useOnAppStateChange notifies without rerendering", () => {
|
||||
const renderSpy = vi.fn();
|
||||
const callback = vi.fn();
|
||||
const { api, updateAppState } = createMockAPI(createAppState());
|
||||
|
||||
const ChangeConsumer = () => {
|
||||
const value = useOnAppStateChange("viewModeEnabled", callback);
|
||||
renderSpy(value);
|
||||
return <div data-testid="value">{String(value)}</div>;
|
||||
};
|
||||
|
||||
render(
|
||||
<ExcalidrawAPIContext.Provider value={api}>
|
||||
<ChangeConsumer />
|
||||
</ExcalidrawAPIContext.Provider>,
|
||||
);
|
||||
|
||||
expect(screen.getByTestId("value").textContent).toBe("undefined");
|
||||
expect(renderSpy).toHaveBeenCalledTimes(1);
|
||||
expect(callback).toHaveBeenCalledTimes(1);
|
||||
expect(callback).toHaveBeenCalledWith(
|
||||
false,
|
||||
expect.objectContaining({ viewModeEnabled: false }),
|
||||
);
|
||||
|
||||
act(() => {
|
||||
updateAppState({ viewModeEnabled: true });
|
||||
});
|
||||
|
||||
expect(renderSpy).toHaveBeenCalledTimes(1);
|
||||
expect(callback).toHaveBeenCalledTimes(2);
|
||||
expect(callback).toHaveBeenLastCalledWith(
|
||||
true,
|
||||
expect.objectContaining({ viewModeEnabled: true }),
|
||||
);
|
||||
});
|
||||
});
|
||||
@@ -200,6 +200,26 @@ describe("restoreElements", () => {
|
||||
});
|
||||
});
|
||||
|
||||
it("should normalize legacy crowfoot arrowheads on restore", () => {
|
||||
const arrowElement = API.createElement({
|
||||
type: "arrow",
|
||||
});
|
||||
|
||||
const restoredArrow = restore.restoreElements(
|
||||
[
|
||||
{
|
||||
...arrowElement,
|
||||
startArrowhead: "crowfoot_one",
|
||||
endArrowhead: "crowfoot_one_or_many",
|
||||
} as any,
|
||||
],
|
||||
null,
|
||||
)[0] as ExcalidrawLinearElement;
|
||||
|
||||
expect(restoredArrow.startArrowhead).toBe("cardinality_one");
|
||||
expect(restoredArrow.endArrowhead).toBe("cardinality_one_or_many");
|
||||
});
|
||||
|
||||
it("should strip element if restore fails", () => {
|
||||
const rect1 = API.createElement({
|
||||
type: "rectangle",
|
||||
|
||||
@@ -4,6 +4,7 @@ import {
|
||||
elementCenterPoint,
|
||||
getCommonBounds,
|
||||
getElementPointsCoords,
|
||||
getLineHeightInPx,
|
||||
} from "@excalidraw/element";
|
||||
import { cropElement } from "@excalidraw/element";
|
||||
import {
|
||||
@@ -20,7 +21,7 @@ import {
|
||||
isTextElement,
|
||||
isFrameLikeElement,
|
||||
} from "@excalidraw/element";
|
||||
import { KEYS, arrayToMap } from "@excalidraw/common";
|
||||
import { KEYS, arrayToMap, getLineHeight } from "@excalidraw/common";
|
||||
|
||||
import type { GlobalPoint, LocalPoint, Radians } from "@excalidraw/math";
|
||||
|
||||
@@ -516,8 +517,17 @@ export class UI {
|
||||
UI.clickTool(type);
|
||||
|
||||
if (type === "text") {
|
||||
const clickY = h.state.gridModeEnabled
|
||||
? y
|
||||
: y +
|
||||
getLineHeightInPx(
|
||||
h.state.currentItemFontSize,
|
||||
getLineHeight(h.state.currentItemFontFamily),
|
||||
) /
|
||||
2;
|
||||
|
||||
mouse.reset();
|
||||
mouse.click(x, y);
|
||||
mouse.click(x, clickY);
|
||||
} else if ((type === "line" || type === "arrow") && points.length > 2) {
|
||||
points.forEach((point) => {
|
||||
mouse.reset();
|
||||
|
||||
@@ -41,13 +41,15 @@ describe("event callbacks", () => {
|
||||
|
||||
await render(
|
||||
<Excalidraw
|
||||
onExcalidrawAPI={(api) =>
|
||||
lifecyclePromise.resolve({
|
||||
api: api as ExcalidrawImperativeAPI,
|
||||
mount: api.onEvent("editor:mount"),
|
||||
initialize: api.onEvent("editor:initialize"),
|
||||
})
|
||||
}
|
||||
onExcalidrawAPI={(api) => {
|
||||
if (api) {
|
||||
lifecyclePromise.resolve({
|
||||
api,
|
||||
mount: api.onEvent("editor:mount"),
|
||||
initialize: api.onEvent("editor:initialize"),
|
||||
});
|
||||
}
|
||||
}}
|
||||
/>,
|
||||
);
|
||||
|
||||
|
||||
@@ -0,0 +1,88 @@
|
||||
import { DEFAULT_TRANSFORM_HANDLE_SPACING } from "@excalidraw/common";
|
||||
import {
|
||||
pointFrom,
|
||||
pointRotateRads,
|
||||
type GlobalPoint,
|
||||
type Radians,
|
||||
} from "@excalidraw/math";
|
||||
|
||||
import type { EditorInterface } from "@excalidraw/common";
|
||||
|
||||
import type { ExcalidrawTextElement } from "@excalidraw/element/types";
|
||||
|
||||
const TEXT_AUTO_RESIZE_HANDLE_GAP = 12;
|
||||
const TEXT_AUTO_RESIZE_HANDLE_LENGTH = 16;
|
||||
const TEXT_AUTO_RESIZE_HANDLE_HITBOX_WIDTH = 10;
|
||||
const TEXT_AUTO_RESIZE_HANDLE_HITBOX_HEIGHT =
|
||||
TEXT_AUTO_RESIZE_HANDLE_LENGTH + 2;
|
||||
const MAX_HANDLE_HEIGHT_RATIO = 0.8;
|
||||
|
||||
export const getTextBoxPadding = (zoomValue: number) =>
|
||||
(DEFAULT_TRANSFORM_HANDLE_SPACING * 2) / zoomValue;
|
||||
|
||||
export const getTextAutoResizeHandle = (
|
||||
textElement: ExcalidrawTextElement,
|
||||
zoomValue: number,
|
||||
formFactor: EditorInterface["formFactor"],
|
||||
) => {
|
||||
if (
|
||||
formFactor !== "desktop" ||
|
||||
TEXT_AUTO_RESIZE_HANDLE_LENGTH >
|
||||
textElement.height * zoomValue * MAX_HANDLE_HEIGHT_RATIO
|
||||
) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const padding = getTextBoxPadding(zoomValue);
|
||||
const gap = TEXT_AUTO_RESIZE_HANDLE_GAP / zoomValue;
|
||||
const length = TEXT_AUTO_RESIZE_HANDLE_LENGTH / zoomValue;
|
||||
const center = pointFrom(
|
||||
textElement.x + textElement.width / 2,
|
||||
textElement.y + textElement.height / 2,
|
||||
);
|
||||
const handleCenter = pointRotateRads(
|
||||
pointFrom(center[0] + textElement.width / 2 + padding + gap, center[1]),
|
||||
center,
|
||||
textElement.angle,
|
||||
);
|
||||
|
||||
return {
|
||||
center: handleCenter,
|
||||
start: pointRotateRads(
|
||||
pointFrom(handleCenter[0], handleCenter[1] - length / 2),
|
||||
handleCenter,
|
||||
textElement.angle,
|
||||
) as GlobalPoint,
|
||||
end: pointRotateRads(
|
||||
pointFrom(handleCenter[0], handleCenter[1] + length / 2),
|
||||
handleCenter,
|
||||
textElement.angle,
|
||||
) as GlobalPoint,
|
||||
hitboxWidth: TEXT_AUTO_RESIZE_HANDLE_HITBOX_WIDTH / zoomValue,
|
||||
hitboxHeight: TEXT_AUTO_RESIZE_HANDLE_HITBOX_HEIGHT / zoomValue,
|
||||
};
|
||||
};
|
||||
|
||||
export const isPointHittingTextAutoResizeHandle = (
|
||||
point: Readonly<{ x: number; y: number }>,
|
||||
textElement: ExcalidrawTextElement,
|
||||
zoomValue: number,
|
||||
formFactor: EditorInterface["formFactor"],
|
||||
) => {
|
||||
const handle = getTextAutoResizeHandle(textElement, zoomValue, formFactor);
|
||||
|
||||
if (!handle) {
|
||||
return false;
|
||||
}
|
||||
|
||||
const unrotatedPoint = pointRotateRads(
|
||||
pointFrom(point.x, point.y),
|
||||
handle.center,
|
||||
-textElement.angle as Radians,
|
||||
);
|
||||
|
||||
return (
|
||||
Math.abs(unrotatedPoint[0] - handle.center[0]) <= handle.hitboxWidth / 2 &&
|
||||
Math.abs(unrotatedPoint[1] - handle.center[1]) <= handle.hitboxHeight / 2
|
||||
);
|
||||
};
|
||||
@@ -32,6 +32,7 @@ import type {
|
||||
OrderedExcalidrawElement,
|
||||
ExcalidrawNonSelectionElement,
|
||||
BindMode,
|
||||
ExcalidrawTextElement,
|
||||
} from "@excalidraw/element/types";
|
||||
|
||||
import type {
|
||||
@@ -327,7 +328,7 @@ export interface AppState {
|
||||
/**
|
||||
* set when a new text is created or when an existing text is being edited
|
||||
*/
|
||||
editingTextElement: NonDeletedExcalidrawElement | null;
|
||||
editingTextElement: ExcalidrawTextElement | null;
|
||||
activeTool: {
|
||||
/**
|
||||
* indicates a previous tool we should revert back to if we deselect the
|
||||
@@ -573,11 +574,15 @@ export interface ExcalidrawProps {
|
||||
* Invoked as soon as the Excalidraw API is available
|
||||
* NOTE editor is not yet mounted, and state is not yet initialized
|
||||
*/
|
||||
onExcalidrawAPI?: (api: ExcalidrawImperativeAPI) => void;
|
||||
onExcalidrawAPI?: (api: ExcalidrawImperativeAPI | null) => void;
|
||||
/**
|
||||
* Invoked once the editor root is mounted.
|
||||
*/
|
||||
onMount?: (payload: ExcalidrawMountPayload) => void;
|
||||
/**
|
||||
* Invoked when the editor root is unmounted.
|
||||
*/
|
||||
onUnmount?: () => void;
|
||||
/**
|
||||
* Invoked once the initial scene is loaded.
|
||||
*/
|
||||
@@ -872,9 +877,8 @@ export type PointerDownState = Readonly<{
|
||||
// by default same as PointerDownState.origin. On alt-duplication, reset
|
||||
// to current pointer position at time of duplication.
|
||||
origin: { x: number; y: number };
|
||||
// Whether to block drag after lasso selection
|
||||
// this is meant to be used to block dragging after lasso selection on PCs
|
||||
// until the next pointer down
|
||||
// explicit flag for specific scenarios such as:
|
||||
// - after lasso selection until the next pointer down
|
||||
blockDragging: boolean;
|
||||
};
|
||||
// We need to have these in the state so that we can unsubscribe them
|
||||
@@ -907,9 +911,12 @@ export type ExcalidrawMountPayload = {
|
||||
export type ExcalidrawImperativeAPIEventMap = {
|
||||
"editor:mount": [payload: ExcalidrawMountPayload];
|
||||
"editor:initialize": [api: ExcalidrawImperativeAPI];
|
||||
"editor:unmount": [];
|
||||
};
|
||||
|
||||
export interface ExcalidrawImperativeAPI {
|
||||
/** Whether the editor has been unmounted and the API is no longer usable. */
|
||||
isDestroyed: boolean;
|
||||
updateScene: InstanceType<typeof App>["updateScene"];
|
||||
applyDeltas: InstanceType<typeof App>["applyDeltas"];
|
||||
mutateElement: InstanceType<typeof App>["mutateElement"];
|
||||
|
||||
@@ -1,7 +1,10 @@
|
||||
import { queryByText } from "@testing-library/react";
|
||||
|
||||
import { pointFrom } from "@excalidraw/math";
|
||||
import { getOriginalContainerHeightFromCache } from "@excalidraw/element";
|
||||
import {
|
||||
getLineHeightInPx,
|
||||
getOriginalContainerHeightFromCache,
|
||||
} from "@excalidraw/element";
|
||||
|
||||
import {
|
||||
CODES,
|
||||
@@ -210,6 +213,42 @@ describe("textWysiwyg", () => {
|
||||
expect(h.elements.length).toBe(1);
|
||||
});
|
||||
|
||||
it("should vertically center newly created text on the cursor when clicked with text tool", async () => {
|
||||
API.setAppState({
|
||||
currentItemFontFamily: FONT_FAMILY.Cascadia,
|
||||
currentItemFontSize: 40,
|
||||
});
|
||||
UI.clickTool("text");
|
||||
|
||||
mouse.clickAt(120, 80);
|
||||
|
||||
const editor = await getTextEditor();
|
||||
const text = h.elements[0] as ExcalidrawTextElement;
|
||||
const lineHeightPx = getLineHeightInPx(text.fontSize, text.lineHeight);
|
||||
|
||||
expect(editor).not.toBe(null);
|
||||
expect(text.y + lineHeightPx / 2).toBe(80);
|
||||
});
|
||||
|
||||
it("should snap newly created text top-left to the current grid cell when clicked with text tool in grid mode", async () => {
|
||||
API.setAppState({
|
||||
currentItemFontFamily: FONT_FAMILY.Cascadia,
|
||||
currentItemFontSize: 40,
|
||||
gridModeEnabled: true,
|
||||
gridSize: 24,
|
||||
});
|
||||
UI.clickTool("text");
|
||||
|
||||
mouse.clickAt(113, 86);
|
||||
|
||||
const editor = await getTextEditor();
|
||||
const text = h.elements[0] as ExcalidrawTextElement;
|
||||
|
||||
expect(editor).not.toBe(null);
|
||||
expect(text.x).toBe(96);
|
||||
expect(text.y).toBe(72);
|
||||
});
|
||||
|
||||
it("should edit text under cursor when double-clicked with selection tool", async () => {
|
||||
const text = API.createElement({
|
||||
type: "text",
|
||||
@@ -232,6 +271,67 @@ describe("textWysiwyg", () => {
|
||||
expect(h.elements.length).toBe(1);
|
||||
});
|
||||
|
||||
it("should edit selected bound text on single click", async () => {
|
||||
const container = API.createElement({
|
||||
type: "rectangle",
|
||||
width: 160,
|
||||
height: 70,
|
||||
boundElements: [],
|
||||
});
|
||||
const text = API.createElement({
|
||||
type: "text",
|
||||
text: "Hello World!",
|
||||
x: container.x + 20,
|
||||
y: container.y + 20,
|
||||
width: 120,
|
||||
height: 25,
|
||||
containerId: container.id,
|
||||
});
|
||||
|
||||
API.setElements([container, text]);
|
||||
API.updateElement(container, {
|
||||
boundElements: [{ type: "text", id: text.id }],
|
||||
});
|
||||
API.setSelectedElements([container]);
|
||||
UI.clickTool("selection");
|
||||
|
||||
mouse.clickAt(text.x + 26, text.y + 10);
|
||||
|
||||
const editor = await getTextEditor();
|
||||
|
||||
expect(editor).not.toBe(null);
|
||||
});
|
||||
|
||||
it("should not edit selected bound text container when only the container was single-clicked", async () => {
|
||||
const container = API.createElement({
|
||||
type: "rectangle",
|
||||
width: 160,
|
||||
height: 70,
|
||||
boundElements: [],
|
||||
});
|
||||
const text = API.createElement({
|
||||
type: "text",
|
||||
text: "Hello World!",
|
||||
x: container.x + 20,
|
||||
y: container.y + 20,
|
||||
width: 120,
|
||||
height: 25,
|
||||
containerId: container.id,
|
||||
});
|
||||
|
||||
API.setElements([container, text]);
|
||||
API.updateElement(container, {
|
||||
boundElements: [{ type: "text", id: text.id }],
|
||||
});
|
||||
API.setSelectedElements([container]);
|
||||
UI.clickTool("selection");
|
||||
|
||||
mouse.clickAt(container.x + 5, container.y + 10);
|
||||
|
||||
expect(h.state.editingTextElement).toBe(null);
|
||||
expect(await getTextEditor({ waitForEditor: false })).toBe(null);
|
||||
});
|
||||
|
||||
// FIXME too flaky. No one knows why.
|
||||
it.skip("should bump the version of a labeled arrow when the label is updated", async () => {
|
||||
const arrow = UI.createElement("arrow", {
|
||||
@@ -1511,7 +1611,7 @@ describe("textWysiwyg", () => {
|
||||
version: 2,
|
||||
width: 610,
|
||||
x: 15,
|
||||
y: 25,
|
||||
y: 12.5,
|
||||
}),
|
||||
);
|
||||
expect(h.elements[2] as ExcalidrawTextElement).toEqual(
|
||||
|
||||
@@ -10,7 +10,9 @@ import {
|
||||
isTestEnv,
|
||||
MIME_TYPES,
|
||||
applyDarkModeFilter,
|
||||
isRTL,
|
||||
} from "@excalidraw/common";
|
||||
import { pointFrom, pointRotateRads, type Radians } from "@excalidraw/math";
|
||||
|
||||
import {
|
||||
getTextFromElements,
|
||||
@@ -33,8 +35,11 @@ import {
|
||||
getBoundTextElement,
|
||||
} from "@excalidraw/element";
|
||||
import { getTextWidth } from "@excalidraw/element";
|
||||
import { getLineHeightInPx } from "@excalidraw/element";
|
||||
import { getLineWidth } from "@excalidraw/element";
|
||||
import { normalizeText } from "@excalidraw/element";
|
||||
import { wrapText } from "@excalidraw/element";
|
||||
import { getWrappedTextLines } from "@excalidraw/element";
|
||||
import {
|
||||
isArrowElement,
|
||||
isBoundToContainer,
|
||||
@@ -91,6 +96,103 @@ const getTransform = (
|
||||
return `translate(${translateX}px, ${translateY}px) scale(${zoom.value}) rotate(${degree}deg)`;
|
||||
};
|
||||
|
||||
const getLineDirection = (text: string, offset: number) => {
|
||||
const hardLineStart = text.lastIndexOf("\n", Math.max(0, offset - 1)) + 1;
|
||||
const hardLineEnd = text.indexOf("\n", offset);
|
||||
const hardLineText = text.slice(
|
||||
hardLineStart,
|
||||
hardLineEnd === -1 ? text.length : hardLineEnd,
|
||||
);
|
||||
|
||||
return isRTL(hardLineText) ? "rtl" : "ltr";
|
||||
};
|
||||
|
||||
const getCaretBoundaryOffsets = (text: string) => {
|
||||
const offsets = [0];
|
||||
let offset = 0;
|
||||
|
||||
for (const char of Array.from(text)) {
|
||||
offset += char.length;
|
||||
offsets.push(offset);
|
||||
}
|
||||
|
||||
return offsets;
|
||||
};
|
||||
|
||||
const getLineCaretOffsetFromNativeLayout = ({
|
||||
text,
|
||||
font,
|
||||
lineHeightPx,
|
||||
direction,
|
||||
targetX,
|
||||
}: {
|
||||
text: string;
|
||||
font: ReturnType<typeof getFontString>;
|
||||
lineHeightPx: number;
|
||||
direction: "ltr" | "rtl";
|
||||
targetX: number;
|
||||
}) => {
|
||||
if (!text || !document.body || typeof document.createRange !== "function") {
|
||||
return null;
|
||||
}
|
||||
|
||||
const offsets = getCaretBoundaryOffsets(text);
|
||||
const mirror = document.createElement("div");
|
||||
const textNode = document.createTextNode(text);
|
||||
const range = document.createRange();
|
||||
const positions: number[] = [];
|
||||
|
||||
mirror.dir = direction;
|
||||
Object.assign(mirror.style, {
|
||||
position: "fixed",
|
||||
top: "0",
|
||||
left: "0",
|
||||
margin: 0,
|
||||
padding: 0,
|
||||
border: 0,
|
||||
opacity: "0",
|
||||
pointerEvents: "none",
|
||||
whiteSpace: "pre",
|
||||
font,
|
||||
lineHeight: `${lineHeightPx}px`,
|
||||
});
|
||||
mirror.append(textNode);
|
||||
document.body.append(mirror);
|
||||
|
||||
try {
|
||||
for (const offset of offsets) {
|
||||
range.setStart(textNode, offset);
|
||||
range.setEnd(textNode, offset);
|
||||
const caretRect = range.getBoundingClientRect();
|
||||
|
||||
if (!Number.isFinite(caretRect.left)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
positions.push(caretRect.left);
|
||||
}
|
||||
} catch {
|
||||
return null;
|
||||
} finally {
|
||||
mirror.remove();
|
||||
}
|
||||
|
||||
const leftEdge = Math.min(...positions);
|
||||
let closestOffset = offsets[0];
|
||||
let closestDistance = Infinity;
|
||||
|
||||
for (let index = 0; index < offsets.length; index++) {
|
||||
const distance = Math.abs(positions[index] - leftEdge - targetX);
|
||||
|
||||
if (distance < closestDistance) {
|
||||
closestDistance = distance;
|
||||
closestOffset = offsets[index];
|
||||
}
|
||||
}
|
||||
|
||||
return closestOffset;
|
||||
};
|
||||
|
||||
type SubmitHandler = () => void;
|
||||
|
||||
export const textWysiwyg = ({
|
||||
@@ -103,6 +205,7 @@ export const textWysiwyg = ({
|
||||
excalidrawContainer,
|
||||
app,
|
||||
autoSelect = true,
|
||||
initialCaretSceneCoords = null,
|
||||
}: {
|
||||
id: ExcalidrawElement["id"];
|
||||
/**
|
||||
@@ -119,7 +222,19 @@ export const textWysiwyg = ({
|
||||
excalidrawContainer: HTMLDivElement | null;
|
||||
app: App;
|
||||
autoSelect?: boolean;
|
||||
initialCaretSceneCoords?: { x: number; y: number } | null;
|
||||
}): SubmitHandler => {
|
||||
let currentTextLayout: {
|
||||
angle: Radians;
|
||||
font: ReturnType<typeof getFontString>;
|
||||
height: number;
|
||||
lineHeightPx: number;
|
||||
textAlign: ExcalidrawTextElement["textAlign"];
|
||||
width: number;
|
||||
x: number;
|
||||
y: number;
|
||||
} | null = null;
|
||||
|
||||
const textPropertiesUpdated = (
|
||||
updatedTextElement: ExcalidrawTextElement,
|
||||
editable: HTMLTextAreaElement,
|
||||
@@ -254,6 +369,7 @@ export const textWysiwyg = ({
|
||||
height *= 1.05;
|
||||
|
||||
const font = getFontString(updatedTextElement);
|
||||
const angle = getTextElementAngle(updatedTextElement, container);
|
||||
|
||||
// Make sure text editor height doesn't go beyond viewport
|
||||
const editorMaxHeight =
|
||||
@@ -269,7 +385,7 @@ export const textWysiwyg = ({
|
||||
transform: getTransform(
|
||||
width,
|
||||
height,
|
||||
getTextElementAngle(updatedTextElement, container),
|
||||
angle,
|
||||
appState,
|
||||
maxWidth,
|
||||
editorMaxHeight,
|
||||
@@ -283,6 +399,19 @@ export const textWysiwyg = ({
|
||||
opacity: updatedTextElement.opacity / 100,
|
||||
maxHeight: `${editorMaxHeight}px`,
|
||||
});
|
||||
currentTextLayout = {
|
||||
angle: angle as Radians,
|
||||
font,
|
||||
height: updatedTextElement.height,
|
||||
lineHeightPx: getLineHeightInPx(
|
||||
updatedTextElement.fontSize,
|
||||
updatedTextElement.lineHeight,
|
||||
),
|
||||
textAlign,
|
||||
width: updatedTextElement.width,
|
||||
x: coordX,
|
||||
y: coordY,
|
||||
};
|
||||
editable.scrollTop = 0;
|
||||
// For some reason updating font attribute doesn't set font family
|
||||
// hence updating font family explicitly for test environment
|
||||
@@ -333,6 +462,71 @@ export const textWysiwyg = ({
|
||||
editable.value = element.originalText;
|
||||
updateWysiwygStyle();
|
||||
|
||||
const getCaretIndexFromInitialSceneCoords = () => {
|
||||
if (!initialCaretSceneCoords || !currentTextLayout) {
|
||||
return null;
|
||||
}
|
||||
|
||||
const layout = currentTextLayout;
|
||||
const center = pointFrom(
|
||||
layout.x + layout.width / 2,
|
||||
layout.y + layout.height / 2,
|
||||
);
|
||||
const [unrotatedX, unrotatedY] = pointRotateRads(
|
||||
pointFrom(initialCaretSceneCoords.x, initialCaretSceneCoords.y),
|
||||
center,
|
||||
-layout.angle as Radians,
|
||||
);
|
||||
const localX = unrotatedX - layout.x;
|
||||
const localY = unrotatedY - layout.y;
|
||||
const lines = getWrappedTextLines(
|
||||
editable.value,
|
||||
layout.font,
|
||||
whiteSpace === "pre-wrap" ? layout.width : Infinity,
|
||||
);
|
||||
const lineIndex = Math.max(
|
||||
0,
|
||||
Math.min(lines.length - 1, Math.floor(localY / layout.lineHeightPx)),
|
||||
);
|
||||
const line = lines[lineIndex];
|
||||
const direction = getLineDirection(editable.value, line.start);
|
||||
const lineWidth = getLineWidth(line.text, layout.font);
|
||||
const lineStartX =
|
||||
layout.textAlign === "center"
|
||||
? (layout.width - lineWidth) / 2
|
||||
: layout.textAlign === "right"
|
||||
? layout.width - lineWidth
|
||||
: 0;
|
||||
const relativeX = localX - lineStartX;
|
||||
|
||||
if (!line.text) {
|
||||
return line.start;
|
||||
}
|
||||
|
||||
const lineCaretOffset = getLineCaretOffsetFromNativeLayout({
|
||||
text: line.text,
|
||||
font: layout.font,
|
||||
lineHeightPx: layout.lineHeightPx,
|
||||
direction,
|
||||
targetX: relativeX,
|
||||
});
|
||||
|
||||
return line.start + (lineCaretOffset || 0);
|
||||
};
|
||||
|
||||
let pendingInitialSelection = (() => {
|
||||
const caretIndex = getCaretIndexFromInitialSceneCoords();
|
||||
|
||||
if (caretIndex === null) {
|
||||
return null;
|
||||
}
|
||||
|
||||
return {
|
||||
start: caretIndex,
|
||||
end: caretIndex,
|
||||
};
|
||||
})();
|
||||
|
||||
if (onChange) {
|
||||
editable.onpaste = async (event) => {
|
||||
// we need to synchronously get the MIME types so we can preventDefault()
|
||||
@@ -696,6 +890,13 @@ export const textWysiwyg = ({
|
||||
// Otherwise, re-enable submit on blur and refocus the editor.
|
||||
editable.onblur = handleSubmit;
|
||||
editable.focus();
|
||||
if (pendingInitialSelection) {
|
||||
editable.setSelectionRange(
|
||||
pendingInitialSelection.start,
|
||||
pendingInitialSelection.end,
|
||||
);
|
||||
pendingInitialSelection = null;
|
||||
}
|
||||
});
|
||||
};
|
||||
|
||||
@@ -786,7 +987,7 @@ export const textWysiwyg = ({
|
||||
|
||||
let isDestroyed = false;
|
||||
|
||||
if (autoSelect) {
|
||||
if (autoSelect && !pendingInitialSelection) {
|
||||
// select on init (focusing is done separately inside the bindBlurEvent()
|
||||
// because we need it to happen *after* the blur event from `pointerdown`)
|
||||
editable.select();
|
||||
|
||||
@@ -123,10 +123,15 @@ export function pointsEqual<Point extends GlobalPoint | LocalPoint>(
|
||||
* @returns The rotated point
|
||||
*/
|
||||
export function pointRotateRads<Point extends GlobalPoint | LocalPoint>(
|
||||
[x, y]: Point,
|
||||
[cx, cy]: Point,
|
||||
point: Point,
|
||||
center: Point,
|
||||
angle: Radians,
|
||||
): Point {
|
||||
if (!angle) {
|
||||
return point;
|
||||
}
|
||||
const [x, y] = point;
|
||||
const [cx, cy] = center;
|
||||
return pointFrom(
|
||||
(x - cx) * Math.cos(angle) - (y - cy) * Math.sin(angle) + cx,
|
||||
(x - cx) * Math.sin(angle) + (y - cy) * Math.cos(angle) + cy,
|
||||
|
||||
@@ -196,7 +196,7 @@ export const getEllipseShape = <Point extends GlobalPoint | LocalPoint>(
|
||||
|
||||
export const getCurvePathOps = (shape: Drawable): Op[] => {
|
||||
// NOTE (mtolmacs): Temporary fix for extremely large elements
|
||||
if (!shape) {
|
||||
if (!shape || shape.sets.length === 0) {
|
||||
return [];
|
||||
}
|
||||
|
||||
@@ -205,6 +205,7 @@ export const getCurvePathOps = (shape: Drawable): Op[] => {
|
||||
return set.ops;
|
||||
}
|
||||
}
|
||||
|
||||
return shape.sets[0].ops;
|
||||
};
|
||||
|
||||
@@ -316,26 +317,29 @@ export const getClosedCurveShape = <Point extends GlobalPoint | LocalPoint>(
|
||||
};
|
||||
}
|
||||
|
||||
const ops = getCurvePathOps(roughShape);
|
||||
// Prefer the fillPath set
|
||||
const fillPathSet = roughShape.sets.find((s) => s.type === "fillPath");
|
||||
const ops = fillPathSet ? fillPathSet.ops : getCurvePathOps(roughShape);
|
||||
|
||||
const points: Point[] = [];
|
||||
let odd = false;
|
||||
for (const operation of ops) {
|
||||
if (operation.op === "move") {
|
||||
odd = !odd;
|
||||
if (odd) {
|
||||
if (fillPathSet) {
|
||||
// fillPath is always a single run — no odd/even skipping needed
|
||||
points.push(pointFrom(operation.data[0], operation.data[1]));
|
||||
} else {
|
||||
odd = !odd;
|
||||
if (odd) {
|
||||
points.push(pointFrom(operation.data[0], operation.data[1]));
|
||||
}
|
||||
}
|
||||
} else if (operation.op === "bcurveTo") {
|
||||
if (odd) {
|
||||
if (fillPathSet || odd) {
|
||||
points.push(pointFrom(operation.data[0], operation.data[1]));
|
||||
points.push(pointFrom(operation.data[2], operation.data[3]));
|
||||
points.push(pointFrom(operation.data[4], operation.data[5]));
|
||||
}
|
||||
} else if (operation.op === "lineTo") {
|
||||
if (odd) {
|
||||
points.push(pointFrom(operation.data[0], operation.data[1]));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -1531,10 +1531,10 @@
|
||||
resolved "https://registry.yarnpkg.com/@excalidraw/markdown-to-text/-/markdown-to-text-0.1.2.tgz#1703705e7da608cf478f17bfe96fb295f55a23eb"
|
||||
integrity sha512-1nDXBNAojfi3oSFwJswKREkFm5wrSjqay81QlyRv2pkITG/XYB5v+oChENVBQLcxQwX4IUATWvXM5BcaNhPiIg==
|
||||
|
||||
"@excalidraw/mermaid-to-excalidraw@2.0.0-rc4":
|
||||
version "2.0.0-rc4"
|
||||
resolved "https://registry.yarnpkg.com/@excalidraw/mermaid-to-excalidraw/-/mermaid-to-excalidraw-2.0.0-rc4.tgz#9d38568de8e403fefb6a162efa71e024ea1f7e03"
|
||||
integrity sha512-92efu7VTYF6appGKgbDJAZEM/YXICpYPYOfl+j1E9SVilIFCJEAg7xH2lt/c44WFtffG+rWKrYwf9KUrPYy1Qw==
|
||||
"@excalidraw/mermaid-to-excalidraw@2.1.0":
|
||||
version "2.1.0"
|
||||
resolved "https://registry.yarnpkg.com/@excalidraw/mermaid-to-excalidraw/-/mermaid-to-excalidraw-2.1.0.tgz#a5b9cf87c3185558cda7f9687d87b9937f452358"
|
||||
integrity sha512-RMd+c2b7WzzUjhERMpKwp8PhF2/XlHDjr/zK+Gxfp8K9sVlafPYJ5OEa/GkN6edi2rBUXRfW+41WdO6L56b6Kw==
|
||||
dependencies:
|
||||
"@excalidraw/markdown-to-text" "0.1.2"
|
||||
"@mermaid-js/parser" "^0.6.3"
|
||||
|
||||
Reference in New Issue
Block a user