扩展 UI API
扩展 UI 在沙盒环境中运行,无法访问任何 Electron 或 Nodejs API。
扩展 UI API 为前端提供了一种执行不同操作并与 Docker Desktop 仪表板或底层系统通信的方法。
可以使用具有 Typescript 支持的 JavaScript API 库,以便将所有 API 定义放入您的扩展代码中。
- @docker/extension-api-client提供对扩展 API 入口点的访问
DockerDesktopCLient
。 - 可以将@docker/extension-api-client-types添加为开发依赖项,以便在 IDE 中自动完成类型。
import { createDockerDesktopClient } from '@docker/extension-api-client';
export function App() {
// obtain Docker Desktop client
const ddClient = createDockerDesktopClient();
// use ddClient to perform extension actions
}
该ddClient
对象提供对各种 API 的访问:
在此处查找扩展 API 参考 。