接口: ProgressOptions

描述进度应该在哪里以及如何显示的值对象。

属性

cancellable?

optional cancellable: boolean

控制是否应该显示一个取消按钮，以允许用户取消长时间运行的操作。请注意，目前只有 ProgressLocation.Notification 支持显示取消按钮。

定义在

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

---

details?

optional details: object

您可以指定一个导航对象，使任务具有用户可以触发的导航操作。

routeArgs

routeArgs: string[]

要提供给路由的参数

routeId

routeId: string

在 navigation.register 中使用的 routeId

示例

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

定义在

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

---

location

location: ProgressLocation

进度应该显示的位置。

定义在

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

---

title?

optional title: string

一个易于理解的字符串，用于描述操作。

定义在

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