mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00

History

steve richards 88edeeef43 Remove non-extension API docs (#2877 ) All documents that related to Lens IDE in general will move to the private lens-ide repository. All extension API documents will remain in the lens repository and be served on a new url. Signed-off-by: Steve Richards <srichards@mirantis.com>		2021-05-27 14:09:15 +01:00
..
images	Add lens:// protocol handling with a routing mechanism (#1949 )	2021-02-25 09:32:40 -05:00
anatomy.md	add step to verify docs on area/documentation PRs (#1528 )	2020-11-27 10:13:53 -05:00
components.md	add step to verify docs on area/documentation PRs (#1528 )	2020-11-27 10:13:53 -05:00
generator.md	Remove non-extension API docs (#2877 )	2021-05-27 14:09:15 +01:00
ipc.md	Fix spelling and grammar in Ipc docs (#2880 )	2021-05-27 08:12:53 -04:00
kube-object-list-layout.md	Fix Extension Docs (#2377 )	2021-04-19 11:46:07 -04:00
main-extension.md	Fixing Singleton typing to correctly return child class (#1914 )	2021-04-21 09:59:59 -04:00
protocol-handlers.md	Add lens:// protocol handling with a routing mechanism (#1949 )	2021-02-25 09:32:40 -05:00
README.md	Add IPC capabilities for Extensions (#2775 )	2021-05-18 12:24:43 +03:00
renderer-extension.md	Remove non-extension API docs (#2877 )	2021-05-27 14:09:15 +01:00
stores.md	Mobx-6 migration (#2718 )	2021-05-25 10:24:31 +03:00
working-with-mobx.md	Rework extensions guides (#1802 )	2021-01-15 12:41:03 -05:00

README.md

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	LensMainExtension
Renderer process extension	LensRendererExtension
Stores
Components
KubeObjectListLayout
Working with mobx
Protocol Handlers
Sending Data between main and renderer

Samples

Sample	APIs
hello-world	LensMainExtension LensRendererExtension Component.Icon Component.IconProps
minikube	LensMainExtension Store.ClusterStore Store.workspaceStore
styling-css-modules-sample	LensMainExtension LensRendererExtension Component.Icon Component.IconProps
styling-emotion-sample	LensMainExtension LensRendererExtension Component.Icon Component.IconProps
styling-sass-sample	LensMainExtension LensRendererExtension Component.Icon Component.IconProps
custom-resource-page	LensRendererExtension K8sApi.KubeApi K8sApi.KubeObjectStore Component.KubeObjectListLayout Component.KubeObjectDetailsProps Component.IconProps