Skip to main content

Interface: ProgressOptions

Value-object describing where and how progress should show.

Properties​

cancellable?​

optional cancellable: boolean

Controls if a cancel button should show to allow the user to cancel the long running operation. Note that currently only ProgressLocation.Notification is supporting to show a cancel button.

Defined in​

packages/extension-api/src/extension-api.d.ts:1265

details?​

optional details: object

You may specify a navigation object, making the task having a navigate action that the user can trigger.

routeArgs​

routeArgs: string[]

The arguments to provide the route

routeId​

routeId: string

The routeId used in navigation.register

Example​

import { window, type ProgressLocation } from '@podman-desktop/api';

await window.withProgress<string>(
    {
      location: ProgressLocation.TASK_WIDGET,
      title: 'My task',
      details: {
        routeId: 'dummy-route-id',
        routeArgs: ['hello', 'world'],
      }
    },
    async () => {
      return 'dummy result';
    },
  );

Defined in​

packages/extension-api/src/extension-api.d.ts:1289

location​

location: ProgressLocation

The location at which progress should show.

Defined in​

packages/extension-api/src/extension-api.d.ts:1251

title?​

optional title: string

A human-readable string which will be used to describe the operation.

Defined in​

packages/extension-api/src/extension-api.d.ts:1257