1
0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
lens/docs/extensions/guides/README.md
Panu Horsmalahti 79c01daf6a
Support extending KubernetesCluster in extensions (#4702)
* Support extending KubernetesCluster in extensions

Signed-off-by: Panu Horsmalahti <phorsmalahti@mirantis.com>

* Simplify getItemsByEntityClass

Signed-off-by: Panu Horsmalahti <phorsmalahti@mirantis.com>

* Make apiVersion string.

Signed-off-by: Panu Horsmalahti <phorsmalahti@mirantis.com>

* Improve entity loading for extension custom types.

Signed-off-by: Panu Horsmalahti <phorsmalahti@mirantis.com>

* Improve comment.

Signed-off-by: Panu Horsmalahti <phorsmalahti@mirantis.com>

* Fix lint.

Signed-off-by: Panu Horsmalahti <phorsmalahti@mirantis.com>

* Properly handle loading custom entity in cluster-frame

Signed-off-by: Panu Horsmalahti <phorsmalahti@mirantis.com>

* Avoid .bind with .loadOnClusterRenderer

Signed-off-by: Panu Horsmalahti <phorsmalahti@mirantis.com>

* Fix lint.

Signed-off-by: Panu Horsmalahti <phorsmalahti@mirantis.com>

* Revert style change.

Signed-off-by: Panu Horsmalahti <phorsmalahti@mirantis.com>

* Make loadOnClusterRenderer arrow function again, revert autoInitExtensions change as unnecessary

Signed-off-by: Panu Horsmalahti <phorsmalahti@mirantis.com>

* Remove commented code.

Signed-off-by: Panu Horsmalahti <phorsmalahti@mirantis.com>

* Document extending KubernetesCluster in extension guides.

Signed-off-by: Panu Horsmalahti <phorsmalahti@mirantis.com>
2022-01-19 14:57:42 +02:00

2.4 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)
Extending KubernetesCluster)
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