mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
1470103fd4
- Add lens:// protocol handling with a routing mechanism - document the methods in an extension guide - remove handlers when an extension is deactivated or removed - make sure that the found extension when routing a request is currently enabled (as a backup) - added documentation about the above behaviour to the guide - tweaked the naming convention so that it is clearer that the router uses extension names as not IDs (which currently are folder paths) - Convert the extension API to use an array for registering handlers - switch design to execute both main and renderer handlers simultaneously, without any overlap checking - change open to be a dev dep - improve docs, export types for extensions, skip integration tests - switch to event emitting renderer being ready - Add logging and fix renderer:loaded send to main Signed-off-by: Sebastian Malton <sebastian@malton.name>
36 lines
2.3 KiB
Markdown
36 lines
2.3 KiB
Markdown
# Extension Guides
|
|
|
|
This section explains how to use specific Lens Extension APIs. It includes detailed guides and code samples. For introductory information about the Lens Extension API, please see [Your First Extension](../get-started/your-first-extension.md).
|
|
|
|
Each guide or code sample includes the following:
|
|
|
|
- Clearly commented source code.
|
|
- Instructions for running the sample extension.
|
|
- An image showing the sample extension's appearance and usage.
|
|
- A listing of the Extension API being used.
|
|
- An explanation of the concepts relevant to the Extension.
|
|
|
|
## Guides
|
|
|
|
| Guide | APIs |
|
|
| ----- | ----- |
|
|
| [Generate new extension project](generator.md) ||
|
|
| [Main process extension](main-extension.md) | LensMainExtension |
|
|
| [Renderer process extension](renderer-extension.md) | LensRendererExtension |
|
|
| [Stores](stores.md) | |
|
|
| [Components](components.md) | |
|
|
| [KubeObjectListLayout](kube-object-list-layout.md) | |
|
|
| [Working with mobx](working-with-mobx.md) | |
|
|
| [Protocol Handlers](protocol-handlers.md) | |
|
|
|
|
## Samples
|
|
|
|
| Sample | APIs |
|
|
| ----- | ----- |
|
|
[hello-world](https://github.com/lensapp/lens-extension-samples/tree/master/helloworld-sample) | LensMainExtension <br> LensRendererExtension <br> Component.Icon <br> Component.IconProps |
|
|
[minikube](https://github.com/lensapp/lens-extension-samples/tree/master/minikube-sample) | LensMainExtension <br> Store.clusterStore <br> Store.workspaceStore |
|
|
[styling-css-modules-sample](https://github.com/lensapp/lens-extension-samples/tree/master/styling-css-modules-sample) | LensMainExtension <br> LensRendererExtension <br> Component.Icon <br> Component.IconProps |
|
|
[styling-emotion-sample](https://github.com/lensapp/lens-extension-samples/tree/master/styling-emotion-sample) | LensMainExtension <br> LensRendererExtension <br> Component.Icon <br> Component.IconProps |
|
|
[styling-sass-sample](https://github.com/lensapp/lens-extension-samples/tree/master/styling-sass-sample) | LensMainExtension <br> LensRendererExtension <br> Component.Icon <br> Component.IconProps |
|
|
[custom-resource-page](https://github.com/lensapp/lens-extension-samples/tree/master/custom-resource-page) | LensRendererExtension <br> K8sApi.KubeApi <br> K8sApi.KubeObjectStore <br> Component.KubeObjectListLayout <br> Component.KubeObjectDetailsProps <br> Component.IconProps |
|