Function showProgressList

  • showProgressList(context, items, options?): Promise<void>

  • Shows a list of Progressibles.

    Parameters

    • context: Context

      Context options.

    • items: Progressible[]

      List of Progressibles.

    • Optionaloptions: {
          background?: "white" | "grey";
          blur?: boolean;
          blurIntensity?: number;
          description?: string;
          forcePosition?: Position;
          isDraggable?: boolean;
          overlay?: boolean;
          title?: string;
      }

      Progress list options.

      • Optionalbackground?: "white" | "grey"
      • Optionalblur?: boolean
      • OptionalblurIntensity?: number
      • Optionaldescription?: string
      • OptionalforcePosition?: Position

        Force the position of the bubble.

      • OptionalisDraggable?: boolean

        If true, the bubble will be draggable. Default true

      • Optionaloverlay?: boolean
      • Optionaltitle?: string

    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,
        blur: true,
        blurIntensity: 2,
      },
    );

    Deprecated

    This function has been deprecated. Please use showUI.progressList instead.

Settings