diff --git a/README.md b/README.md index 5f4db77..b420cf8 100644 --- a/README.md +++ b/README.md @@ -488,9 +488,9 @@ interface PluginInstance { 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..0f5ad3e 100644 --- a/src/types.ts +++ b/src/types.ts @@ -303,10 +303,11 @@ export interface PluginInstance { 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 and is ready to be used. + * @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