ctx.loading.start

Kicks off a loading spinner to provide context during any long-running action work. Can also be called with a single string argument as the label, or with no arguments to display only a spinner.

TypeScript

await ctx.loading.start({
  label: "Reticulating splines...",
});

await ctx.loading.start("Label only shorthand");

JavaScript

await ctx.loading.start({
  label: "Reticulating splines...",
});

await ctx.loading.start("Label only shorthand");

Python Experimental

await ctx.loading.start(
  label="Reticulating splines...",
)

await ctx.loading.start("Label only shorthand")

TypeScript

description

Optional

string

Secondary label providing additional context for the loading indicator.

itemsInQueue

Optional

number

Number of "items" your action needs to work through to complete loading. Subsequently calling `ctx.loading.completeOne` (e.g. within a loop) updates the indicator’s progress.

label

Optional

string

Primary label for the loading indicator.

Returns

null

JavaScript

description

Optional

string

Secondary label providing additional context for the loading indicator.

itemsInQueue

Optional

number

Number of "items" your action needs to work through to complete loading. Subsequently calling `ctx.loading.completeOne` (e.g. within a loop) updates the indicator’s progress.

label

Optional

string

Primary label for the loading indicator.

Returns

null

Python Experimental

description

Optional

str

Secondary label providing additional context for the loading indicator.

items_in_queue

Optional

int

Number of "items" your action needs to work through to complete loading. Subsequently calling `ctx.loading.complete_one` (e.g. within a loop) updates the indicator’s progress.

label

Optional

str

Primary label for the loading indicator.

Returns

None

Did this section clearly explain what you wanted to learn?