Function: showProgress()

function showProgress(
   context: Context, 
   title: string, 
   options?: {
  description?: string;
  overlay?: boolean;
  blur?: boolean;
  blurIntensity?: number;
  background?: "white" | "grey";
  forcePosition?: Position;
  isDraggable?: boolean;
}): Promise<void>;

Defined in: src/progress/showProgress.tsx:36

Parameters

Parameter	Type	Description
context	Context	Context object.
title	string	Title text for the progress bubble.
options?	{ description?: string; overlay?: boolean; blur?: boolean; blurIntensity?: number; background?: "white" | "grey"; forcePosition?: Position; isDraggable?: boolean; }	Display options for the bubble.
options.description?	string	-
options.overlay?	boolean	-
options.blur?	boolean	-
options.blurIntensity?	number	-
options.background?	"white" | "grey"	-
options.forcePosition?	Position	Force the position of the bubble.
options.isDraggable?	boolean	If true, the bubble will be draggable. Default true

Returns

Promise<void>

Deprecated

Use showUI.progress instead.

Show a progress status bubble.

Example

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

await showProgress(ctx, 'Uploading rocket telemetry', {
  description: 'Streaming data to ground control',
  overlay: true,
  blur: true,
  blurIntensity: 2,
  background: 'grey',
});