Add comments for triggerCancel

specklesystems · Jan 10, 2025 · 19e1e75 · 19e1e75
1 parent 1ff0887
commit 19e1e75
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/packages/dui3/lib/bindings/definitions/ISendBinding.ts b/packages/dui3/lib/bindings/definitions/ISendBinding.ts
@@ -31,5 +31,8 @@ export interface ISendBindingEvents
     idMap: Record<string, string>
     newSelectedObjectIds: string[]
   }) => void
+  /**
+   * Use whenever want to cancel model card progress, it is used on Archicad so far since send operation blocks the UI thread.
+   */
   triggerCancel: (modelCardId: string) => void
 }
diff --git a/packages/dui3/store/hostApp.ts b/packages/dui3/store/hostApp.ts
@@ -183,6 +183,7 @@ export const useHostAppStore = defineStore('hostAppStore', () => {
     () => sendFilters.value?.find((f) => f.name === 'Selection') as ISendFilter
   )
 
+  // Used on Archicad so far since send operation blocks the UI thread.
   app.$sendBinding?.on('triggerCancel', (modelCardId: string) => {
     const model = documentModelStore.value.models.find(
       (m) => m.modelCardId === modelCardId