mirror of
https://github.com/lensapp/lens.git
synced 2025-05-20 05:10:56 +00:00
49935a7306
* updating extension api docs for 5.0 Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com> * beefed up migration details Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com> * address review comments Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com> * updated cluster features docs (#3094) Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com> * revert extension package-lock.json files again Signed-off-by: Jim Ehrismann <jehrismann@mirantis.com>
2.3 KiB
2.3 KiB
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.
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 | |
| Main process extension | Main.LensExtension |
| Renderer process extension | Renderer.LensExtension |
| Resource stack (cluster feature) | |
| Stores | |
| Components | |
| KubeObjectListLayout | |
| Working with mobx | |
| Protocol Handlers | |
| Sending Data between main and renderer |
Samples
| Sample | APIs |
|---|---|
| hello-world | LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps |
| styling-css-modules-sample | LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps |
| styling-emotion-sample | LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps |
| styling-sass-sample | LensMainExtension LensRendererExtension Renderer.Component.Icon Renderer.Component.IconProps |
| custom-resource-page | LensRendererExtension Renderer.K8sApi.KubeApi Renderer.K8sApi.KubeObjectStore Renderer.Component.KubeObjectListLayout Renderer.Component.KubeObjectDetailsProps Renderer.Component.IconProps |