From 958436288087c0fd66bb0bb463634dfc3bb0e439 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Fri, 9 Apr 2021 06:18:15 +0000 Subject: [PATCH] Deployed 99a464c61 to master with MkDocs 1.1.2 and mike 0.5.5 --- .../index.html | 44 +- .../_core_api_stores_.cluster/index.html | 2184 ----------------- .../_core_api_stores_.clusterstore/index.html | 1346 ---------- .../index.html | 54 +- .../index.html | 281 +-- .../index.html | 891 ++++--- .../_core_api_utils_.singleton/index.html | 6 +- .../index.html | 2 +- .../index.html | 2 +- .../index.html | 6 +- .../index.html | 4 +- .../index.html | 30 +- .../index.html | 2 +- .../index.html | 50 +- .../index.html | 20 +- .../index.html | 2 +- .../index.html | 6 +- .../index.html | 2 +- .../_renderer_api_components_.icon/index.html | 12 +- .../index.html | 52 +- .../index.html | 4 +- .../index.html | 14 +- .../index.html | 8 +- .../index.html | 14 +- .../index.html | 6 +- .../index.html | 12 +- .../_renderer_api_components_.menu/index.html | 48 +- .../index.html | 16 +- .../index.html | 18 +- .../index.html | 10 +- .../index.html | 16 +- .../index.html | 14 +- .../index.html | 12 +- .../index.html | 24 +- .../index.html | 6 +- .../index.html | 2 +- .../index.html | 22 +- .../index.html | 4 +- .../index.html | 8 +- .../index.html | 2 +- .../index.html | 2 +- .../index.html | 2 +- .../_renderer_api_components_.tab/index.html | 24 +- .../index.html | 28 +- .../index.html | 10 +- .../index.html | 6 +- .../index.html | 2 +- .../_renderer_api_components_.tabs/index.html | 6 +- .../index.html | 30 +- .../index.html | 26 +- .../index.html | 2 +- .../index.html | 18 +- .../index.html | 60 +- .../index.html | 64 +- .../index.html | 60 +- .../index.html | 110 +- .../index.html | 110 +- .../index.html | 116 +- .../_renderer_api_k8s_api_.cronjob/index.html | 68 +- .../index.html | 112 +- .../index.html | 88 +- .../index.html | 72 +- .../index.html | 116 +- .../index.html | 76 +- .../index.html | 68 +- .../index.html | 116 +- .../index.html | 62 +- .../index.html | 110 +- .../index.html | 118 +- .../index.html | 74 +- .../index.html | 110 +- .../_renderer_api_k8s_api_.ingress/index.html | 68 +- .../index.html | 62 +- .../index.html | 114 +- .../_renderer_api_k8s_api_.job/index.html | 80 +- .../index.html | 114 +- .../_renderer_api_k8s_api_.kubeapi/index.html | 60 +- .../index.html | 86 +- .../index.html | 54 +- .../index.html | 110 +- .../index.html | 64 +- .../index.html | 110 +- .../index.html | 58 +- .../index.html | 128 +- .../index.html | 62 +- .../index.html | 110 +- .../_renderer_api_k8s_api_.node/index.html | 80 +- .../index.html | 62 +- .../index.html | 130 +- .../index.html | 68 +- .../index.html | 68 +- .../index.html | 62 +- .../index.html | 112 +- .../_renderer_api_k8s_api_.pod/index.html | 114 +- .../index.html | 68 +- .../index.html | 110 +- .../_renderer_api_k8s_api_.podsapi/index.html | 64 +- .../index.html | 128 +- .../index.html | 78 +- .../index.html | 118 +- .../index.html | 60 +- .../index.html | 110 +- .../_renderer_api_k8s_api_.role/index.html | 60 +- .../index.html | 64 +- .../index.html | 112 +- .../index.html | 110 +- .../_renderer_api_k8s_api_.secret/index.html | 64 +- .../index.html | 110 +- .../_renderer_api_k8s_api_.service/index.html | 74 +- .../index.html | 64 +- .../index.html | 110 +- .../index.html | 110 +- .../index.html | 74 +- .../index.html | 116 +- .../index.html | 72 +- .../index.html | 112 +- .../index.html | 114 +- .../index.html | 34 +- .../api/classes/lensmainextension/index.html | 96 +- .../classes/lensrendererextension/index.html | 72 +- .../index.html | 6 +- .../index.html | 16 +- .../index.html | 6 +- .../index.html | 8 +- .../index.html | 4 +- .../index.html | 8 +- .../index.html | 95 +- .../index.html | 40 +- .../index.html | 1151 +++++++++ .../index.html | 174 +- .../index.html | 65 +- .../index.html | 10 +- .../index.html | 2 +- .../index.html | 8 +- .../index.html | 2 +- .../index.html | 6 +- .../index.html | 6 +- .../index.html | 2 +- .../index.html | 2 +- .../index.html | 2 +- .../index.html | 6 +- .../index.html | 6 +- .../_interfaces_index_.pagetarget/index.html | 6 +- .../index.html | 4 +- .../index.html | 10 +- .../index.html | 2 +- .../_interfaces_index_.routeparams/index.html | 6 +- .../index.html | 4 +- .../index.html | 10 +- .../index.html | 30 +- .../index.html | 14 +- .../index.html | 14 +- .../index.html | 4 +- .../index.html | 18 +- .../index.html | 14 +- .../index.html | 12 +- .../index.html | 2 +- .../index.html | 20 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 30 +- .../index.html | 8 +- .../index.html | 2 +- .../index.html | 4 +- .../index.html | 64 +- .../index.html | 34 +- .../index.html | 4 +- .../index.html | 14 +- .../index.html | 27 +- .../index.html | 10 +- .../index.html | 8 +- .../index.html | 28 +- .../index.html | 10 +- .../index.html | 18 +- .../index.html | 10 +- .../index.html | 4 +- .../index.html | 12 +- .../index.html | 4 +- .../index.html | 6 +- .../index.html | 4 +- .../index.html | 4 +- .../index.html | 8 +- .../index.html | 12 +- .../index.html | 22 +- .../index.html | 8 +- .../index.html | 36 +- .../index.html | 14 +- .../index.html | 14 +- .../index.html | 16 +- .../index.html | 10 +- .../index.html | 4 +- .../index.html | 20 +- .../index.html | 14 +- .../index.html | 20 +- .../index.html | 60 +- .../index.html | 16 +- .../index.html | 26 +- .../index.html | 18 +- .../index.html | 4 +- .../index.html | 6 +- .../index.html | 16 +- .../api/modules/_core_api_app_/index.html | 18 +- .../modules/_core_api_event_bus_/index.html | 4 +- .../api/modules/_core_api_stores_/index.html | 89 +- .../api/modules/_core_api_utils_/index.html | 8 +- .../api/modules/_interfaces_index_/index.html | 153 +- .../_renderer_api_components_/index.html | 60 +- .../modules/_renderer_api_k8s_api_/index.html | 66 +- .../_renderer_api_navigation_/index.html | 12 +- .../modules/_renderer_api_theming_/index.html | 2 +- master/search/search_index.json | 2 +- master/sitemap.xml | 64 +- master/sitemap.xml.gz | Bin 486 -> 486 bytes 213 files changed, 6127 insertions(+), 8205 deletions(-) delete mode 100644 master/extensions/api/classes/_core_api_stores_.cluster/index.html delete mode 100644 master/extensions/api/classes/_core_api_stores_.clusterstore/index.html rename master/extensions/api/classes/{_core_api_stores_.workspace => _core_api_stores_.kubernetescluster}/index.html (76%) rename master/extensions/api/classes/{_core_api_stores_.workspacestore => _core_api_stores_.kubernetesclustercategory}/index.html (62%) rename master/extensions/api/interfaces/{_core_api_stores_.workspacemodel => _interfaces_index_.catalogcategory}/index.html (90%) rename master/extensions/api/interfaces/{_interfaces_index_.clusterfeaturecomponents => _interfaces_index_.catalogcategoryversion}/index.html (94%) create mode 100644 master/extensions/api/interfaces/_interfaces_index_.catalogentity/index.html rename master/extensions/api/interfaces/{_core_api_stores_.clustermodel => _interfaces_index_.catalogentityactioncontext}/index.html (83%) rename master/extensions/api/interfaces/{_interfaces_index_.clusterfeatureregistration => _interfaces_index_.catalogentitycontextmenucontext}/index.html (93%) diff --git a/master/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html b/master/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html index 0074c10c5e..1b6ce90b74 100644 --- a/master/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html +++ b/master/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html @@ -1024,13 +1024,13 @@

Properties#

templateContext#

templateContext: any

-

Defined in src/extensions/cluster-feature.ts:29

+

Defined in src/extensions/cluster-feature.ts:30

this field sets the template parameters that are to be applied to any templated kubernetes resources that are to be installed for the feature. See the renderTemplates() method for more details

Methods#

Protected applyResources#

-

applyResources(cluster: Cluster, resourceSpec: string | string[]): Promise‹void›

-

Defined in src/extensions/cluster-feature.ts:85

+

applyResources(cluster: KubernetesCluster, resourceSpec: string | string[]): Promise‹void›

+

Defined in src/extensions/cluster-feature.ts:86

this is a helper method that conveniently applies kubernetes resources to the cluster.

Parameters:

@@ -1044,7 +1044,7 @@ See the renderTemplates() method for more details

- + @@ -1057,8 +1057,8 @@ See the renderTemplates() method for more details

Returns: Promise‹void›


Abstract install#

-

install(cluster: Cluster): Promise‹void›

-

Defined in src/extensions/cluster-feature.ts:47

+

install(cluster: KubernetesCluster): Promise‹void›

+

Defined in src/extensions/cluster-feature.ts:48

to be implemented in the derived class, this method is typically called by Lens when a user has indicated that this feature is to be installed. The implementation of this method should install kubernetes resources using the applyResources() method, or by directly accessing the kubernetes api (K8sApi)

Parameters:

@@ -1073,7 +1073,7 @@ of this method should install kubernetes resources using the applyResources() me - + @@ -1082,7 +1082,7 @@ of this method should install kubernetes resources using the applyResources() me

Protected renderTemplates#

renderTemplates(folderPath: string): string[]

-

Defined in src/extensions/cluster-feature.ts:109

+

Defined in src/extensions/cluster-feature.ts:116

this is a helper method that conveniently reads kubernetes resource files into a string array. It also fills templated resource files with the template parameter values specified by the templateContext field. Templated files must end with the extension '.hb' and the template syntax must be compatible with handlebars.js

Parameters:

@@ -1106,8 +1106,8 @@ specified by the templateContext field. Templated files must end with the extens

an array of strings, each string being the contents of a resource file found in the folder path. This can be passed directly to applyResources()


Abstract uninstall#

-

uninstall(cluster: Cluster): Promise‹void›

-

Defined in src/extensions/cluster-feature.ts:63

+

uninstall(cluster: KubernetesCluster): Promise‹void›

+

Defined in src/extensions/cluster-feature.ts:64

to be implemented in the derived class, this method is typically called by Lens when a user has indicated that this feature is to be uninstalled. The implementation of this method should uninstall kubernetes resources using the kubernetes api (K8sApi)

Parameters:

