Remove the listener when component is unmounted

prezly · Sep 17, 2024 · 8d6df46 · 8d6df46
1 parent f15d268
commit 8d6df46
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/packages/slate-editor/src/extensions/coverage/components/CoverageElement.tsx b/packages/slate-editor/src/extensions/coverage/components/CoverageElement.tsx
@@ -60,14 +60,14 @@ export function CoverageElement({
         }
     }
 
-    function handleCoverageUpdated({ coverage }: { coverage: Pick<CoverageEntry, 'id'>}) {
-        if (element.coverage.id === coverage.id) {
-            loadCoverage();
+    useEffect(() => {
+        function handleCoverageUpdated({ coverage }: { coverage: Pick<CoverageEntry, 'id'>}) {
+            if (element.coverage.id === coverage.id) {
+                loadCoverage();
+            }
         }
-    }
 
-    useEffect(() => {
-        EventsEditor.addEventListener(editor, 'coverage-updated', handleCoverageUpdated);
+        return EventsEditor.addEventListener(editor, 'coverage-updated', handleCoverageUpdated);
     }, []);
 
     return (

diff --git a/packages/slate-editor/src/modules/events/EventsEditor.ts b/packages/slate-editor/src/modules/events/EventsEditor.ts
@@ -1,4 +1,6 @@
+import type { RemoveListener } from '@prezly/events';
 import { Events } from '@prezly/events';
+import { noop } from '@technically/lodash';
 import { Editor } from 'slate';
 
 import { EVENTS_PROPERTY } from './constants';
@@ -10,10 +12,12 @@ export abstract class EventsEditor {
         editor: Editor,
         event: Event,
         listener: EditorEventHandlers[Event],
-    ): void {
+    ): RemoveListener {
         if (EventsEditor.isEventsEditor(editor)) {
-            editor[EVENTS_PROPERTY].addEventListener(event, listener);
+            return editor[EVENTS_PROPERTY].addEventListener(event, listener);
         }
+
+        return noop;
     }
 
     static dispatchEvent<Event extends keyof EditorEventMap>(