perf: strictly memoize Excalidraw callbacks to prevent unnecessary re-renders

This commit is contained in:
ruinivist
2026-06-06 07:54:45 +00:00
parent 01300c7061
commit da4948741e
3 changed files with 25 additions and 11 deletions
+4
View File
@@ -0,0 +1,4 @@
## 2023-10-27 - Excalidraw Component Re-render Performance Penalty
**Learning:** Due to the exceptionally high rendering cost of the `@excalidraw/excalidraw` canvas, inline functions passed as props (like `onChange` and `onExcalidrawAPI`) cause severe performance degradation by defeating `React.memo` and triggering full canvas re-renders when parent state changes.
**Action:** Always strictly memoize all callbacks passed to the Excalidraw component using `useCallback` to preserve prop stability and prevent unnecessary, expensive re-renders.
+5 -3
View File
@@ -307,6 +307,10 @@ function PrivateApp() {
[],
);
const handleExcalidrawAPI = useCallback((api: ExcalidrawImperativeAPI) => {
excalidrawApiRef.current = api;
}, []);
return (
<div className="app-shell" ref={appShellRef}>
{toastMessage && (
@@ -332,9 +336,7 @@ function PrivateApp() {
onSceneChange={handleSceneChange}
onSelectionStateChange={handleCodeBlockSelectionChange}
onEditorActivity={scheduleThemeTokenSync}
onExcalidrawAPI={(api) => {
excalidrawApiRef.current = api;
}}
onExcalidrawAPI={handleExcalidrawAPI}
renderEmbeddable={renderCodeBlockEmbeddable}
/>
<CodeBlockSidebar
+16 -8
View File
@@ -1,4 +1,4 @@
import { memo } from "react";
import { memo, useCallback } from "react";
import { Excalidraw } from "@excalidraw/excalidraw";
import type {
AppState,
@@ -7,6 +7,7 @@ import type {
ExcalidrawInitialDataState,
ExcalidrawProps,
} from "@excalidraw/excalidraw/types";
import type { OrderedExcalidrawElement } from "@excalidraw/excalidraw/element/types";
import "../../../node_modules/@excalidraw/excalidraw/dist/prod/index.css";
import { type ScenePayload } from "../../core/shared";
import {
@@ -56,6 +57,19 @@ export const EditorCanvas = memo(function EditorCanvas({
onExcalidrawAPI,
renderEmbeddable,
}: EditorCanvasProps) {
const handleChange = useCallback(
(
elements: readonly OrderedExcalidrawElement[],
appState: AppState,
files: BinaryFiles,
) => {
onEditorActivity();
onSceneChange(sceneFromEditor(elements, appState, files));
onSelectionStateChange(getCodeBlockSelectionState(elements, appState));
},
[onEditorActivity, onSceneChange, onSelectionStateChange],
);
if (loading || !scene) {
return <div className="editor-loading">{error ?? "Loading..."}</div>;
}
@@ -67,13 +81,7 @@ export const EditorCanvas = memo(function EditorCanvas({
initialData={sceneToInitialData(scene)}
excalidrawAPI={onExcalidrawAPI}
renderEmbeddable={renderEmbeddable}
onChange={(elements, appState, files) => {
onEditorActivity();
onSceneChange(sceneFromEditor(elements, appState, files));
onSelectionStateChange(
getCodeBlockSelectionState(elements, appState),
);
}}
onChange={handleChange}
/>
</div>
);