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
Sebastian Malton 1470103fd4
Add lens:// protocol handling with a routing mechanism (#1949)
- 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>
2021-02-25 09:32:40 -05:00

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 LensMainExtension
Renderer process extension LensRendererExtension
Stores
Components
KubeObjectListLayout
Working with mobx
Protocol Handlers

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