Function: showProgressList()

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

Defined in: src/progress/showProgressList.tsx:45

Parameters

Parameter	Type	Description
context	Context	Context object.
items	Progressible[]	List of progressible items.
options?	{ title?: string; description?: string; overlay?: boolean; blur?: boolean; blurIntensity?: number; background?: "white" | "grey"; forcePosition?: Position; isDraggable?: boolean; }	Display options for the progress list.
options.title?	string	-
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.progressList instead.

Show a list of progressible items in a bubble.

Example

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

await showProgressList(
  ctx,
  [
    {title: 'Brew coffee', description: 'Grinding beans', status: 'running'},
    {title: 'Pour latte', description: 'Ready to pour', status: 'done'},
    {title: 'Add foam art', description: 'Waiting', status: 'pending'},
    {title: 'Spill on keyboard', description: 'Oops', status: 'failed'},
  ],
  {
    title: 'Morning Routine',
    description: 'Preparing the perfect cup',
    overlay: true,
    blur: true,
    blurIntensity: 2,
  },
);