Skip to content

Commit cc9d3ac

Browse files
authored
docs(website): added extension related use cases with API references (podman-desktop#11978)
* docs(website): added extension related use cases with API references Signed-off-by: Shipra Singh <[email protected]> * docs(website): corrected cross-references Signed-off-by: Shipra Singh <[email protected]> --------- Signed-off-by: Shipra Singh <[email protected]>
1 parent 7a430a4 commit cc9d3ac

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

website/docs/extensions/api/index.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,17 @@ tags: [podman-desktop, extension, api]
66
keywords: [podman desktop, extension, api]
77
---
88

9-
The API reference is located [here](/api).
9+
The extension API reference is located [here](/api).
10+
11+
Based on your use cases, you can add these common capabilities to your extension:
12+
13+
- Create a new CLI tool instance and register it with Podman Desktop, see the details [here](https://podman-desktop.io/api/@podman-desktop/namespaces/cli/functions/createCliTool). You can add the `createCliTool()` function with relevant parameters in your `src/extension.ts` file.
14+
- Register the state of a CLI tool, see the [resource](/api/type-aliases/CliToolState).
15+
- Add operations related to a container engine, see the usage of the [containerEngine](https://podman-desktop.io/api/@podman-desktop/namespaces/containerEngine) API.
16+
- Add a new Kubernetes provider connection, use the [`KubernetesProviderConnection`](/api/interfaces/KubernetesProviderConnection) interface.
17+
- Enable navigation to a CLI tool page, use the function [`navigateToCliTools()`](https://podman-desktop.io/api/@podman-desktop/namespaces/navigation/functions/navigateToCliTools).
18+
- Enable navigation to a specific page in the UI, refer to the [navigation APIs](https://podman-desktop.io/api/@podman-desktop/namespaces/navigation) category.
19+
- Create and show a new webview panel in the UI, use the [`createWebviewPanel()`](https://podman-desktop.io/api/@podman-desktop/namespaces/window/functions/createWebviewPanel) function.
20+
- Add options for running a command, use the [`RunOptions`](/api/interfaces/RunOptions) interface.
21+
22+
You can also create your own custom extensions and add them to the catalog for others to use.

0 commit comments

Comments
 (0)