@@ -1122,7 +1122,7 @@ of this method should uninstall kubernetes resources using the kubernetes api (K - + @@ -1130,8 +1130,8 @@ of this method should uninstall kubernetes resources using the kubernetes api (K

Returns: Promise‹void›


Abstract updateStatus#

-

updateStatus(cluster: Cluster): Promise‹ClusterFeatureStatus

-

Defined in src/extensions/cluster-feature.ts:75

+

updateStatus(cluster: KubernetesCluster): Promise‹ClusterFeatureStatus

+

Defined in src/extensions/cluster-feature.ts:76

to be implemented in the derived class, this method is called periodically by Lens to determine details about the feature's current status. The implementation of this method should provide the current status information. The currentVersion and latestVersion fields may be displayed by Lens in describing the feature. The installed field should be set to true if the feature has been installed, otherwise false. Also, Lens relies on the canUpgrade field to determine if the feature @@ -1148,7 +1148,7 @@ can be upgraded so the implementation should set the canUpgrade field according

- + @@ -1157,8 +1157,8 @@ can be upgraded so the implementation should set the canUpgrade field according

a promise, resolved with the updated ClusterFeatureStatus


Abstract upgrade#

-

upgrade(cluster: Cluster): Promise‹void›

-

Defined in src/extensions/cluster-feature.ts:55

+

upgrade(cluster: KubernetesCluster): Promise‹void›

+

Defined in src/extensions/cluster-feature.ts:56

to be implemented in the derived class, this method is typically called by Lens when a user has indicated that this feature is to be upgraded. The implementation of this method should upgrade the kubernetes resources already installed, if relevant to the feature

Parameters:

@@ -1173,7 +1173,7 @@ of this method should upgrade the kubernetes resources already installed, if rel - + @@ -1182,20 +1182,20 @@ of this method should upgrade the kubernetes resources already installed, if rel

Object literals#

status#

status: object#

-

Defined in src/extensions/cluster-feature.ts:34

+

Defined in src/extensions/cluster-feature.ts:35

this field holds the current feature status, is accessed directly by Lens

canUpgrade#

canUpgrade: false = false

-

Defined in src/extensions/cluster-feature.ts:38

+

Defined in src/extensions/cluster-feature.ts:39

currentVersion#

currentVersion: null = null

-

Defined in src/extensions/cluster-feature.ts:35

+

Defined in src/extensions/cluster-feature.ts:36

installed#

installed: false = false

-

Defined in src/extensions/cluster-feature.ts:36

+

Defined in src/extensions/cluster-feature.ts:37

latestVersion#

latestVersion: null = null

-

Defined in src/extensions/cluster-feature.ts:37

+

Defined in src/extensions/cluster-feature.ts:38

diff --git a/master/extensions/api/classes/_core_api_stores_.cluster/index.html b/master/extensions/api/classes/_core_api_stores_.cluster/index.html deleted file mode 100644 index 2966d581cf..0000000000 --- a/master/extensions/api/classes/_core_api_stores_.cluster/index.html +++ /dev/null @@ -1,2184 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: Cluster - Lens Documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
clusterClusterKubernetesCluster the cluster that the resources are to be applied to
clusterClusterKubernetesCluster the cluster that the feature is to be installed on
clusterClusterKubernetesCluster the cluster that the feature is to be uninstalled from
clusterClusterKubernetesCluster the cluster that the feature may be installed on
clusterClusterKubernetesCluster the cluster that the feature is to be upgraded on
- - - - - - - - - - - - -
NameType
modelClusterModel
-

Returns: Cluster

-

Properties#

-

accessible#

-

accessible: boolean = false

-

Defined in src/main/cluster.ts:149

-

Can user access cluster resources

-

observable

-
-

accessibleNamespaces#

-

accessibleNamespaces: string[] = []

-

Implementation of ClusterModel.accessibleNamespaces

-

Defined in src/main/cluster.ts:217

-

List of accessible namespaces provided by user in the Cluster Settings

-

observable

-
-

Protected activated#

-

activated: boolean = false

-

Defined in src/main/cluster.ts:82

-
-

allowedNamespaces#

-

allowedNamespaces: string[] = []

-

Defined in src/main/cluster.ts:204

-

List of allowed namespaces verified via K8S::SelfSubjectAccessReview api

-

observable

-
-

allowedResources#

-

allowedResources: string[] = []

-

Defined in src/main/cluster.ts:211

-

List of allowed resources

-

observable

-

internal

-
-

apiUrl#

-

apiUrl: string

-

Defined in src/main/cluster.ts:124

-

Kubernetes API server URL

-

observable

-
-

contextHandler#

-

contextHandler: ContextHandler

-

Defined in src/main/cluster.ts:73

-

Context handler

-

internal

-
-

contextName#

-

contextName: string

-

Implementation of ClusterModel.contextName

-

Defined in src/main/cluster.ts:106

-

Kubeconfig context name

-

observable

-
-

disconnected#

-

disconnected: boolean = true

-

Defined in src/main/cluster.ts:167

-

Is cluster disconnected. False if user has selected to connect.

-

observable

-
-

enabled#

-

enabled: boolean = false

-

Defined in src/main/cluster.ts:137

-

Is cluster instance enabled (disabled clusters are currently hidden)

-

observable

-
-

Protected eventDisposers#

-

eventDisposers: Function[] = []

-

Defined in src/main/cluster.ts:81

-
-

failureReason#

-

failureReason: string

-

Defined in src/main/cluster.ts:173

-

Connection failure reason

-

observable

-
-

id#

-

id: ClusterId

-

Implementation of ClusterModel.id

-

Defined in src/main/cluster.ts:61

-

Unique id for a cluster

-
-

initialized#

-

initialized: boolean = false

-

Defined in src/main/cluster.ts:100

-

Is cluster object initialized

-

observable

-
-

initializing#

-

initializing: boolean = false

-

Defined in src/main/cluster.ts:93

-

Is cluster object initializinng on-going

-

observable

-
-

isAdmin#

-

isAdmin: boolean = false

-

Defined in src/main/cluster.ts:179

-

Does user have admin like access

-

observable

-
-

isGlobalWatchEnabled#

-

isGlobalWatchEnabled: boolean = false

-

Defined in src/main/cluster.ts:186

-

Global watch-api accessibility , e.g. "/api/v1/services?watch=1"

-

observable

-
-

kubeConfigPath#

-

kubeConfigPath: string

-

Implementation of ClusterModel.kubeConfigPath

-

Defined in src/main/cluster.ts:118

-

Path to kubeconfig

-

observable

-
-

kubeCtl#

-

kubeCtl: Kubectl

-

Defined in src/main/cluster.ts:67

-

Kubectl

-

internal

-
-

kubeProxyUrl#

-

kubeProxyUrl: string

-

Defined in src/main/cluster.ts:131

-

Internal authentication proxy URL

-

observable

-

internal

-
-

Protected kubeconfigManager#

-

kubeconfigManager: KubeconfigManager

-

Defined in src/main/cluster.ts:80

-
-

metadata#

-

metadata: ClusterMetadata

-

Implementation of ClusterModel.metadata

-

Defined in src/main/cluster.ts:198

-

Metadata

-

observable

-
-

online#

-

online: boolean = false

-

Defined in src/main/cluster.ts:143

-

Is cluster online

-

observable

-
-

ownerRef#

-

ownerRef: string

-

Implementation of ClusterModel.ownerRef

-

Defined in src/main/cluster.ts:79

-

Owner reference

-

If extension sets this it needs to also mark cluster as enabled on activate (or when added to a store)

-
-

preferences#

-

preferences: ClusterPreferences

-

Implementation of ClusterModel.preferences

-

Defined in src/main/cluster.ts:192

-

Preferences

-

observable

-
-

ready#

-

ready: boolean = false

-

Defined in src/main/cluster.ts:155

-

Is cluster instance in usable state

-

observable

-
-

reconnecting#

-

reconnecting: boolean = false

-

Defined in src/main/cluster.ts:161

-

Is cluster currently reconnecting

-

observable

-
-

whenInitialized#

-

whenInitialized: Promise‹void› & object = when(() => this.initialized)

-

Defined in src/main/cluster.ts:85

-
-

whenReady#

-

whenReady: Promise‹void› & object = when(() => this.ready)

-

Defined in src/main/cluster.ts:86

-
-

workspace#

-

workspace: WorkspaceId

-

Implementation of ClusterModel.workspace

-

Defined in src/main/cluster.ts:112

-

Workspace id

-

observable

-

Accessors#

-

available#

-

get available(): boolean

-

Defined in src/main/cluster.ts:224

-

Is cluster available

-

computed

-

Returns: boolean

-
-

isManaged#

-

get isManaged(): boolean

-

Defined in src/main/cluster.ts:276

-

Is cluster managed by an extension

-

Returns: boolean

-
-

name#

-

get name(): string

-

Defined in src/main/cluster.ts:233

-

Cluster name

-

computed

-

Returns: string

-
-

prometheusPreferences#

-

get prometheusPreferences(): ClusterPrometheusPreferences

-

Defined in src/main/cluster.ts:243

-

Prometheus preferences

-

computed

-

internal

-

Returns: ClusterPrometheusPreferences

-
-

version#

-

get version(): string

-

Defined in src/main/cluster.ts:254

-

Kubernetes version

-

Returns: string

-

Methods#

-

activate#

-

activate(force: boolean): Promise‹void›

-

Defined in src/main/cluster.ts:352

-

internal

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
forcebooleanfalseforce activation
-

Returns: Promise‹void›

-
-

Protected bindEvents#

-

bindEvents(): void

-

Defined in src/main/cluster.ts:321

-

internal

-

Returns: void

-
-

canI#

-

canI(resourceAttributes: V1ResourceAttributes): Promise‹boolean›

-

Defined in src/main/cluster.ts:570

-

internal

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
resourceAttributesV1ResourceAttributesresource attributes
-

Returns: Promise‹boolean›

-
-

canUseWatchApi#

-

canUseWatchApi(customizeResource: V1ResourceAttributes): Promise‹boolean›

-

Defined in src/main/cluster.ts:602

-

internal

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDefault
customizeResourceV1ResourceAttributes{}
-

Returns: Promise‹boolean›

-
-

disconnect#

-

disconnect(): void

-

Defined in src/main/cluster.ts:400

-

internal

-

Returns: void

-
-

Protected ensureKubectl#

-

ensureKubectl(): Promise‹boolean›

-

Defined in src/main/cluster.ts:380

-

internal

-

Returns: Promise‹boolean›

-
-

Protected getAllowedNamespaces#

-

getAllowedNamespaces(): Promise‹string[]›

-

Defined in src/main/cluster.ts:681

-

Returns: Promise‹string[]›

-
-

Protected getAllowedResources#

-

getAllowedResources(): Promise‹("namespaces" | "nodes" | "events" | "resourcequotas" | "services" | "limitranges" | "secrets" | "configmaps" | "ingresses" | "networkpolicies" | "persistentvolumeclaims" | "persistentvolumes" | "storageclasses" | "pods" | "daemonsets" | "deployments" | "statefulsets" | "replicasets" | "jobs" | "cronjobs" | "endpoints" | "customresourcedefinitions" | "horizontalpodautoscalers" | "podsecuritypolicies" | "poddisruptionbudgets")[]›

-

Defined in src/main/cluster.ts:705

-

Returns: Promise‹("namespaces" | "nodes" | "events" | "resourcequotas" | "services" | "limitranges" | "secrets" | "configmaps" | "ingresses" | "networkpolicies" | "persistentvolumeclaims" | "persistentvolumes" | "storageclasses" | "pods" | "daemonsets" | "deployments" | "statefulsets" | "replicasets" | "jobs" | "cronjobs" | "endpoints" | "customresourcedefinitions" | "horizontalpodautoscalers" | "podsecuritypolicies" | "poddisruptionbudgets")[]›

-
-

Protected getConnectionStatus#

-

getConnectionStatus(): Promise‹ClusterStatus›

-

Defined in src/main/cluster.ts:526

-

Returns: Promise‹ClusterStatus›

-
-

Protected getKubeconfig#

-

getKubeconfig(): KubeConfig

-

Defined in src/main/cluster.ts:478

-

Returns: KubeConfig

-
-

getMeta#

-

getMeta(): object

-

Defined in src/main/cluster.ts:669

-

Returns: object

- -
-

getMetrics#

-

getMetrics(prometheusPath: string, queryParams: IMetricsReqParams & object): Promise‹any›

-

Defined in src/main/cluster.ts:513

-

internal

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
prometheusPathstringpath to prometheus service
queryParamsIMetricsReqParams & objectquery parameters
-

Returns: Promise‹any›

-
-

getProxyKubeconfig#

-

getProxyKubeconfig(): Promise‹KubeConfig›

-

Defined in src/main/cluster.ts:485

-

internal

-

Returns: Promise‹KubeConfig›

-
-

getProxyKubeconfigPath#

-

getProxyKubeconfigPath(): Promise‹string›

-

Defined in src/main/cluster.ts:494

-

internal

-

Returns: Promise‹string›

-
-

getState#

-

getState(): ClusterState

-

Defined in src/main/cluster.ts:630

-

Serializable cluster-state used for sync btw main <-> renderer

-

Returns: ClusterState

-
-

init#

-

init(port: number): Promise‹void›

-

Defined in src/main/cluster.ts:296

-

Initialize a cluster (can be done only in main process)

-

internal

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
portnumberport where internal auth proxy is listening
-

Returns: Promise‹void›

-
-

isAllowedResource#

-

isAllowedResource(kind: string): boolean

-

Defined in src/main/cluster.ts:740

-

Parameters:

- - - - - - - - - - - - - -
NameType
kindstring
-

Returns: boolean

-
-

isClusterAdmin#

-

isClusterAdmin(): Promise‹boolean›

-

Defined in src/main/cluster.ts:591

-

internal

-

Returns: Promise‹boolean›

-
-

Protected k8sRequest#

-

k8sRequestT›(path: string, options: RequestPromiseOptions): Promise‹T›

-

Defined in src/main/cluster.ts:498

-

Type parameters:

-

T

-

Parameters:

- - - - - - - - - - - - - - - - - - - - -
NameTypeDefault
pathstring-
optionsRequestPromiseOptions{}
-

Returns: Promise‹T›

-
-

pushState#

-

pushState(state: ClusterState): void

-

Defined in src/main/cluster.ts:663

-

internal

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
stateClusterStatethis.getState()cluster state
-

Returns: void

-
-

reconnect#

-

reconnect(): Promise‹void›

-

Defined in src/main/cluster.ts:390

-

internal

-

Returns: Promise‹void›

-
-

refresh#

-

refresh(opts: ClusterRefreshOptions): Promise‹void›

-

Defined in src/main/cluster.ts:419

-

internal

-

Parameters:

- - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
optsClusterRefreshOptions{}refresh options
-

Returns: Promise‹void›

-
-

refreshAllowedResources#

-

refreshAllowedResources(): Promise‹void›

-

Defined in src/main/cluster.ts:473

-

internal

-

Returns: Promise‹void›

-
-

refreshConnectionStatus#

-

refreshConnectionStatus(): Promise‹void›

-

Defined in src/main/cluster.ts:462

-

internal

-

Returns: Promise‹void›

-
-

refreshMetadata#

-

refreshMetadata(): Promise‹void›

-

Defined in src/main/cluster.ts:438

-

internal

-

Returns: Promise‹void›

-
-

setState#

-

setState(state: ClusterState): void

-

Defined in src/main/cluster.ts:655

-

internal

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
stateClusterStatecluster state
-

Returns: void

-
-

toJSON#

-

toJSON(): ClusterModel

-

Defined in src/main/cluster.ts:610

-

Returns: ClusterModel

-
-

Protected unbindEvents#

-

unbindEvents(): void

-

Defined in src/main/cluster.ts:341

-

internal

-

Returns: void

-
-

updateModel#

-

updateModel(model: ClusterModel): void

-

Defined in src/main/cluster.ts:285

-

Update cluster data model

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
modelClusterModel
-

Returns: void

- - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_core_api_stores_.clusterstore/index.html b/master/extensions/api/classes/_core_api_stores_.clusterstore/index.html deleted file mode 100644 index e9b9248ef3..0000000000 --- a/master/extensions/api/classes/_core_api_stores_.clusterstore/index.html +++ /dev/null @@ -1,1346 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Class: ClusterStore - Lens Documentation - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - Skip to content - - -
-
- -
- - - -
- -
- -
- - - - -
-
- - -
-
-
- - - -
-
-
- - - - - - - -
-
-
- - -
-
-
- - - -
-
- - - -

Class: ClusterStore#

-

Store for all added clusters

-

beta

-

Hierarchy#

- -

ClusterStore

-

Index#

-

Accessors#

- -

Methods#

- -

Accessors#

-

activeCluster#

-

get activeCluster(): Cluster | null

-

Defined in src/extensions/stores/cluster-store.ts:41

-

Get active cluster (a cluster which is currently visible)

-

Returns: Cluster | null

-
-

activeClusterId#

-

get activeClusterId(): string

-

Defined in src/extensions/stores/cluster-store.ts:20

-

Active cluster id

-

Returns: string

-

set activeClusterId(id: ClusterId): void

-

Defined in src/extensions/stores/cluster-store.ts:27

-

Set active cluster id

-

Parameters:

- - - - - - - - - - - - - -
NameType
idClusterId
-

Returns: void

-
-

clusters#

-

get clusters(): ObservableMap‹string, Cluster

-

Defined in src/extensions/stores/cluster-store.ts:34

-

Map of all clusters

-

Returns: ObservableMap‹string, Cluster

-
-

clustersList#

-

get clustersList(): Cluster[]

-

Defined in src/extensions/stores/cluster-store.ts:48

-

Array of all clusters

-

Returns: Cluster[]

-
-

connectedClustersList#

-

get connectedClustersList(): Cluster[]

-

Defined in src/extensions/stores/cluster-store.ts:62

-

Array of all clusters that have active connection to a Kubernetes cluster

-

Returns: Cluster[]

-
-

enabledClustersList#

-

get enabledClustersList(): Cluster[]

-

Defined in src/extensions/stores/cluster-store.ts:55

-

Array of all enabled clusters

-

Returns: Cluster[]

-

Methods#

-

addCluster#

-

addCluster(model: ClusterModel | Cluster): Cluster

-

Defined in src/extensions/stores/cluster-store.ts:94

-

Add a cluster to store

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
modelClusterModel | Clustercluster
-

Returns: Cluster

-
-

addClusters#

-

addClusters(...models: ClusterModel[]): Cluster[]

-

Defined in src/extensions/stores/cluster-store.ts:86

-

Add clusters to store

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
...modelsClusterModel[]list of cluster models
-

Returns: Cluster[]

-
-

getById#

-

getById(id: ClusterId): Cluster

-

Defined in src/extensions/stores/cluster-store.ts:70

-

Get cluster object by cluster id

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
idClusterIdcluster id
-

Returns: Cluster

-
-

getByWorkspaceId#

-

getByWorkspaceId(workspaceId: string): Cluster[]

-

Defined in src/extensions/stores/cluster-store.ts:78

-

Get all clusters belonging to a workspace

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
workspaceIdstringworkspace id
-

Returns: Cluster[]

-
-

removeById#

-

removeById(clusterId: ClusterId): Promise‹void›

-

Defined in src/extensions/stores/cluster-store.ts:110

-

Remove a cluster from store by id

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
clusterIdClusterIdcluster id
-

Returns: Promise‹void›

-
-

removeByWorkspaceId#

-

removeByWorkspaceId(workspaceId: string): void

-

Defined in src/extensions/stores/cluster-store.ts:118

-

Remove all clusters belonging to a workspaces

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
workspaceIdstringworkspace id
-

Returns: void

-
-

removeCluster#

-

removeCluster(model: ClusterModel): Promise‹void›

-

Defined in src/extensions/stores/cluster-store.ts:102

-

Remove a cluster from store

-

Parameters:

- - - - - - - - - - - - - - - -
NameTypeDescription
modelClusterModelcluster
-

Returns: Promise‹void›

-
-

Static getInstance#

-

getInstanceT›(...args: ConstructorParameters‹Constructor‹T››): T

-

Inherited from ExtensionStore.getInstance

-

Defined in src/common/utils/singleton.ts:15

-

Type parameters:

-

T

-

Parameters:

- - - - - - - - - - - - - -
NameType
...argsConstructorParameters‹Constructor‹T››
-

Returns: T

-
-

Static resetInstance#

-

resetInstance(): void

-

Inherited from ExtensionStore.resetInstance

-

Defined in src/common/utils/singleton.ts:23

-

Returns: void

- - - - - - - -
-
-
-
- - - - -
- - - - - - - - - \ No newline at end of file diff --git a/master/extensions/api/classes/_core_api_stores_.extensionstore/index.html b/master/extensions/api/classes/_core_api_stores_.extensionstore/index.html index 6e993973ab..0976eb372e 100644 --- a/master/extensions/api/classes/_core_api_stores_.extensionstore/index.html +++ b/master/extensions/api/classes/_core_api_stores_.extensionstore/index.html @@ -1175,7 +1175,7 @@

Protected constructor#

+ new ExtensionStore(params: BaseStoreParams): ExtensionStore

Inherited from ExtensionStore.constructor

-

Defined in src/common/base-store.ts:26

+

Defined in src/common/base-store.ts:26

Parameters:

@@ -1195,61 +1195,61 @@

Properties#

Protected extension#

extension: LensExtension

-

Defined in src/extensions/extension-store.ts:6

+

Defined in src/extensions/extension-store.ts:6


isLoaded#

isLoaded: boolean = false

Inherited from ExtensionStore.isLoaded

-

Defined in src/common/base-store.ts:26

+

Defined in src/common/base-store.ts:26


Protected params#

params: BaseStoreParams

Inherited from ExtensionStore.params

-

Defined in src/common/base-store.ts:28

+

Defined in src/common/base-store.ts:28


Protected Optional storeConfig#

storeConfig? : Config‹T›

Inherited from ExtensionStore.storeConfig

-

Defined in src/common/base-store.ts:22

+

Defined in src/common/base-store.ts:22


Protected syncDisposers#

syncDisposers: Function[] = []

Inherited from ExtensionStore.syncDisposers

-

Defined in src/common/base-store.ts:23

+

Defined in src/common/base-store.ts:23


whenLoaded#

whenLoaded: Promise‹void› & object = when(() => this.isLoaded)

Inherited from ExtensionStore.whenLoaded

-

Defined in src/common/base-store.ts:25

+

Defined in src/common/base-store.ts:25

Accessors#

name#

get name(): string

Inherited from ExtensionStore.name

-

Defined in src/common/base-store.ts:38

+

Defined in src/common/base-store.ts:38

Returns: string


path#

get path(): string

Inherited from ExtensionStore.path

-

Defined in src/common/base-store.ts:50

+

Defined in src/common/base-store.ts:50

Returns: string


Protected syncMainChannel#

get syncMainChannel(): string

Inherited from ExtensionStore.syncMainChannel

-

Defined in src/common/base-store.ts:46

+

Defined in src/common/base-store.ts:46

Returns: string


Protected syncRendererChannel#

get syncRendererChannel(): string

Inherited from ExtensionStore.syncRendererChannel

-

Defined in src/common/base-store.ts:42

+

Defined in src/common/base-store.ts:42

Returns: string

Methods#

Protected applyWithoutSync#

applyWithoutSync(callback: function): void

Inherited from ExtensionStore.applyWithoutSync

-

Defined in src/common/base-store.ts:136

+

Defined in src/common/base-store.ts:136

Parameters:

callback: function

▸ (): void

@@ -1258,25 +1258,25 @@

Protected cwd#

cwd(): string

Overrides void

-

Defined in src/extensions/extension-store.ts:20

+

Defined in src/extensions/extension-store.ts:20

Returns: string


disableSync#

disableSync(): void

Inherited from ExtensionStore.disableSync

-

Defined in src/common/base-store.ts:131

+

Defined in src/common/base-store.ts:131

Returns: void


enableSync#

enableSync(): void

Inherited from ExtensionStore.enableSync

-

Defined in src/common/base-store.ts:94

+

Defined in src/common/base-store.ts:94

Returns: void


Protected Abstract fromStore#

fromStore(data: T): void

Inherited from ExtensionStore.fromStore

-

Defined in src/common/base-store.ts:166

+

Defined in src/common/base-store.ts:166

fromStore is called internally when a child class syncs with the file system.

Parameters:

@@ -1301,18 +1301,18 @@ system.

Protected init#

init(): Promise‹void›

Inherited from ExtensionStore.init

-

Defined in src/common/base-store.ts:54

+

Defined in src/common/base-store.ts:54

Returns: Promise‹void›


load#

load(): Promise‹void›

Overrides void

-

Defined in src/extensions/extension-store.ts:14

+

Defined in src/extensions/extension-store.ts:14

Returns: Promise‹void›


loadExtension#

loadExtension(extension: LensExtension): Promise‹void›

-

Defined in src/extensions/extension-store.ts:8

+

Defined in src/extensions/extension-store.ts:8

Parameters:

@@ -1333,7 +1333,7 @@ system.

Protected onModelChange#

onModelChange(model: T): Promise‹void›

Inherited from ExtensionStore.onModelChange

-

Defined in src/common/base-store.ts:152

+

Defined in src/common/base-store.ts:152

Parameters:

@@ -1354,7 +1354,7 @@ system.

Protected onSync#

onSync(model: T): void

Inherited from ExtensionStore.onSync

-

Defined in src/common/base-store.ts:145

+

Defined in src/common/base-store.ts:145

Parameters:

@@ -1375,7 +1375,7 @@ system.

Protected onSyncFromMain#

onSyncFromMain(model: T): void

Inherited from ExtensionStore.onSyncFromMain

-

Defined in src/common/base-store.ts:120

+

Defined in src/common/base-store.ts:120

Parameters:

@@ -1396,7 +1396,7 @@ system.

Protected saveToFile#

saveToFile(model: T): Promise‹void›

Inherited from ExtensionStore.saveToFile

-

Defined in src/common/base-store.ts:83

+

Defined in src/common/base-store.ts:83

Parameters:

@@ -1417,7 +1417,7 @@ system.

Abstract toJSON#

toJSON(): T

Inherited from ExtensionStore.toJSON

-

Defined in src/common/base-store.ts:175

+

Defined in src/common/base-store.ts:175

toJSON is called when syncing the store to the filesystem. It should produce a JSON serializable object representaion of the current state.

It is recommended that a round trip is valid. Namely, calling @@ -1427,13 +1427,13 @@ produce a JSON serializable object representaion of the current state.

unregisterIpcListener#

unregisterIpcListener(): void

Inherited from ExtensionStore.unregisterIpcListener

-

Defined in src/common/base-store.ts:126

+

Defined in src/common/base-store.ts:126

Returns: void


Static getInstance#

getInstanceT›(...args: ConstructorParameters‹Constructor‹T››): T

Inherited from ExtensionStore.getInstance

-

Defined in src/common/utils/singleton.ts:15

+

Defined in src/common/utils/singleton.ts:15

Type parameters:

T

Parameters:

@@ -1456,7 +1456,7 @@ produce a JSON serializable object representaion of the current state.

Static resetInstance#

resetInstance(): void

Inherited from ExtensionStore.resetInstance

-

Defined in src/common/utils/singleton.ts:23

+

Defined in src/common/utils/singleton.ts:23

Returns: void

diff --git a/master/extensions/api/classes/_core_api_stores_.workspace/index.html b/master/extensions/api/classes/_core_api_stores_.kubernetescluster/index.html similarity index 76% rename from master/extensions/api/classes/_core_api_stores_.workspace/index.html rename to master/extensions/api/classes/_core_api_stores_.kubernetescluster/index.html index eac1d5dd5c..fcf358fc18 100644 --- a/master/extensions/api/classes/_core_api_stores_.workspace/index.html +++ b/master/extensions/api/classes/_core_api_stores_.kubernetescluster/index.html @@ -9,7 +9,7 @@ - + @@ -19,7 +19,7 @@ - Class: Workspace - Lens Documentation + Class: KubernetesCluster - Lens Documentation @@ -75,7 +75,7 @@
- + Skip to content @@ -106,7 +106,7 @@
- Class: Workspace + Class: KubernetesCluster
@@ -847,13 +847,6 @@ Properties - - -
  • - - Accessors - -
  • @@ -897,70 +890,36 @@ - - -
  • - -
  • - - Accessors - - -
  • @@ -1078,146 +1036,91 @@ - +
    dataWorkspaceModelCatalogEntityData
    -

    Returns: Workspace

    +

    Returns: KubernetesCluster

    Properties#

    -

    [updateFromModel]#

    -

    [updateFromModel]: (Anonymous function) & IAction = action((model: WorkspaceModel) => { - Object.assign(this, model); - })

    -

    Defined in src/common/workspace-store.ts:135

    +

    apiVersion#

    +

    apiVersion: "entity.k8slens.dev/v1alpha1" = "entity.k8slens.dev/v1alpha1"

    +

    Implementation of CatalogEntity.apiVersion

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:19


    -

    Optional description#

    -

    description? : string

    -

    Implementation of WorkspaceModel.description

    -

    Defined in src/common/workspace-store.ts:54

    -

    Workspace description

    -

    observable

    +

    kind#

    +

    kind: "KubernetesCluster" = "KubernetesCluster"

    +

    Implementation of CatalogEntity.kind

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:20


    -

    id#

    -

    id: WorkspaceId

    -

    Implementation of WorkspaceModel.id

    -

    Defined in src/common/workspace-store.ts:42

    -

    Unique id for workspace

    -

    observable

    +

    metadata#

    +

    metadata: CatalogEntityMetadata

    +

    Implementation of CatalogEntity.metadata

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:21


    -

    Optional lastActiveClusterId#

    -

    lastActiveClusterId? : ClusterId

    -

    Implementation of WorkspaceModel.lastActiveClusterId

    -

    Defined in src/common/workspace-store.ts:69

    -

    Last active cluster id

    -

    observable

    +

    spec#

    +

    spec: KubernetesClusterSpec

    +

    Implementation of CatalogEntity.spec

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:23


    -

    name#

    -

    name: string

    -

    Implementation of WorkspaceModel.name

    -

    Defined in src/common/workspace-store.ts:48

    -

    Workspace name

    -

    observable

    -
    -

    Optional ownerRef#

    -

    ownerRef? : string

    -

    Implementation of WorkspaceModel.ownerRef

    -

    Defined in src/common/workspace-store.ts:62

    -

    Workspace owner reference

    -

    If extension sets ownerRef then it needs to explicitly mark workspace as enabled onActivate (or when workspace is saved)

    -

    observable

    -

    Accessors#

    -

    enabled#

    -

    get enabled(): boolean

    -

    Defined in src/common/workspace-store.ts:91

    -

    Is workspace enabled

    -

    Workspaces that don't have ownerRef will be enabled by default. Workspaces with ownerRef need to explicitly enable a workspace.

    -

    observable

    -

    Returns: boolean

    -

    set enabled(enabled: boolean): void

    -

    Defined in src/common/workspace-store.ts:95

    -

    Is workspace enabled

    -

    Workspaces that don't have ownerRef will be enabled by default. Workspaces with ownerRef need to explicitly enable a workspace.

    -

    Parameters:

    - - - - - - - - - - - - - -
    NameType
    enabledboolean
    -

    Returns: void

    -
    -

    isManaged#

    -

    get isManaged(): boolean

    -

    Defined in src/common/workspace-store.ts:102

    -

    Is workspace managed by an extension

    -

    Returns: boolean

    +

    status#

    +

    status: KubernetesClusterStatus

    +

    Implementation of CatalogEntity.status

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:22

    Methods#

    -

    getState#

    -

    getState(): WorkspaceState

    -

    Defined in src/common/workspace-store.ts:110

    -

    Get workspace state

    -

    Returns: WorkspaceState

    +

    getId#

    +

    getId(): string

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:31

    +

    Returns: string


    -

    pushState#

    -

    pushState(state: WorkspaceState): void

    -

    Defined in src/common/workspace-store.ts:122

    -

    Push state

    -

    internal

    +

    getName#

    +

    getName(): string

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:35

    +

    Returns: string

    +
    +

    onContextMenuOpen#

    +

    onContextMenuOpen(context: CatalogEntityContextMenuContext): Promise‹void›

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:47

    Parameters:

    - - - - - - + +
    Name TypeDefaultDescription
    stateWorkspaceStatethis.getState()workspace statecontextCatalogEntityContextMenuContext
    -

    Returns: void

    +

    Returns: Promise‹void›


    -

    setState#

    -

    setState(state: WorkspaceState): void

    -

    Defined in src/common/workspace-store.ts:131

    +

    onDetailsOpen#

    +

    onDetailsOpen(): Promise‹void›

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:43

    +

    Returns: Promise‹void›

    +
    +

    onRun#

    +

    onRun(context: CatalogEntityActionContext): Promise‹void›

    +

    Defined in src/common/catalog-entities/kubernetes-cluster.ts:39

    Parameters:

    - - - - + +
    Name TypeDescription
    stateWorkspaceStateworkspace statecontextCatalogEntityActionContext
    -

    Returns: void

    -
    -

    toJSON#

    -

    toJSON(): WorkspaceModel

    -

    Defined in src/common/workspace-store.ts:139

    -

    Returns: WorkspaceModel

    +

    Returns: Promise‹void›

    diff --git a/master/extensions/api/classes/_core_api_stores_.workspacestore/index.html b/master/extensions/api/classes/_core_api_stores_.kubernetesclustercategory/index.html similarity index 62% rename from master/extensions/api/classes/_core_api_stores_.workspacestore/index.html rename to master/extensions/api/classes/_core_api_stores_.kubernetesclustercategory/index.html index f2999aaf2d..1117f7f466 100644 --- a/master/extensions/api/classes/_core_api_stores_.workspacestore/index.html +++ b/master/extensions/api/classes/_core_api_stores_.kubernetesclustercategory/index.html @@ -9,7 +9,7 @@ - + @@ -19,7 +19,7 @@ - Class: WorkspaceStore - Lens Documentation + Class: KubernetesClusterCategory - Lens Documentation @@ -75,7 +75,7 @@
    - + Skip to content @@ -106,7 +106,7 @@
    - Class: WorkspaceStore + Class: KubernetesClusterCategory
    @@ -818,6 +818,13 @@ Hierarchy + + +
  • + + Implements + +
  • @@ -836,15 +843,15 @@
  • - - Accessors + + Methods
  • - - Methods + + Object literals
  • @@ -863,56 +870,22 @@ - - - - -
  • - - Accessors - - - + +
  • + +
  • + + Object literals + + +
  • + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/master/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html b/master/extensions/api/interfaces/_interfaces_index_.catalogentityactioncontext/index.html similarity index 83% rename from master/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html rename to master/extensions/api/interfaces/_interfaces_index_.catalogentityactioncontext/index.html index 4656931218..418a3085b7 100644 --- a/master/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.catalogentityactioncontext/index.html @@ -9,7 +9,7 @@ - + @@ -19,7 +19,7 @@ - Interface: ClusterModel - Lens Documentation + Interface: CatalogEntityActionContext - Lens Documentation @@ -75,7 +75,7 @@
    - + Skip to content @@ -106,7 +106,7 @@
    - Interface: ClusterModel + Interface: CatalogEntityActionContext
    @@ -818,13 +818,6 @@ Hierarchy - - -
  • - - Implemented by - -
  • @@ -856,64 +849,15 @@
    • - - Optional accessibleNamespaces + + navigate
    • - - Optional contextName - - -
    • - -
    • - - id - - -
    • - -
    • - - Optional kubeConfig - - -
    • - -
    • - - kubeConfigPath - - -
    • - -
    • - - Optional metadata - - -
    • - -
    • - - Optional ownerRef - - -
    • - -
    • - - Optional preferences - - -
    • - -
    • - - Optional workspace + + setCommandPaletteContext
    • @@ -937,73 +881,59 @@ -

      Interface: ClusterModel#

      +

      Interface: CatalogEntityActionContext#

      Hierarchy#

        -
      • ClusterModel
      • -
      -

      Implemented by#

      -
        -
      • Cluster
      • +
      • CatalogEntityActionContext

      Index#

      Properties#

      Properties#

      -

      Optional accessibleNamespaces#

      -

      accessibleNamespaces? : string[]

      -

      Defined in src/common/cluster-store.ts:68

      -

      List of accessible namespaces

      + +

      navigate: function

      +

      Defined in src/common/catalog-entity.ts:41

      +

      Type declaration:#

      +

      ▸ (url: string): void

      +

      Parameters:

      + + + + + + + + + + + + + +
      NameType
      urlstring

      -

      Optional contextName#

      -

      contextName? : string

      -

      Defined in src/common/cluster-store.ts:54

      -

      User context in kubeconfig

      -
      -

      id#

      -

      id: ClusterId

      -

      Defined in src/common/cluster-store.ts:45

      -

      Unique id for a cluster

      -
      -

      Optional kubeConfig#

      -

      kubeConfig? : string

      -

      Defined in src/common/cluster-store.ts:71

      -

      deprecated

      -
      -

      kubeConfigPath#

      -

      kubeConfigPath: string

      -

      Defined in src/common/cluster-store.ts:48

      -

      Path to cluster kubeconfig

      -
      -

      Optional metadata#

      -

      metadata? : ClusterMetadata

      -

      Defined in src/common/cluster-store.ts:60

      -

      Metadata

      -
      -

      Optional ownerRef#

      -

      ownerRef? : string

      -

      Defined in src/common/cluster-store.ts:65

      -

      If extension sets ownerRef it has to explicitly mark a cluster as enabled during onActive (or when cluster is saved)

      -
      -

      Optional preferences#

      -

      preferences? : ClusterPreferences

      -

      Defined in src/common/cluster-store.ts:57

      -

      Preferences

      -
      -

      Optional workspace#

      -

      workspace? : WorkspaceId

      -

      Defined in src/common/cluster-store.ts:51

      -

      Workspace id

      +

      setCommandPaletteContext#

      +

      setCommandPaletteContext: function

      +

      Defined in src/common/catalog-entity.ts:42

      +

      Type declaration:#

      +

      ▸ (context?: CatalogEntity): void

      +

      Parameters:

      + + + + + + + + + + + + + +
      NameType
      context?CatalogEntity
      diff --git a/master/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html b/master/extensions/api/interfaces/_interfaces_index_.catalogentitycontextmenucontext/index.html similarity index 93% rename from master/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html rename to master/extensions/api/interfaces/_interfaces_index_.catalogentitycontextmenucontext/index.html index c956443ae3..8a3afb5755 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.catalogentitycontextmenucontext/index.html @@ -9,7 +9,7 @@ - + @@ -19,7 +19,7 @@ - Interface: ClusterFeatureRegistration - Lens Documentation + Interface: CatalogEntityContextMenuContext - Lens Documentation @@ -75,7 +75,7 @@
      - + Skip to content @@ -106,7 +106,7 @@
      - Interface: ClusterFeatureRegistration + Interface: CatalogEntityContextMenuContext
      @@ -849,22 +849,15 @@

      Callable#

      ▸ (params: RouteParams): void

      -

      Defined in src/extensions/registries/protocol-handler-registry.ts:42

      +

      Defined in src/extensions/registries/protocol-handler-registry.ts:42

      RouteHandler represents the function signature of the handler function for lens:// protocol routing.

      Parameters:

      diff --git a/master/extensions/api/interfaces/_interfaces_index_.routeparams/index.html b/master/extensions/api/interfaces/_interfaces_index_.routeparams/index.html index 1eeda033d1..296029248f 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.routeparams/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.routeparams/index.html @@ -905,17 +905,17 @@ protocol request

      Properties#

      pathname#

      pathname: Record‹string, string›

      -

      Defined in src/extensions/registries/protocol-handler-registry.ts:23

      +

      Defined in src/extensions/registries/protocol-handler-registry.ts:23

      the matching parts of the path. The dynamic parts of the URI path.


      search: Record‹string, string›

      -

      Defined in src/extensions/registries/protocol-handler-registry.ts:18

      +

      Defined in src/extensions/registries/protocol-handler-registry.ts:18

      the parts of the URI query string


      Optional tail#

      tail? : string

      -

      Defined in src/extensions/registries/protocol-handler-registry.ts:35

      +

      Defined in src/extensions/registries/protocol-handler-registry.ts:35

      if the most specific path schema that is matched does not cover the whole of the URI's path. Then this field will be set to the remaining path segments.

      diff --git a/master/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html b/master/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html index 4e72a4d4d8..95b7ec1315 100644 --- a/master/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html +++ b/master/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html @@ -897,11 +897,11 @@

      Optional components#

      components? : StatusBarComponents

      Inherited from StatusBarRegistration.components

      -

      Defined in src/extensions/registries/status-bar-registry.ts:11

      +

      Defined in src/extensions/registries/status-bar-registry.ts:11


      Optional item#

      item? : React.ReactNode

      -

      Defined in src/extensions/registries/status-bar-registry.ts:18

      +

      Defined in src/extensions/registries/status-bar-registry.ts:18

      deprecated use components.Item instead

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html index 2685993cef..581498622b 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html @@ -3359,7 +3359,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional flat#

      flat? : boolean

      -

      Defined in src/renderer/components/badge/badge.tsx:9

      +

      Defined in src/renderer/components/badge/badge.tsx:9


      Optional hidden#

      hidden? : boolean

      @@ -3417,7 +3417,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional label#

      label? : React.ReactNode

      -

      Defined in src/renderer/components/badge/badge.tsx:10

      +

      Defined in src/renderer/components/badge/badge.tsx:10


      Optional lang#

      lang? : string

      @@ -4271,7 +4271,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional small#

      small? : boolean

      -

      Defined in src/renderer/components/badge/badge.tsx:8

      +

      Defined in src/renderer/components/badge/badge.tsx:8


      Optional spellCheck#

      spellCheck? : Booleanish

      @@ -4306,12 +4306,12 @@ A hint could be a sample value or a brief description of the expected format.

      Optional tooltip#

      tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

      Inherited from ButtonProps.tooltip

      -

      Defined in src/renderer/components/tooltip/withTooltip.tsx:10

      +

      Defined in src/renderer/components/tooltip/withTooltip.tsx:10


      Optional tooltipOverrideDisabled#

      tooltipOverrideDisabled? : boolean

      Inherited from ButtonProps.tooltipOverrideDisabled

      -

      Defined in src/renderer/components/tooltip/withTooltip.tsx:15

      +

      Defined in src/renderer/components/tooltip/withTooltip.tsx:15

      forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is "disabled"


      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html index 36e5becb82..be61bfccb6 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html @@ -3122,7 +3122,7 @@

      Optional accent#

      accent? : boolean

      -

      Defined in src/renderer/components/button/button.tsx:10

      +

      Defined in src/renderer/components/button/button.tsx:10


      Optional accessKey#

      accessKey? : string

      @@ -3131,7 +3131,7 @@

      Optional active#

      active? : boolean

      -

      Defined in src/renderer/components/button/button.tsx:15

      +

      Defined in src/renderer/components/button/button.tsx:15


      Optional aria-activedescendant#

      aria-activedescendant? : string

      @@ -3473,7 +3473,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional big#

      big? : boolean

      -

      Defined in src/renderer/components/button/button.tsx:16

      +

      Defined in src/renderer/components/button/button.tsx:16


      Optional children#

      children? : ReactNode

      @@ -3572,11 +3572,11 @@ A hint could be a sample value or a brief description of the expected format.

      Optional hidden#

      hidden? : boolean

      Overrides IconProps.hidden

      -

      Defined in src/renderer/components/button/button.tsx:14

      +

      Defined in src/renderer/components/button/button.tsx:14


      Optional href#

      href? : string

      -

      Defined in src/renderer/components/button/button.tsx:18

      +

      Defined in src/renderer/components/button/button.tsx:18


      Optional id#

      id? : string

      @@ -3629,7 +3629,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional label#

      label? : React.ReactNode

      -

      Defined in src/renderer/components/button/button.tsx:7

      +

      Defined in src/renderer/components/button/button.tsx:7


      Optional lang#

      lang? : string

      @@ -3638,7 +3638,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional light#

      light? : boolean

      -

      Defined in src/renderer/components/button/button.tsx:11

      +

      Defined in src/renderer/components/button/button.tsx:11


      Optional name#

      name? : string

      @@ -4447,7 +4447,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional outlined#

      outlined? : boolean

      -

      Defined in src/renderer/components/button/button.tsx:13

      +

      Defined in src/renderer/components/button/button.tsx:13


      Optional placeholder#

      placeholder? : string

      @@ -4456,7 +4456,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional plain#

      plain? : boolean

      -

      Defined in src/renderer/components/button/button.tsx:12

      +

      Defined in src/renderer/components/button/button.tsx:12


      Optional prefix#

      prefix? : string

      @@ -4465,7 +4465,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional primary#

      primary? : boolean

      -

      Defined in src/renderer/components/button/button.tsx:9

      +

      Defined in src/renderer/components/button/button.tsx:9


      Optional property#

      property? : string

      @@ -4494,7 +4494,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional round#

      round? : boolean

      -

      Defined in src/renderer/components/button/button.tsx:17

      +

      Defined in src/renderer/components/button/button.tsx:17


      Optional security#

      security? : string

      @@ -4533,7 +4533,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional target#

      target? : "_blank"

      -

      Defined in src/renderer/components/button/button.tsx:19

      +

      Defined in src/renderer/components/button/button.tsx:19


      Optional title#

      title? : string

      @@ -4543,12 +4543,12 @@ A hint could be a sample value or a brief description of the expected format.

      Optional tooltip#

      tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

      Inherited from ButtonProps.tooltip

      -

      Defined in src/renderer/components/tooltip/withTooltip.tsx:10

      +

      Defined in src/renderer/components/tooltip/withTooltip.tsx:10


      Optional tooltipOverrideDisabled#

      tooltipOverrideDisabled? : boolean

      Inherited from ButtonProps.tooltipOverrideDisabled

      -

      Defined in src/renderer/components/tooltip/withTooltip.tsx:15

      +

      Defined in src/renderer/components/tooltip/withTooltip.tsx:15

      forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is "disabled"


      @@ -4584,7 +4584,7 @@ useful for displaying tooltips even when the target is "disabled"


      Optional waiting#

      waiting? : boolean

      -

      Defined in src/renderer/components/button/button.tsx:8

      +

      Defined in src/renderer/components/button/button.tsx:8

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html index d46b4a82d6..60f4e924c1 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html @@ -967,31 +967,31 @@

      Properties#

      Optional className#

      className? : string

      -

      Defined in src/renderer/components/checkbox/checkbox.tsx:7

      +

      Defined in src/renderer/components/checkbox/checkbox.tsx:7


      Optional disabled#

      disabled? : boolean

      -

      Defined in src/renderer/components/checkbox/checkbox.tsx:10

      +

      Defined in src/renderer/components/checkbox/checkbox.tsx:10


      Optional inline#

      inline? : boolean

      -

      Defined in src/renderer/components/checkbox/checkbox.tsx:9

      +

      Defined in src/renderer/components/checkbox/checkbox.tsx:9


      Optional label#

      label? : React.ReactNode

      -

      Defined in src/renderer/components/checkbox/checkbox.tsx:8

      +

      Defined in src/renderer/components/checkbox/checkbox.tsx:8


      Optional theme#

      theme? : "dark" | "light"

      -

      Defined in src/renderer/components/checkbox/checkbox.tsx:6

      +

      Defined in src/renderer/components/checkbox/checkbox.tsx:6


      Optional value#

      value? : T

      -

      Defined in src/renderer/components/checkbox/checkbox.tsx:11

      +

      Defined in src/renderer/components/checkbox/checkbox.tsx:11

      Methods#

      Optional onChange#

      onChange(value: T, evt: ChangeEvent‹HTMLInputElement›): void

      -

      Defined in src/renderer/components/checkbox/checkbox.tsx:12

      +

      Defined in src/renderer/components/checkbox/checkbox.tsx:12

      Parameters:

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html b/master/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html index 701c9bde4d..1adbbaaa36 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html @@ -935,33 +935,33 @@

      Properties#

      Optional cancelButtonProps#

      cancelButtonProps? : Partial‹ButtonProps

      -

      Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:21

      +

      Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:21


      Optional icon#

      icon? : ReactNode

      -

      Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:19

      +

      Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:19


      Optional labelCancel#

      labelCancel? : ReactNode

      -

      Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:17

      +

      Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:17


      Optional labelOk#

      labelOk? : ReactNode

      -

      Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:16

      +

      Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:16


      Optional message#

      message? : ReactNode

      -

      Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:18

      +

      Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:18


      Optional ok#

      ok? : function

      -

      Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:15

      +

      Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:15

      Type declaration:#

      ▸ (): void


      Optional okButtonProps#

      okButtonProps? : Partial‹ButtonProps

      -

      Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:20

      +

      Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:20

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html index 5c3df8002f..48e6b28052 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html @@ -895,11 +895,11 @@

      Properties#

      Optional center#

      center? : boolean

      -

      Defined in src/renderer/components/spinner/cube-spinner.tsx:7

      +

      Defined in src/renderer/components/spinner/cube-spinner.tsx:7


      Optional className#

      className? : string

      -

      Defined in src/renderer/components/spinner/cube-spinner.tsx:6

      +

      Defined in src/renderer/components/spinner/cube-spinner.tsx:6

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html index 1e3490d245..9b3535c046 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html @@ -951,47 +951,47 @@

      Properties#

      Optional animated#

      animated? : boolean

      -

      Defined in src/renderer/components/dialog/dialog.tsx:22

      +

      Defined in src/renderer/components/dialog/dialog.tsx:22


      Optional className#

      className? : string

      -

      Defined in src/renderer/components/dialog/dialog.tsx:14

      +

      Defined in src/renderer/components/dialog/dialog.tsx:14


      Optional close#

      close? : function

      -

      Defined in src/renderer/components/dialog/dialog.tsx:17

      +

      Defined in src/renderer/components/dialog/dialog.tsx:17

      Type declaration:#

      ▸ (): void


      Optional isOpen#

      isOpen? : boolean

      -

      Defined in src/renderer/components/dialog/dialog.tsx:15

      +

      Defined in src/renderer/components/dialog/dialog.tsx:15


      Optional modal#

      modal? : boolean

      -

      Defined in src/renderer/components/dialog/dialog.tsx:20

      +

      Defined in src/renderer/components/dialog/dialog.tsx:20


      Optional onClose#

      onClose? : function

      -

      Defined in src/renderer/components/dialog/dialog.tsx:19

      +

      Defined in src/renderer/components/dialog/dialog.tsx:19

      Type declaration:#

      ▸ (): void


      Optional onOpen#

      onOpen? : function

      -

      Defined in src/renderer/components/dialog/dialog.tsx:18

      +

      Defined in src/renderer/components/dialog/dialog.tsx:18

      Type declaration:#

      ▸ (): void


      Optional open#

      open? : function

      -

      Defined in src/renderer/components/dialog/dialog.tsx:16

      +

      Defined in src/renderer/components/dialog/dialog.tsx:16

      Type declaration:#

      ▸ (): void


      Optional pinned#

      pinned? : boolean

      -

      Defined in src/renderer/components/dialog/dialog.tsx:21

      +

      Defined in src/renderer/components/dialog/dialog.tsx:21

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html index c741ced14d..9d1e799d93 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html @@ -3292,7 +3292,7 @@ A hint could be a sample value or a brief description of the expected format.

      className? : string

      Inherited from DrawerItemProps.className

      Overrides ButtonProps.className

      -

      Defined in src/renderer/components/drawer/drawer-item.tsx:7

      +

      Defined in src/renderer/components/drawer/drawer-item.tsx:7


      Optional color#

      color? : string

      @@ -3347,7 +3347,7 @@ A hint could be a sample value or a brief description of the expected format.

      hidden? : boolean

      Inherited from DrawerItemProps.hidden

      Overrides IconProps.hidden

      -

      Defined in src/renderer/components/drawer/drawer-item.tsx:10

      +

      Defined in src/renderer/components/drawer/drawer-item.tsx:10


      Optional id#

      id? : string

      @@ -3400,12 +3400,12 @@ A hint could be a sample value or a brief description of the expected format.

      labels#

      labels: string[]

      -

      Defined in src/renderer/components/drawer/drawer-item-labels.tsx:6

      +

      Defined in src/renderer/components/drawer/drawer-item-labels.tsx:6


      Optional labelsOnly#

      labelsOnly? : boolean

      Inherited from DrawerItemProps.labelsOnly

      -

      Defined in src/renderer/components/drawer/drawer-item.tsx:9

      +

      Defined in src/renderer/components/drawer/drawer-item.tsx:9


      Optional lang#

      lang? : string

      @@ -3415,7 +3415,7 @@ A hint could be a sample value or a brief description of the expected format.

      name#

      name: React.ReactNode

      Inherited from DrawerItemProps.name

      -

      Defined in src/renderer/components/drawer/drawer-item.tsx:6

      +

      Defined in src/renderer/components/drawer/drawer-item.tsx:6


      Optional onAbort#

      onAbort? : ReactEventHandler‹any›

      @@ -4240,7 +4240,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional renderBoolean#

      renderBoolean? : boolean

      Inherited from DrawerItemProps.renderBoolean

      -

      Defined in src/renderer/components/drawer/drawer-item.tsx:11

      +

      Defined in src/renderer/components/drawer/drawer-item.tsx:11


      Optional resource#

      resource? : string

      @@ -4296,7 +4296,7 @@ A hint could be a sample value or a brief description of the expected format.

      title? : string

      Inherited from DrawerItemProps.title

      Overrides ButtonProps.title

      -

      Defined in src/renderer/components/drawer/drawer-item.tsx:8

      +

      Defined in src/renderer/components/drawer/drawer-item.tsx:8


      Optional translate#

      translate? : "yes" | "no"

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html index 944471e92e..f506f7fc53 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html @@ -3286,7 +3286,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional className#

      className? : string

      Overrides ButtonProps.className

      -

      Defined in src/renderer/components/drawer/drawer-item.tsx:7

      +

      Defined in src/renderer/components/drawer/drawer-item.tsx:7


      Optional color#

      color? : string

      @@ -3340,7 +3340,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional hidden#

      hidden? : boolean

      Overrides IconProps.hidden

      -

      Defined in src/renderer/components/drawer/drawer-item.tsx:10

      +

      Defined in src/renderer/components/drawer/drawer-item.tsx:10


      Optional id#

      id? : string

      @@ -3393,7 +3393,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional labelsOnly#

      labelsOnly? : boolean

      -

      Defined in src/renderer/components/drawer/drawer-item.tsx:9

      +

      Defined in src/renderer/components/drawer/drawer-item.tsx:9


      Optional lang#

      lang? : string

      @@ -3402,7 +3402,7 @@ A hint could be a sample value or a brief description of the expected format.

      name#

      name: React.ReactNode

      -

      Defined in src/renderer/components/drawer/drawer-item.tsx:6

      +

      Defined in src/renderer/components/drawer/drawer-item.tsx:6


      Optional onAbort#

      onAbort? : ReactEventHandler‹any›

      @@ -4226,7 +4226,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional renderBoolean#

      renderBoolean? : boolean

      -

      Defined in src/renderer/components/drawer/drawer-item.tsx:11

      +

      Defined in src/renderer/components/drawer/drawer-item.tsx:11


      Optional resource#

      resource? : string

      @@ -4281,7 +4281,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional title#

      title? : string

      Overrides ButtonProps.title

      -

      Defined in src/renderer/components/drawer/drawer-item.tsx:8

      +

      Defined in src/renderer/components/drawer/drawer-item.tsx:8


      Optional translate#

      translate? : "yes" | "no"

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html index 2a31029813..40af715c97 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html @@ -887,7 +887,7 @@

      Properties#

      label#

      label: string | number

      -

      Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:7

      +

      Defined in src/renderer/components/drawer/drawer-param-toggler.tsx:7

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html index ade88edf56..8a8ed93d8d 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html @@ -959,45 +959,45 @@

      Properties#

      Optional animation#

      animation? : AnimateName

      -

      Defined in src/renderer/components/drawer/drawer.tsx:18

      +

      Defined in src/renderer/components/drawer/drawer.tsx:18


      Optional className#

      className? : string | object

      -

      Defined in src/renderer/components/drawer/drawer.tsx:15

      +

      Defined in src/renderer/components/drawer/drawer.tsx:15


      Optional contentClass#

      contentClass? : string | object

      -

      Defined in src/renderer/components/drawer/drawer.tsx:16

      +

      Defined in src/renderer/components/drawer/drawer.tsx:16


      Optional onClose#

      onClose? : function

      -

      Defined in src/renderer/components/drawer/drawer.tsx:19

      +

      Defined in src/renderer/components/drawer/drawer.tsx:19

      Type declaration:#

      ▸ (): void


      open#

      open: boolean

      -

      Defined in src/renderer/components/drawer/drawer.tsx:11

      +

      Defined in src/renderer/components/drawer/drawer.tsx:11


      Optional position#

      position? : "top" | "left" | "right" | "bottom"

      -

      Defined in src/renderer/components/drawer/drawer.tsx:17

      +

      Defined in src/renderer/components/drawer/drawer.tsx:17


      Optional size#

      size? : string

      -

      Defined in src/renderer/components/drawer/drawer.tsx:13

      +

      Defined in src/renderer/components/drawer/drawer.tsx:13


      title#

      title: React.ReactNode

      -

      Defined in src/renderer/components/drawer/drawer.tsx:12

      +

      Defined in src/renderer/components/drawer/drawer.tsx:12


      Optional toolbar#

      toolbar? : React.ReactNode

      -

      Defined in src/renderer/components/drawer/drawer.tsx:20

      +

      Defined in src/renderer/components/drawer/drawer.tsx:20


      Optional usePortal#

      usePortal? : boolean

      -

      Defined in src/renderer/components/drawer/drawer.tsx:14

      +

      Defined in src/renderer/components/drawer/drawer.tsx:14

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html index 97986d2f9c..973c857dbc 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html @@ -895,11 +895,11 @@

      Properties#

      Optional className#

      className? : string

      -

      Defined in src/renderer/components/drawer/drawer-title.tsx:6

      +

      Defined in src/renderer/components/drawer/drawer-title.tsx:6


      Optional title#

      title? : React.ReactNode

      -

      Defined in src/renderer/components/drawer/drawer-title.tsx:7

      +

      Defined in src/renderer/components/drawer/drawer-title.tsx:7

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html b/master/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html index 4eb8c588b3..accbae41d8 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html @@ -904,11 +904,11 @@

      Properties#

      label#

      label: ReactNode

      -

      Defined in src/renderer/components/select/select.tsx:16

      +

      Defined in src/renderer/components/select/select.tsx:16


      options#

      options: T[]

      -

      Defined in src/renderer/components/select/select.tsx:17

      +

      Defined in src/renderer/components/select/select.tsx:17

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html index 116ad6926b..afd0a9026f 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html @@ -3047,7 +3047,7 @@

      Optional active#

      active? : boolean

      -

      Defined in src/renderer/components/icon/icon.tsx:20

      +

      Defined in src/renderer/components/icon/icon.tsx:20


      Optional aria-activedescendant#

      aria-activedescendant? : string

      @@ -3384,7 +3384,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional big#

      big? : boolean

      -

      Defined in src/renderer/components/icon/icon.tsx:19

      +

      Defined in src/renderer/components/icon/icon.tsx:19


      Optional children#

      children? : ReactNode

      @@ -3442,7 +3442,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional disabled#

      disabled? : boolean

      -

      Defined in src/renderer/components/icon/icon.tsx:24

      +

      Defined in src/renderer/components/icon/icon.tsx:24


      Optional draggable#

      draggable? : Booleanish

      @@ -3451,7 +3451,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional focusable#

      focusable? : boolean

      -

      Defined in src/renderer/components/icon/icon.tsx:22

      +

      Defined in src/renderer/components/icon/icon.tsx:22


      Optional hidden#

      hidden? : boolean

      @@ -3460,7 +3460,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional href#

      href? : string

      -

      Defined in src/renderer/components/icon/icon.tsx:15

      +

      Defined in src/renderer/components/icon/icon.tsx:15


      Optional id#

      id? : string

      @@ -3481,7 +3481,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional interactive#

      interactive? : boolean

      -

      Defined in src/renderer/components/icon/icon.tsx:21

      +

      Defined in src/renderer/components/icon/icon.tsx:21


      Optional is#

      is? : string

      @@ -3522,11 +3522,11 @@ A hint could be a sample value or a brief description of the expected format.

      link? : LocationDescriptor

      -

      Defined in src/renderer/components/icon/icon.tsx:14

      +

      Defined in src/renderer/components/icon/icon.tsx:14


      Optional material#

      material? : string

      -

      Defined in src/renderer/components/icon/icon.tsx:12

      +

      Defined in src/renderer/components/icon/icon.tsx:12


      Optional onAbort#

      onAbort? : ReactEventHandler‹any›

      @@ -4370,7 +4370,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional size#

      size? : string | number

      -

      Defined in src/renderer/components/icon/icon.tsx:16

      +

      Defined in src/renderer/components/icon/icon.tsx:16


      Optional slot#

      slot? : string

      @@ -4379,11 +4379,11 @@ A hint could be a sample value or a brief description of the expected format.

      Optional small#

      small? : boolean

      -

      Defined in src/renderer/components/icon/icon.tsx:17

      +

      Defined in src/renderer/components/icon/icon.tsx:17


      Optional smallest#

      smallest? : boolean

      -

      Defined in src/renderer/components/icon/icon.tsx:18

      +

      Defined in src/renderer/components/icon/icon.tsx:18


      Optional spellCheck#

      spellCheck? : Booleanish

      @@ -4392,7 +4392,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional sticker#

      sticker? : boolean

      -

      Defined in src/renderer/components/icon/icon.tsx:23

      +

      Defined in src/renderer/components/icon/icon.tsx:23


      Optional style#

      style? : CSSProperties

      @@ -4411,7 +4411,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional svg#

      svg? : string

      -

      Defined in src/renderer/components/icon/icon.tsx:13

      +

      Defined in src/renderer/components/icon/icon.tsx:13


      Optional tabIndex#

      tabIndex? : number

      @@ -4426,12 +4426,12 @@ A hint could be a sample value or a brief description of the expected format.

      Optional tooltip#

      tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

      Inherited from ButtonProps.tooltip

      -

      Defined in src/renderer/components/tooltip/withTooltip.tsx:10

      +

      Defined in src/renderer/components/tooltip/withTooltip.tsx:10


      Optional tooltipOverrideDisabled#

      tooltipOverrideDisabled? : boolean

      Inherited from ButtonProps.tooltipOverrideDisabled

      -

      Defined in src/renderer/components/tooltip/withTooltip.tsx:15

      +

      Defined in src/renderer/components/tooltip/withTooltip.tsx:15

      forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is "disabled"


      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html b/master/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html index 953dcad161..d553b93cd4 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html @@ -934,15 +934,15 @@

      Properties#

      Optional debounce#

      debounce? : number

      -

      Defined in src/renderer/components/input/input_validators.ts:6

      +

      Defined in src/renderer/components/input/input_validators.ts:6


      Optional message#

      message? : ReactNode | function

      -

      Defined in src/renderer/components/input/input_validators.ts:8

      +

      Defined in src/renderer/components/input/input_validators.ts:8

      Methods#

      Optional condition#

      condition(props: InputProps): boolean

      -

      Defined in src/renderer/components/input/input_validators.ts:7

      +

      Defined in src/renderer/components/input/input_validators.ts:7

      Parameters:

      @@ -962,7 +962,7 @@

      validate#

      validate(value: string, props?: InputProps): boolean | Promise‹any›

      -

      Defined in src/renderer/components/input/input_validators.ts:9

      +

      Defined in src/renderer/components/input/input_validators.ts:9

      Parameters:

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html index ed68bcc15d..372975456f 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html @@ -887,7 +887,7 @@

      Properties#

      object#

      object: KubeObject

      -

      Defined in src/renderer/components/+events/kube-event-details.tsx:11

      +

      Defined in src/renderer/components/+events/kube-event-details.tsx:11

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html index 25cf30887a..d9112d87ab 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html @@ -904,11 +904,11 @@

      Properties#

      Optional className#

      className? : string

      -

      Defined in src/renderer/components/kube-object/kube-object-details.tsx:64

      +

      Defined in src/renderer/components/kube-object/kube-object-details.tsx:64


      object#

      object: T

      -

      Defined in src/renderer/components/kube-object/kube-object-details.tsx:65

      +

      Defined in src/renderer/components/kube-object/kube-object-details.tsx:65

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html index d0314a68f8..49c38f781e 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html @@ -1146,22 +1146,22 @@

      Optional addRemoveButtons#

      addRemoveButtons? : Partial‹AddRemoveButtonsProps›

      Inherited from KubeObjectListLayoutProps.addRemoveButtons

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:69

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:69


      className#

      className: IClassName

      Inherited from KubeObjectListLayoutProps.className

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:40

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:40


      Optional copyClassNameFromHeadCells#

      copyClassNameFromHeadCells? : boolean

      Inherited from KubeObjectListLayoutProps.copyClassNameFromHeadCells

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:62

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:62


      Optional customizeHeader#

      customizeHeader? : function

      Inherited from KubeObjectListLayoutProps.customizeHeader

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:55

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:55

      Type declaration:#

      ▸ (placeholders: IHeaderPlaceholders, content: ReactNode): Partial‹IHeaderPlaceholders› | ReactNode

      Parameters:

      @@ -1187,7 +1187,7 @@

      Optional customizeRemoveDialog#

      customizeRemoveDialog? : function

      Inherited from KubeObjectListLayoutProps.customizeRemoveDialog

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:78

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:78

      Type declaration:#

      ▸ (selectedItems: T[]): Partial‹ConfirmDialogParams

      Parameters:

      @@ -1209,7 +1209,7 @@

      Optional customizeTableRowProps#

      customizeTableRowProps? : function

      Inherited from KubeObjectListLayoutProps.customizeTableRowProps

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:68

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:68

      Type declaration:#

      ▸ (item: T): Partial‹TableRowProps

      Parameters:

      @@ -1231,68 +1231,68 @@

      Optional dependentStores#

      dependentStores? : KubeObjectStore[]

      Overrides void

      -

      Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:15

      +

      Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:15


      Optional detailsItem#

      detailsItem? : T

      Inherited from KubeObjectListLayoutProps.detailsItem

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:74

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:74


      Optional filterItems#

      filterItems? : ItemsFilter‹T›[]

      Inherited from KubeObjectListLayoutProps.filterItems

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:49

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:49

      deprecated


      Optional hasDetailsView#

      hasDetailsView? : boolean

      Inherited from KubeObjectListLayoutProps.hasDetailsView

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:73

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:73


      Optional headerClassName#

      headerClassName? : IClassName

      Inherited from KubeObjectListLayoutProps.headerClassName

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:53

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:53


      Optional hideFilters#

      hideFilters? : boolean

      Inherited from KubeObjectListLayoutProps.hideFilters

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:46

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:46


      Optional isClusterScoped#

      isClusterScoped? : boolean

      Inherited from KubeObjectListLayoutProps.isClusterScoped

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:45

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:45


      Optional isConfigurable#

      isConfigurable? : boolean

      Inherited from KubeObjectListLayoutProps.isConfigurable

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:61

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:61


      Optional isReady#

      isReady? : boolean

      Inherited from KubeObjectListLayoutProps.isReady

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:58

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:58


      Optional isSearchable#

      isSearchable? : boolean

      Inherited from KubeObjectListLayoutProps.isSearchable

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:60

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:60


      Optional isSelectable#

      isSelectable? : boolean

      Inherited from KubeObjectListLayoutProps.isSelectable

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:59

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:59


      Optional items#

      items? : T[]

      Inherited from KubeObjectListLayoutProps.items

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:41

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:41


      Optional onDetails#

      onDetails? : function

      Inherited from KubeObjectListLayoutProps.onDetails

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:75

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:75

      Type declaration:#

      ▸ (item: T): void

      Parameters:

      @@ -1314,12 +1314,12 @@

      Optional preloadStores#

      preloadStores? : boolean

      Inherited from KubeObjectListLayoutProps.preloadStores

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:44

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:44


      Optional renderFooter#

      renderFooter? : function

      Inherited from KubeObjectListLayoutProps.renderFooter

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:79

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:79

      Type declaration:#

      ▸ (parent: ItemListLayout): React.ReactNode

      Parameters:

      @@ -1341,12 +1341,12 @@

      Optional renderHeaderTitle#

      renderHeaderTitle? : ReactNode | function

      Inherited from KubeObjectListLayoutProps.renderHeaderTitle

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:54

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:54


      Optional renderItemMenu#

      renderItemMenu? : function

      Inherited from KubeObjectListLayoutProps.renderItemMenu

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:67

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:67

      Type declaration:#

      ▸ (item: T, store: ItemStore‹T›): ReactNode

      Parameters:

      @@ -1372,7 +1372,7 @@

      renderTableContents#

      renderTableContents: function

      Inherited from KubeObjectListLayoutProps.renderTableContents

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:66

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:66

      Type declaration:#

      ▸ (item: T): (string | number | false | true | object | ReactElement‹any, string | function | object› | ReactNodeArray‹› | ReactPortal‹› | TableCellProps‹›)[]

      Parameters:

      @@ -1394,22 +1394,22 @@

      renderTableHeader#

      renderTableHeader: TableCellProps[] | null

      Inherited from KubeObjectListLayoutProps.renderTableHeader

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:65

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:65


      Optional searchFilters#

      searchFilters? : SearchFilter‹T›[]

      Inherited from KubeObjectListLayoutProps.searchFilters

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:47

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:47


      Optional showHeader#

      showHeader? : boolean

      Inherited from KubeObjectListLayoutProps.showHeader

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:52

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:52


      Optional sortingCallbacks#

      sortingCallbacks? : object

      Inherited from KubeObjectListLayoutProps.sortingCallbacks

      -

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:63

      +

      Defined in src/renderer/components/item-object-list/item-list-layout.tsx:63

      Type declaration:#

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html b/master/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html index f2cc7b33b0..79b69d9d0c 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html @@ -904,11 +904,11 @@

      Properties#

      Optional label#

      label? : React.ReactNode

      -

      Defined in src/renderer/components/select/select.tsx:22

      +

      Defined in src/renderer/components/select/select.tsx:22


      value#

      value: T

      -

      Defined in src/renderer/components/select/select.tsx:21

      +

      Defined in src/renderer/components/select/select.tsx:21

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html index 6d9b7234ec..c8a4892251 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html @@ -1540,7 +1540,7 @@

      Optional autoConvertOptions#

      autoConvertOptions? : boolean

      -

      Defined in src/renderer/components/select/select.tsx:30

      +

      Defined in src/renderer/components/select/select.tsx:30


      Optional autoFocus#

      autoFocus? : boolean

      @@ -1748,7 +1748,7 @@

      Optional isCreatable#

      isCreatable? : boolean

      -

      Defined in src/renderer/components/select/select.tsx:29

      +

      Defined in src/renderer/components/select/select.tsx:29


      Optional isDisabled#

      isDisabled? : boolean

      @@ -1887,7 +1887,7 @@

      Optional menuClass#

      menuClass? : string

      -

      Defined in src/renderer/components/select/select.tsx:28

      +

      Defined in src/renderer/components/select/select.tsx:28


      Optional menuIsOpen#

      menuIsOpen? : boolean

      @@ -2143,17 +2143,17 @@

      Optional themeName#

      themeName? : "dark" | "light" | "outlined" | "lens"

      -

      Defined in src/renderer/components/select/select.tsx:27

      +

      Defined in src/renderer/components/select/select.tsx:27


      Optional value#

      value? : T

      Overrides void

      -

      Defined in src/renderer/components/select/select.tsx:26

      +

      Defined in src/renderer/components/select/select.tsx:26

      Methods#

      Optional onChange#

      onChange(option: T, meta?: ActionMeta‹any›): void

      Overrides void

      -

      Defined in src/renderer/components/select/select.tsx:31

      +

      Defined in src/renderer/components/select/select.tsx:31

      Parameters:

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html index ecd031571b..8bdfb31052 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html @@ -919,11 +919,11 @@

      Properties#

      Optional className#

      className? : string

      -

      Defined in src/renderer/components/slider/slider.tsx:10

      +

      Defined in src/renderer/components/slider/slider.tsx:10

      Methods#

      Optional onChange#

      onChange(evt: FormEvent‹any›, value: number): void

      -

      Defined in src/renderer/components/slider/slider.tsx:11

      +

      Defined in src/renderer/components/slider/slider.tsx:11

      Parameters:

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html index 72c89dd204..5fe80122c0 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html @@ -4205,11 +4205,11 @@ A hint could be a sample value or a brief description of the expected format.

      Optional center#

      center? : boolean

      -

      Defined in src/renderer/components/spinner/spinner.tsx:8

      +

      Defined in src/renderer/components/spinner/spinner.tsx:8


      Optional centerHorizontal#

      centerHorizontal? : boolean

      -

      Defined in src/renderer/components/spinner/spinner.tsx:9

      +

      Defined in src/renderer/components/spinner/spinner.tsx:9


      Optional challenge#

      challenge? : string

      @@ -5552,7 +5552,7 @@ A hint could be a sample value or a brief description of the expected format.

      Optional singleColor#

      singleColor? : boolean

      -

      Defined in src/renderer/components/spinner/spinner.tsx:7

      +

      Defined in src/renderer/components/spinner/spinner.tsx:7


      Optional size#

      size? : number

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html index 9de5d37ba6..278cdf18de 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html @@ -4270,12 +4270,12 @@ A hint could be a sample value or a brief description of the expected format.

      Optional tooltip#

      tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

      Inherited from ButtonProps.tooltip

      -

      Defined in src/renderer/components/tooltip/withTooltip.tsx:10

      +

      Defined in src/renderer/components/tooltip/withTooltip.tsx:10


      Optional tooltipOverrideDisabled#

      tooltipOverrideDisabled? : boolean

      Inherited from ButtonProps.tooltipOverrideDisabled

      -

      Defined in src/renderer/components/tooltip/withTooltip.tsx:15

      +

      Defined in src/renderer/components/tooltip/withTooltip.tsx:15

      forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is "disabled"


      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html index 16ffa7f37a..4dcf14c8a9 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html @@ -5579,11 +5579,11 @@ A hint could be a sample value or a brief description of the expected format.

      step#

      step: number

      Overrides LineProgressProps.step

      -

      Defined in src/renderer/components/stepper/stepper.tsx:6

      +

      Defined in src/renderer/components/stepper/stepper.tsx:6


      steps#

      steps: Step[]

      -

      Defined in src/renderer/components/stepper/stepper.tsx:7

      +

      Defined in src/renderer/components/stepper/stepper.tsx:7


      Optional style#

      style? : CSSProperties

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html index 39a18e66b9..959d455350 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html @@ -911,19 +911,19 @@

      Properties#

      Optional children#

      children? : ReactNode

      -

      Defined in src/renderer/components/layout/tab-layout.tsx:15

      +

      Defined in src/renderer/components/layout/tab-layout.tsx:15


      Optional className#

      className? : IClassName

      -

      Defined in src/renderer/components/layout/tab-layout.tsx:12

      +

      Defined in src/renderer/components/layout/tab-layout.tsx:12


      Optional contentClass#

      contentClass? : IClassName

      -

      Defined in src/renderer/components/layout/tab-layout.tsx:13

      +

      Defined in src/renderer/components/layout/tab-layout.tsx:13


      Optional tabs#

      tabs? : TabLayoutRoute[]

      -

      Defined in src/renderer/components/layout/tab-layout.tsx:14

      +

      Defined in src/renderer/components/layout/tab-layout.tsx:14

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html index 08f92e8776..5537a03c4f 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html @@ -927,27 +927,27 @@

      Properties#

      component#

      component: React.ComponentType‹any›

      -

      Defined in src/renderer/components/layout/tab-layout.tsx:21

      +

      Defined in src/renderer/components/layout/tab-layout.tsx:21


      Optional default#

      default? : boolean

      -

      Defined in src/renderer/components/layout/tab-layout.tsx:24

      +

      Defined in src/renderer/components/layout/tab-layout.tsx:24


      Optional exact#

      exact? : boolean

      -

      Defined in src/renderer/components/layout/tab-layout.tsx:23

      +

      Defined in src/renderer/components/layout/tab-layout.tsx:23


      routePath#

      routePath: string

      -

      Defined in src/renderer/components/layout/tab-layout.tsx:19

      +

      Defined in src/renderer/components/layout/tab-layout.tsx:19


      title#

      title: React.ReactNode

      -

      Defined in src/renderer/components/layout/tab-layout.tsx:20

      +

      Defined in src/renderer/components/layout/tab-layout.tsx:20


      Optional url#

      url? : string

      -

      Defined in src/renderer/components/layout/tab-layout.tsx:22

      +

      Defined in src/renderer/components/layout/tab-layout.tsx:22

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html index 59230a1ae5..67a1b20f3a 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html @@ -2287,15 +2287,15 @@

      Properties#

      Optional _nowrap#

      _nowrap? : boolean

      -

      Defined in src/renderer/components/table/table-cell.tsx:22

      +

      Defined in src/renderer/components/table/table-cell.tsx:22


      Optional _sorting#

      _sorting? : Partial‹TableSortParams

      -

      Defined in src/renderer/components/table/table-cell.tsx:20

      +

      Defined in src/renderer/components/table/table-cell.tsx:20


      Optional checkbox#

      checkbox? : boolean

      -

      Defined in src/renderer/components/table/table-cell.tsx:15

      +

      Defined in src/renderer/components/table/table-cell.tsx:15


      Optional children#

      children? : ReactNode

      @@ -2304,7 +2304,7 @@

      Optional className#

      className? : string

      -

      Defined in src/renderer/components/table/table-cell.tsx:13

      +

      Defined in src/renderer/components/table/table-cell.tsx:13


      Optional dangerouslySetInnerHTML#

      dangerouslySetInnerHTML? : object

      @@ -2317,11 +2317,11 @@

      Optional id#

      id? : string

      -

      Defined in src/renderer/components/table/table-cell.tsx:12

      +

      Defined in src/renderer/components/table/table-cell.tsx:12


      Optional isChecked#

      isChecked? : boolean

      -

      Defined in src/renderer/components/table/table-cell.tsx:16

      +

      Defined in src/renderer/components/table/table-cell.tsx:16


      Optional onAbort#

      onAbort? : ReactEventHandler‹HTMLDivElement›

      @@ -3125,23 +3125,23 @@

      Optional renderBoolean#

      renderBoolean? : boolean

      -

      Defined in src/renderer/components/table/table-cell.tsx:17

      +

      Defined in src/renderer/components/table/table-cell.tsx:17


      Optional showWithColumn#

      showWithColumn? : string

      -

      Defined in src/renderer/components/table/table-cell.tsx:19

      +

      Defined in src/renderer/components/table/table-cell.tsx:19


      Optional sortBy#

      sortBy? : TableSortBy

      -

      Defined in src/renderer/components/table/table-cell.tsx:18

      +

      Defined in src/renderer/components/table/table-cell.tsx:18


      Optional title#

      title? : ReactNode

      -

      Defined in src/renderer/components/table/table-cell.tsx:14

      +

      Defined in src/renderer/components/table/table-cell.tsx:14

      Methods#

      Optional _sort#

      _sort(sortBy: TableSortBy): void

      -

      Defined in src/renderer/components/table/table-cell.tsx:21

      +

      Defined in src/renderer/components/table/table-cell.tsx:21

      Parameters:

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html index a2840b066d..f797cb6eb5 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html @@ -2213,7 +2213,7 @@

      Optional className#

      className? : string

      -

      Defined in src/renderer/components/table/table-head.tsx:9

      +

      Defined in src/renderer/components/table/table-head.tsx:9


      Optional dangerouslySetInnerHTML#

      dangerouslySetInnerHTML? : object

      @@ -2226,7 +2226,7 @@

      Optional nowrap#

      nowrap? : boolean

      -

      Defined in src/renderer/components/table/table-head.tsx:12

      +

      Defined in src/renderer/components/table/table-head.tsx:12


      Optional onAbort#

      onAbort? : ReactEventHandler‹HTMLDivElement›

      @@ -3030,11 +3030,11 @@

      Optional showTopLine#

      showTopLine? : boolean

      -

      Defined in src/renderer/components/table/table-head.tsx:10

      +

      Defined in src/renderer/components/table/table-head.tsx:10


      Optional sticky#

      sticky? : boolean

      -

      Defined in src/renderer/components/table/table-head.tsx:11

      +

      Defined in src/renderer/components/table/table-head.tsx:11

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html index 4b7bfdf733..710e06aa8a 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html @@ -2320,7 +2320,7 @@

      Properties#

      Optional autoSize#

      autoSize? : boolean

      -

      Defined in src/renderer/components/table/table.tsx:26

      +

      Defined in src/renderer/components/table/table.tsx:26


      Optional children#

      children? : ReactNode

      @@ -2329,11 +2329,11 @@

      Optional className#

      className? : string

      -

      Defined in src/renderer/components/table/table.tsx:25

      +

      Defined in src/renderer/components/table/table.tsx:25


      Optional customRowHeights#

      customRowHeights? : function

      -

      Defined in src/renderer/components/table/table.tsx:43

      +

      Defined in src/renderer/components/table/table.tsx:43

      Type declaration:#

      ▸ (item: object, lineHeight: number, paddings: number): number

      Parameters:

      @@ -2371,7 +2371,7 @@

      Optional getTableRow#

      getTableRow? : function

      -

      Defined in src/renderer/components/table/table.tsx:44

      +

      Defined in src/renderer/components/table/table.tsx:44

      Type declaration:#

      ▸ (uid: string): ReactElement‹TableRowProps

      Parameters:

      @@ -2392,11 +2392,11 @@

      Optional items#

      items? : ItemObject[]

      -

      Defined in src/renderer/components/table/table.tsx:24

      +

      Defined in src/renderer/components/table/table.tsx:24


      Optional noItems#

      noItems? : React.ReactNode

      -

      Defined in src/renderer/components/table/table.tsx:38

      +

      Defined in src/renderer/components/table/table.tsx:38


      Optional onAbort#

      onAbort? : ReactEventHandler‹HTMLDivElement›

      @@ -3080,7 +3080,7 @@

      Optional onSort#

      onSort? : function

      -

      Defined in src/renderer/components/table/table.tsx:37

      +

      Defined in src/renderer/components/table/table.tsx:37

      Type declaration:#

      ▸ (params: TableSortParams): void

      Parameters:

      @@ -3221,49 +3221,49 @@

      Optional rowLineHeight#

      rowLineHeight? : string

      -

      Defined in src/renderer/components/table/table.tsx:42

      +

      Defined in src/renderer/components/table/table.tsx:42


      Optional rowPadding#

      rowPadding? : string

      -

      Defined in src/renderer/components/table/table.tsx:41

      +

      Defined in src/renderer/components/table/table.tsx:41


      Optional scrollable#

      scrollable? : boolean

      -

      Defined in src/renderer/components/table/table.tsx:28

      +

      Defined in src/renderer/components/table/table.tsx:28


      Optional selectable#

      selectable? : boolean

      -

      Defined in src/renderer/components/table/table.tsx:27

      +

      Defined in src/renderer/components/table/table.tsx:27


      Optional selectedItemId#

      selectedItemId? : string

      -

      Defined in src/renderer/components/table/table.tsx:39

      +

      Defined in src/renderer/components/table/table.tsx:39


      Optional sortByDefault#

      sortByDefault? : Partial‹TableSortParams

      -

      Defined in src/renderer/components/table/table.tsx:36

      +

      Defined in src/renderer/components/table/table.tsx:36


      Optional sortSyncWithUrl#

      sortSyncWithUrl? : boolean

      -

      Defined in src/renderer/components/table/table.tsx:35

      +

      Defined in src/renderer/components/table/table.tsx:35


      Optional sortable#

      sortable? : TableSortCallbacks

      -

      Defined in src/renderer/components/table/table.tsx:34

      +

      Defined in src/renderer/components/table/table.tsx:34

      Define sortable callbacks for every column in

      sortitem argument in the callback is an object, provided in


      Optional storageKey#

      storageKey? : string

      -

      Defined in src/renderer/components/table/table.tsx:29

      +

      Defined in src/renderer/components/table/table.tsx:29


      Optional tableId#

      tableId? : string

      -

      Defined in src/renderer/components/table/table.tsx:23

      +

      Defined in src/renderer/components/table/table.tsx:23


      Optional virtual#

      virtual? : boolean

      -

      Defined in src/renderer/components/table/table.tsx:40

      +

      Defined in src/renderer/components/table/table.tsx:40

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html index ba7476be79..f1bd94d950 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html @@ -2237,7 +2237,7 @@

      Optional className#

      className? : string

      -

      Defined in src/renderer/components/table/table-row.tsx:10

      +

      Defined in src/renderer/components/table/table-row.tsx:10


      Optional dangerouslySetInnerHTML#

      dangerouslySetInnerHTML? : object

      @@ -2250,11 +2250,11 @@

      Optional disabled#

      disabled? : boolean

      -

      Defined in src/renderer/components/table/table-row.tsx:16

      +

      Defined in src/renderer/components/table/table-row.tsx:16


      Optional nowrap#

      nowrap? : boolean

      -

      Defined in src/renderer/components/table/table-row.tsx:13

      +

      Defined in src/renderer/components/table/table-row.tsx:13


      Optional onAbort#

      onAbort? : ReactEventHandler‹HTMLDivElement›

      @@ -3058,19 +3058,19 @@

      Optional searchItem#

      searchItem? : ItemObject | any

      -

      Defined in src/renderer/components/table/table-row.tsx:15

      +

      Defined in src/renderer/components/table/table-row.tsx:15


      Optional selected#

      selected? : boolean

      -

      Defined in src/renderer/components/table/table-row.tsx:11

      +

      Defined in src/renderer/components/table/table-row.tsx:11


      Optional sortItem#

      sortItem? : ItemObject | any

      -

      Defined in src/renderer/components/table/table-row.tsx:14

      +

      Defined in src/renderer/components/table/table-row.tsx:14


      Optional style#

      style? : CSSProperties

      -

      Defined in src/renderer/components/table/table-row.tsx:12

      +

      Defined in src/renderer/components/table/table-row.tsx:12

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html index a5a52fdccb..a05ce80373 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html @@ -2241,7 +2241,7 @@

      Properties#

      Optional active#

      active? : boolean

      -

      Defined in src/renderer/components/tabs/tabs.tsx:56

      +

      Defined in src/renderer/components/tabs/tabs.tsx:56


      Optional children#

      children? : ReactNode

      @@ -2250,7 +2250,7 @@

      Optional className#

      className? : string

      -

      Defined in src/renderer/components/tabs/tabs.tsx:55

      +

      Defined in src/renderer/components/tabs/tabs.tsx:55


      Optional dangerouslySetInnerHTML#

      dangerouslySetInnerHTML? : object

      @@ -2263,19 +2263,19 @@

      Optional disabled#

      disabled? : boolean

      -

      Defined in src/renderer/components/tabs/tabs.tsx:57

      +

      Defined in src/renderer/components/tabs/tabs.tsx:57


      Optional icon#

      icon? : React.ReactNode | string

      -

      Defined in src/renderer/components/tabs/tabs.tsx:58

      +

      Defined in src/renderer/components/tabs/tabs.tsx:58


      Optional id#

      id? : string

      -

      Defined in src/renderer/components/tabs/tabs.tsx:54

      +

      Defined in src/renderer/components/tabs/tabs.tsx:54


      Optional label#

      label? : React.ReactNode

      -

      Defined in src/renderer/components/tabs/tabs.tsx:59

      +

      Defined in src/renderer/components/tabs/tabs.tsx:59


      Optional onAbort#

      onAbort? : ReactEventHandler‹HTMLElement›

      @@ -3079,7 +3079,7 @@

      value#

      value: D

      -

      Defined in src/renderer/components/tabs/tabs.tsx:60

      +

      Defined in src/renderer/components/tabs/tabs.tsx:60

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html index 16672dfc1b..bc623a5278 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html @@ -982,38 +982,38 @@

      Optional autoFocus#

      autoFocus? : boolean

      Inherited from TabsProps.autoFocus

      -

      Defined in src/renderer/components/tabs/tabs.tsx:9

      +

      Defined in src/renderer/components/tabs/tabs.tsx:9


      Optional center#

      center? : boolean

      -

      Defined in src/renderer/components/tabs/tabs.tsx:19

      +

      Defined in src/renderer/components/tabs/tabs.tsx:19


      Optional className#

      className? : string

      -

      Defined in src/renderer/components/tabs/tabs.tsx:18

      +

      Defined in src/renderer/components/tabs/tabs.tsx:18


      Optional scrollable#

      scrollable? : boolean

      -

      Defined in src/renderer/components/tabs/tabs.tsx:21

      +

      Defined in src/renderer/components/tabs/tabs.tsx:21


      Optional value#

      value? : D

      Inherited from TabsProps.value

      -

      Defined in src/renderer/components/tabs/tabs.tsx:11

      +

      Defined in src/renderer/components/tabs/tabs.tsx:11


      Optional withBorder#

      withBorder? : boolean

      Inherited from TabsProps.withBorder

      -

      Defined in src/renderer/components/tabs/tabs.tsx:10

      +

      Defined in src/renderer/components/tabs/tabs.tsx:10


      Optional wrap#

      wrap? : boolean

      -

      Defined in src/renderer/components/tabs/tabs.tsx:20

      +

      Defined in src/renderer/components/tabs/tabs.tsx:20

      Methods#

      Optional onChange#

      onChange(value: D): void

      Inherited from TabsProps.onChange

      -

      Defined in src/renderer/components/tabs/tabs.tsx:12

      +

      Defined in src/renderer/components/tabs/tabs.tsx:12

      Parameters:

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html index 1a4185dc58..df5882eba4 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html @@ -919,23 +919,23 @@

      Properties#

      Optional narrow#

      narrow? : boolean

      -

      Defined in src/renderer/components/tooltip/tooltip.tsx:34

      +

      Defined in src/renderer/components/tooltip/tooltip.tsx:34


      Optional nowrap#

      nowrap? : boolean

      -

      Defined in src/renderer/components/tooltip/tooltip.tsx:37

      +

      Defined in src/renderer/components/tooltip/tooltip.tsx:37


      Optional small#

      small? : boolean

      -

      Defined in src/renderer/components/tooltip/tooltip.tsx:36

      +

      Defined in src/renderer/components/tooltip/tooltip.tsx:36


      Optional tableView#

      tableView? : boolean

      -

      Defined in src/renderer/components/tooltip/tooltip.tsx:38

      +

      Defined in src/renderer/components/tooltip/tooltip.tsx:38


      Optional warning#

      warning? : boolean

      -

      Defined in src/renderer/components/tooltip/tooltip.tsx:35

      +

      Defined in src/renderer/components/tooltip/tooltip.tsx:35

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html index cae13f7e6b..a3c08c51e8 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html @@ -900,11 +900,11 @@

      Properties#

      Optional tooltip#

      tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

      -

      Defined in src/renderer/components/tooltip/withTooltip.tsx:10

      +

      Defined in src/renderer/components/tooltip/withTooltip.tsx:10


      Optional tooltipOverrideDisabled#

      tooltipOverrideDisabled? : boolean

      -

      Defined in src/renderer/components/tooltip/withTooltip.tsx:15

      +

      Defined in src/renderer/components/tooltip/withTooltip.tsx:15

      forces tooltip to detect the target's parent for mouse events. This is useful for displaying tooltips even when the target is "disabled"

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html index 18d4839636..a2a192c64e 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html @@ -959,43 +959,43 @@

      Properties#

      Optional children#

      children? : React.ReactNode

      -

      Defined in src/renderer/components/tooltip/tooltip.tsx:30

      +

      Defined in src/renderer/components/tooltip/tooltip.tsx:30


      Optional className#

      className? : IClassName

      -

      Defined in src/renderer/components/tooltip/tooltip.tsx:27

      +

      Defined in src/renderer/components/tooltip/tooltip.tsx:27


      Optional formatters#

      formatters? : TooltipContentFormatters

      -

      Defined in src/renderer/components/tooltip/tooltip.tsx:28

      +

      Defined in src/renderer/components/tooltip/tooltip.tsx:28


      Optional offset#

      offset? : number

      -

      Defined in src/renderer/components/tooltip/tooltip.tsx:24

      +

      Defined in src/renderer/components/tooltip/tooltip.tsx:24


      Optional preferredPositions#

      preferredPositions? : TooltipPosition | TooltipPosition[]

      -

      Defined in src/renderer/components/tooltip/tooltip.tsx:26

      +

      Defined in src/renderer/components/tooltip/tooltip.tsx:26


      Optional style#

      style? : CSSProperties

      -

      Defined in src/renderer/components/tooltip/tooltip.tsx:29

      +

      Defined in src/renderer/components/tooltip/tooltip.tsx:29


      targetId#

      targetId: string

      -

      Defined in src/renderer/components/tooltip/tooltip.tsx:21

      +

      Defined in src/renderer/components/tooltip/tooltip.tsx:21


      Optional tooltipOnParentHover#

      tooltipOnParentHover? : boolean

      -

      Defined in src/renderer/components/tooltip/tooltip.tsx:22

      +

      Defined in src/renderer/components/tooltip/tooltip.tsx:22


      Optional usePortal#

      usePortal? : boolean

      -

      Defined in src/renderer/components/tooltip/tooltip.tsx:25

      +

      Defined in src/renderer/components/tooltip/tooltip.tsx:25


      Optional visible#

      visible? : boolean

      -

      Defined in src/renderer/components/tooltip/tooltip.tsx:23

      +

      Defined in src/renderer/components/tooltip/tooltip.tsx:23

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html index 7ad905e053..aaa491ed76 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html @@ -2232,7 +2232,7 @@

      Properties#

      Optional centered#

      centered? : boolean

      -

      Defined in src/renderer/components/layout/wizard-layout.tsx:13

      +

      Defined in src/renderer/components/layout/wizard-layout.tsx:13


      Optional children#

      children? : ReactNode

      @@ -2241,11 +2241,11 @@

      Optional className#

      className? : IClassName

      -

      Defined in src/renderer/components/layout/wizard-layout.tsx:7

      +

      Defined in src/renderer/components/layout/wizard-layout.tsx:7


      Optional contentClass#

      contentClass? : IClassName

      -

      Defined in src/renderer/components/layout/wizard-layout.tsx:10

      +

      Defined in src/renderer/components/layout/wizard-layout.tsx:10


      Optional dangerouslySetInnerHTML#

      dangerouslySetInnerHTML? : object

      @@ -2258,19 +2258,19 @@

      Optional header#

      header? : React.ReactNode

      -

      Defined in src/renderer/components/layout/wizard-layout.tsx:8

      +

      Defined in src/renderer/components/layout/wizard-layout.tsx:8


      Optional headerClass#

      headerClass? : IClassName

      -

      Defined in src/renderer/components/layout/wizard-layout.tsx:9

      +

      Defined in src/renderer/components/layout/wizard-layout.tsx:9


      Optional infoPanel#

      infoPanel? : React.ReactNode

      -

      Defined in src/renderer/components/layout/wizard-layout.tsx:12

      +

      Defined in src/renderer/components/layout/wizard-layout.tsx:12


      Optional infoPanelClass#

      infoPanelClass? : IClassName

      -

      Defined in src/renderer/components/layout/wizard-layout.tsx:11

      +

      Defined in src/renderer/components/layout/wizard-layout.tsx:11


      Optional onAbort#

      onAbort? : ReactEventHandler‹any›

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html index fc23ecf4d7..54345922ac 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.wizardprops/index.html @@ -969,32 +969,32 @@

      Properties#

      Optional className#

      className? : string

      -

      Defined in src/renderer/components/wizard/wizard.tsx:18

      +

      Defined in src/renderer/components/wizard/wizard.tsx:18


      Optional data#

      data? : Partial‹D›

      Inherited from WizardProps.data

      -

      Defined in src/renderer/components/wizard/wizard.tsx:10

      +

      Defined in src/renderer/components/wizard/wizard.tsx:10


      Optional done#

      done? : function

      Inherited from WizardProps.done

      -

      Defined in src/renderer/components/wizard/wizard.tsx:13

      +

      Defined in src/renderer/components/wizard/wizard.tsx:13

      Type declaration:#

      ▸ (): void


      Optional header#

      header? : React.ReactNode

      -

      Defined in src/renderer/components/wizard/wizard.tsx:21

      +

      Defined in src/renderer/components/wizard/wizard.tsx:21


      Optional hideSteps#

      hideSteps? : boolean

      Inherited from WizardProps.hideSteps

      -

      Defined in src/renderer/components/wizard/wizard.tsx:14

      +

      Defined in src/renderer/components/wizard/wizard.tsx:14


      Optional onChange#

      onChange? : function

      -

      Defined in src/renderer/components/wizard/wizard.tsx:22

      +

      Defined in src/renderer/components/wizard/wizard.tsx:22

      Type declaration:#

      ▸ (step: number): void

      Parameters:

      @@ -1016,14 +1016,14 @@

      Optional reset#

      reset? : function

      Inherited from WizardProps.reset

      -

      Defined in src/renderer/components/wizard/wizard.tsx:12

      +

      Defined in src/renderer/components/wizard/wizard.tsx:12

      Type declaration:#

      ▸ (): void


      Optional save#

      save? : function

      Inherited from WizardProps.save

      -

      Defined in src/renderer/components/wizard/wizard.tsx:11

      +

      Defined in src/renderer/components/wizard/wizard.tsx:11

      Type declaration:#

      ▸ (data: Partial‹D›, callback?: function): void

      Parameters:

      @@ -1033,11 +1033,11 @@

      Optional step#

      step? : number

      -

      Defined in src/renderer/components/wizard/wizard.tsx:19

      +

      Defined in src/renderer/components/wizard/wizard.tsx:19


      Optional title#

      title? : string

      -

      Defined in src/renderer/components/wizard/wizard.tsx:20

      +

      Defined in src/renderer/components/wizard/wizard.tsx:20

      diff --git a/master/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html b/master/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html index 92b2d141cc..d8a46e8456 100644 --- a/master/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html +++ b/master/extensions/api/interfaces/_renderer_api_components_.wizardstepprops/index.html @@ -1129,120 +1129,120 @@

      Properties#

      Optional afterContent#

      afterContent? : React.ReactNode

      -

      Defined in src/renderer/components/wizard/wizard.tsx:122

      +

      Defined in src/renderer/components/wizard/wizard.tsx:122


      Optional beforeContent#

      beforeContent? : React.ReactNode

      -

      Defined in src/renderer/components/wizard/wizard.tsx:121

      +

      Defined in src/renderer/components/wizard/wizard.tsx:121


      Optional className#

      className? : string | object

      -

      Defined in src/renderer/components/wizard/wizard.tsx:103

      +

      Defined in src/renderer/components/wizard/wizard.tsx:103


      Optional contentClass#

      contentClass? : string | object

      -

      Defined in src/renderer/components/wizard/wizard.tsx:104

      +

      Defined in src/renderer/components/wizard/wizard.tsx:104


      Optional customButtons#

      customButtons? : React.ReactNode

      -

      Defined in src/renderer/components/wizard/wizard.tsx:105

      +

      Defined in src/renderer/components/wizard/wizard.tsx:105


      Optional data#

      data? : Partial‹D›

      Inherited from WizardProps.data

      -

      Defined in src/renderer/components/wizard/wizard.tsx:10

      +

      Defined in src/renderer/components/wizard/wizard.tsx:10


      Optional disabledNext#

      disabledNext? : boolean

      -

      Defined in src/renderer/components/wizard/wizard.tsx:109

      +

      Defined in src/renderer/components/wizard/wizard.tsx:109


      Optional done#

      done? : function

      Inherited from WizardProps.done

      -

      Defined in src/renderer/components/wizard/wizard.tsx:13

      +

      Defined in src/renderer/components/wizard/wizard.tsx:13

      Type declaration:#

      ▸ (): void


      Optional first#

      first? : function

      -

      Defined in src/renderer/components/wizard/wizard.tsx:117

      +

      Defined in src/renderer/components/wizard/wizard.tsx:117

      Type declaration:#

      ▸ (): void


      Optional hideBackBtn#

      hideBackBtn? : boolean

      -

      Defined in src/renderer/components/wizard/wizard.tsx:111

      +

      Defined in src/renderer/components/wizard/wizard.tsx:111


      Optional hideNextBtn#

      hideNextBtn? : boolean

      -

      Defined in src/renderer/components/wizard/wizard.tsx:110

      +

      Defined in src/renderer/components/wizard/wizard.tsx:110


      Optional hideSteps#

      hideSteps? : boolean

      Inherited from WizardProps.hideSteps

      -

      Defined in src/renderer/components/wizard/wizard.tsx:14

      +

      Defined in src/renderer/components/wizard/wizard.tsx:14


      Optional isFirst#

      isFirst? : function

      -

      Defined in src/renderer/components/wizard/wizard.tsx:119

      +

      Defined in src/renderer/components/wizard/wizard.tsx:119

      Type declaration:#

      ▸ (): boolean


      Optional isLast#

      isLast? : function

      -

      Defined in src/renderer/components/wizard/wizard.tsx:120

      +

      Defined in src/renderer/components/wizard/wizard.tsx:120

      Type declaration:#

      ▸ (): boolean


      Optional last#

      last? : function

      -

      Defined in src/renderer/components/wizard/wizard.tsx:118

      +

      Defined in src/renderer/components/wizard/wizard.tsx:118

      Type declaration:#

      ▸ (): void


      Optional loading#

      loading? : boolean

      -

      Defined in src/renderer/components/wizard/wizard.tsx:107

      +

      Defined in src/renderer/components/wizard/wizard.tsx:107


      Optional moreButtons#

      moreButtons? : React.ReactNode

      -

      Defined in src/renderer/components/wizard/wizard.tsx:106

      +

      Defined in src/renderer/components/wizard/wizard.tsx:106


      Optional next#

      next? : function

      -

      Defined in src/renderer/components/wizard/wizard.tsx:115

      +

      Defined in src/renderer/components/wizard/wizard.tsx:115

      Type declaration:#

      ▸ (): void | boolean | Promise‹any›


      Optional nextLabel#

      nextLabel? : React.ReactNode

      -

      Defined in src/renderer/components/wizard/wizard.tsx:114

      +

      Defined in src/renderer/components/wizard/wizard.tsx:114


      Optional noValidate#

      noValidate? : boolean

      -

      Defined in src/renderer/components/wizard/wizard.tsx:123

      +

      Defined in src/renderer/components/wizard/wizard.tsx:123


      Optional prev#

      prev? : function

      -

      Defined in src/renderer/components/wizard/wizard.tsx:116

      +

      Defined in src/renderer/components/wizard/wizard.tsx:116

      Type declaration:#

      ▸ (): void


      Optional prevLabel#

      prevLabel? : React.ReactNode

      -

      Defined in src/renderer/components/wizard/wizard.tsx:113

      +

      Defined in src/renderer/components/wizard/wizard.tsx:113


      Optional reset#

      reset? : function

      Inherited from WizardProps.reset

      -

      Defined in src/renderer/components/wizard/wizard.tsx:12

      +

      Defined in src/renderer/components/wizard/wizard.tsx:12

      Type declaration:#

      ▸ (): void


      Optional save#

      save? : function

      Inherited from WizardProps.save

      -

      Defined in src/renderer/components/wizard/wizard.tsx:11

      +

      Defined in src/renderer/components/wizard/wizard.tsx:11

      Type declaration:#

      ▸ (data: Partial‹D›, callback?: function): void

      Parameters:

      @@ -1252,27 +1252,27 @@

      Optional scrollable#

      scrollable? : boolean

      -

      Defined in src/renderer/components/wizard/wizard.tsx:125

      +

      Defined in src/renderer/components/wizard/wizard.tsx:125


      Optional skip#

      skip? : boolean

      -

      Defined in src/renderer/components/wizard/wizard.tsx:124

      +

      Defined in src/renderer/components/wizard/wizard.tsx:124


      Optional step#

      step? : number

      -

      Defined in src/renderer/components/wizard/wizard.tsx:112

      +

      Defined in src/renderer/components/wizard/wizard.tsx:112


      Optional title#

      title? : string

      -

      Defined in src/renderer/components/wizard/wizard.tsx:102

      +

      Defined in src/renderer/components/wizard/wizard.tsx:102


      Optional waiting#

      waiting? : boolean

      -

      Defined in src/renderer/components/wizard/wizard.tsx:108

      +

      Defined in src/renderer/components/wizard/wizard.tsx:108


      Optional wizard#

      wizard? : Wizard

      -

      Defined in src/renderer/components/wizard/wizard.tsx:101

      +

      Defined in src/renderer/components/wizard/wizard.tsx:101

      diff --git a/master/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html b/master/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html index 0a3183831a..1904901006 100644 --- a/master/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html +++ b/master/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html @@ -849,8 +849,8 @@
      @@ -1019,7 +1019,7 @@

      Optional stringify#

      stringify(value: V): string | string[]

      -

      Defined in src/renderer/navigation/page-param.ts:12

      +

      Defined in src/renderer/navigation/page-param.ts:12

      Parameters:

      diff --git a/master/extensions/api/modules/_core_api_app_/index.html b/master/extensions/api/modules/_core_api_app_/index.html index 2f737752c4..b34c50403d 100644 --- a/master/extensions/api/modules/_core_api_app_/index.html +++ b/master/extensions/api/modules/_core_api_app_/index.html @@ -963,39 +963,39 @@

      Variables#

      Const appName#

      appName: string = ${packageInfo.productName}${isDevelopment ? "Dev" : ""}

      -

      Defined in src/common/vars.ts:15

      +

      Defined in src/common/vars.ts:15


      Const isLinux#

      isLinux: boolean = process.platform === "linux"

      -

      Defined in src/common/vars.ts:8

      +

      Defined in src/common/vars.ts:8


      Const isMac#

      isMac: boolean = process.platform === "darwin"

      -

      Defined in src/common/vars.ts:6

      +

      Defined in src/common/vars.ts:6


      Const isSnap#

      isSnap: boolean = !!process.env.SNAP

      -

      Defined in src/common/vars.ts:10

      +

      Defined in src/common/vars.ts:10


      Const isWindows#

      isWindows: boolean = process.platform === "win32"

      -

      Defined in src/common/vars.ts:7

      +

      Defined in src/common/vars.ts:7


      Const issuesTrackerUrl#

      issuesTrackerUrl: "https://github.com/lensapp/lens/issues" = "https://github.com/lensapp/lens/issues"

      -

      Defined in src/common/vars.ts:43

      +

      Defined in src/common/vars.ts:43


      Const slackUrl#

      slackUrl: "https://join.slack.com/t/k8slens/shared_invite/enQtOTc5NjAyNjYyOTk4LWU1NDQ0ZGFkOWJkNTRhYTc2YjVmZDdkM2FkNGM5MjhiYTRhMDU2NDQ1MzIyMDA4ZGZlNmExOTc0N2JmY2M3ZGI" = "https://join.slack.com/t/k8slens/shared_invite/enQtOTc5NjAyNjYyOTk4LWU1NDQ0ZGFkOWJkNTRhYTc2YjVmZDdkM2FkNGM5MjhiYTRhMDU2NDQ1MzIyMDA4ZGZlNmExOTc0N2JmY2M3ZGI"

      -

      Defined in src/common/vars.ts:44

      +

      Defined in src/common/vars.ts:44


      Const version#

      version: string = getAppVersion()

      -

      Defined in src/extensions/core-api/app.ts:4

      +

      Defined in src/extensions/core-api/app.ts:4

      Functions#

      getEnabledExtensions#

      getEnabledExtensions(): string[]

      -

      Defined in src/extensions/core-api/app.ts:7

      +

      Defined in src/extensions/core-api/app.ts:7

      Returns: string[]

      diff --git a/master/extensions/api/modules/_core_api_event_bus_/index.html b/master/extensions/api/modules/_core_api_event_bus_/index.html index 30003b4285..411f674723 100644 --- a/master/extensions/api/modules/_core_api_event_bus_/index.html +++ b/master/extensions/api/modules/_core_api_event_bus_/index.html @@ -907,7 +907,7 @@

      Type aliases#

      AppEvent#

      Ƭ AppEvent: object

      -

      Defined in src/common/event-bus.ts:3

      +

      Defined in src/common/event-bus.ts:3

      Type declaration:#

      • @@ -923,7 +923,7 @@

        Variables#

        Const appEventBus#

        appEventBus: EventEmitter‹[object]› = new EventEmitter<[AppEvent]>()

        -

        Defined in src/common/event-bus.ts:9

        +

        Defined in src/common/event-bus.ts:9

        diff --git a/master/extensions/api/modules/_core_api_stores_/index.html b/master/extensions/api/modules/_core_api_stores_/index.html index 4e2bd4ba00..6a4ecbf8d3 100644 --- a/master/extensions/api/modules/_core_api_stores_/index.html +++ b/master/extensions/api/modules/_core_api_stores_/index.html @@ -826,20 +826,6 @@ Classes -
      • - -
      • - - Interfaces - - -
      • - -
      • - - Type aliases - -
      • @@ -852,33 +838,6 @@
      - - -
    • - - Type aliases - - - -
    • @@ -890,15 +849,15 @@
    • @@ -931,7 +931,7 @@

      openExternal#

      openExternal(url: string): Promise‹void›

      -

      Defined in src/common/utils/openExternal.ts:4

      +

      Defined in src/common/utils/openExternal.ts:4

      Parameters:

      @@ -951,7 +951,7 @@

      prevDefault#

      prevDefaultE›(callback: function): (Anonymous function)

      -

      Defined in src/renderer/utils/prevDefault.ts:15

      +

      Defined in src/renderer/utils/prevDefault.ts:15

      Type parameters:

      E: SyntheticEvent | Event

      Parameters:

      @@ -976,7 +976,7 @@

      stopPropagation#

      stopPropagation(evt: Event | SyntheticEvent): void

      -

      Defined in src/renderer/utils/prevDefault.ts:24

      +

      Defined in src/renderer/utils/prevDefault.ts:24

      Parameters:

      diff --git a/master/extensions/api/modules/_interfaces_index_/index.html b/master/extensions/api/modules/_interfaces_index_/index.html index 6799317b4a..998c71021d 100644 --- a/master/extensions/api/modules/_interfaces_index_/index.html +++ b/master/extensions/api/modules/_interfaces_index_/index.html @@ -826,6 +826,54 @@ Interfaces + + +
    • + + Type aliases + + +
    • + + + + + + +
    • + + Type aliases + + +
    • @@ -1471,7 +1471,7 @@ last clicked Node should be "active" while Pod details are shown).


      SubMenu(props: Partial‹MenuProps›): Element‹›

      -

      Defined in src/renderer/components/menu/menu.tsx:289

      +

      Defined in src/renderer/components/menu/menu.tsx:289

      Parameters:

      @@ -1491,7 +1491,7 @@ last clicked Node should be "active" while Pod details are shown).


      createTerminalTab#

      createTerminalTab(tabParams: Partial‹ITerminalTab›): IDockTab

      -

      Defined in src/renderer/components/dock/terminal.store.ts:16

      +

      Defined in src/renderer/components/dock/terminal.store.ts:16

      Parameters:

      @@ -1513,7 +1513,7 @@ last clicked Node should be "active" while Pod details are shown).


      getDetailsUrl#

      getDetailsUrl(selfLink: string, resetSelected: boolean, mergeGlobals: boolean): string

      -

      Defined in src/renderer/components/kube-object/kube-object-details.tsx:49

      +

      Defined in src/renderer/components/kube-object/kube-object-details.tsx:49

      Parameters:

      @@ -1545,12 +1545,12 @@ last clicked Node should be "active" while Pod details are shown).


      hideDetails#

      hideDetails(): void

      -

      Defined in src/renderer/components/kube-object/kube-object-details.tsx:45

      +

      Defined in src/renderer/components/kube-object/kube-object-details.tsx:45

      Returns: void


      showDetails#

      showDetails(selfLink: string, resetSelected: boolean): void

      -

      Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

      +

      Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

      Parameters:

      @@ -1577,7 +1577,7 @@ last clicked Node should be "active" while Pod details are shown).


      withTooltip#

      withTooltipT›(Target: T): T

      -

      Defined in src/renderer/components/tooltip/withTooltip.tsx:18

      +

      Defined in src/renderer/components/tooltip/withTooltip.tsx:18

      Type parameters:

      T: React.ComponentType‹any›

      Parameters:

      diff --git a/master/extensions/api/modules/_renderer_api_k8s_api_/index.html b/master/extensions/api/modules/_renderer_api_k8s_api_/index.html index d98e495000..5c35f2b446 100644 --- a/master/extensions/api/modules/_renderer_api_k8s_api_/index.html +++ b/master/extensions/api/modules/_renderer_api_k8s_api_/index.html @@ -1278,7 +1278,7 @@

      Type aliases#

      KubeObjectStatus#

      Ƭ KubeObjectStatus: object

      -

      Defined in src/extensions/renderer-api/kube-object-status.ts:1

      +

      Defined in src/extensions/renderer-api/kube-object-status.ts:1

      Type declaration:#

      diff --git a/master/extensions/api/modules/_renderer_api_navigation_/index.html b/master/extensions/api/modules/_renderer_api_navigation_/index.html index 93f5c013db..a433a70c6d 100644 --- a/master/extensions/api/modules/_renderer_api_navigation_/index.html +++ b/master/extensions/api/modules/_renderer_api_navigation_/index.html @@ -939,7 +939,7 @@

      Functions#

      createPageParam#

      createPageParamV›(init: PageParamInit‹V›): PageParam‹V›

      -

      Defined in src/extensions/renderer-api/navigation.ts:10

      +

      Defined in src/extensions/renderer-api/navigation.ts:10

      Type parameters:

      V

      Parameters:

      @@ -961,7 +961,7 @@

      getDetailsUrl#

      getDetailsUrl(selfLink: string, resetSelected: boolean, mergeGlobals: boolean): string

      -

      Defined in src/renderer/components/kube-object/kube-object-details.tsx:49

      +

      Defined in src/renderer/components/kube-object/kube-object-details.tsx:49

      Parameters:

      @@ -993,12 +993,12 @@

      hideDetails#

      hideDetails(): void

      -

      Defined in src/renderer/components/kube-object/kube-object-details.tsx:45

      +

      Defined in src/renderer/components/kube-object/kube-object-details.tsx:45

      Returns: void


      isActiveRoute#

      isActiveRoute(route: string | string[] | RouteProps): boolean

      -

      Defined in src/renderer/navigation/helpers.ts:25

      +

      Defined in src/renderer/navigation/helpers.ts:25

      Parameters:

      @@ -1018,7 +1018,7 @@

      navigate(location: LocationDescriptor): void

      -

      Defined in src/renderer/navigation/helpers.ts:7

      +

      Defined in src/renderer/navigation/helpers.ts:7

      Parameters:

      @@ -1038,7 +1038,7 @@

      showDetails#

      showDetails(selfLink: string, resetSelected: boolean): void

      -

      Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

      +

      Defined in src/renderer/components/kube-object/kube-object-details.tsx:39

      Parameters:

      diff --git a/master/extensions/api/modules/_renderer_api_theming_/index.html b/master/extensions/api/modules/_renderer_api_theming_/index.html index f5e95d0559..398f72bf94 100644 --- a/master/extensions/api/modules/_renderer_api_theming_/index.html +++ b/master/extensions/api/modules/_renderer_api_theming_/index.html @@ -876,7 +876,7 @@

      Functions#

      getActiveTheme#

      getActiveTheme(): Theme

      -

      Defined in src/extensions/renderer-api/theming.ts:3

      +

      Defined in src/extensions/renderer-api/theming.ts:3

      Returns: Theme

      diff --git a/master/search/search_index.json b/master/search/search_index.json index b1daaa7075..08129ec375 100644 --- a/master/search/search_index.json +++ b/master/search/search_index.json @@ -1 +1 @@ -{"config":{"lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Overview # Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: Confidence that your clusters are properly setup and configured. Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. Watch this introductory video to see Lens in action: Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab Downloading Lens # Download Lens for macOS, Windows, or Linux. Quick Start # Get up and running quickly by learning to add clusters .","title":"Overview"},{"location":"#overview","text":"Lens is the most powerful Kubernetes IDE on the market. It is a standalone application, and it is available on macOS, Windows, and Linux. Some of the benefits of using Lens include: Confidence that your clusters are properly setup and configured. Increased visibility, real time statistics, log streams, and hands-on troubleshooting capabilities. The ability to work with your clusters quickly and easily, radically improving productivity and the speed of business. Watch this introductory video to see Lens in action: Note: Use CTRL+click (on Windows and Linux) or CMD+click (on MacOS) to open the above in a new tab","title":"Overview"},{"location":"#downloading-lens","text":"Download Lens for macOS, Windows, or Linux.","title":"Downloading Lens"},{"location":"#quick-start","text":"Get up and running quickly by learning to add clusters .","title":"Quick Start"},{"location":"clusters/adding-clusters/","text":"Adding Clusters # Add clusters by clicking the Add Cluster button in the left-side menu. Click the Add Cluster button (indicated with a '+' icon). Or click here . Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. Selected cluster contexts are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts. NOTE : Any cluster that you added manually will not be merged into your kubeconfig file. For more information on kubeconfig see Kubernetes docs . To see your currently-enabled config with kubectl , enter kubectl config view --minify --raw in your terminal. When connecting to a cluster, make sure you have a valid and working kubeconfig for the cluster. Following lists known \"gotchas\" in some authentication types used in kubeconfig with Lens app. Exec auth plugins # When using exec auth plugins make sure the paths that are used to call any binaries are full paths as Lens app might not be able to call binaries with relative paths. Make also sure that you pass all needed information either as arguments or env variables in the config, Lens app might not have all login shell env variables set automatically.","title":"Adding Clusters"},{"location":"clusters/adding-clusters/#adding-clusters","text":"Add clusters by clicking the Add Cluster button in the left-side menu. Click the Add Cluster button (indicated with a '+' icon). Or click here . Enter the path to your kubeconfig file. You'll need to have a kubeconfig file for the cluster you want to add. You can either browse for the path from the file system or or enter it directly. Selected cluster contexts are added as a separate item in the left-side cluster menu to allow you to operate easily on multiple clusters and/or contexts. NOTE : Any cluster that you added manually will not be merged into your kubeconfig file. For more information on kubeconfig see Kubernetes docs . To see your currently-enabled config with kubectl , enter kubectl config view --minify --raw in your terminal. When connecting to a cluster, make sure you have a valid and working kubeconfig for the cluster. Following lists known \"gotchas\" in some authentication types used in kubeconfig with Lens app.","title":"Adding Clusters"},{"location":"clusters/adding-clusters/#exec-auth-plugins","text":"When using exec auth plugins make sure the paths that are used to call any binaries are full paths as Lens app might not be able to call binaries with relative paths. Make also sure that you pass all needed information either as arguments or env variables in the config, Lens app might not have all login shell env variables set automatically.","title":"Exec auth plugins"},{"location":"clusters/removing-clusters/","text":"Removing Clusters # Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove. To remove a cluster from your cluster list: Right-click the name of the cluster in the left-side menu that you want to remove. Click Remove . NOTE : This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.","title":"Removing Clusters"},{"location":"clusters/removing-clusters/#removing-clusters","text":"Remove Lens clusters using the context menu that appears when you right-click the cluster in the left-side menu that you want to remove. To remove a cluster from your cluster list: Right-click the name of the cluster in the left-side menu that you want to remove. Click Remove . NOTE : This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.","title":"Removing Clusters"},{"location":"clusters/settings/","text":"Settings # It is easy to configure Lens Clusters to your liking through its various settings. Right-click the name of the cluster in the left-side menu that you want to open the settings for. Click Settings . Status # Overview of the cluster status Cluster Status # Cluster status information including the detected distribution, kernel version, API endpoint, and online status General # General cluster settings Cluster Name # The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file. Workspace # This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking workspace in \"Define cluster workspace\" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings. Cluster Icon # Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon. HTTP Proxy # Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so. Prometheus # Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations: Lens Helm Operator Prometheus Operator Stacklight To learn more about custom Prometheus configurations, please refer to this guide . Working Directory # Use this field to set the terminal working directory. The default is $HOME . Features # Additional Lens features that can be installed by the user Metrics # Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed. User Mode # User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces. Removal # Use this setting to remove the current cluster.","title":"Settings"},{"location":"clusters/settings/#settings","text":"It is easy to configure Lens Clusters to your liking through its various settings. Right-click the name of the cluster in the left-side menu that you want to open the settings for. Click Settings .","title":"Settings"},{"location":"clusters/settings/#status","text":"Overview of the cluster status","title":"Status"},{"location":"clusters/settings/#cluster-status","text":"Cluster status information including the detected distribution, kernel version, API endpoint, and online status","title":"Cluster Status"},{"location":"clusters/settings/#general","text":"General cluster settings","title":"General"},{"location":"clusters/settings/#cluster-name","text":"The cluster name is inheritated by default from the kubeconfig file. Change the cluster name to another value by updating it here. Note that doing so does not update your kubeconfig file.","title":"Cluster Name"},{"location":"clusters/settings/#workspace","text":"This is the Lens workspace that the cluster is associated with. Change workspaces by selecting a different workspace from the dropdown menu. Create a new workspace by clicking workspace in \"Define cluster workspace\" above the dropdown menu. This option will take you the workspaces editor. Create a new workspace and then navigate back to cluster settings.","title":"Workspace"},{"location":"clusters/settings/#cluster-icon","text":"Lens randomly generates an icon to associate with each newly-created cluster. Use this setting to choose your own icon.","title":"Cluster Icon"},{"location":"clusters/settings/#http-proxy","text":"Some users will need to define an HTTP proxy for communicating with the Kubernetes API. Use this setting to do so.","title":"HTTP Proxy"},{"location":"clusters/settings/#prometheus","text":"Lens can be configured to query a Prometheus server installed in the cluster. Select a query format by choosing either to auto-detect or from the following configurations: Lens Helm Operator Prometheus Operator Stacklight To learn more about custom Prometheus configurations, please refer to this guide .","title":"Prometheus"},{"location":"clusters/settings/#working-directory","text":"Use this field to set the terminal working directory. The default is $HOME .","title":"Working Directory"},{"location":"clusters/settings/#features","text":"Additional Lens features that can be installed by the user","title":"Features"},{"location":"clusters/settings/#metrics","text":"Enable timeseries data visualization (Prometheus stack) for your cluster. Install this only if you don't have existing Prometheus stack installed.","title":"Metrics"},{"location":"clusters/settings/#user-mode","text":"User Mode feature enables non-admin users to see namespaces they have access to. This is achieved by configuring RBAC rules so that every authenticated user is granted to list namespaces.","title":"User Mode"},{"location":"clusters/settings/#removal","text":"Use this setting to remove the current cluster.","title":"Removal"},{"location":"contributing/","text":"Contributing # There are multiple ways you can contribute to Lens. Even if you are not a developer, you can still contribute. We are always looking for assistance with creating or updating documentation, testing the application, reporting, and troubleshooting issues. Here are some ways you can contribute! Development \u2013 Help make Lens better. Maintaining the Project \u2013 Become a community maintainer and help us maintain the project. Extension Development \u2013 Add integrations via Lens Extensions. Documentation \u2013 Help improve Lens documentation. Promotion \u2013 Show your support, be an ambassador to Lens, write blogs, and make videos! If you are an influencer, blogger, or journalist, feel free to spread the word ! Code of Conduct # This project adheres to the Contributor Covenant code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev.","title":"Overview"},{"location":"contributing/#contributing","text":"There are multiple ways you can contribute to Lens. Even if you are not a developer, you can still contribute. We are always looking for assistance with creating or updating documentation, testing the application, reporting, and troubleshooting issues. Here are some ways you can contribute! Development \u2013 Help make Lens better. Maintaining the Project \u2013 Become a community maintainer and help us maintain the project. Extension Development \u2013 Add integrations via Lens Extensions. Documentation \u2013 Help improve Lens documentation. Promotion \u2013 Show your support, be an ambassador to Lens, write blogs, and make videos! If you are an influencer, blogger, or journalist, feel free to spread the word !","title":"Contributing"},{"location":"contributing/#code-of-conduct","text":"This project adheres to the Contributor Covenant code of conduct. By participating and contributing to Lens, you are expected to uphold this code. Please report unacceptable behaviour to info@k8slens.dev.","title":"Code of Conduct"},{"location":"contributing/development/","text":"Development # Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens. When contributing to this repository, please consider first discussing the change you wish to make by opening an issue. Recommended Reading: # TypeScript (front-end/back-end) ReactJS (front-end, ui) MobX (app-state-management, back-end/front-end) ElectronJS (chrome/node) NodeJS (api docs) Local Development Environment # Prerequisites: Nodejs v12, make, yarn make dev - builds and starts the app make clean - cleanup local environment build artifacts Developing on Windows # On Windows we only support Git Bash (or similar shell) for running commands. Github Workflow # We Use Github Flow , so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below: Github Workflow Code Testing # All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here: Contributor's Guide to Testing License # By contributing, you agree that your contributions will be licensed as described in LICENSE .","title":"Development"},{"location":"contributing/development/#development","text":"Thank you for taking the time to make a contribution to Lens. The following document is a set of guidelines and instructions for contributing to Lens. When contributing to this repository, please consider first discussing the change you wish to make by opening an issue.","title":"Development"},{"location":"contributing/development/#recommended-reading","text":"TypeScript (front-end/back-end) ReactJS (front-end, ui) MobX (app-state-management, back-end/front-end) ElectronJS (chrome/node) NodeJS (api docs)","title":"Recommended Reading:"},{"location":"contributing/development/#local-development-environment","text":"Prerequisites: Nodejs v12, make, yarn make dev - builds and starts the app make clean - cleanup local environment build artifacts","title":"Local Development Environment"},{"location":"contributing/development/#developing-on-windows","text":"On Windows we only support Git Bash (or similar shell) for running commands.","title":"Developing on Windows"},{"location":"contributing/development/#github-workflow","text":"We Use Github Flow , so all code changes are tracked via Pull Requests. A detailed guide on the recommended workflow can be found below: Github Workflow","title":"Github Workflow"},{"location":"contributing/development/#code-testing","text":"All submitted PRs go through a set of tests and reviews. You can run most of these tests before a PR is submitted. In fact, we recommend it, because it will save on many possible review iterations and automated tests. The testing guidelines can be found here: Contributor's Guide to Testing","title":"Code Testing"},{"location":"contributing/development/#license","text":"By contributing, you agree that your contributions will be licensed as described in LICENSE .","title":"License"},{"location":"contributing/documentation/","text":"Documentation # We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source . Finding Documentation Issues to Work On # You can find a list of open documentation-related issues here . When you find something you would like to work on: Express your interest to start working on an issue via comments. One of the maintainers will assign the issue for you. You can start working on the issue. When you're done, simply submit a pull request. Requirements for Documentation Pull Requests # When you create a new pull request, we expect some requirements to be met. Follow this naming convention for Pull Requests: When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing. Testing Documentation Site Locally # Run a local instance of mkdocs in a docker container for developing the Lens Documentation. Prerequisites: docker, yarn make docs - local build and serve of mkdocs with auto update enabled Go to localhost:8000 .","title":"Documentation"},{"location":"contributing/documentation/#documentation","text":"We are glad to see you're interested in contributing to the Lens documentation. If this is the first Open Source project you've contributed to, we strongly suggest reading GitHub's excellent guide: How to Contribute to Open Source .","title":"Documentation"},{"location":"contributing/documentation/#finding-documentation-issues-to-work-on","text":"You can find a list of open documentation-related issues here . When you find something you would like to work on: Express your interest to start working on an issue via comments. One of the maintainers will assign the issue for you. You can start working on the issue. When you're done, simply submit a pull request.","title":"Finding Documentation Issues to Work On"},{"location":"contributing/documentation/#requirements-for-documentation-pull-requests","text":"When you create a new pull request, we expect some requirements to be met. Follow this naming convention for Pull Requests: When adding new documentation, add New Documentation: before the title. E.g. New Documentation: Getting Started When fixing documentation, add Fix Documentation: before the title. E.g. Fix Documentation: Getting Started When updating documentation, add Update Documentation: before the title. E.g. Update Documentation: Getting Started If your Pull Request closes an issue, you must write Closes #ISSUE_NUMBER where the ISSUE_NUMBER is the number in the end of the link url or the relevent issue. This will link your pull request to the issue, and when it is merged, the issue will close. For each pull request made, we run tests to check if there are any broken links, the markdown formatting is valid, and the linter is passing.","title":"Requirements for Documentation Pull Requests"},{"location":"contributing/documentation/#testing-documentation-site-locally","text":"Run a local instance of mkdocs in a docker container for developing the Lens Documentation. Prerequisites: docker, yarn make docs - local build and serve of mkdocs with auto update enabled Go to localhost:8000 .","title":"Testing Documentation Site Locally"},{"location":"contributing/github_workflow/","text":"Github Workflow # Fork The Project Adding the Forked Remote Create & Rebase Your Feature Branch Commit & Push Open a Pull Request Get a code review Squash commits Push Your Final Changes This guide assumes you have already cloned the upstream repo to your system via git clone. Fork The Project # Go to http://github.com/lensapp/lens On the top, right-hand side, click on \"fork\" and select your username for the fork destination. Adding the Forked Remote # export GITHUB_USER={ your github's username } cd $WORKDIR/lens git remote add $GITHUB_USER git@github.com:${GITHUB_USER}/lens.git # Prevent push to Upstream git remote set-url --push origin no_push # Set your fork remote as a default push target git push --set-upstream $GITHUB_USER master Your remotes should look something like this: \u279c git remote -v origin https://github.com/lensapp/lens (fetch) origin no_push (push) my_fork git@github.com:{ github_username }/lens.git (fetch) my_fork git@github.com:{ github_username }/lens.git (push) Create & Rebase Your Feature Branch # Create a feature branch: git branch -b my_feature_branch Rebase your branch: git fetch origin git rebase origin/master Current branch my_feature_branch is up to date. Please don't use git pull instead of the above fetch / rebase . git pull does a merge, which leaves merge commits. These make the commit history messy and violate the principle that commits ought to be individually understandable and useful. Commit & Push # Commit and sign your changes: git commit -m \"my commit title\" --signoff You can go back and edit/build/test some more, then commit --amend in a few cycles. When ready, push your changes to your fork's repository: git push --set-upstream my_fork my_feature_branch Open a Pull Request # See Github Docs . Get a code review # Once your pull request has been opened it will be assigned to one or more reviewers, and will go through a series of smoke tests. Commit changes made in response to review comments should be added to the same branch on your fork. Very small PRs are easy to review. Very large PRs are very difficult to review. Squashing Commits # Commits on your branch should represent meaningful milestones or units of work. Small commits that contain typo fixes, rebases, review feedbacks, etc should be squashed. To do that, it's best to perform an interactive rebase : Example # If you PR has 3 commits, count backwards from your last commit using HEAD~3 : git rebase -i HEAD~3 Output would be similar to this: pick f7f3f6d Changed some code pick 310154e fixed some typos pick a5f4a0d made some review changes # Rebase 710f0f8..a5f4a0d onto 710f0f8 # # Commands: # p, pick = use commit # r, reword = use commit, but edit the commit message # e, edit = use commit, but stop for amending # s, squash = use commit, but meld into previous commit # f, fixup = like \"squash\", but discard this commit's log message # x, exec = run command (the rest of the line) using shell # b, break = stop here (continue rebase later with 'git rebase --continue') # d, drop = remove commit # l, label