跳转到主内容

Interface: ProgressOptions

定义于: packages/extension-api/src/extension-api.d.ts:1298

描述进度应显示在哪里以及如何显示的value-object。

属性​

cancellable?​

optional cancellable: boolean

定义于: packages/extension-api/src/extension-api.d.ts:1316

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

details?​

optional details: object

定义于: packages/extension-api/src/extension-api.d.ts:1340

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

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

location​

location: ProgressLocation

定义于: packages/extension-api/src/extension-api.d.ts:1302

进度应显示的位置。

title?​

optional title: string

定义于: packages/extension-api/src/extension-api.d.ts:1308

将用于描述操作的可读字符串。