More docs

deephaven · May 27, 2024 · 61dd02a · 61dd02a
1 parent 96cdc07
commit 61dd02a
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/packages/jsapi-bootstrap/src/useWidget.ts b/packages/jsapi-bootstrap/src/useWidget.ts
@@ -51,6 +51,8 @@ export function useWidget<T extends dh.Widget = dh.Widget>(
       }
 
       // We should be able to load the widget. Load it asynchronously, and set the widget when it's done.
+      // If we get cancelled before the fetch is done, we should close the widget and its exported objects.
+      // If not though, the consumer of the widget is expected to take ownership and close the widget appropriately.
       let isCancelled = false;
       async function loadWidgetInternal() {
         try {