From 3f4db7682ec92b52868e1c67a94be45f0b0a17d2 Mon Sep 17 00:00:00 2001
From: Riley Crahen <riley.crahen@sigmacomputing.com>
Date: Tue, 10 Mar 2026 13:45:49 -0700
Subject: [PATCH 1/2] fix loading state docs

---
 README.md    | 10 +++++-----
 src/types.ts |  7 ++++---
 2 files changed, 9 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 5f4db77..b420cf8 100644
--- a/README.md
+++ b/README.md
@@ -488,9 +488,9 @@ interface PluginInstance<T> {
     registerEffect(configId: string, effect: Function): void;
 
     /**
-     * Overrider function for Config Ready state
+     * Overrider function for Config loading state
      */
-    setLoadingState(ready: boolean): void;
+    setLoadingState(isLoading: boolean): void;
 
     /**
      * Allows users to subscribe to changes in the passed in variable
@@ -655,8 +655,8 @@ Arguments
 
 #### useLoadingState()
 
-Gets the current plugin's loading stat. Returns a value and a setter allowing
-you to update the plugin's loading state
+Gets the current plugin's loading state and a setter. Call the setter with
+`false` when your plugin has finished loading
 
 ```ts
 function useLoadingState(
@@ -666,7 +666,7 @@ function useLoadingState(
 
 Arguments
 
-- `initialState : boolean` - Initial value to set loading state to
+- `initialState : boolean` - Initial loading state (typically `true`; then set to `false` when ready)
 
 #### useElementColumns()
 
diff --git a/src/types.ts b/src/types.ts
index c8e9cc5..2f06c9e 100644
--- a/src/types.ts
+++ b/src/types.ts
@@ -303,10 +303,11 @@ export interface PluginInstance<T = any> {
     registerEffect(configId: string, effect: () => void): () => void;
 
     /**
-     * Overrider function for Config Ready state
-     * @param {boolean} loadingState Boolean representing if Plugin Config is still loading
+     * Tell the workbook whether the plugin is still loading. Pass false when the plugin
+     * has finished loading so that workbook export (PDF/PNG) and screenshots can complete.
+     * @param {boolean} isLoading Boolean representing if Plugin Config is still loading
      */
-    setLoadingState(ready: boolean): void;
+    setLoadingState(isLoading: boolean): void;
 
     /**
      * Allows users to subscribe to changes in the passed in variable

From 9e444d156a3cfe46d5c7724a88572e9a8ed1d4dd Mon Sep 17 00:00:00 2001
From: Riley Crahen <riley.crahen@sigmacomputing.com>
Date: Tue, 10 Mar 2026 14:14:09 -0700
Subject: [PATCH 2/2] rm line about exports

---
 src/types.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/types.ts b/src/types.ts
index 2f06c9e..0f5ad3e 100644
--- a/src/types.ts
+++ b/src/types.ts
@@ -304,7 +304,7 @@ export interface PluginInstance<T = any> {
 
     /**
      * Tell the workbook whether the plugin is still loading. Pass false when the plugin
-     * has finished loading so that workbook export (PDF/PNG) and screenshots can complete.
+     * has finished loading and is ready to be used.
      * @param {boolean} isLoading Boolean representing if Plugin Config is still loading
      */
     setLoadingState(isLoading: boolean): void;