Skip to content

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
Catalog Entities and Categories

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