Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 80e53ef03c |
+3
-3
@@ -1,4 +1,4 @@
|
|||||||
## 2023-10-27 - Excalidraw Component Re-render Performance Penalty
|
## 2024-06-07 - Memoize callbacks passed to Excalidraw
|
||||||
|
|
||||||
**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.
|
**Learning:** Due to the exceptionally high rendering cost of the `@excalidraw/excalidraw` canvas, always ensure all callbacks passed to it (e.g., `onExcalidrawAPI`) are strictly memoized using `useCallback`. Passing inline functions as props breaks prop stability for `React.memo` and causes severe UI input lag caused by full canvas re-renders when parent states change.
|
||||||
**Action:** Always strictly memoize all callbacks passed to the Excalidraw component using `useCallback` to preserve prop stability and prevent unnecessary, expensive re-renders.
|
**Action:** When working with `<Excalidraw>` or its wrapper components like `<EditorCanvas>`, always extract inline callback functions (like `onExcalidrawAPI={(api) => { ... }}`) into `useCallback` hooks before passing them down.
|
||||||
|
|||||||
@@ -307,6 +307,9 @@ function PrivateApp() {
|
|||||||
[],
|
[],
|
||||||
);
|
);
|
||||||
|
|
||||||
|
// ⚡ Bolt: Memoize the Excalidraw API callback to prevent EditorCanvas from re-rendering
|
||||||
|
// Excalidraw has exceptionally high rendering cost, so we must maintain prop stability
|
||||||
|
// for EditorCanvas's React.memo to avoid severe UI input lag on any parent state change.
|
||||||
const handleExcalidrawAPI = useCallback((api: ExcalidrawImperativeAPI) => {
|
const handleExcalidrawAPI = useCallback((api: ExcalidrawImperativeAPI) => {
|
||||||
excalidrawApiRef.current = api;
|
excalidrawApiRef.current = api;
|
||||||
}, []);
|
}, []);
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import { memo, useCallback } from "react";
|
import { memo } from "react";
|
||||||
import { Excalidraw } from "@excalidraw/excalidraw";
|
import { Excalidraw } from "@excalidraw/excalidraw";
|
||||||
import type {
|
import type {
|
||||||
AppState,
|
AppState,
|
||||||
@@ -7,7 +7,6 @@ import type {
|
|||||||
ExcalidrawInitialDataState,
|
ExcalidrawInitialDataState,
|
||||||
ExcalidrawProps,
|
ExcalidrawProps,
|
||||||
} from "@excalidraw/excalidraw/types";
|
} from "@excalidraw/excalidraw/types";
|
||||||
import type { OrderedExcalidrawElement } from "@excalidraw/excalidraw/element/types";
|
|
||||||
import "../../../node_modules/@excalidraw/excalidraw/dist/prod/index.css";
|
import "../../../node_modules/@excalidraw/excalidraw/dist/prod/index.css";
|
||||||
import { type ScenePayload } from "../../core/shared";
|
import { type ScenePayload } from "../../core/shared";
|
||||||
import {
|
import {
|
||||||
@@ -57,19 +56,6 @@ export const EditorCanvas = memo(function EditorCanvas({
|
|||||||
onExcalidrawAPI,
|
onExcalidrawAPI,
|
||||||
renderEmbeddable,
|
renderEmbeddable,
|
||||||
}: EditorCanvasProps) {
|
}: 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) {
|
if (loading || !scene) {
|
||||||
return <div className="editor-loading">{error ?? "Loading..."}</div>;
|
return <div className="editor-loading">{error ?? "Loading..."}</div>;
|
||||||
}
|
}
|
||||||
@@ -81,7 +67,13 @@ export const EditorCanvas = memo(function EditorCanvas({
|
|||||||
initialData={sceneToInitialData(scene)}
|
initialData={sceneToInitialData(scene)}
|
||||||
excalidrawAPI={onExcalidrawAPI}
|
excalidrawAPI={onExcalidrawAPI}
|
||||||
renderEmbeddable={renderEmbeddable}
|
renderEmbeddable={renderEmbeddable}
|
||||||
onChange={handleChange}
|
onChange={(elements, appState, files) => {
|
||||||
|
onEditorActivity();
|
||||||
|
onSceneChange(sceneFromEditor(elements, appState, files));
|
||||||
|
onSelectionStateChange(
|
||||||
|
getCodeBlockSelectionState(elements, appState),
|
||||||
|
);
|
||||||
|
}}
|
||||||
/>
|
/>
|
||||||
</div>
|
</div>
|
||||||
);
|
);
|
||||||
|
|||||||
Reference in New Issue
Block a user