Function: progressList()

function progressList(ctx: Context, options: ProgressListOptions): RenderSession;

Defined in: src/renderer/templates/progressList.ts:43

Displays a progress list showing multiple operation statuses.

Shows bubble with progress items (done, failed, in-progress). Fire-and-forget: returns a RenderSession the caller can await session.cleanup() on once the work is done.

Parameters

Parameter	Type	Description
ctx	Context	The context to render to.
options	ProgressListOptions	Configuration for the bubble.

Returns

RenderSession

Example

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

const session = progressList(ctx, {
  title: 'Loading Data',
  description: 'Please wait while we load the data',
  items: [
    { label: 'Data fetched successfully.', value: 'done' },
    { label: 'Data sorting', value: 'failed' },
    { label: 'Data filtering', value: 'in-progress' },
  ],
});
// ...do work...
await session.cleanup();