扩展 UI API
扩展程序界面运行在一个沙箱环境中,无法访问任何 Electron 或 Node.js API。
扩展 UI API 为前端提供了一种执行不同操作并与 Docker Desktop 仪表盘或底层系统进行通信的方式。
提供包含 TypeScript 支持的 JavaScript API 库,以便将所有 API 定义集成到您的扩展代码中。
- @docker/extension-api-client 提供对扩展 API 入口点
DockerDesktopCLient的访问。 - @docker/extension-api-client-types 可作为开发依赖项(dev dependency)添加,以便在您的集成开发环境(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 参考文档 此处。