Matterway
    Preparing search index...

    Function showProgressList

    • Shows a list of Progressibles.

      Parameters

      • context: Context

        Context options.

      • items: Progressible[]

        List of Progressibles.

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

        Progress list options.

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

          Force the position of the bubble.

        • OptionalisDraggable?: boolean

          If true, the bubble will be draggable. Default true

      Returns Promise<void>

      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,
        },
      );

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

    Settings