sdk.progress.showprogress

Home > @matterway/sdk > Progress > showProgress

Progress.showProgress() function

Shows the progress status in a bubble.

Signature:

export declare function showProgress(context: Context, title: string, options?: {
    description?: string;
    overlay?: boolean;
}): Promise<void>;

Parameters

Parameter	Type	Description
context	Context
title	string
options	{ description?: string; overlay?: boolean; }	(Optional) Show progress options.

Returns:

Promise<void>

Example

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

await showProgress(
  ctx,
  'Title Item',
  {
    description: 'Description of the Item',
    overlay: true,
  },
);