Function showProgress

  • showProgress(context, title, options?): Promise<void>

  • Shows the progress status in a bubble.

    Parameters

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

      Show progress 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

    Returns Promise<void>

    Example

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

    await showProgress(
      ctx,
      'Title Item',
      {
        description: 'Description of the Item',
        overlay: true,
        blur: true,
        blurIntensity: 2,
       background: 'grey',
      },
    );

    Deprecated

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

Settings