sdk.progress.showprogresslist

Home > @matterway/sdk > Progress > showProgressList

Progress.showProgressList() function

Shows a list of Progressibles.

Signature:

export declare function showProgressList(context: Context, items: Progressible[], options?: {
    title?: string;
    description?: string;
    overlay?: boolean;
}): Promise<void>;

Parameters

Parameter	Type	Description
context	Context	Context options.
items	Progressible[]	List of Progressibles.
options	{ title?: string; description?: string; overlay?: boolean; }	(Optional) Progress list options.

Returns:

Promise<void>

Example

import {showProgressList} from '@matterway/sdk-progress';

...
 await showProgressList(
  ctx,
  [
    {
      title: 'Title Progress',
      description: 'Example Running Progress',
      status: 'running',
    },
    {
      title: 'Title Progress',
      description: 'Example Done Progress',
      status: 'done',
    },
    {
      title: 'Title Progress',
      description: 'Example Pending Progress',
      status: 'pending',
    },
    {
      title: 'Title Progress',
      description: 'Example Failed Progress',
      status: 'failed',
    },
  ],
  {
    title: 'Title of the Step',
    description: 'Description of the Step',
    overlay: true,
  },
);