Function: progress()

function progress(
   ctx: Context, 
   label: string, 
   options?: Omit<ProgressOptions, "label">): RenderSession;

Defined in: src/renderer/templates/progress.ts:35

Displays a progress indicator for long-running operations.

Shows a shield with spinner and label. Fire-and-forget: returns a RenderSession the caller can await session.cleanup() on later.

Parameters

Parameter	Type	Description
ctx	Context	Render context
label	string	Progress text
options?	Omit<ProgressOptions, "label">	Shield configuration

Returns

RenderSession

Example

import {progress} from '@matterway/sdk/UI';

const session = progress(ctx, 'Loading Data', {overlay: true});
// ...do work...
await session.cleanup();