Skip to content

Fix loading state README and JSDOC #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rilescode merged 2 commits into from
Mar 10, 2026
Merged

Fix loading state README and JSDOC #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f4db76
fix loading state docs
rilescode Mar 10, 2026
9e444d1
rm line about exports
rilescode Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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(
Expand All @@ -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()

Expand Down
7 changes: 4 additions & 3 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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
Expand Down