仪表板

用户通知

浮动通知为用户提供简短的通知。它们暂时出现，不应中断用户体验。它们也不需要用户输入即可消失。

成功

▸ success(msg): void

用于显示成功类型的浮动通知消息。

ddClient.desktopUI.toast.success("message");

警告

▸ warning(msg): void

用于显示警告类型的浮动通知消息。

ddClient.desktopUI.toast.warning("message");

错误

▸ error(msg): void

用于显示错误类型的浮动通知消息。

ddClient.desktopUI.toast.error("message");

有关方法参数和可用返回类型的更多详细信息，请参阅 Toast API 参考。

已废弃的用户通知

这些方法已废弃，将在未来版本中移除。请使用上面指定的方法。

window.ddClient.toastSuccess("message");
window.ddClient.toastWarning("message");
window.ddClient.toastError("message");

打开文件选择对话框

此函数会打开一个文件选择器对话框，要求用户选择一个文件或文件夹。

▸ showOpenDialog(dialogProperties): Promise< OpenDialogResult>

dialogProperties 参数是传递给 Electron 的标志列表，用于自定义对话框的行为。例如，您可以传递 multiSelections 允许用户选择多个文件。有关完整列表，请参阅 Electron 的文档。

const result = await ddClient.desktopUI.dialog.showOpenDialog({
  properties: ["openDirectory"],
});
if (!result.canceled) {
  console.log(result.paths);
}

打开一个 URL

此函数使用系统默认浏览器打开外部 URL。

▸ openExternal(url): void

ddClient.host.openExternal("https://docker.com");

URL 必须具有 http 或 https 协议。

有关方法参数和可用返回类型的更多详细信息，请参阅 桌面主机 API 参考。

已废弃的用户通知

此方法已废弃，将在未来版本中移除。请使用上面指定的方法。

window.ddClient.openExternal("https://docker.com");

导航到仪表盘路由

在您的扩展中，您还可以导航到 Docker Desktop 仪表盘的其他部分。