diff --git a/latest/404.html b/latest/404.html index aaad4c579d..46654eb321 100644 --- a/latest/404.html +++ b/latest/404.html @@ -541,6 +541,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -566,8 +578,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/clusters/adding-clusters/index.html b/latest/clusters/adding-clusters/index.html index b04768787d..1e8f08442b 100644 --- a/latest/clusters/adding-clusters/index.html +++ b/latest/clusters/adding-clusters/index.html @@ -588,6 +588,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -613,8 +625,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/clusters/removing-clusters/index.html b/latest/clusters/removing-clusters/index.html index bea06161b5..c0d691684d 100644 --- a/latest/clusters/removing-clusters/index.html +++ b/latest/clusters/removing-clusters/index.html @@ -559,6 +559,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -584,8 +596,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/clusters/settings/index.html b/latest/clusters/settings/index.html index 60b45d07c2..3d59a74edb 100644 --- a/latest/clusters/settings/index.html +++ b/latest/clusters/settings/index.html @@ -690,6 +690,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -715,8 +727,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/contributing/development/index.html b/latest/contributing/development/index.html index 852fb9c180..71017bab76 100644 --- a/latest/contributing/development/index.html +++ b/latest/contributing/development/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/contributing/documentation/index.html b/latest/contributing/documentation/index.html index 9646384d0f..4a637d9da6 100644 --- a/latest/contributing/documentation/index.html +++ b/latest/contributing/documentation/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/contributing/github_workflow/index.html b/latest/contributing/github_workflow/index.html index c73e428e62..e3c29c1e4b 100644 --- a/latest/contributing/github_workflow/index.html +++ b/latest/contributing/github_workflow/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/contributing/index.html b/latest/contributing/index.html index 9c780ecbe6..cac92ab8c8 100644 --- a/latest/contributing/index.html +++ b/latest/contributing/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/contributing/maintainers/index.html b/latest/contributing/maintainers/index.html index c8c6ce5ec0..00bc6a52a7 100644 --- a/latest/contributing/maintainers/index.html +++ b/latest/contributing/maintainers/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/contributing/promotion/index.html b/latest/contributing/promotion/index.html index 45b596b2af..8c9aa1495e 100644 --- a/latest/contributing/promotion/index.html +++ b/latest/contributing/promotion/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/contributing/testing/index.html b/latest/contributing/testing/index.html index 3821477b3c..b75e3aa0c4 100644 --- a/latest/contributing/testing/index.html +++ b/latest/contributing/testing/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html b/latest/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html index 9f8e1fb362..c4e341a632 100644 --- a/latest/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html +++ b/latest/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1012,13 +1024,13 @@

    Properties#

    templateContext#

    • templateContext: any

    -

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

    +

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

    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

    +

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

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

    Parameters:

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

    Abstract install#

    ▸ install(cluster: Cluster): Promise‹void›

    -

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

    +

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

    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:

    @@ -1070,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:109

    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:

    @@ -1095,7 +1107,7 @@ specified by the templateContext field. Templated files must end with the extens

    Abstract uninstall#

    ▸ uninstall(cluster: Cluster): Promise‹void›

    -

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

    +

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

    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:

    @@ -1119,7 +1131,7 @@ of this method should uninstall kubernetes resources using the kubernetes api (K

    Abstract updateStatus#

    ▸ updateStatus(cluster: Cluster): Promise‹ClusterFeatureStatus›

    -

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

    +

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

    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 @@ -1146,7 +1158,7 @@ can be upgraded so the implementation should set the canUpgrade field according

    Abstract upgrade#

    ▸ upgrade(cluster: Cluster): Promise‹void›

    -

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

    +

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

    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:

    @@ -1170,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:34

    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:38

    currentVersion#

    • currentVersion: null = null

    -

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

    +

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

    installed#

    • installed: false = false

    -

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

    +

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

    latestVersion#

    • latestVersion: null = null

    -

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

    +

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

    diff --git a/latest/extensions/api/classes/_core_api_stores_.cluster/index.html b/latest/extensions/api/classes/_core_api_stores_.cluster/index.html index 2e9122b46f..7954926846 100644 --- a/latest/extensions/api/classes/_core_api_stores_.cluster/index.html +++ b/latest/extensions/api/classes/_core_api_stores_.cluster/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1438,7 +1450,7 @@

    Constructors#

    constructor#

    + new Cluster(model: ClusterModel): Cluster

    -

    Defined in src/main/cluster.ts:239

    +

    Defined in src/main/cluster.ts:239

    Parameters:

    @@ -1458,194 +1470,194 @@

    Properties#

    accessible#

    • accessible: boolean = false

    -

    Defined in src/main/cluster.ts:139

    +

    Defined in src/main/cluster.ts:139

    Can user access cluster resources

    observable

    accessibleNamespaces#

    • accessibleNamespaces: string[] = []

    Implementation of ClusterModel.accessibleNamespaces

    -

    Defined in src/main/cluster.ts:200

    +

    Defined in src/main/cluster.ts:200

    List of accessible namespaces

    observable

    Protected activated#

    • activated: boolean = false

    -

    Defined in src/main/cluster.ts:80

    +

    Defined in src/main/cluster.ts:80

    allowedNamespaces#

    • allowedNamespaces: string[] = []

    -

    Defined in src/main/cluster.ts:187

    +

    Defined in src/main/cluster.ts:187

    List of allowed namespaces

    observable

    allowedResources#

    • allowedResources: string[] = []

    -

    Defined in src/main/cluster.ts:194

    +

    Defined in src/main/cluster.ts:194

    List of allowed resources

    observable

    internal

    apiUrl#

    • apiUrl: string

    -

    Defined in src/main/cluster.ts:114

    +

    Defined in src/main/cluster.ts:114

    Kubernetes API server URL

    observable

    contextHandler#

    • contextHandler: ContextHandler

    -

    Defined in src/main/cluster.ts:71

    +

    Defined in src/main/cluster.ts:71

    Context handler

    internal

    contextName#

    • contextName: string

    Implementation of ClusterModel.contextName

    -

    Defined in src/main/cluster.ts:96

    +

    Defined in src/main/cluster.ts:96

    Kubeconfig context name

    observable

    disconnected#

    • disconnected: boolean = true

    -

    Defined in src/main/cluster.ts:157

    +

    Defined in src/main/cluster.ts:157

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

    observable

    enabled#

    • enabled: boolean = false

    -

    Defined in src/main/cluster.ts:127

    +

    Defined in src/main/cluster.ts:127

    Is cluster instance enabled (disabled clusters are currently hidden)

    observable

    Protected eventDisposers#

    • eventDisposers: Function[] = []

    -

    Defined in src/main/cluster.ts:79

    +

    Defined in src/main/cluster.ts:79

    failureReason#

    • failureReason: string

    -

    Defined in src/main/cluster.ts:163

    +

    Defined in src/main/cluster.ts:163

    Connection failure reason

    observable

    id#

    • id: ClusterId

    Implementation of ClusterModel.id

    -

    Defined in src/main/cluster.ts:59

    +

    Defined in src/main/cluster.ts:59

    Unique id for a cluster

    initialized#

    • initialized: boolean = false

    -

    Defined in src/main/cluster.ts:90

    +

    Defined in src/main/cluster.ts:90

    Is cluster object initialized

    observable

    isAdmin#

    • isAdmin: boolean = false

    -

    Defined in src/main/cluster.ts:169

    +

    Defined in src/main/cluster.ts:169

    Does user have admin like access

    observable

    kubeConfigPath#

    • kubeConfigPath: string

    Implementation of ClusterModel.kubeConfigPath

    -

    Defined in src/main/cluster.ts:108

    +

    Defined in src/main/cluster.ts:108

    Path to kubeconfig

    observable

    kubeCtl#

    • kubeCtl: Kubectl

    -

    Defined in src/main/cluster.ts:65

    +

    Defined in src/main/cluster.ts:65

    Kubectl

    internal

    kubeProxyUrl#

    • kubeProxyUrl: string

    -

    Defined in src/main/cluster.ts:121

    +

    Defined in src/main/cluster.ts:121

    Internal authentication proxy URL

    observable

    internal

    Protected kubeconfigManager#

    • kubeconfigManager: KubeconfigManager

    -

    Defined in src/main/cluster.ts:78

    +

    Defined in src/main/cluster.ts:78

    metadata#

    • metadata: ClusterMetadata

    Implementation of ClusterModel.metadata

    -

    Defined in src/main/cluster.ts:181

    +

    Defined in src/main/cluster.ts:181

    Metadata

    observable

    online#

    • online: boolean = false

    -

    Defined in src/main/cluster.ts:133

    +

    Defined in src/main/cluster.ts:133

    Is cluster online

    observable

    ownerRef#

    • ownerRef: string

    Implementation of ClusterModel.ownerRef

    -

    Defined in src/main/cluster.ts:77

    +

    Defined in src/main/cluster.ts:77

    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:175

    +

    Defined in src/main/cluster.ts:175

    Preferences

    observable

    ready#

    • ready: boolean = false

    -

    Defined in src/main/cluster.ts:145

    +

    Defined in src/main/cluster.ts:145

    Is cluster instance in usable state

    observable

    reconnecting#

    • reconnecting: boolean = false

    -

    Defined in src/main/cluster.ts:151

    +

    Defined in src/main/cluster.ts:151

    Is cluster currently reconnecting

    observable

    whenInitialized#

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

    -

    Defined in src/main/cluster.ts:82

    +

    Defined in src/main/cluster.ts:82

    whenReady#

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

    -

    Defined in src/main/cluster.ts:83

    +

    Defined in src/main/cluster.ts:83

    workspace#

    • workspace: WorkspaceId

    Implementation of ClusterModel.workspace

    -

    Defined in src/main/cluster.ts:102

    +

    Defined in src/main/cluster.ts:102

    Workspace id

    observable

    Accessors#

    available#

    • get available(): boolean

    -

    Defined in src/main/cluster.ts:207

    +

    Defined in src/main/cluster.ts:207

    Is cluster available

    computed

    Returns: boolean

    isManaged#

    • get isManaged(): boolean

    -

    Defined in src/main/cluster.ts:253

    +

    Defined in src/main/cluster.ts:253

    Is cluster managed by an extension

    Returns: boolean

    name#

    • get name(): string

    -

    Defined in src/main/cluster.ts:216

    +

    Defined in src/main/cluster.ts:216

    Cluster name

    computed

    Returns: string

    prometheusPreferences#

    • get prometheusPreferences(): ClusterPrometheusPreferences

    -

    Defined in src/main/cluster.ts:226

    +

    Defined in src/main/cluster.ts:226

    Prometheus preferences

    computed

    internal

    @@ -1653,13 +1665,13 @@

    version#

    • get version(): string

    -

    Defined in src/main/cluster.ts:237

    +

    Defined in src/main/cluster.ts:237

    Kubernetes version

    Returns: string

    Methods#

    activate#

    ▸ activate(force: boolean): Promise‹void›

    -

    Defined in src/main/cluster.ts:324

    +

    Defined in src/main/cluster.ts:324

    internal

    Parameters:

    @@ -1684,13 +1696,13 @@

    Protected bindEvents#

    ▸ bindEvents(): void

    -

    Defined in src/main/cluster.ts:294

    +

    Defined in src/main/cluster.ts:294

    internal

    Returns: void

    canI#

    ▸ canI(resourceAttributes: V1ResourceAttributes): Promise‹boolean›

    -

    Defined in src/main/cluster.ts:522

    +

    Defined in src/main/cluster.ts:522

    internal

    Parameters:

    @@ -1713,39 +1725,39 @@

    disconnect#

    ▸ disconnect(): void

    -

    Defined in src/main/cluster.ts:373

    +

    Defined in src/main/cluster.ts:373

    internal

    Returns: void

    Protected ensureKubectl#

    ▸ ensureKubectl(): Promise‹boolean›

    -

    Defined in src/main/cluster.ts:354

    +

    Defined in src/main/cluster.ts:354

    internal

    Returns: Promise‹boolean›

    Protected getAllowedNamespaces#

    ▸ getAllowedNamespaces(): Promise‹string[]›

    -

    Defined in src/main/cluster.ts:621

    +

    Defined in src/main/cluster.ts:621

    Returns: Promise‹string[]›

    Protected getAllowedResources#

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

    -

    Defined in src/main/cluster.ts:641

    +

    Defined in src/main/cluster.ts:641

    Returns: Promise‹("namespaces" | "nodes" | "events" | "resourcequotas" | "services" | "secrets" | "configmaps" | "ingresses" | "networkpolicies" | "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:480

    +

    Defined in src/main/cluster.ts:480

    Returns: Promise‹ClusterStatus›

    Protected getKubeconfig#

    ▸ getKubeconfig(): KubeConfig

    -

    Defined in src/main/cluster.ts:435

    +

    Defined in src/main/cluster.ts:435

    Returns: KubeConfig

    getMeta#

    ▸ getMeta(): object

    -

    Defined in src/main/cluster.ts:609

    +

    Defined in src/main/cluster.ts:609

    Returns: object

    @@ -1801,25 +1813,25 @@

    getProxyKubeconfig#

    ▸ getProxyKubeconfig(): KubeConfig

    -

    Defined in src/main/cluster.ts:442

    +

    Defined in src/main/cluster.ts:442

    internal

    Returns: KubeConfig

    getProxyKubeconfigPath#

    ▸ getProxyKubeconfigPath(): string

    -

    Defined in src/main/cluster.ts:449

    +

    Defined in src/main/cluster.ts:449

    internal

    Returns: string

    getState#

    ▸ getState(): ClusterState

    -

    Defined in src/main/cluster.ts:571

    +

    Defined in src/main/cluster.ts:571

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

    Returns: ClusterState

    init#

    ▸ init(port: number): Promise‹void›

    -

    Defined in src/main/cluster.ts:272

    +

    Defined in src/main/cluster.ts:272

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

    internal

    Parameters:

    @@ -1843,13 +1855,13 @@

    isClusterAdmin#

    ▸ isClusterAdmin(): Promise‹boolean›

    -

    Defined in src/main/cluster.ts:543

    +

    Defined in src/main/cluster.ts:543

    internal

    Returns: Promise‹boolean›

    Protected k8sRequest#

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

    -

    Defined in src/main/cluster.ts:453

    +

    Defined in src/main/cluster.ts:453

    Type parameters:

    ▪ T

    Parameters:

    @@ -1878,7 +1890,7 @@

    pushState#

    ▸ pushState(state: ClusterState): void

    -

    Defined in src/main/cluster.ts:603

    +

    Defined in src/main/cluster.ts:603

    internal

    Parameters:

    @@ -1903,13 +1915,13 @@

    reconnect#

    ▸ reconnect(): Promise‹void›

    -

    Defined in src/main/cluster.ts:363

    +

    Defined in src/main/cluster.ts:363

    internal

    Returns: Promise‹void›

    refresh#

    ▸ refresh(opts: ClusterRefreshOptions): Promise‹void›

    -

    Defined in src/main/cluster.ts:389

    +

    Defined in src/main/cluster.ts:389

    internal

    Parameters:

    @@ -1934,25 +1946,25 @@

    refreshAllowedResources#

    ▸ refreshAllowedResources(): Promise‹void›

    -

    Defined in src/main/cluster.ts:430

    +

    Defined in src/main/cluster.ts:430

    internal

    Returns: Promise‹void›

    refreshConnectionStatus#

    ▸ refreshConnectionStatus(): Promise‹void›

    -

    Defined in src/main/cluster.ts:420

    +

    Defined in src/main/cluster.ts:420

    internal

    Returns: Promise‹void›

    refreshMetadata#

    ▸ refreshMetadata(): Promise‹void›

    -

    Defined in src/main/cluster.ts:409

    +

    Defined in src/main/cluster.ts:409

    internal

    Returns: Promise‹void›

    setState#

    ▸ setState(state: ClusterState): void

    -

    Defined in src/main/cluster.ts:595

    +

    Defined in src/main/cluster.ts:595

    internal

    Parameters:

    @@ -1975,18 +1987,18 @@

    toJSON#

    ▸ toJSON(): ClusterModel

    -

    Defined in src/main/cluster.ts:551

    +

    Defined in src/main/cluster.ts:551

    Returns: ClusterModel

    Protected unbindEvents#

    ▸ unbindEvents(): void

    -

    Defined in src/main/cluster.ts:314

    +

    Defined in src/main/cluster.ts:314

    internal

    Returns: void

    updateModel#

    ▸ updateModel(model: ClusterModel): void

    -

    Defined in src/main/cluster.ts:262

    +

    Defined in src/main/cluster.ts:262

    Update cluster data model

    Parameters:

    diff --git a/latest/extensions/api/classes/_core_api_stores_.clusterstore/index.html b/latest/extensions/api/classes/_core_api_stores_.clusterstore/index.html index 61830503e2..93f4c9e8c8 100644 --- a/latest/extensions/api/classes/_core_api_stores_.clusterstore/index.html +++ b/latest/extensions/api/classes/_core_api_stores_.clusterstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1013,17 +1025,17 @@

    Accessors#

    activeCluster#

    • get activeCluster(): Cluster

    -

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

    +

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

    Get active cluster (a cluster which is currently visible)

    Returns: Cluster

    activeClusterId#

    • get activeClusterId(): string

    -

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

    +

    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

    +

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

    Set active cluster id

    Parameters:

    @@ -1044,31 +1056,31 @@

    clusters#

    • get clusters(): ObservableMap‹string, Cluster›

    -

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

    +

    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:52

    +

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

    Array of all clusters

    Returns: Cluster[]

    connectedClustersList#

    • get connectedClustersList(): Cluster[]

    -

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

    +

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

    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:59

    +

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

    Array of all enabled clusters

    Returns: Cluster[]

    Methods#

    addCluster#

    ▸ addCluster(model: ClusterModel | Cluster): Cluster

    -

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

    +

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

    Add a cluster to store

    Parameters:

    @@ -1091,7 +1103,7 @@

    addClusters#

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

    -

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

    +

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

    Add clusters to store

    Parameters:

    @@ -1114,7 +1126,7 @@

    getById#

    ▸ getById(id: ClusterId): Cluster

    -

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

    +

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

    Get cluster object by cluster id

    Parameters:

    @@ -1137,7 +1149,7 @@

    getByWorkspaceId#

    ▸ getByWorkspaceId(workspaceId: string): Cluster[]

    -

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

    +

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

    Get all clusters belonging to a workspace

    Parameters:

    @@ -1160,7 +1172,7 @@

    removeById#

    ▸ removeById(clusterId: ClusterId): Promise‹void›

    -

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

    +

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

    Remove a cluster from store by id

    Parameters:

    @@ -1183,7 +1195,7 @@

    removeByWorkspaceId#

    ▸ removeByWorkspaceId(workspaceId: string): void

    -

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

    +

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

    Remove all clusters belonging to a workspaces

    Parameters:

    @@ -1206,7 +1218,7 @@

    removeCluster#

    ▸ removeCluster(model: ClusterModel): Promise‹void›

    -

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

    +

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

    Remove a cluster from store

    Parameters:

    @@ -1230,7 +1242,7 @@

    Static getInstance#

    ▸ getInstance‹T›(...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:

    @@ -1253,7 +1265,7 @@

    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/latest/extensions/api/classes/_core_api_stores_.extensionstore/index.html b/latest/extensions/api/classes/_core_api_stores_.extensionstore/index.html index 94ee47e135..109150cd41 100644 --- a/latest/extensions/api/classes/_core_api_stores_.extensionstore/index.html +++ b/latest/extensions/api/classes/_core_api_stores_.extensionstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1163,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:

    @@ -1183,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 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:133

    +

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

    Parameters:

    ▪ callback: function

    ▸ (): void

    @@ -1246,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:128

    +

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

    Returns: void

    enableSync#

    ▸ enableSync(): void

    Inherited from ExtensionStore.enableSync

    -

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

    +

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

    Returns: void

    Protected Abstract fromStore#

    ▸ fromStore(data: T): void

    Inherited from ExtensionStore.fromStore

    -

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

    +

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

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

    Parameters:

    @@ -1289,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:

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

    Protected onModelChange#

    ▸ onModelChange(model: T): Promise‹void›

    Inherited from ExtensionStore.onModelChange

    -

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

    +

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

    Parameters:

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

    Protected onSync#

    ▸ onSync(model: T): void

    Inherited from ExtensionStore.onSync

    -

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

    +

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

    Parameters:

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

    Protected onSyncFromMain#

    ▸ onSyncFromMain(model: T): void

    Inherited from ExtensionStore.onSyncFromMain

    -

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

    +

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

    Parameters:

    @@ -1384,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:

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

    Abstract toJSON#

    ▸ toJSON(): T

    Inherited from ExtensionStore.toJSON

    -

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

    +

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

    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 @@ -1415,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:123

    +

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

    Returns: void

    Static getInstance#

    ▸ getInstance‹T›(...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:

    @@ -1444,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/latest/extensions/api/classes/_core_api_stores_.workspace/index.html b/latest/extensions/api/classes/_core_api_stores_.workspace/index.html index 07e2dde337..5d438d0be0 100644 --- a/latest/extensions/api/classes/_core_api_stores_.workspace/index.html +++ b/latest/extensions/api/classes/_core_api_stores_.workspace/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1046,7 +1058,7 @@

    Constructors#

    constructor#

    + new Workspace(data: WorkspaceModel): Workspace

    -

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

    +

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

    Parameters:

    @@ -1067,13 +1079,13 @@

    Optional description#

    • description? : string

    Implementation of WorkspaceModel.description

    -

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

    +

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

    Workspace description

    observable

    enabled#

    • enabled: boolean

    -

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

    +

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

    Is workspace enabled

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

    observable

    @@ -1081,47 +1093,47 @@

    id#

    • id: WorkspaceId

    Implementation of WorkspaceModel.id

    -

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

    +

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

    Unique id for workspace

    observable

    Optional lastActiveClusterId#

    • lastActiveClusterId? : ClusterId

    Implementation of WorkspaceModel.lastActiveClusterId

    -

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

    +

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

    Last active cluster id

    observable

    name#

    • name: string

    Implementation of WorkspaceModel.name

    -

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

    +

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

    Workspace name

    observable

    Optional ownerRef#

    • ownerRef? : string

    Implementation of WorkspaceModel.ownerRef

    -

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

    +

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

    Workspace owner reference

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

    observable

    Accessors#

    isManaged#

    • get isManaged(): boolean

    -

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

    +

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

    Is workspace managed by an extension

    Returns: boolean

    Methods#

    getState#

    ▸ getState(): WorkspaceState

    -

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

    +

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

    Get workspace state

    Returns: WorkspaceState

    pushState#

    ▸ pushState(state: WorkspaceState): void

    -

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

    +

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

    Push state

    interal

    Parameters:

    @@ -1147,7 +1159,7 @@

    setState#

    ▸ setState(state: WorkspaceState): void

    -

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

    +

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

    Parameters:

    @@ -1169,7 +1181,7 @@

    toJSON#

    ▸ toJSON(): WorkspaceModel

    -

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

    +

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

    Returns: WorkspaceModel

    diff --git a/latest/extensions/api/classes/_core_api_stores_.workspacestore/index.html b/latest/extensions/api/classes/_core_api_stores_.workspacestore/index.html index 53eb76d3a7..db935a1f7e 100644 --- a/latest/extensions/api/classes/_core_api_stores_.workspacestore/index.html +++ b/latest/extensions/api/classes/_core_api_stores_.workspacestore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1036,22 +1048,22 @@

    Properties#

    Static defaultId#

    ▪ defaultId: WorkspaceId = InternalWorkspaceStore.defaultId

    -

    Defined in src/extensions/stores/workspace-store.ts:17

    +

    Defined in src/extensions/stores/workspace-store.ts:17

    Default workspace id, this workspace is always present

    Accessors#

    currentWorkspace#

    • get currentWorkspace(): Workspace

    -

    Defined in src/extensions/stores/workspace-store.ts:43

    +

    Defined in src/extensions/stores/workspace-store.ts:43

    Currently active workspace

    Returns: Workspace

    currentWorkspaceId#

    • get currentWorkspaceId(): string

    -

    Defined in src/extensions/stores/workspace-store.ts:22

    +

    Defined in src/extensions/stores/workspace-store.ts:22

    Currently active workspace id

    Returns: string

    • set currentWorkspaceId(id: string): void

    -

    Defined in src/extensions/stores/workspace-store.ts:29

    +

    Defined in src/extensions/stores/workspace-store.ts:29

    Set active workspace id

    Parameters:

    @@ -1072,25 +1084,25 @@

    enabledWorkspacesList#

    • get enabledWorkspacesList(): Workspace[]

    -

    Defined in src/extensions/stores/workspace-store.ts:57

    +

    Defined in src/extensions/stores/workspace-store.ts:57

    Array of all enabled (visible) workspaces

    Returns: Workspace[]

    workspaces#

    • get workspaces(): ObservableMap‹string, Workspace›

    -

    Defined in src/extensions/stores/workspace-store.ts:36

    +

    Defined in src/extensions/stores/workspace-store.ts:36

    Map of all workspaces

    Returns: ObservableMap‹string, Workspace›

    workspacesList#

    • get workspacesList(): Workspace[]

    -

    Defined in src/extensions/stores/workspace-store.ts:50

    +

    Defined in src/extensions/stores/workspace-store.ts:50

    Array of all workspaces

    Returns: Workspace[]

    Methods#

    addWorkspace#

    ▸ addWorkspace(workspace: Workspace): Workspace‹›

    -

    Defined in src/extensions/stores/workspace-store.ts:89

    +

    Defined in src/extensions/stores/workspace-store.ts:89

    Add a workspace to store

    Parameters:

    @@ -1113,7 +1125,7 @@

    getById#

    ▸ getById(id: WorkspaceId): Workspace

    -

    Defined in src/extensions/stores/workspace-store.ts:65

    +

    Defined in src/extensions/stores/workspace-store.ts:65

    Get workspace by id

    Parameters:

    @@ -1136,7 +1148,7 @@

    getByName#

    ▸ getByName(name: string): Workspace

    -

    Defined in src/extensions/stores/workspace-store.ts:73

    +

    Defined in src/extensions/stores/workspace-store.ts:73

    Get workspace by name

    Parameters:

    @@ -1159,7 +1171,7 @@

    removeWorkspace#

    ▸ removeWorkspace(workspace: Workspace): void

    -

    Defined in src/extensions/stores/workspace-store.ts:105

    +

    Defined in src/extensions/stores/workspace-store.ts:105

    Remove workspace from store

    Parameters:

    @@ -1182,7 +1194,7 @@

    removeWorkspaceById#

    ▸ removeWorkspaceById(id: WorkspaceId): void

    -

    Defined in src/extensions/stores/workspace-store.ts:113

    +

    Defined in src/extensions/stores/workspace-store.ts:113

    Remove workspace by id

    Parameters:

    @@ -1205,7 +1217,7 @@

    setActive#

    ▸ setActive(id: string): void

    -

    Defined in src/extensions/stores/workspace-store.ts:81

    +

    Defined in src/extensions/stores/workspace-store.ts:81

    Set active workspace

    Parameters:

    @@ -1230,7 +1242,7 @@

    updateWorkspace#

    ▸ updateWorkspace(workspace: Workspace): void

    -

    Defined in src/extensions/stores/workspace-store.ts:97

    +

    Defined in src/extensions/stores/workspace-store.ts:97

    Update a workspace in store

    Parameters:

    @@ -1254,7 +1266,7 @@

    Static getInstance#

    ▸ getInstance‹T›(...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:

    @@ -1277,7 +1289,7 @@

    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/latest/extensions/api/classes/_core_api_utils_.singleton/index.html b/latest/extensions/api/classes/_core_api_utils_.singleton/index.html index e99cf1b0b8..52ccee6494 100644 --- a/latest/extensions/api/classes/_core_api_utils_.singleton/index.html +++ b/latest/extensions/api/classes/_core_api_utils_.singleton/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -885,7 +897,7 @@

    Methods#

    Static getInstance#

    ▸ getInstance‹T›(...args: ConstructorParameters‹Constructor‹T››): T

    -

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

    +

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

    Type parameters:

    ▪ T

    Parameters:

    @@ -907,7 +919,7 @@

    Static resetInstance#

    ▸ resetInstance(): void

    -

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

    +

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

    Returns: void

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.badge/index.html b/latest/extensions/api/classes/_renderer_api_components_.badge/index.html index af7f1e9208..036e4cd9ed 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.badge/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.badge/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1476,7 +1488,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.button/index.html b/latest/extensions/api/classes/_renderer_api_components_.button/index.html index 873781c4a7..a5ffe6c123 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.button/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.button/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1253,7 +1265,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    -

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

    +

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

    Returns: Element‹›

    Optional shouldComponentUpdate#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.checkbox/index.html b/latest/extensions/api/classes/_renderer_api_components_.checkbox/index.html index 38f3a92eba..f0086470f3 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.checkbox/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.checkbox/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1270,12 +1282,12 @@ lifecycle events from running.

    getValue#

    ▸ getValue(): boolean

    -

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

    +

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

    Returns: boolean

    onChange#

    ▸ onChange(evt: ChangeEvent‹HTMLInputElement›): void

    -

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

    +

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

    Parameters:

    @@ -1295,7 +1307,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    -

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

    +

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

    Returns: Element‹›

    Optional shouldComponentUpdate#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html b/latest/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html index e73b6dca87..99e9301dc2 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1315,7 +1327,7 @@ Should be used with type annotation or static contextType.

    isSaving#

    • isSaving: boolean = false

    -

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

    +

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

    props#

    • props: Readonly‹ConfirmDialogProps› & Readonly‹object›

    @@ -1359,15 +1371,15 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Static isOpen#

    ▪ isOpen: boolean = false

    -

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

    +

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

    Static params#

    ▪ params: ConfirmDialogParams

    -

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

    +

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

    Accessors#

    params#

    • get params(): ConfirmDialogParams

    -

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

    +

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

    Returns: ConfirmDialogParams

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1458,7 +1470,7 @@ prevents this from being invoked.

    close#

    ▸ close(): void

    -

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

    +

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

    Returns: void

    Optional componentDidCatch#

    @@ -1658,18 +1670,18 @@ lifecycle events from running.

    ok#

    ▸ ok(): Promise‹void›

    -

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

    +

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

    Returns: Promise‹void›

    onClose#

    ▸ onClose(): void

    -

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

    +

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

    Returns: void

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    @@ -1721,12 +1733,12 @@ and componentDidUpdate will not be called.

    Static close#

    ▸ close(): void

    -

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

    +

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

    Returns: void

    Static open#

    ▸ open(params: ConfirmDialogParams): void

    -

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

    +

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

    Parameters:

    @@ -1746,19 +1758,19 @@ and componentDidUpdate will not be called.

    Object literals#

    defaultParams#

    ▪ defaultParams: object#

    -

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

    +

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

    icon#

    • icon: Element‹› =

    -

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

    +

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

    labelCancel#

    • labelCancel: Element‹› = Cancel

    -

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

    +

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

    labelOk#

    • labelOk: Element‹› = Ok

    -

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

    +

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

    ok#

    • ok: any = noop

    -

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

    +

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

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.cubespinner/index.html b/latest/extensions/api/classes/_renderer_api_components_.cubespinner/index.html index 30a1ae4807..ea9bed1a07 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.cubespinner/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.cubespinner/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1476,7 +1488,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.dialog/index.html b/latest/extensions/api/classes/_renderer_api_components_.dialog/index.html index fbf69069f0..88a3d40157 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.dialog/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.dialog/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1223,16 +1235,16 @@

    Properties#

    closeOnNavigate#

    • closeOnNavigate: IReactionDisposer = reaction(() => navigation.getPath(), () => this.close())

    -

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

    +

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

    Accessors#

    elem#

    • get elem(): HTMLElement

    -

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

    +

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

    Returns: HTMLElement

    isOpen#

    • get isOpen(): boolean

    -

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

    +

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

    Returns: boolean

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1323,7 +1335,7 @@ prevents this from being invoked.

    close#

    ▸ close(): void

    -

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

    +

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

    Returns: void

    Optional componentDidCatch#

    @@ -1356,13 +1368,13 @@ the entire component tree to unmount.

    componentDidMount#

    ▸ componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

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

    +

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

    Returns: void

    componentDidUpdate#

    ▸ componentDidUpdate(prevProps: DialogProps): void

    Overrides PageLayout.componentDidUpdate

    -

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

    +

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

    Parameters:

    @@ -1430,7 +1442,7 @@ prevents this from being invoked.

    componentWillUnmount#

    ▸ componentWillUnmount(): void

    Overrides WizardLayout.componentWillUnmount

    -

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

    +

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

    Returns: void

    Optional componentWillUpdate#

    @@ -1501,7 +1513,7 @@ lifecycle events from running.

    onClickOutside#

    ▸ onClickOutside(evt: MouseEvent): void

    -

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

    +

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

    Parameters:

    @@ -1521,12 +1533,12 @@ lifecycle events from running.

    onClose#

    ▸ onClose(): void

    -

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

    +

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

    Returns: void

    onEscapeKey#

    ▸ onEscapeKey(evt: KeyboardEvent): void

    -

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

    +

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

    Parameters:

    @@ -1546,17 +1558,17 @@ lifecycle events from running.

    onOpen#

    ▸ onOpen(): void

    -

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

    +

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

    Returns: void

    open#

    ▸ open(): void

    -

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

    +

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

    Returns: void

    render#

    ▸ render(): ReactPortal‹›

    -

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

    +

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

    Returns: ReactPortal‹›

    Optional shouldComponentUpdate#

    @@ -1596,7 +1608,7 @@ and componentDidUpdate will not be called.

    toggle#

    ▸ toggle(isOpen: boolean): void

    -

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

    +

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

    Parameters:

    @@ -1616,38 +1628,38 @@ and componentDidUpdate will not be called.

    Object literals#

    state#

    ▪ state: object#

    -

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

    +

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

    isOpen#

    • isOpen: boolean = this.props.isOpen

    -

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

    +

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

    Static defaultProps#

    ▪ defaultProps: object#

    -

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

    +

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

    animated#

    • animated: true = true

    -

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

    +

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

    close#

    • close: any = noop

    -

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

    +

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

    isOpen#

    • isOpen: false = false

    -

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

    +

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

    • modal: true = true

    -

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

    +

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

    onClose#

    • onClose: any = noop

    -

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

    +

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

    onOpen#

    • onOpen: any = noop

    -

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

    +

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

    open#

    • open: any = noop

    -

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

    +

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

    pinned#

    • pinned: false = false

    -

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

    +

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

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.drawer/index.html b/latest/extensions/api/classes/_renderer_api_components_.drawer/index.html index 458c8d4728..64d981bc7a 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.drawer/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.drawer/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1250,7 +1262,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Static defaultProps#

    ▪ defaultProps: object = defaultProps as object

    -

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

    +

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

    Methods#

    Optional UNSAFE_componentWillMount#

    ▸ UNSAFE_componentWillMount(): void

    @@ -1340,7 +1352,7 @@ prevents this from being invoked.

    close#

    ▸ close(): void

    -

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

    +

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

    Returns: void

    Optional componentDidCatch#

    @@ -1373,7 +1385,7 @@ the entire component tree to unmount.

    componentDidMount#

    ▸ componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

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

    +

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

    Returns: void

    Optional componentDidUpdate#

    @@ -1457,7 +1469,7 @@ prevents this from being invoked.

    componentWillUnmount#

    ▸ componentWillUnmount(): void

    Overrides WizardLayout.componentWillUnmount

    -

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

    +

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

    Returns: void

    Optional componentWillUpdate#

    @@ -1537,7 +1549,7 @@ lifecycle events from running.

    onClickOutside#

    ▸ onClickOutside(evt: MouseEvent): void

    -

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

    +

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

    Parameters:

    @@ -1557,7 +1569,7 @@ lifecycle events from running.

    onEscapeKey#

    ▸ onEscapeKey(evt: KeyboardEvent): void

    -

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

    +

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

    Parameters:

    @@ -1577,7 +1589,7 @@ lifecycle events from running.

    onMouseDown#

    ▸ onMouseDown(evt: MouseEvent): void

    -

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

    +

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

    Parameters:

    @@ -1598,17 +1610,17 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    restoreScrollPos#

    ▸ restoreScrollPos(): void

    -

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

    +

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

    Returns: void

    saveScrollPos#

    ▸ saveScrollPos(): void

    -

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

    +

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

    Returns: void

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.draweritem/index.html b/latest/extensions/api/classes/_renderer_api_components_.draweritem/index.html index 529f5f3784..36eb0c0684 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.draweritem/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.draweritem/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1476,7 +1488,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html b/latest/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html index ff31315abb..10667e2cdf 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1177,7 +1189,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    state#

    • state: State

    Overrides PageLayout.state

    -

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

    +

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

    Static Optional contextType#

    ▪ contextType? : Context‹any›

    @@ -1482,7 +1494,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    @@ -1534,7 +1546,7 @@ and componentDidUpdate will not be called.

    toggle#

    ▸ toggle(): void

    -

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

    +

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

    Returns: void

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.drawertitle/index.html b/latest/extensions/api/classes/_renderer_api_components_.drawertitle/index.html index 6a9214d072..a56f5e05a4 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.drawertitle/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.drawertitle/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1476,7 +1488,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.icon/index.html b/latest/extensions/api/classes/_renderer_api_components_.icon/index.html index e1936c7cc3..980eb0b679 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.icon/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.icon/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1074,7 +1086,7 @@

    Accessors#

    isInteractive#

    • get isInteractive(): boolean

    -

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

    +

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

    Returns: boolean

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1351,7 +1363,7 @@ lifecycle events from running.

    onClick#

    ▸ onClick(evt: MouseEvent): void

    -

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

    +

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

    Parameters:

    @@ -1371,7 +1383,7 @@ lifecycle events from running.

    onKeyDown#

    ▸ onKeyDown(evt: KeyboardEvent‹any›): void

    -

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

    +

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

    Parameters:

    @@ -1391,7 +1403,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    -

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

    +

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

    Returns: Element‹›

    Optional shouldComponentUpdate#

    @@ -1431,10 +1443,10 @@ and componentDidUpdate will not be called.

    Object literals#

    Static defaultProps#

    ▪ defaultProps: object#

    -

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

    +

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

    focusable#

    • focusable: true = true

    -

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

    +

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

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.input/index.html b/latest/extensions/api/classes/_renderer_api_components_.input/index.html index 77f204cad4..79131d82af 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.input/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.input/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1378,7 +1390,7 @@ Should be used with type annotation or static contextType.

    input#

    • input: InputElement

    -

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

    +

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

    props#

    • props: Readonly‹InputProps› & Readonly‹object›

    @@ -1398,7 +1410,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    validators#

    • validators: InputValidator[] = []

    -

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

    +

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

    Static Optional contextType#

    ▪ contextType? : Context‹any›

    @@ -1421,16 +1433,16 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Static defaultProps#

    ▪ defaultProps: object = defaultProps as object

    -

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

    +

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

    Accessors#

    isUncontrolled#

    • get isUncontrolled(): boolean

    -

    Defined in src/renderer/components/input/input.tsx:258

    +

    Defined in src/renderer/components/input/input.tsx:258

    Returns: boolean

    showMaxLenIndicator#

    • get showMaxLenIndicator(): boolean

    -

    Defined in src/renderer/components/input/input.tsx:252

    +

    Defined in src/renderer/components/input/input.tsx:252

    Returns: boolean

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1521,7 +1533,7 @@ prevents this from being invoked.

    bindRef#

    ▸ bindRef(elem: InputElement): void

    -

    Defined in src/renderer/components/input/input.tsx:285

    +

    Defined in src/renderer/components/input/input.tsx:285

    Parameters:

    @@ -1541,7 +1553,7 @@ prevents this from being invoked.

    blur#

    ▸ blur(): void

    -

    Defined in src/renderer/components/input/input.tsx:95

    +

    Defined in src/renderer/components/input/input.tsx:95

    Returns: void

    Optional componentDidCatch#

    @@ -1574,13 +1586,13 @@ the entire component tree to unmount.

    componentDidMount#

    ▸ componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

    Defined in src/renderer/components/input/input.tsx:262

    +

    Defined in src/renderer/components/input/input.tsx:262

    Returns: void

    componentDidUpdate#

    ▸ componentDidUpdate(prevProps: InputProps): void

    Overrides PageLayout.componentDidUpdate

    -

    Defined in src/renderer/components/input/input.tsx:267

    +

    Defined in src/renderer/components/input/input.tsx:267

    Parameters:

    @@ -1691,7 +1703,7 @@ prevents this from being invoked.

    focus#

    ▸ focus(): void

    -

    Defined in src/renderer/components/input/input.tsx:91

    +

    Defined in src/renderer/components/input/input.tsx:91

    Returns: void

    forceUpdate#

    @@ -1735,17 +1747,17 @@ lifecycle events from running.

    getValue#

    ▸ getValue(): string

    -

    Defined in src/renderer/components/input/input.tsx:82

    +

    Defined in src/renderer/components/input/input.tsx:82

    Returns: string

    isValid#

    ▸ isValid(): boolean

    -

    Defined in src/renderer/components/input/input.tsx:67

    +

    Defined in src/renderer/components/input/input.tsx:67

    Returns: boolean

    onBlur#

    ▸ onBlur(evt: FocusEvent‹InputElement›): void

    -

    Defined in src/renderer/components/input/input.tsx:208

    +

    Defined in src/renderer/components/input/input.tsx:208

    Parameters:

    @@ -1765,7 +1777,7 @@ lifecycle events from running.

    onChange#

    ▸ onChange(evt: ChangeEvent‹any›): void

    -

    Defined in src/renderer/components/input/input.tsx:217

    +

    Defined in src/renderer/components/input/input.tsx:217

    Parameters:

    @@ -1785,7 +1797,7 @@ lifecycle events from running.

    onFocus#

    ▸ onFocus(evt: FocusEvent‹InputElement›): void

    -

    Defined in src/renderer/components/input/input.tsx:199

    +

    Defined in src/renderer/components/input/input.tsx:199

    Parameters:

    @@ -1805,7 +1817,7 @@ lifecycle events from running.

    onKeyDown#

    ▸ onKeyDown(evt: KeyboardEvent‹any›): void

    -

    Defined in src/renderer/components/input/input.tsx:236

    +

    Defined in src/renderer/components/input/input.tsx:236

    Parameters:

    @@ -1826,17 +1838,17 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/input/input.tsx:289

    +

    Defined in src/renderer/components/input/input.tsx:289

    Returns: Element‹›

    select#

    ▸ select(): void

    -

    Defined in src/renderer/components/input/input.tsx:99

    +

    Defined in src/renderer/components/input/input.tsx:99

    Returns: void

    setDirty#

    ▸ setDirty(dirty: boolean): void

    -

    Defined in src/renderer/components/input/input.tsx:193

    +

    Defined in src/renderer/components/input/input.tsx:193

    Parameters:

    @@ -1870,7 +1882,7 @@ lifecycle events from running.

    setValidation#

    ▸ setValidation(errors: React.ReactNode[]): void

    -

    Defined in src/renderer/components/input/input.tsx:163

    +

    Defined in src/renderer/components/input/input.tsx:163

    Parameters:

    @@ -1890,7 +1902,7 @@ lifecycle events from running.

    setValue#

    ▸ setValue(value: string): void

    -

    Defined in src/renderer/components/input/input.tsx:71

    +

    Defined in src/renderer/components/input/input.tsx:71

    Parameters:

    @@ -1945,7 +1957,7 @@ and componentDidUpdate will not be called.

    validate#

    ▸ validate(value: string): Promise‹void›

    -

    Defined in src/renderer/components/input/input.tsx:119

    +

    Defined in src/renderer/components/input/input.tsx:119

    Parameters:

    @@ -1968,16 +1980,16 @@ and componentDidUpdate will not be called.

    state#

    ▪ state: object#

    Overrides PageLayout.state

    -

    Defined in src/renderer/components/input/input.tsx:61

    +

    Defined in src/renderer/components/input/input.tsx:61

    dirty#

    • dirty: boolean = !!this.props.dirty

    -

    Defined in src/renderer/components/input/input.tsx:62

    +

    Defined in src/renderer/components/input/input.tsx:62

    errors#

    • errors: undefined[] = []

    -

    Defined in src/renderer/components/input/input.tsx:64

    +

    Defined in src/renderer/components/input/input.tsx:64

    valid#

    • valid: true = true

    -

    Defined in src/renderer/components/input/input.tsx:63

    +

    Defined in src/renderer/components/input/input.tsx:63

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html b/latest/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html index d734dcd796..9f7de08927 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1308,7 +1320,7 @@ the entire component tree to unmount.

    componentDidMount#

    ▸ componentDidMount(): Promise‹void›

    Overrides WizardLayout.componentDidMount

    -

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

    +

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

    Returns: Promise‹void›

    Optional componentDidUpdate#

    @@ -1475,7 +1487,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html index 7876ede3ab..0fe49a8c5e 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1227,7 +1239,7 @@ Should be used with type annotation or static contextType.

    isLoading#

    • isLoading: boolean = false

    -

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

    +

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

    loader#

    • loader: IReactionDisposer = reaction(() => [ @@ -1254,11 +1266,11 @@ Should be used with type annotation or static contextType.

    }

    })

    -

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

    +

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

    loadingError#

    • loadingError: React.ReactNode

    -

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

    +

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

    props#

    • props: Readonly‹P› & Readonly‹object›

    @@ -1302,17 +1314,17 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Accessors#

    isCrdInstance#

    • get isCrdInstance(): boolean

    -

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

    +

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

    Returns: boolean

    object#

    • get object(): any

    -

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

    +

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

    Returns: any

    path#

    • get path(): string

    -

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

    +

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

    Returns: string

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1599,7 +1611,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html index 885b43c148..55f24dc7a7 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1233,7 +1245,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Accessors#

    selectedItem#

    • get selectedItem(): any

    -

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

    +

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

    Returns: any

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1519,7 +1531,7 @@ lifecycle events from running.

    onDetails#

    ▸ onDetails(item: KubeObject): void

    -

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

    +

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

    Parameters:

    @@ -1540,7 +1552,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html index 96050b4266..02e9fd15f8 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1265,17 +1277,17 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Accessors#

    isEditable#

    • get isEditable(): boolean

    -

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:26

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:26

    Returns: boolean

    isRemovable#

    • get isRemovable(): boolean

    -

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:32

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:32

    Returns: boolean

    store#

    • get store(): KubeObjectStore‹any›

    -

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:18

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:18

    Returns: KubeObjectStore‹any›

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1561,18 +1573,18 @@ lifecycle events from running.

    remove#

    ▸ remove(): Promise‹void›

    -

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:45

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:45

    Returns: Promise‹void›

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    renderRemoveMessage#

    ▸ renderRemoveMessage(): Element‹›

    -

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:54

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:54

    Returns: Element‹›

    setState#

    @@ -1624,7 +1636,7 @@ and componentDidUpdate will not be called.

    update#

    ▸ update(): Promise‹void›

    -

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:39

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:39

    Returns: Promise‹void›

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html index af3a62b92c..06134b61cf 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1212,7 +1224,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    ▪ defaultHiddenFields: IKubeMetaField[] = [ "uid", "resourceVersion", "selfLink" ]

    -

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:16

    +

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:16

    Methods#

    Optional UNSAFE_componentWillMount#

    ▸ UNSAFE_componentWillMount(): void

    @@ -1497,7 +1509,7 @@ lifecycle events from running.

    isHidden#

    ▸ isHidden(field: IKubeMetaField): boolean

    -

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:20

    +

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:20

    Parameters:

    @@ -1518,7 +1530,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:26

    +

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:26

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.lineprogress/index.html b/latest/extensions/api/classes/_renderer_api_components_.lineprogress/index.html index d00a52fc89..06408409f5 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.lineprogress/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.lineprogress/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1320,7 +1332,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    -

    Defined in src/renderer/components/line-progress/line-progress.tsx:23

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:23

    Returns: Element‹›

    Optional shouldComponentUpdate#

    @@ -1360,19 +1372,19 @@ and componentDidUpdate will not be called.

    Object literals#

    Static defaultProps#

    ▪ defaultProps: object#

    -

    Defined in src/renderer/components/line-progress/line-progress.tsx:16

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:16

    max#

    • max: number = 100

    -

    Defined in src/renderer/components/line-progress/line-progress.tsx:19

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:19

    min#

    • min: number = 0

    -

    Defined in src/renderer/components/line-progress/line-progress.tsx:18

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:18

    precise#

    • precise: number = 2

    -

    Defined in src/renderer/components/line-progress/line-progress.tsx:20

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:20

    value#

    • value: number = 0

    -

    Defined in src/renderer/components/line-progress/line-progress.tsx:17

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:17

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.menu/index.html b/latest/extensions/api/classes/_renderer_api_components_.menu/index.html index f1ac3a6b88..5d9e6f085d 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.menu/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.menu/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1319,11 +1331,11 @@ Should be used with type annotation or static contextType.

    elem#

    • elem: HTMLUListElement

    -

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

    +

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

    Protected items#

    • items: object

    -

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

    +

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

    Type declaration:

    @@ -1543,7 +1555,7 @@ prevents this from being invoked.

    Protected bindRef#

    ▸ bindRef(elem: HTMLUListElement): void

    -

    Defined in src/renderer/components/menu/menu.tsx:228

    +

    Defined in src/renderer/components/menu/menu.tsx:228

    Parameters:

    @@ -1563,7 +1575,7 @@ prevents this from being invoked.

    close#

    ▸ close(): void

    -

    Defined in src/renderer/components/menu/menu.tsx:165

    +

    Defined in src/renderer/components/menu/menu.tsx:165

    Returns: void

    Optional componentDidCatch#

    @@ -1596,7 +1608,7 @@ the entire component tree to unmount.

    componentDidMount#

    ▸ componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

    Defined in src/renderer/components/menu/menu.tsx:63

    +

    Defined in src/renderer/components/menu/menu.tsx:63

    Returns: void

    Optional componentDidUpdate#

    @@ -1680,7 +1692,7 @@ prevents this from being invoked.

    componentWillUnmount#

    ▸ componentWillUnmount(): void

    Overrides WizardLayout.componentWillUnmount

    -

    Defined in src/renderer/components/menu/menu.tsx:84

    +

    Defined in src/renderer/components/menu/menu.tsx:84

    Returns: void

    Optional componentWillUpdate#

    @@ -1721,7 +1733,7 @@ prevents this from being invoked.

    Protected focusNextItem#

    ▸ focusNextItem(reverse: boolean): void

    -

    Defined in src/renderer/components/menu/menu.tsx:103

    +

    Defined in src/renderer/components/menu/menu.tsx:103

    Parameters:

    @@ -1782,7 +1794,7 @@ lifecycle events from running.

    onClickOutside#

    ▸ onClickOutside(evt: MouseEvent): void

    -

    Defined in src/renderer/components/menu/menu.tsx:216

    +

    Defined in src/renderer/components/menu/menu.tsx:216

    Parameters:

    @@ -1802,7 +1814,7 @@ lifecycle events from running.

    onKeyDown#

    ▸ onKeyDown(evt: KeyboardEvent): void

    -

    Defined in src/renderer/components/menu/menu.tsx:174

    +

    Defined in src/renderer/components/menu/menu.tsx:174

    Parameters:

    @@ -1822,7 +1834,7 @@ lifecycle events from running.

    onScrollOutside#

    ▸ onScrollOutside(evt: UIEvent): void

    -

    Defined in src/renderer/components/menu/menu.tsx:206

    +

    Defined in src/renderer/components/menu/menu.tsx:206

    Parameters:

    @@ -1842,18 +1854,18 @@ lifecycle events from running.

    onWindowResize#

    ▸ onWindowResize(): void

    -

    Defined in src/renderer/components/menu/menu.tsx:201

    +

    Defined in src/renderer/components/menu/menu.tsx:201

    Returns: void

    open#

    ▸ open(): void

    -

    Defined in src/renderer/components/menu/menu.tsx:158

    +

    Defined in src/renderer/components/menu/menu.tsx:158

    Returns: void

    render#

    ▸ render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/menu/menu.tsx:236

    +

    Defined in src/renderer/components/menu/menu.tsx:236

    Returns: Element‹›

    setState#

    @@ -1905,7 +1917,7 @@ and componentDidUpdate will not be called.

    toggle#

    ▸ toggle(): void

    -

    Defined in src/renderer/components/menu/menu.tsx:170

    +

    Defined in src/renderer/components/menu/menu.tsx:170

    Returns: void

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.menuactions/index.html b/latest/extensions/api/classes/_renderer_api_components_.menuactions/index.html index 77bd5aa596..75fdaba315 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.menuactions/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.menuactions/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1239,11 +1251,11 @@ Should be used with type annotation or static contextType.

    id#

    • id: string = uniqueId("menu_actions_")

    -

    Defined in src/renderer/components/menu/menu-actions.tsx:32

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:32

    isOpen#

    • isOpen: boolean = !!this.props.toolbar

    -

    Defined in src/renderer/components/menu/menu-actions.tsx:34

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:34

    props#

    • props: Readonly‹MenuActionsProps› & Readonly‹object›

    @@ -1568,18 +1580,18 @@ lifecycle events from running.

    remove#

    ▸ remove(): void

    -

    Defined in src/renderer/components/menu/menu-actions.tsx:42

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:42

    Returns: void

    render#

    ▸ render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/menu/menu-actions.tsx:83

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:83

    Returns: Element‹›

    renderTriggerIcon#

    ▸ renderTriggerIcon(): Element‹›

    -

    Defined in src/renderer/components/menu/menu-actions.tsx:56

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:56

    Returns: Element‹›

    setState#

    @@ -1631,15 +1643,15 @@ and componentDidUpdate will not be called.

    toggle#

    ▸ toggle(): void

    -

    Defined in src/renderer/components/menu/menu-actions.tsx:36

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:36

    Returns: void

    Object literals#

    Static defaultProps#

    ▪ defaultProps: object#

    -

    Defined in src/renderer/components/menu/menu-actions.tsx:26

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:26

    removeConfirmationMessage#

    • removeConfirmationMessage:

    -

    Defined in src/renderer/components/menu/menu-actions.tsx:27

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:27

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.menuitem/index.html b/latest/extensions/api/classes/_renderer_api_components_.menuitem/index.html index aea94b3481..763c8314f3 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.menuitem/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.menuitem/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1211,11 +1223,11 @@

    context#

    • context: MenuContextValue

    Overrides PageLayout.context

    -

    Defined in src/renderer/components/menu/menu.tsx:307

    +

    Defined in src/renderer/components/menu/menu.tsx:307

    elem#

    • elem: HTMLElement

    -

    Defined in src/renderer/components/menu/menu.tsx:308

    +

    Defined in src/renderer/components/menu/menu.tsx:308

    props#

    • props: Readonly‹MenuItemProps› & Readonly‹object›

    @@ -1241,20 +1253,20 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Static contextType#

    ▪ contextType: Context‹Menu‹›› = MenuContext

    Overrides PageLayout.contextType

    -

    Defined in src/renderer/components/menu/menu.tsx:305

    +

    Defined in src/renderer/components/menu/menu.tsx:305

    Static defaultProps#

    ▪ defaultProps: object = defaultPropsMenuItem as object

    -

    Defined in src/renderer/components/menu/menu.tsx:304

    +

    Defined in src/renderer/components/menu/menu.tsx:304

    Accessors#

    isFocusable#

    • get isFocusable(): boolean

    -

    Defined in src/renderer/components/menu/menu.tsx:310

    +

    Defined in src/renderer/components/menu/menu.tsx:310

    Returns: boolean

    • get isLink(): boolean

    -

    Defined in src/renderer/components/menu/menu.tsx:316

    +

    Defined in src/renderer/components/menu/menu.tsx:316

    Returns: boolean

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1345,7 +1357,7 @@ prevents this from being invoked.

    Protected bindRef#

    ▸ bindRef(elem: HTMLElement): void

    -

    Defined in src/renderer/components/menu/menu.tsx:332

    +

    Defined in src/renderer/components/menu/menu.tsx:332

    Parameters:

    @@ -1560,7 +1572,7 @@ lifecycle events from running.

    onClick#

    ▸ onClick(evt: MouseEvent): void

    -

    Defined in src/renderer/components/menu/menu.tsx:320

    +

    Defined in src/renderer/components/menu/menu.tsx:320

    Parameters:

    @@ -1581,7 +1593,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/menu/menu.tsx:336

    +

    Defined in src/renderer/components/menu/menu.tsx:336

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.notifications/index.html b/latest/extensions/api/classes/_renderer_api_components_.notifications/index.html index 468474808f..20ea4effde 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.notifications/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.notifications/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1204,7 +1216,7 @@ Should be used with type annotation or static contextType.

    elem#

    • elem: HTMLElement

    -

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

    +

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

    props#

    • props: Readonly‹P› & Readonly‹object›

    @@ -1362,7 +1374,7 @@ the entire component tree to unmount.

    componentDidMount#

    ▸ componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

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

    +

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

    Returns: void

    Optional componentDidUpdate#

    @@ -1498,7 +1510,7 @@ prevents this from being invoked.

    getMessage#

    ▸ getMessage(notification: Notification): (string | number | object | ReactElement‹any, string | function | object› | ReactNodeArray‹› | ReactPortal‹›)[]

    -

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

    +

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

    Parameters:

    @@ -1549,12 +1561,12 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/notifications/notifications.tsx:69

    +

    Defined in src/renderer/components/notifications/notifications.tsx:69

    Returns: Element‹›

    scrollToLastNotification#

    ▸ scrollToLastNotification(): void

    -

    Defined in src/renderer/components/notifications/notifications.tsx:49

    +

    Defined in src/renderer/components/notifications/notifications.tsx:49

    Returns: void

    setState#

    @@ -1606,7 +1618,7 @@ and componentDidUpdate will not be called.

    Static error#

    ▸ error(message: NotificationMessage): void

    -

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

    +

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

    Parameters:

    @@ -1626,7 +1638,7 @@ and componentDidUpdate will not be called.

    Static info#

    ▸ info(message: NotificationMessage, customOpts: Partial‹Notification›): function

    -

    Defined in src/renderer/components/notifications/notifications.tsx:32

    +

    Defined in src/renderer/components/notifications/notifications.tsx:32

    Parameters:

    @@ -1654,7 +1666,7 @@ and componentDidUpdate will not be called.

    Static ok#

    ▸ ok(message: NotificationMessage): void

    -

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

    +

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

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html b/latest/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html index 3a41ad411a..c984cd9f26 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -946,15 +958,15 @@

    Properties#

    Protected autoHideTimers#

    • autoHideTimers: Map‹string | number, number› = new Map()

    -

    Defined in src/renderer/components/notifications/notifications.store.ts:27

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:27

    notifications#

    • notifications: IObservableArray‹Notification› = observable.array([], { deep: false })

    -

    Defined in src/renderer/components/notifications/notifications.store.ts:25

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:25

    Methods#

    add#

    ▸ add(notification: Notification): function

    -

    Defined in src/renderer/components/notifications/notifications.store.ts:54

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:54

    Parameters:

    @@ -975,7 +987,7 @@

    addAutoHideTimer#

    ▸ addAutoHideTimer(id: NotificationId): void

    -

    Defined in src/renderer/components/notifications/notifications.store.ts:33

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:33

    Parameters:

    @@ -995,7 +1007,7 @@

    getById#

    ▸ getById(id: NotificationId): Notification | null

    -

    Defined in src/renderer/components/notifications/notifications.store.ts:29

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:29

    Parameters:

    @@ -1015,7 +1027,7 @@

    remove#

    ▸ remove(id: NotificationId): void

    -

    Defined in src/renderer/components/notifications/notifications.store.ts:71

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:71

    Parameters:

    @@ -1035,7 +1047,7 @@

    removeAutoHideTimer#

    ▸ removeAutoHideTimer(id: NotificationId): void

    -

    Defined in src/renderer/components/notifications/notifications.store.ts:46

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:46

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.pagelayout/index.html b/latest/extensions/api/classes/_renderer_api_components_.pagelayout/index.html index e59af73da8..9fecc045d1 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.pagelayout/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.pagelayout/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1218,7 +1230,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Static defaultProps#

    ▪ defaultProps: object = defaultProps as object

    -

    Defined in src/renderer/components/layout/page-layout.tsx:27

    +

    Defined in src/renderer/components/layout/page-layout.tsx:27

    Methods#

    Optional UNSAFE_componentWillMount#

    ▸ UNSAFE_componentWillMount(): void

    @@ -1308,7 +1320,7 @@ prevents this from being invoked.

    back#

    ▸ back(evt?: MouseEvent | KeyboardEvent): void

    -

    Defined in src/renderer/components/layout/page-layout.tsx:30

    +

    Defined in src/renderer/components/layout/page-layout.tsx:30

    Parameters:

    @@ -1356,7 +1368,7 @@ the entire component tree to unmount.

    componentDidMount#

    ▸ componentDidMount(): Promise‹void›

    Overrides WizardLayout.componentDidMount

    -

    Defined in src/renderer/components/layout/page-layout.tsx:38

    +

    Defined in src/renderer/components/layout/page-layout.tsx:38

    Returns: Promise‹void›

    Optional componentDidUpdate#

    @@ -1440,7 +1452,7 @@ prevents this from being invoked.

    componentWillUnmount#

    ▸ componentWillUnmount(): void

    Overrides WizardLayout.componentWillUnmount

    -

    Defined in src/renderer/components/layout/page-layout.tsx:42

    +

    Defined in src/renderer/components/layout/page-layout.tsx:42

    Returns: void

    Optional componentWillUpdate#

    @@ -1520,7 +1532,7 @@ lifecycle events from running.

    onEscapeKey#

    ▸ onEscapeKey(evt: KeyboardEvent): void

    -

    Defined in src/renderer/components/layout/page-layout.tsx:46

    +

    Defined in src/renderer/components/layout/page-layout.tsx:46

    Parameters:

    @@ -1541,7 +1553,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/layout/page-layout.tsx:57

    +

    Defined in src/renderer/components/layout/page-layout.tsx:57

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.radio/index.html b/latest/extensions/api/classes/_renderer_api_components_.radio/index.html index 3a2cedbfd3..c6ad7874b1 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.radio/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.radio/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1491,12 +1503,12 @@ lifecycle events from running.

    onChange#

    ▸ onChange(): void

    -

    Defined in src/renderer/components/radio/radio.tsx:52

    +

    Defined in src/renderer/components/radio/radio.tsx:52

    Returns: void

    onKeyDown#

    ▸ onKeyDown(e: KeyboardEvent‹any›): void

    -

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

    +

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

    Parameters:

    @@ -1517,7 +1529,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/radio/radio.tsx:70

    +

    Defined in src/renderer/components/radio/radio.tsx:70

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.radiogroup/index.html b/latest/extensions/api/classes/_renderer_api_components_.radiogroup/index.html index 63206414b1..2f9f795231 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.radiogroup/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.radiogroup/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1474,7 +1486,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.select/index.html b/latest/extensions/api/classes/_renderer_api_components_.select/index.html index 83a4ef92fd..eaaa39a43f 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.select/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.select/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1324,17 +1336,17 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Accessors#

    options#

    • get options(): SelectOption[]

    -

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

    +

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

    Returns: SelectOption[]

    selectedOption#

    • get selectedOption(): SelectOption‹any› | SelectOption‹any›[]

    -

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

    +

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

    Returns: SelectOption‹any› | SelectOption‹any›[]

    theme#

    • get theme(): "dark" | "light" | "outlined"

    -

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

    +

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

    Returns: "dark" | "light" | "outlined"

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1620,7 +1632,7 @@ lifecycle events from running.

    Protected isValidOption#

    ▸ isValidOption(opt: SelectOption | any): boolean

    -

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

    +

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

    Parameters:

    @@ -1640,7 +1652,7 @@ lifecycle events from running.

    onChange#

    ▸ onChange(value: SelectOption, meta: ActionMeta‹any›): void

    -

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

    +

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

    Parameters:

    @@ -1664,7 +1676,7 @@ lifecycle events from running.

    onKeyDown#

    ▸ onKeyDown(evt: KeyboardEvent‹HTMLElement›): void

    -

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

    +

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

    Parameters:

    @@ -1685,7 +1697,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    @@ -1737,16 +1749,16 @@ and componentDidUpdate will not be called.

    Object literals#

    Static defaultProps#

    ▪ defaultProps: object#

    -

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

    +

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

    autoConvertOptions#

    • autoConvertOptions: true = true

    -

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

    +

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

    • menuPlacement: "auto" = "auto"

    -

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

    +

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

    • menuPortalTarget: HTMLElement = document.body

    -

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

    +

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

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.slider/index.html b/latest/extensions/api/classes/_renderer_api_components_.slider/index.html index c4626cb1d7..1cc01dc03b 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.slider/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.slider/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1202,7 +1214,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Static defaultProps#

    ▪ defaultProps: object = defaultProps as object

    -

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

    +

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

    Methods#

    Optional UNSAFE_componentWillMount#

    ▸ UNSAFE_componentWillMount(): void

    @@ -1488,7 +1500,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.spinner/index.html b/latest/extensions/api/classes/_renderer_api_components_.spinner/index.html index 50b4bf901b..2d3c2bb534 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.spinner/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.spinner/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1526,7 +1538,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    @@ -1578,13 +1590,13 @@ and componentDidUpdate will not be called.

    Object literals#

    Static defaultProps#

    ▪ defaultProps: object#

    -

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

    +

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

    center#

    • center: boolean = false

    -

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

    +

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

    singleColor#

    • singleColor: boolean = true

    -

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

    +

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

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.statusbrick/index.html b/latest/extensions/api/classes/_renderer_api_components_.statusbrick/index.html index 9057a60acc..b17499d0a9 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.statusbrick/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.statusbrick/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1476,7 +1488,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

    Defined in src/renderer/components/status-brick/status-brick.tsx:12

    +

    Defined in src/renderer/components/status-brick/status-brick.tsx:12

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.stepper/index.html b/latest/extensions/api/classes/_renderer_api_components_.stepper/index.html index fd2615ce28..c22bc54049 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.stepper/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.stepper/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1474,7 +1486,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.tab/index.html b/latest/extensions/api/classes/_renderer_api_components_.tab/index.html index a760042441..ed52c65c2c 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tab/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tab/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1108,19 +1120,19 @@

    Properties#

    context#

    • context: TabsContextValue

    -

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

    +

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

    elem#

    • elem: HTMLElement

    -

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

    +

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

    Static contextType#

    ▪ contextType: Context‹TabsContextValue‹any›› = TabsContext

    -

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

    +

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

    Accessors#

    isActive#

    • get isActive(): boolean

    -

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

    +

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

    Returns: boolean

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1211,7 +1223,7 @@ prevents this from being invoked.

    Protected bindRef#

    ▸ bindRef(elem: HTMLElement): void

    -

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

    +

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

    Parameters:

    @@ -1259,7 +1271,7 @@ the entire component tree to unmount.

    componentDidMount#

    ▸ componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

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

    +

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

    Returns: void

    Optional componentDidUpdate#

    @@ -1386,7 +1398,7 @@ prevents this from being invoked.

    focus#

    ▸ focus(): void

    -

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

    +

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

    Returns: void

    Optional getSnapshotBeforeUpdate#

    @@ -1421,7 +1433,7 @@ lifecycle events from running.

    onClick#

    ▸ onClick(evt: MouseEvent‹HTMLElement›): void

    -

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

    +

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

    Parameters:

    @@ -1441,7 +1453,7 @@ lifecycle events from running.

    onFocus#

    ▸ onFocus(evt: FocusEvent‹HTMLElement›): void

    -

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

    +

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

    Parameters:

    @@ -1461,7 +1473,7 @@ lifecycle events from running.

    onKeyDown#

    ▸ onKeyDown(evt: KeyboardEvent‹HTMLElement›): void

    -

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

    +

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

    Parameters:

    @@ -1481,12 +1493,12 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    -

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

    +

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

    Returns: Element‹›

    scrollIntoView#

    ▸ scrollIntoView(): void

    -

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

    +

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

    Returns: void

    Optional shouldComponentUpdate#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.table/index.html b/latest/extensions/api/classes/_renderer_api_components_.table/index.html index 4e75cfe5f7..0923cd8bd1 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.table/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.table/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1322,7 +1334,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    sortParamsLocal#

    • sortParamsLocal: object = this.props.sortByDefault

    -

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

    +

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

    Type declaration:

    state#

    @@ -1351,7 +1363,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Accessors#

    sortParams#

    • get sortParams(): Partial‹TableSortParams›

    -

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

    +

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

    Returns: Partial‹TableSortParams›

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1637,7 +1649,7 @@ lifecycle events from running.

    getSorted#

    ▸ getSorted(items: any[]): any[]

    -

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

    +

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

    Parameters:

    @@ -1657,7 +1669,7 @@ lifecycle events from running.

    Protected onSort#

    ▸ onSort(params: TableSortParams): void

    -

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

    +

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

    Parameters:

    @@ -1678,17 +1690,17 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    renderHead#

    ▸ renderHead(): ReactElement‹TableHeadProps‹›, string | function | object›

    -

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

    +

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

    Returns: ReactElement‹TableHeadProps‹›, string | function | object›

    renderRows#

    ▸ renderRows(): object

    -

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

    +

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

    Returns: object

    setState#

    @@ -1740,7 +1752,7 @@ and componentDidUpdate will not be called.

    sort#

    ▸ sort(colName: TableSortBy): void

    -

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

    +

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

    Parameters:

    @@ -1760,22 +1772,22 @@ and componentDidUpdate will not be called.

    Object literals#

    Static defaultProps#

    ▪ defaultProps: object#

    -

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

    +

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

    autoSize#

    • autoSize: true = true

    -

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

    +

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

    rowLineHeight#

    • rowLineHeight: string = "17px"

    -

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

    +

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

    rowPadding#

    • rowPadding: string = "8px"

    -

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

    +

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

    scrollable#

    • scrollable: true = true

    -

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

    +

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

    sortSyncWithUrl#

    • sortSyncWithUrl: true = true

    -

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

    +

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

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.tablecell/index.html b/latest/extensions/api/classes/_renderer_api_components_.tablecell/index.html index 64dc606785..e4eb8d2640 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tablecell/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tablecell/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1249,7 +1261,7 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Accessors#

    isSortable#

    • get isSortable(): boolean

    -

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

    +

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

    Returns: boolean

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1535,7 +1547,7 @@ lifecycle events from running.

    onClick#

    ▸ onClick(evt: MouseEvent‹HTMLDivElement›): void

    -

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

    +

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

    Parameters:

    @@ -1556,17 +1568,17 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    renderCheckbox#

    ▸ renderCheckbox(): Element‹›

    -

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

    +

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

    Returns: Element‹›

    renderSortIcon#

    ▸ renderSortIcon(): Element‹›

    -

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

    +

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

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.tablehead/index.html b/latest/extensions/api/classes/_renderer_api_components_.tablehead/index.html index 78aa9504c6..6443e6ce8f 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tablehead/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tablehead/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1521,7 +1533,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    @@ -1573,10 +1585,10 @@ and componentDidUpdate will not be called.

    Object literals#

    Static defaultProps#

    ▪ defaultProps: object#

    -

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

    +

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

    sticky#

    • sticky: true = true

    -

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

    +

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

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.tablerow/index.html b/latest/extensions/api/classes/_renderer_api_components_.tablerow/index.html index 1c3e6c3da2..fee9cc4f35 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tablerow/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tablerow/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1476,7 +1488,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.tabs/index.html b/latest/extensions/api/classes/_renderer_api_components_.tabs/index.html index 795fe4384a..60a51086b0 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tabs/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tabs/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1021,7 +1033,7 @@

    Properties#

    elem#

    • elem: HTMLElement

    -

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

    +

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

    Methods#

    Optional UNSAFE_componentWillMount#

    ▸ UNSAFE_componentWillMount(): void

    @@ -1111,7 +1123,7 @@ prevents this from being invoked.

    Protected bindRef#

    ▸ bindRef(elem: HTMLElement): void

    -

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

    +

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

    Parameters:

    @@ -1317,7 +1329,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    -

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

    +

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

    Returns: Element‹›

    Optional shouldComponentUpdate#

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.tooltip/index.html b/latest/extensions/api/classes/_renderer_api_components_.tooltip/index.html index 8abbb9c5f3..ea5da958ef 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.tooltip/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.tooltip/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1258,7 +1270,7 @@

    Properties#

    activePosition#

    • activePosition: TooltipPosition

    -

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

    +

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

    context#

    • context: any

    @@ -1277,11 +1289,11 @@ Should be used with type annotation or static contextType.

    elem#

    • elem: HTMLElement

    -

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

    +

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

    isVisible#

    • isVisible: boolean = !!this.props.visible

    -

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

    +

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

    props#

    • props: Readonly‹TooltipProps› & Readonly‹object›

    @@ -1325,16 +1337,16 @@ https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    Static defaultProps#

    ▪ defaultProps: object = defaultProps as object

    -

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

    +

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

    Accessors#

    hoverTarget#

    • get hoverTarget(): HTMLElement

    -

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

    +

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

    Returns: HTMLElement

    targetElem#

    • get targetElem(): HTMLElement

    -

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

    +

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

    Returns: HTMLElement

    Methods#

    Optional UNSAFE_componentWillMount#

    @@ -1425,7 +1437,7 @@ prevents this from being invoked.

    bindRef#

    ▸ bindRef(elem: HTMLElement): void

    -

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

    +

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

    Parameters:

    @@ -1473,7 +1485,7 @@ the entire component tree to unmount.

    componentDidMount#

    ▸ componentDidMount(): void

    Overrides WizardLayout.componentDidMount

    -

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

    +

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

    Returns: void

    Optional componentDidUpdate#

    @@ -1557,7 +1569,7 @@ prevents this from being invoked.

    componentWillUnmount#

    ▸ componentWillUnmount(): void

    Overrides WizardLayout.componentWillUnmount

    -

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

    +

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

    Returns: void

    Optional componentWillUpdate#

    @@ -1607,7 +1619,7 @@ prevents this from being invoked.

    Protected getPosition#

    ▸ getPosition(position: TooltipPosition, tooltipBounds: DOMRect, targetBounds: DOMRect): object

    -

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

    +

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

    Parameters:

    @@ -1679,28 +1691,28 @@ lifecycle events from running.

    Protected onEnterTarget#

    ▸ onEnterTarget(): void

    -

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

    +

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

    Returns: void

    Protected onLeaveTarget#

    ▸ onLeaveTarget(): void

    -

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

    +

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

    Returns: void

    refreshPosition#

    ▸ refreshPosition(): void

    -

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

    +

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

    Returns: void

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    Protected setPosition#

    ▸ setPosition(pos: object): void

    -

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

    +

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

    Parameters:

    ▪ pos: object

    diff --git a/latest/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html b/latest/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html index 909e55cc29..e70446b89f 100644 --- a/latest/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html +++ b/latest/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1476,7 +1488,7 @@ lifecycle events from running.

    render#

    ▸ render(): Element‹›

    Overrides void

    -

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

    +

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

    Returns: Element‹›

    setState#

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html index 2c74edeb96..bf38738ffd 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1179,7 +1191,7 @@

    constructor#

    + new ClusterRole(data: KubeJsonApiData): ClusterRole

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1200,53 +1212,53 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    rules#

    • rules: object[]

    Inherited from Role.rules

    -

    Defined in src/renderer/api/endpoints/role.api.ts:9

    +

    Defined in src/renderer/api/endpoints/role.api.ts:9

    Optional status#

    • status? : any

    Inherited from KubeObject.status

    -

    Defined in src/renderer/api/kube-object.ts:79

    +

    Defined in src/renderer/api/kube-object.ts:79

    Static apiBase#

    ▪ apiBase: string = "/apis/rbac.authorization.k8s.io/v1/clusterroles"

    Overrides Role.apiBase

    -

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:9

    +

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:9

    Static kind#

    ▪ kind: string = "ClusterRole"

    Overrides Role.kind

    -

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:7

    +

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:7

    Static namespaced#

    ▪ namespaced: boolean = false

    Overrides Role.namespaced

    -

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:8

    +

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:8

    Accessors#

    • get selfLink(): string

    Inherited from KubeObject.selfLink

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Returns: string

    Methods#

    delete#

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    Inherited from KubeObject.delete

    -

    Defined in src/renderer/api/kube-object.ts:167

    +

    Defined in src/renderer/api/kube-object.ts:167

    Parameters:

    @@ -1267,7 +1279,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1300,7 +1312,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1323,67 +1335,67 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getRules#

    ▸ getRules(): object[]

    Inherited from Role.getRules

    -

    Defined in src/renderer/api/endpoints/role.api.ts:16

    +

    Defined in src/renderer/api/endpoints/role.api.ts:16

    Returns: object[]

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1406,7 +1418,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1427,7 +1439,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1448,7 +1460,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1469,7 +1481,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1490,7 +1502,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html index 1208354a82..af5a651cbb 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1195,7 +1207,7 @@

    constructor#

    + new ClusterRoleBinding(data: KubeJsonApiData): ClusterRoleBinding

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1216,22 +1228,22 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    roleRef#

    • roleRef: object

    Inherited from RoleBinding.roleRef

    -

    Defined in src/renderer/api/endpoints/role-binding.api.ts:19

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:19

    Type declaration:

    @@ -1300,7 +1312,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1333,7 +1345,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1356,73 +1368,73 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getSubjectNames#

    ▸ getSubjectNames(): string

    Inherited from RoleBinding.getSubjectNames

    -

    Defined in src/renderer/api/endpoints/role-binding.api.ts:29

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:29

    Returns: string

    getSubjects#

    ▸ getSubjects(): IRoleBindingSubject[]

    Inherited from RoleBinding.getSubjects

    -

    Defined in src/renderer/api/endpoints/role-binding.api.ts:25

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:25

    Returns: IRoleBindingSubject[]

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1445,7 +1457,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1466,7 +1478,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1487,7 +1499,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1508,7 +1520,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1529,7 +1541,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html index ea32f2a062..4386cfd397 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1181,7 +1193,7 @@

    constructor#

    + new ConfigMap(data: KubeJsonApiData): ConfigMap

    Overrides KubeObject.constructor

    -

    Defined in src/renderer/api/endpoints/configmap.api.ts:10

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:10

    Parameters:

    @@ -1202,11 +1214,11 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    data#

    • data: object

    -

    Defined in src/renderer/api/endpoints/configmap.api.ts:17

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:17

    Type declaration:

    @@ -1271,7 +1283,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1304,7 +1316,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1327,66 +1339,66 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getKeys#

    ▸ getKeys(): string[]

    -

    Defined in src/renderer/api/endpoints/configmap.api.ts:21

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:21

    Returns: string[]

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1409,7 +1421,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1430,7 +1442,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1451,7 +1463,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1472,7 +1484,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1493,7 +1505,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html index d5053bf5d9..b2bc84cf8a 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1288,71 +1300,71 @@

    constructor#

    + new ConfigMapsStore(): ConfigMapsStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: ConfigMapsStore

    Properties#

    api#

    • api: KubeApi‹ConfigMap‹›› = configMapApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+config-maps/config-maps.store.ts:8

    +

    Defined in src/renderer/components/+config-maps/config-maps.store.ts:8

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): ConfigMap[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: ConfigMap[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1375,7 +1387,7 @@

    create#

    ▸ create(params: object, data?: Partial‹ConfigMap›): Promise‹ConfigMap›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1403,7 +1415,7 @@

    ▸ createItem(params: object, data?: Partial‹ConfigMap›): Promise‹ConfigMap›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1430,7 +1442,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: ConfigMap): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1451,7 +1463,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: ConfigMap[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1472,7 +1484,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): ConfigMap[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1500,7 +1512,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): ConfigMap[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1522,7 +1534,7 @@

    ▸ getByName(name: string, namespace?: string): ConfigMap

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1547,7 +1559,7 @@

    getByPath#

    ▸ getByPath(path: string): ConfigMap

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1568,7 +1580,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: ConfigMap[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1589,7 +1601,7 @@

    isSelected#

    ▸ isSelected(item: ConfigMap): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1610,7 +1622,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: ConfigMap[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1633,7 +1645,7 @@

    load#

    ▸ load(params: object): Promise‹ConfigMap›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1660,13 +1672,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1688,7 +1700,7 @@

    ▸ loadItem(params: object): Promise‹ConfigMap›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1715,7 +1727,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹ConfigMap[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

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

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1757,7 +1769,7 @@

    remove#

    ▸ remove(item: ConfigMap): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1778,7 +1790,7 @@

    Protected removeItem#

    ▸ removeItem(item: ConfigMap, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: ConfigMap

    ▪ request: function

    @@ -1789,25 +1801,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: ConfigMap): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1828,7 +1840,7 @@

    Protected sortItems#

    ▸ sortItems(items: ConfigMap[], sorting?: function[], order?: "asc" | "desc"): ConfigMap[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1862,7 +1874,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1885,7 +1897,7 @@

    toggleSelection#

    ▸ toggleSelection(item: ConfigMap): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1906,7 +1918,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: ConfigMap[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1929,7 +1941,7 @@

    unselect#

    ▸ unselect(item: ConfigMap): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1950,7 +1962,7 @@

    update#

    ▸ update(item: ConfigMap, data: Partial‹ConfigMap›): Promise‹ConfigMap›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -1975,13 +1987,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: ConfigMap, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: ConfigMap

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html index 0c1717bebf..6663be7a75 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1297,7 +1309,7 @@

    constructor#

    + new CRDResourceStore(api: KubeApi‹T›): CRDResourceStore

    Overrides KubeObjectStore.constructor

    -

    Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8

    +

    Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8

    Parameters:

    @@ -1318,65 +1330,65 @@

    api#

    • api: KubeApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8

    +

    Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): T[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: T[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1399,7 +1411,7 @@

    create#

    ▸ create(params: object, data?: Partial‹T›): Promise‹T›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1427,7 +1439,7 @@

    ▸ createItem(params: object, data?: Partial‹T›): Promise‹T›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1454,7 +1466,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: T): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1475,7 +1487,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: T[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1496,7 +1508,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): T[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1524,7 +1536,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): T[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1546,7 +1558,7 @@

    ▸ getByName(name: string, namespace?: string): T

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1571,7 +1583,7 @@

    getByPath#

    ▸ getByPath(path: string): T

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1592,7 +1604,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: T[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1613,7 +1625,7 @@

    isSelected#

    ▸ isSelected(item: T): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1634,7 +1646,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: T[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1657,7 +1669,7 @@

    load#

    ▸ load(params: object): Promise‹T›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1684,13 +1696,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1712,7 +1724,7 @@

    ▸ loadItem(params: object): Promise‹T›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1739,7 +1751,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹T[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

    @@ -1760,7 +1772,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1781,7 +1793,7 @@

    remove#

    ▸ remove(item: T): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1802,7 +1814,7 @@

    Protected removeItem#

    ▸ removeItem(item: T, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: T

    ▪ request: function

    @@ -1813,25 +1825,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: T): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1852,7 +1864,7 @@

    Protected sortItems#

    ▸ sortItems(items: T[], sorting?: function[], order?: "asc" | "desc"): T[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1886,7 +1898,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1909,7 +1921,7 @@

    toggleSelection#

    ▸ toggleSelection(item: T): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1930,7 +1942,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: T[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1953,7 +1965,7 @@

    unselect#

    ▸ unselect(item: T): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1974,7 +1986,7 @@

    update#

    ▸ update(item: T, data: Partial‹T›): Promise‹T›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -1999,13 +2011,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: T, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: T

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html index 3b1320577b..052aa1708d 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1312,76 +1324,76 @@

    constructor#

    + new CRDStore(): CRDStore

    Overrides KubeObjectStore.constructor

    -

    Defined in src/renderer/components/+custom-resources/crd.store.ts:23

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:23

    Returns: CRDStore

    Properties#

    api#

    • api: KubeApi‹CustomResourceDefinition‹›› = crdApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+custom-resources/crd.store.ts:23

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:23

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    groups#

    • get groups(): object

    -

    Defined in src/renderer/components/+custom-resources/crd.store.ts:39

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:39

    Returns: object

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): CustomResourceDefinition[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: CustomResourceDefinition[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1404,7 +1416,7 @@

    create#

    ▸ create(params: object, data?: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1432,7 +1444,7 @@

    ▸ createItem(params: object, data?: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1459,7 +1471,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: CustomResourceDefinition): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1480,7 +1492,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: CustomResourceDefinition[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1501,7 +1513,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): CustomResourceDefinition[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1528,7 +1540,7 @@

    getByGroup#

    ▸ getByGroup(group: string, pluralName: string): CustomResourceDefinition‹›

    -

    Defined in src/renderer/components/+custom-resources/crd.store.ts:52

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:52

    Parameters:

    @@ -1553,7 +1565,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): CustomResourceDefinition[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1575,7 +1587,7 @@

    ▸ getByName(name: string, namespace?: string): CustomResourceDefinition

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1599,7 +1611,7 @@

    getByObject#

    ▸ getByObject(obj: KubeObject): CustomResourceDefinition‹›

    -

    Defined in src/renderer/components/+custom-resources/crd.store.ts:60

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:60

    Parameters:

    @@ -1620,7 +1632,7 @@

    getByPath#

    ▸ getByPath(path: string): CustomResourceDefinition

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1641,7 +1653,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: CustomResourceDefinition[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1662,7 +1674,7 @@

    isSelected#

    ▸ isSelected(item: CustomResourceDefinition): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1683,7 +1695,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: CustomResourceDefinition[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1706,7 +1718,7 @@

    load#

    ▸ load(params: object): Promise‹CustomResourceDefinition›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1733,13 +1745,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1761,7 +1773,7 @@

    ▸ loadItem(params: object): Promise‹CustomResourceDefinition›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1788,7 +1800,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹CustomResourceDefinition[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

    @@ -1809,7 +1821,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1830,7 +1842,7 @@

    remove#

    ▸ remove(item: CustomResourceDefinition): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1851,7 +1863,7 @@

    Protected removeItem#

    ▸ removeItem(item: CustomResourceDefinition, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: CustomResourceDefinition

    ▪ request: function

    @@ -1862,25 +1874,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: CustomResourceDefinition): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1901,7 +1913,7 @@

    Protected sortItems#

    ▸ sortItems(items: CustomResourceDefinition[]): CustomResourceDefinition‹›[]

    Overrides KubeObjectStore.sortItems

    -

    Defined in src/renderer/components/+custom-resources/crd.store.ts:32

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:32

    Parameters:

    @@ -1923,7 +1935,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1946,7 +1958,7 @@

    toggleSelection#

    ▸ toggleSelection(item: CustomResourceDefinition): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1967,7 +1979,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: CustomResourceDefinition[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1990,7 +2002,7 @@

    unselect#

    ▸ unselect(item: CustomResourceDefinition): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -2011,7 +2023,7 @@

    update#

    ▸ update(item: CustomResourceDefinition, data: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -2036,13 +2048,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: CustomResourceDefinition, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: CustomResourceDefinition

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html index 2a044e9e7a..965f32c191 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1205,7 +1217,7 @@

    constructor#

    + new CronJob(data: KubeJsonApiData): CronJob

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1226,17 +1238,17 @@

    apiVersion#

    • apiVersion: string

    Overrides KubeObject.apiVersion

    -

    Defined in src/renderer/api/endpoints/cron-job.api.ts:15

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:15

    kind#

    • kind: string

    Overrides KubeObject.kind

    -

    Defined in src/renderer/api/endpoints/cron-job.api.ts:14

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:14

    metadata#

    • metadata: object

    Overrides KubeObject.metadata

    -

    Defined in src/renderer/api/endpoints/cron-job.api.ts:16

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:16

    Type declaration:

    @@ -1394,7 +1406,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1427,7 +1439,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1450,81 +1462,81 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getLastScheduleTime#

    ▸ getLastScheduleTime(): string

    -

    Defined in src/renderer/api/endpoints/cron-job.api.ts:71

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:71

    Returns: string

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSchedule#

    ▸ getSchedule(): string

    -

    Defined in src/renderer/api/endpoints/cron-job.api.ts:78

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:78

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getSuspendFlag#

    ▸ getSuspendFlag(): string

    -

    Defined in src/renderer/api/endpoints/cron-job.api.ts:67

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:67

    Returns: string

    isNeverRun#

    ▸ isNeverRun(): boolean

    -

    Defined in src/renderer/api/endpoints/cron-job.api.ts:82

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:82

    Returns: boolean

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1547,7 +1559,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1568,7 +1580,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1589,7 +1601,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1610,7 +1622,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1631,7 +1643,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html index 50d0abd322..3c4d1200cb 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1296,71 +1308,71 @@

    constructor#

    + new CronJobStore(): CronJobStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: CronJobStore

    Properties#

    api#

    • api: KubeApi‹CronJob‹›› = cronJobApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:9

    +

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:9

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): CronJob[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: CronJob[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1383,7 +1395,7 @@

    create#

    ▸ create(params: object, data?: Partial‹CronJob›): Promise‹CronJob›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1411,7 +1423,7 @@

    ▸ createItem(params: object, data?: Partial‹CronJob›): Promise‹CronJob›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1438,7 +1450,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: CronJob): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1459,7 +1471,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: CronJob[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1479,7 +1491,7 @@

    getActiveJobsNum#

    ▸ getActiveJobsNum(cronJob: CronJob): number

    -

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:26

    +

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:26

    Parameters:

    @@ -1500,7 +1512,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): CronJob[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1528,7 +1540,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): CronJob[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1550,7 +1562,7 @@

    ▸ getByName(name: string, namespace?: string): CronJob

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1575,7 +1587,7 @@

    getByPath#

    ▸ getByPath(path: string): CronJob

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1596,7 +1608,7 @@

    getStatuses#

    ▸ getStatuses(cronJobs?: CronJob[]): object

    Overrides KubeObjectStore.getStatuses

    -

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:11

    +

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:11

    Parameters:

    @@ -1625,7 +1637,7 @@

    isSelected#

    ▸ isSelected(item: CronJob): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1646,7 +1658,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: CronJob[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1669,7 +1681,7 @@

    load#

    ▸ load(params: object): Promise‹CronJob›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1696,13 +1708,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1724,7 +1736,7 @@

    ▸ loadItem(params: object): Promise‹CronJob›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1751,7 +1763,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹CronJob[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

    @@ -1772,7 +1784,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1793,7 +1805,7 @@

    remove#

    ▸ remove(item: CronJob): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1814,7 +1826,7 @@

    Protected removeItem#

    ▸ removeItem(item: CronJob, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: CronJob

    ▪ request: function

    @@ -1825,25 +1837,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: CronJob): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1864,7 +1876,7 @@

    Protected sortItems#

    ▸ sortItems(items: CronJob[], sorting?: function[], order?: "asc" | "desc"): CronJob[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1898,7 +1910,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1921,7 +1933,7 @@

    toggleSelection#

    ▸ toggleSelection(item: CronJob): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1942,7 +1954,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: CronJob[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1965,7 +1977,7 @@

    unselect#

    ▸ unselect(item: CronJob): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1986,7 +1998,7 @@

    update#

    ▸ update(item: CronJob, data: Partial‹CronJob›): Promise‹CronJob›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -2011,13 +2023,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: CronJob, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: CronJob

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html index b550325925..c6af421e17 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1293,7 +1305,7 @@

    constructor#

    + new CustomResourceDefinition(data: KubeJsonApiData): CustomResourceDefinition

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1314,21 +1326,21 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    spec#

    • spec: object

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:25

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:25

    Type declaration:

    @@ -1451,7 +1463,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1484,7 +1496,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1506,46 +1518,46 @@

    getConditions#

    ▸ getConditions(): object[]

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:139

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:139

    Returns: object[]

    getConversion#

    ▸ getConversion(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:121

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:121

    Returns: string

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getGroup#

    ▸ getGroup(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:96

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:96

    Returns: string

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNames#

    ▸ getNames(): object

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:117

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:117

    Returns: object

    @@ -1603,71 +1615,71 @@

    getResourceApiBase#

    ▸ getResourceApiBase(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:76

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:76

    Returns: string

    getResourceKind#

    ▸ getResourceKind(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:86

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:86

    Returns: string

    getResourceTitle#

    ▸ getResourceTitle(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:90

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:90

    Returns: string

    getResourceUrl#

    ▸ getResourceUrl(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:67

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:67

    Returns: string

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getScope#

    ▸ getScope(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:100

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:100

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getStoredVersions#

    ▸ getStoredVersions(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:113

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:113

    Returns: string

    getValidation#

    ▸ getValidation(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:135

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:135

    Returns: string

    getVersion#

    ▸ getVersion(): string

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:104

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:104

    Returns: string

    isNamespaced#

    ▸ isNamespaced(): boolean

    -

    Defined in src/renderer/api/endpoints/crd.api.ts:109

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:109

    Returns: boolean

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1690,7 +1702,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1711,7 +1723,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1732,7 +1744,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1753,7 +1765,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1774,7 +1786,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html index 7bd3869a00..7d280aee1b 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1229,7 +1241,7 @@

    constructor#

    + new DaemonSet(data: KubeJsonApiData): DaemonSet

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1250,22 +1262,22 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    spec#

    • spec: object

    Overrides void

    -

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:13

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:13

    Type declaration:

    @@ -1422,19 +1434,19 @@

    getAffinity#

    ▸ getAffinity(): IAffinity

    Inherited from Deployment.getAffinity

    -

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    Returns: IAffinity

    getAffinityNumber#

    ▸ getAffinityNumber(): number

    Inherited from Pod.getAffinityNumber

    -

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    Returns: number

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1467,7 +1479,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1490,90 +1502,90 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getImages#

    ▸ getImages(): string[]

    -

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:66

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:66

    Returns: string[]

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNodeSelectors#

    ▸ getNodeSelectors(): string[]

    Inherited from Deployment.getNodeSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    Returns: string[]

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getSelectors#

    ▸ getSelectors(): string[]

    Inherited from Pod.getSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    Returns: string[]

    getTemplateLabels#

    ▸ getTemplateLabels(): string[]

    Inherited from Pod.getTemplateLabels

    -

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    Returns: string[]

    getTolerations#

    ▸ getTolerations(): IToleration[]

    Inherited from Deployment.getTolerations

    -

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    Returns: IToleration[]

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1596,7 +1608,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1617,7 +1629,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1638,7 +1650,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1659,7 +1671,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1680,7 +1692,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html index ce5b67a1f4..a89be73029 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1312,75 +1324,75 @@

    constructor#

    + new DaemonSetStore(): DaemonSetStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: DaemonSetStore

    Properties#

    api#

    • api: KubeApi‹DaemonSet‹›› = daemonSetApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:10

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:10

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    metrics#

    • metrics: IPodMetrics = null

    -

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:12

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:12

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): DaemonSet[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: DaemonSet[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1403,7 +1415,7 @@

    create#

    ▸ create(params: object, data?: Partial‹DaemonSet›): Promise‹DaemonSet›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1431,7 +1443,7 @@

    ▸ createItem(params: object, data?: Partial‹DaemonSet›): Promise‹DaemonSet›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1458,7 +1470,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: DaemonSet): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1479,7 +1491,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: DaemonSet[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1500,7 +1512,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): DaemonSet[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1528,7 +1540,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): DaemonSet[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1550,7 +1562,7 @@

    ▸ getByName(name: string, namespace?: string): DaemonSet

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1575,7 +1587,7 @@

    getByPath#

    ▸ getByPath(path: string): DaemonSet

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1595,7 +1607,7 @@

    getChildPods#

    ▸ getChildPods(daemonSet: DaemonSet): Pod[]

    -

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:20

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:20

    Parameters:

    @@ -1616,7 +1628,7 @@

    getStatuses#

    ▸ getStatuses(daemonSets?: DaemonSet[]): object

    Overrides KubeObjectStore.getStatuses

    -

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:24

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:24

    Parameters:

    @@ -1648,7 +1660,7 @@

    isSelected#

    ▸ isSelected(item: DaemonSet): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1669,7 +1681,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: DaemonSet[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1692,7 +1704,7 @@

    load#

    ▸ load(params: object): Promise‹DaemonSet›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1719,13 +1731,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1747,7 +1759,7 @@

    ▸ loadItem(params: object): Promise‹DaemonSet›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1774,7 +1786,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹DaemonSet[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

    @@ -1794,7 +1806,7 @@

    loadMetrics#

    ▸ loadMetrics(daemonSet: DaemonSet): Promise‹void›

    -

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:14

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:14

    Parameters:

    @@ -1815,7 +1827,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1836,7 +1848,7 @@

    remove#

    ▸ remove(item: DaemonSet): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1857,7 +1869,7 @@

    Protected removeItem#

    ▸ removeItem(item: DaemonSet, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: DaemonSet

    ▪ request: function

    @@ -1868,25 +1880,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:44

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:44

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: DaemonSet): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1907,7 +1919,7 @@

    Protected sortItems#

    ▸ sortItems(items: DaemonSet[], sorting?: function[], order?: "asc" | "desc"): DaemonSet[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1941,7 +1953,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1964,7 +1976,7 @@

    toggleSelection#

    ▸ toggleSelection(item: DaemonSet): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1985,7 +1997,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: DaemonSet[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2008,7 +2020,7 @@

    unselect#

    ▸ unselect(item: DaemonSet): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -2029,7 +2041,7 @@

    update#

    ▸ update(item: DaemonSet, data: Partial‹DaemonSet›): Promise‹DaemonSet›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -2054,13 +2066,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: DaemonSet, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: DaemonSet

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html index 0a09aa389f..6373f5a0f1 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1245,7 +1257,7 @@

    constructor#

    + new Deployment(data: KubeJsonApiData): Deployment

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1266,22 +1278,22 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    spec#

    • spec: object

    Overrides void

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:55

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:55

    Type declaration:

    @@ -1443,19 +1455,19 @@

    getAffinity#

    ▸ getAffinity(): IAffinity

    Inherited from Deployment.getAffinity

    -

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    Returns: IAffinity

    getAffinityNumber#

    ▸ getAffinityNumber(): number

    Inherited from Pod.getAffinityNumber

    -

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    Returns: number

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1488,7 +1500,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1510,7 +1522,7 @@

    getConditions#

    ▸ getConditions(activeOnly: boolean): object[]

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:172

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:172

    Parameters:

    @@ -1532,7 +1544,7 @@

    getConditionsText#

    ▸ getConditionsText(activeOnly: boolean): string

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:184

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:184

    Parameters:

    @@ -1555,90 +1567,90 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNodeSelectors#

    ▸ getNodeSelectors(): string[]

    Inherited from Deployment.getNodeSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    Returns: string[]

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getReplicas#

    ▸ getReplicas(): number

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:188

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:188

    Returns: number

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getSelectors#

    ▸ getSelectors(): string[]

    Inherited from Pod.getSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    Returns: string[]

    getTemplateLabels#

    ▸ getTemplateLabels(): string[]

    Inherited from Pod.getTemplateLabels

    -

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    Returns: string[]

    getTolerations#

    ▸ getTolerations(): IToleration[]

    Inherited from Deployment.getTolerations

    -

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    Returns: IToleration[]

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1661,7 +1673,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1682,7 +1694,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1703,7 +1715,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1724,7 +1736,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1745,7 +1757,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html index 1160a7b612..7f1238bac5 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1210,7 +1222,7 @@

    constructor#

    + new DeploymentApi(options: IKubeApiOptions‹Deployment›): DeploymentApi

    Inherited from KubeApi.constructor

    -

    Defined in src/renderer/api/kube-api.ts:102

    +

    Defined in src/renderer/api/kube-api.ts:102

    Parameters:

    @@ -1231,84 +1243,84 @@

    apiBase#

    • apiBase: string

    Inherited from KubeApi.apiBase

    -

    Defined in src/renderer/api/kube-api.ts:92

    +

    Defined in src/renderer/api/kube-api.ts:92

    apiGroup#

    • apiGroup: string

    Inherited from KubeApi.apiGroup

    -

    Defined in src/renderer/api/kube-api.ts:94

    +

    Defined in src/renderer/api/kube-api.ts:94

    apiPrefix#

    • apiPrefix: string

    Inherited from KubeApi.apiPrefix

    -

    Defined in src/renderer/api/kube-api.ts:93

    +

    Defined in src/renderer/api/kube-api.ts:93

    apiResource#

    • apiResource: string

    Inherited from KubeApi.apiResource

    -

    Defined in src/renderer/api/kube-api.ts:97

    +

    Defined in src/renderer/api/kube-api.ts:97

    apiVersion#

    • apiVersion: string

    Inherited from KubeApi.apiVersion

    -

    Defined in src/renderer/api/kube-api.ts:95

    +

    Defined in src/renderer/api/kube-api.ts:95

    Optional apiVersionPreferred#

    • apiVersionPreferred? : string

    Inherited from KubeApi.apiVersionPreferred

    -

    Defined in src/renderer/api/kube-api.ts:96

    +

    Defined in src/renderer/api/kube-api.ts:96

    isNamespaced#

    • isNamespaced: boolean

    Inherited from KubeApi.isNamespaced

    -

    Defined in src/renderer/api/kube-api.ts:98

    +

    Defined in src/renderer/api/kube-api.ts:98

    kind#

    • kind: string

    Inherited from KubeApi.kind

    -

    Defined in src/renderer/api/kube-api.ts:91

    +

    Defined in src/renderer/api/kube-api.ts:91

    objectConstructor#

    • objectConstructor: IKubeObjectConstructor‹Deployment›

    Inherited from KubeApi.objectConstructor

    -

    Defined in src/renderer/api/kube-api.ts:100

    +

    Defined in src/renderer/api/kube-api.ts:100

    Protected options#

    • options: IKubeApiOptions‹Deployment›

    Inherited from KubeApi.options

    -

    Defined in src/renderer/api/kube-api.ts:104

    +

    Defined in src/renderer/api/kube-api.ts:104

    Protected request#

    • request: KubeJsonApi

    Inherited from KubeApi.request

    -

    Defined in src/renderer/api/kube-api.ts:101

    +

    Defined in src/renderer/api/kube-api.ts:101

    Protected resourceVersions#

    • resourceVersions: Map‹string, string› = new Map()

    Inherited from KubeApi.resourceVersions

    -

    Defined in src/renderer/api/kube-api.ts:102

    +

    Defined in src/renderer/api/kube-api.ts:102

    Static parseApi#

    ▪ parseApi: parseKubeApi = parseKubeApi

    Inherited from KubeApi.parseApi

    -

    Defined in src/renderer/api/kube-api.ts:83

    +

    Defined in src/renderer/api/kube-api.ts:83

    Accessors#

    apiVersionWithGroup#

    • get apiVersionWithGroup(): string

    Inherited from KubeApi.apiVersionWithGroup

    -

    Defined in src/renderer/api/kube-api.ts:132

    +

    Defined in src/renderer/api/kube-api.ts:132

    Returns: string

    Methods#

    Protected checkPreferredVersion#

    ▸ checkPreferredVersion(): Promise‹void›

    Inherited from KubeApi.checkPreferredVersion

    -

    Defined in src/renderer/api/kube-api.ts:194

    +

    Defined in src/renderer/api/kube-api.ts:194

    Returns: Promise‹void›

    create#

    ▸ create(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment›

    Inherited from KubeApi.create

    -

    Defined in src/renderer/api/kube-api.ts:304

    +

    Defined in src/renderer/api/kube-api.ts:304

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1338,7 +1350,7 @@

    delete#

    ▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

    Inherited from KubeApi.delete

    -

    Defined in src/renderer/api/kube-api.ts:331

    +

    Defined in src/renderer/api/kube-api.ts:331

    Parameters:

    ▪ __namedParameters: object

    @@ -1367,7 +1379,7 @@

    get#

    ▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Deployment›

    Inherited from KubeApi.get

    -

    Defined in src/renderer/api/kube-api.ts:296

    +

    Defined in src/renderer/api/kube-api.ts:296

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1396,7 +1408,7 @@

    getReplicas#

    ▸ getReplicas(params: object): Promise‹number›

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:12

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:12

    Parameters:

    ▪ params: object

    @@ -1422,7 +1434,7 @@

    getResourceVersion#

    ▸ getResourceVersion(namespace: string): string

    Inherited from KubeApi.getResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:227

    +

    Defined in src/renderer/api/kube-api.ts:227

    Parameters:

    @@ -1444,7 +1456,7 @@

    Protected getScaleApiUrl#

    ▸ getScaleApiUrl(params: object): string

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:8

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:8

    Parameters:

    ▪ params: object

    @@ -1470,7 +1482,7 @@

    getUrl#

    ▸ getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    Inherited from KubeApi.getUrl

    -

    Defined in src/renderer/api/kube-api.ts:235

    +

    Defined in src/renderer/api/kube-api.ts:235

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1500,7 +1512,7 @@

    getWatchUrl#

    ▸ getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    Inherited from KubeApi.getWatchUrl

    -

    Defined in src/renderer/api/kube-api.ts:338

    +

    Defined in src/renderer/api/kube-api.ts:338

    Parameters:

    @@ -1528,7 +1540,7 @@

    list#

    ▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Deployment[]›

    Inherited from KubeApi.list

    -

    Defined in src/renderer/api/kube-api.ts:288

    +

    Defined in src/renderer/api/kube-api.ts:288

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1553,7 +1565,7 @@

    Protected normalizeQuery#

    ▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    Inherited from KubeApi.normalizeQuery

    -

    Defined in src/renderer/api/kube-api.ts:247

    +

    Defined in src/renderer/api/kube-api.ts:247

    Parameters:

    @@ -1576,7 +1588,7 @@

    Protected parseResponse#

    ▸ parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    Inherited from KubeApi.parseResponse

    -

    Defined in src/renderer/api/kube-api.ts:259

    +

    Defined in src/renderer/api/kube-api.ts:259

    Parameters:

    @@ -1601,7 +1613,7 @@

    refreshResourceVersion#

    ▸ refreshResourceVersion(params?: object): Promise‹T[]›

    Inherited from KubeApi.refreshResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:231

    +

    Defined in src/renderer/api/kube-api.ts:231

    Parameters:

    ▪Optional params: object

    @@ -1622,7 +1634,7 @@

    restart#

    ▸ restart(params: object): CancelablePromise‹KubeJsonApiData›

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:29

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:29

    Parameters:

    ▪ params: object

    @@ -1647,7 +1659,7 @@

    scale#

    ▸ scale(params: object, replicas: number): CancelablePromise‹KubeJsonApiData›

    -

    Defined in src/renderer/api/endpoints/deployment.api.ts:18

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:18

    Parameters:

    ▪ params: object

    @@ -1674,7 +1686,7 @@

    setResourceVersion#

    ▸ setResourceVersion(namespace: string, newVersion: string): void

    Inherited from KubeApi.setResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:223

    +

    Defined in src/renderer/api/kube-api.ts:223

    Parameters:

    @@ -1702,7 +1714,7 @@

    update#

    ▸ update(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment›

    Inherited from KubeApi.update

    -

    Defined in src/renderer/api/kube-api.ts:322

    +

    Defined in src/renderer/api/kube-api.ts:322

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1732,14 +1744,14 @@

    watch#

    ▸ watch(): function

    Inherited from KubeApi.watch

    -

    Defined in src/renderer/api/kube-api.ts:346

    +

    Defined in src/renderer/api/kube-api.ts:346

    Returns: function

    ▸ (): void

    Static watchAll#

    ▸ watchAll(...apis: KubeApi[]): (Anonymous function)

    Inherited from KubeApi.watchAll

    -

    Defined in src/renderer/api/kube-api.ts:85

    +

    Defined in src/renderer/api/kube-api.ts:85

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html index e61e287a60..4b900f1c6b 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1312,75 +1324,75 @@

    constructor#

    + new DeploymentStore(): DeploymentStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: DeploymentStore

    Properties#

    api#

    • api: DeploymentApi‹› = deploymentApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:10

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:10

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    metrics#

    • metrics: IPodMetrics = null

    -

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:11

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:11

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): Deployment[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Deployment[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1403,7 +1415,7 @@

    create#

    ▸ create(params: object, data?: Partial‹Deployment›): Promise‹Deployment›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1431,7 +1443,7 @@

    ▸ createItem(params: object, data?: Partial‹Deployment›): Promise‹Deployment›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1458,7 +1470,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: Deployment): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1479,7 +1491,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: Deployment[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1500,7 +1512,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Deployment[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1528,7 +1540,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): Deployment[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1550,7 +1562,7 @@

    ▸ getByName(name: string, namespace?: string): Deployment

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1575,7 +1587,7 @@

    getByPath#

    ▸ getByPath(path: string): Deployment

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1595,7 +1607,7 @@

    getChildPods#

    ▸ getChildPods(deployment: Deployment): Pod‹›[]

    -

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:45

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:45

    Parameters:

    @@ -1616,7 +1628,7 @@

    getStatuses#

    ▸ getStatuses(deployments?: Deployment[]): object

    Overrides KubeObjectStore.getStatuses

    -

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:25

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:25

    Parameters:

    @@ -1648,7 +1660,7 @@

    isSelected#

    ▸ isSelected(item: Deployment): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1669,7 +1681,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: Deployment[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1692,7 +1704,7 @@

    load#

    ▸ load(params: object): Promise‹Deployment›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1719,13 +1731,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1747,7 +1759,7 @@

    ▸ loadItem(params: object): Promise‹Deployment›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1774,7 +1786,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹Deployment[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

    @@ -1794,7 +1806,7 @@

    loadMetrics#

    ▸ loadMetrics(deployment: Deployment): Promise‹void›

    -

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:19

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:19

    Parameters:

    @@ -1815,7 +1827,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1836,7 +1848,7 @@

    remove#

    ▸ remove(item: Deployment): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1857,7 +1869,7 @@

    Protected removeItem#

    ▸ removeItem(item: Deployment, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: Deployment

    ▪ request: function

    @@ -1868,25 +1880,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:51

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:51

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: Deployment): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1907,7 +1919,7 @@

    Protected sortItems#

    ▸ sortItems(items: Deployment[]): Deployment‹›[]

    Overrides KubeObjectStore.sortItems

    -

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:13

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:13

    Parameters:

    @@ -1929,7 +1941,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1952,7 +1964,7 @@

    toggleSelection#

    ▸ toggleSelection(item: Deployment): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1973,7 +1985,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: Deployment[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1996,7 +2008,7 @@

    unselect#

    ▸ unselect(item: Deployment): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -2017,7 +2029,7 @@

    update#

    ▸ update(item: Deployment, data: Partial‹Deployment›): Promise‹Deployment›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -2042,13 +2054,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: Deployment, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: Deployment

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html index b754a37aab..2bbe275cfd 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1189,7 +1201,7 @@

    constructor#

    + new Endpoint(data: KubeJsonApiData): Endpoint

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1210,51 +1222,51 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    Optional status#

    • status? : any

    Inherited from KubeObject.status

    -

    Defined in src/renderer/api/kube-object.ts:79

    +

    Defined in src/renderer/api/kube-object.ts:79

    subsets#

    • subsets: IEndpointSubset[]

    -

    Defined in src/renderer/api/endpoints/endpoint.api.ts:109

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:109

    Static apiBase#

    ▪ apiBase: string = "/api/v1/endpoints"

    -

    Defined in src/renderer/api/endpoints/endpoint.api.ts:107

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:107

    Static kind#

    ▪ kind: string = "Endpoints"

    Overrides KubeObject.kind

    -

    Defined in src/renderer/api/endpoints/endpoint.api.ts:105

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:105

    Static namespaced#

    ▪ namespaced: boolean = true

    Overrides KubeObject.namespaced

    -

    Defined in src/renderer/api/endpoints/endpoint.api.ts:106

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:106

    Accessors#

    • get selfLink(): string

    Inherited from KubeObject.selfLink

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Returns: string

    Methods#

    delete#

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    Inherited from KubeObject.delete

    -

    Defined in src/renderer/api/kube-object.ts:167

    +

    Defined in src/renderer/api/kube-object.ts:167

    Parameters:

    @@ -1275,7 +1287,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1308,7 +1320,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1330,72 +1342,72 @@

    getEndpointSubsets#

    ▸ getEndpointSubsets(): EndpointSubset[]

    -

    Defined in src/renderer/api/endpoints/endpoint.api.ts:111

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:111

    Returns: EndpointSubset[]

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    toString#

    ▸ toString(): string

    -

    Defined in src/renderer/api/endpoints/endpoint.api.ts:117

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:117

    Returns: string

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1418,7 +1430,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1439,7 +1451,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1460,7 +1472,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1481,7 +1493,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1502,7 +1514,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html index 5c4d00b41f..429f8ee167 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1288,71 +1300,71 @@

    constructor#

    + new EndpointStore(): EndpointStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: EndpointStore

    Properties#

    api#

    • api: KubeApi‹Endpoint‹›› = endpointApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+network-endpoints/endpoints.store.ts:8

    +

    Defined in src/renderer/components/+network-endpoints/endpoints.store.ts:8

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): Endpoint[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Endpoint[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1375,7 +1387,7 @@

    create#

    ▸ create(params: object, data?: Partial‹Endpoint›): Promise‹Endpoint›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1403,7 +1415,7 @@

    ▸ createItem(params: object, data?: Partial‹Endpoint›): Promise‹Endpoint›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1430,7 +1442,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: Endpoint): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1451,7 +1463,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: Endpoint[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1472,7 +1484,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Endpoint[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1500,7 +1512,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): Endpoint[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1522,7 +1534,7 @@

    ▸ getByName(name: string, namespace?: string): Endpoint

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1547,7 +1559,7 @@

    getByPath#

    ▸ getByPath(path: string): Endpoint

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1568,7 +1580,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: Endpoint[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1589,7 +1601,7 @@

    isSelected#

    ▸ isSelected(item: Endpoint): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1610,7 +1622,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: Endpoint[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1633,7 +1645,7 @@

    load#

    ▸ load(params: object): Promise‹Endpoint›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1660,13 +1672,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1688,7 +1700,7 @@

    ▸ loadItem(params: object): Promise‹Endpoint›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1715,7 +1727,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹Endpoint[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

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

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1757,7 +1769,7 @@

    remove#

    ▸ remove(item: Endpoint): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1778,7 +1790,7 @@

    Protected removeItem#

    ▸ removeItem(item: Endpoint, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: Endpoint

    ▪ request: function

    @@ -1789,25 +1801,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: Endpoint): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1828,7 +1840,7 @@

    Protected sortItems#

    ▸ sortItems(items: Endpoint[], sorting?: function[], order?: "asc" | "desc"): Endpoint[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1862,7 +1874,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1885,7 +1897,7 @@

    toggleSelection#

    ▸ toggleSelection(item: Endpoint): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1906,7 +1918,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: Endpoint[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1929,7 +1941,7 @@

    unselect#

    ▸ unselect(item: Endpoint): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1950,7 +1962,7 @@

    update#

    ▸ update(item: Endpoint, data: Partial‹Endpoint›): Promise‹Endpoint›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -1975,13 +1987,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: Endpoint, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: Endpoint

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html index d1dd1773b3..f3f34f6085 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1312,81 +1324,81 @@

    constructor#

    + new EventStore(): EventStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: EventStore

    Properties#

    api#

    • api: KubeApi‹KubeEvent‹›› = eventApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+events/event.store.ts:13

    +

    Defined in src/renderer/components/+events/event.store.ts:13

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    limit#

    • limit: number = 1000

    Overrides KubeObjectStore.limit

    -

    Defined in src/renderer/components/+events/event.store.ts:14

    +

    Defined in src/renderer/components/+events/event.store.ts:14

    saveLimit#

    • saveLimit: number = 50000

    -

    Defined in src/renderer/components/+events/event.store.ts:15

    +

    Defined in src/renderer/components/+events/event.store.ts:15

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): KubeEvent[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: KubeEvent[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(): IReactionDisposer

    Overrides KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/components/+events/event.store.ts:17

    +

    Defined in src/renderer/components/+events/event.store.ts:17

    Returns: IReactionDisposer

    create#

    ▸ create(params: object, data?: Partial‹KubeEvent›): Promise‹KubeEvent›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1414,7 +1426,7 @@

    ▸ createItem(params: object, data?: Partial‹KubeEvent›): Promise‹KubeEvent›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1441,7 +1453,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: KubeEvent): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1462,7 +1474,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: KubeEvent[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1483,7 +1495,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): KubeEvent[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1511,7 +1523,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): KubeEvent[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1533,7 +1545,7 @@

    ▸ getByName(name: string, namespace?: string): KubeEvent

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1558,7 +1570,7 @@

    getByPath#

    ▸ getByPath(path: string): KubeEvent

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1578,7 +1590,7 @@

    getEventsByObject#

    ▸ getEventsByObject(obj: KubeObject): KubeEvent[]

    -

    Defined in src/renderer/components/+events/event.store.ts:27

    +

    Defined in src/renderer/components/+events/event.store.ts:27

    Parameters:

    @@ -1599,7 +1611,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: KubeEvent[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1619,13 +1631,13 @@

    getWarnings#

    ▸ getWarnings(): KubeEvent‹›[]

    -

    Defined in src/renderer/components/+events/event.store.ts:37

    +

    Defined in src/renderer/components/+events/event.store.ts:37

    Returns: KubeEvent‹›[]

    isSelected#

    ▸ isSelected(item: KubeEvent): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1646,7 +1658,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: KubeEvent[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1669,7 +1681,7 @@

    load#

    ▸ load(params: object): Promise‹KubeEvent›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1696,13 +1708,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1724,7 +1736,7 @@

    ▸ loadItem(params: object): Promise‹KubeEvent›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1751,7 +1763,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹KubeEvent[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

    @@ -1772,7 +1784,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1793,7 +1805,7 @@

    remove#

    ▸ remove(item: KubeEvent): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1814,7 +1826,7 @@

    Protected removeItem#

    ▸ removeItem(item: KubeEvent, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: KubeEvent

    ▪ request: function

    @@ -1825,25 +1837,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: KubeEvent): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1864,7 +1876,7 @@

    Protected sortItems#

    ▸ sortItems(items: KubeEvent[]): KubeEvent‹›[]

    Overrides KubeObjectStore.sortItems

    -

    Defined in src/renderer/components/+events/event.store.ts:21

    +

    Defined in src/renderer/components/+events/event.store.ts:21

    Parameters:

    @@ -1886,7 +1898,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1909,7 +1921,7 @@

    toggleSelection#

    ▸ toggleSelection(item: KubeEvent): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1930,7 +1942,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: KubeEvent[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1953,7 +1965,7 @@

    unselect#

    ▸ unselect(item: KubeEvent): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1974,7 +1986,7 @@

    update#

    ▸ update(item: KubeEvent, data: Partial‹KubeEvent›): Promise‹KubeEvent›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -1999,13 +2011,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: KubeEvent, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: KubeEvent

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html index c863cadcdb..fc652cbdec 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1237,7 +1249,7 @@

    constructor#

    + new HorizontalPodAutoscaler(data: KubeJsonApiData): HorizontalPodAutoscaler

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1258,21 +1270,21 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    spec#

    • spec: object

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:46

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:46

    Type declaration:

    @@ -1362,7 +1374,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1395,7 +1407,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1417,40 +1429,40 @@

    getConditions#

    ▸ getConditions(): object[]

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:81

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:81

    Returns: object[]

    getCurrentMetrics#

    ▸ getCurrentMetrics(): IHpaMetric[]

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:99

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:99

    Returns: IHpaMetric[]

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getMaxPods#

    ▸ getMaxPods(): number

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:69

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:69

    Returns: number

    Protected getMetricName#

    ▸ getMetricName(metric: IHpaMetric): string

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:103

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:103

    Parameters:

    @@ -1470,7 +1482,7 @@

    getMetricValues#

    ▸ getMetricValues(metric: IHpaMetric): string

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:119

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:119

    Parameters:

    @@ -1490,59 +1502,59 @@

    getMetrics#

    ▸ getMetrics(): IHpaMetric[]

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:95

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:95

    Returns: IHpaMetric[]

    getMinPods#

    ▸ getMinPods(): number

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:73

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:73

    Returns: number

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getReplicas#

    ▸ getReplicas(): number

    -

    Defined in src/renderer/api/endpoints/hpa.api.ts:77

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:77

    Returns: number

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1565,7 +1577,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1586,7 +1598,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1607,7 +1619,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1628,7 +1640,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1649,7 +1661,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html index 0e2f435310..a37b953440 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1288,71 +1300,71 @@

    constructor#

    + new HPAStore(): HPAStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: HPAStore

    Properties#

    api#

    • api: KubeApi‹HorizontalPodAutoscaler‹›› = hpaApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+config-autoscalers/hpa.store.ts:8

    +

    Defined in src/renderer/components/+config-autoscalers/hpa.store.ts:8

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): HorizontalPodAutoscaler[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: HorizontalPodAutoscaler[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1375,7 +1387,7 @@

    create#

    ▸ create(params: object, data?: Partial‹HorizontalPodAutoscaler›): Promise‹HorizontalPodAutoscaler›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1403,7 +1415,7 @@

    ▸ createItem(params: object, data?: Partial‹HorizontalPodAutoscaler›): Promise‹HorizontalPodAutoscaler›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1430,7 +1442,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: HorizontalPodAutoscaler): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1451,7 +1463,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: HorizontalPodAutoscaler[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1472,7 +1484,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): HorizontalPodAutoscaler[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1500,7 +1512,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): HorizontalPodAutoscaler[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1522,7 +1534,7 @@

    ▸ getByName(name: string, namespace?: string): HorizontalPodAutoscaler

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1547,7 +1559,7 @@

    getByPath#

    ▸ getByPath(path: string): HorizontalPodAutoscaler

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1568,7 +1580,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: HorizontalPodAutoscaler[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1589,7 +1601,7 @@

    isSelected#

    ▸ isSelected(item: HorizontalPodAutoscaler): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1610,7 +1622,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: HorizontalPodAutoscaler[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1633,7 +1645,7 @@

    load#

    ▸ load(params: object): Promise‹HorizontalPodAutoscaler›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1660,13 +1672,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1688,7 +1700,7 @@

    ▸ loadItem(params: object): Promise‹HorizontalPodAutoscaler›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1715,7 +1727,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹HorizontalPodAutoscaler[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

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

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1757,7 +1769,7 @@

    remove#

    ▸ remove(item: HorizontalPodAutoscaler): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1778,7 +1790,7 @@

    Protected removeItem#

    ▸ removeItem(item: HorizontalPodAutoscaler, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: HorizontalPodAutoscaler

    ▪ request: function

    @@ -1789,25 +1801,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: HorizontalPodAutoscaler): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1828,7 +1840,7 @@

    Protected sortItems#

    ▸ sortItems(items: HorizontalPodAutoscaler[], sorting?: function[], order?: "asc" | "desc"): HorizontalPodAutoscaler[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1862,7 +1874,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1885,7 +1897,7 @@

    toggleSelection#

    ▸ toggleSelection(item: HorizontalPodAutoscaler): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1906,7 +1918,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: HorizontalPodAutoscaler[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1929,7 +1941,7 @@

    unselect#

    ▸ unselect(item: HorizontalPodAutoscaler): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1950,7 +1962,7 @@

    update#

    ▸ update(item: HorizontalPodAutoscaler, data: Partial‹HorizontalPodAutoscaler›): Promise‹HorizontalPodAutoscaler›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -1975,13 +1987,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: HorizontalPodAutoscaler, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: HorizontalPodAutoscaler

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html index 00ec4b08f3..64d27fd28c 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1213,7 +1225,7 @@

    constructor#

    + new Ingress(data: KubeJsonApiData): Ingress

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1234,21 +1246,21 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    spec#

    • spec: object

    -

    Defined in src/renderer/api/endpoints/ingress.api.ts:70

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:70

    Type declaration:

    @@ -1323,7 +1335,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1356,7 +1368,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1379,74 +1391,74 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getHosts#

    ▸ getHosts(): string[]

    -

    Defined in src/renderer/api/endpoints/ingress.api.ts:137

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:137

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getLoadBalancers#

    ▸ getLoadBalancers(): string[]

    -

    Defined in src/renderer/api/endpoints/ingress.api.ts:168

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:168

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getPorts#

    ▸ getPorts(): string

    -

    Defined in src/renderer/api/endpoints/ingress.api.ts:145

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:145

    Returns: string

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getRoutes#

    ▸ getRoutes(): string[]

    -

    Defined in src/renderer/api/endpoints/ingress.api.ts:100

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:100

    Returns: string[]

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getServiceNamePort#

    ▸ getServiceNamePort(): object

    -

    Defined in src/renderer/api/endpoints/ingress.api.ts:126

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:126

    Returns: object

    @@ -1510,7 +1522,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1531,7 +1543,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1552,7 +1564,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1573,7 +1585,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html index 5ee25a9e41..85170f3832 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1186,7 +1198,7 @@

    constructor#

    + new IngressApi(options: IKubeApiOptions‹Ingress›): IngressApi

    Inherited from KubeApi.constructor

    -

    Defined in src/renderer/api/kube-api.ts:102

    +

    Defined in src/renderer/api/kube-api.ts:102

    Parameters:

    @@ -1207,84 +1219,84 @@

    apiBase#

    • apiBase: string

    Inherited from KubeApi.apiBase

    -

    Defined in src/renderer/api/kube-api.ts:92

    +

    Defined in src/renderer/api/kube-api.ts:92

    apiGroup#

    • apiGroup: string

    Inherited from KubeApi.apiGroup

    -

    Defined in src/renderer/api/kube-api.ts:94

    +

    Defined in src/renderer/api/kube-api.ts:94

    apiPrefix#

    • apiPrefix: string

    Inherited from KubeApi.apiPrefix

    -

    Defined in src/renderer/api/kube-api.ts:93

    +

    Defined in src/renderer/api/kube-api.ts:93

    apiResource#

    • apiResource: string

    Inherited from KubeApi.apiResource

    -

    Defined in src/renderer/api/kube-api.ts:97

    +

    Defined in src/renderer/api/kube-api.ts:97

    apiVersion#

    • apiVersion: string

    Inherited from KubeApi.apiVersion

    -

    Defined in src/renderer/api/kube-api.ts:95

    +

    Defined in src/renderer/api/kube-api.ts:95

    Optional apiVersionPreferred#

    • apiVersionPreferred? : string

    Inherited from KubeApi.apiVersionPreferred

    -

    Defined in src/renderer/api/kube-api.ts:96

    +

    Defined in src/renderer/api/kube-api.ts:96

    isNamespaced#

    • isNamespaced: boolean

    Inherited from KubeApi.isNamespaced

    -

    Defined in src/renderer/api/kube-api.ts:98

    +

    Defined in src/renderer/api/kube-api.ts:98

    kind#

    • kind: string

    Inherited from KubeApi.kind

    -

    Defined in src/renderer/api/kube-api.ts:91

    +

    Defined in src/renderer/api/kube-api.ts:91

    objectConstructor#

    • objectConstructor: IKubeObjectConstructor‹Ingress›

    Inherited from KubeApi.objectConstructor

    -

    Defined in src/renderer/api/kube-api.ts:100

    +

    Defined in src/renderer/api/kube-api.ts:100

    Protected options#

    • options: IKubeApiOptions‹Ingress›

    Inherited from KubeApi.options

    -

    Defined in src/renderer/api/kube-api.ts:104

    +

    Defined in src/renderer/api/kube-api.ts:104

    Protected request#

    • request: KubeJsonApi

    Inherited from KubeApi.request

    -

    Defined in src/renderer/api/kube-api.ts:101

    +

    Defined in src/renderer/api/kube-api.ts:101

    Protected resourceVersions#

    • resourceVersions: Map‹string, string› = new Map()

    Inherited from KubeApi.resourceVersions

    -

    Defined in src/renderer/api/kube-api.ts:102

    +

    Defined in src/renderer/api/kube-api.ts:102

    Static parseApi#

    ▪ parseApi: parseKubeApi = parseKubeApi

    Inherited from KubeApi.parseApi

    -

    Defined in src/renderer/api/kube-api.ts:83

    +

    Defined in src/renderer/api/kube-api.ts:83

    Accessors#

    apiVersionWithGroup#

    • get apiVersionWithGroup(): string

    Inherited from KubeApi.apiVersionWithGroup

    -

    Defined in src/renderer/api/kube-api.ts:132

    +

    Defined in src/renderer/api/kube-api.ts:132

    Returns: string

    Methods#

    Protected checkPreferredVersion#

    ▸ checkPreferredVersion(): Promise‹void›

    Inherited from KubeApi.checkPreferredVersion

    -

    Defined in src/renderer/api/kube-api.ts:194

    +

    Defined in src/renderer/api/kube-api.ts:194

    Returns: Promise‹void›

    create#

    ▸ create(__namedParameters: object, data?: Partial‹Ingress›): Promise‹Ingress›

    Inherited from KubeApi.create

    -

    Defined in src/renderer/api/kube-api.ts:304

    +

    Defined in src/renderer/api/kube-api.ts:304

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1314,7 +1326,7 @@

    delete#

    ▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

    Inherited from KubeApi.delete

    -

    Defined in src/renderer/api/kube-api.ts:331

    +

    Defined in src/renderer/api/kube-api.ts:331

    Parameters:

    ▪ __namedParameters: object

    @@ -1343,7 +1355,7 @@

    get#

    ▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Ingress›

    Inherited from KubeApi.get

    -

    Defined in src/renderer/api/kube-api.ts:296

    +

    Defined in src/renderer/api/kube-api.ts:296

    Parameters:

    ▪Default value __namedParameters: object= {}

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

    getMetrics#

    ▸ getMetrics(ingress: string, namespace: string): Promise‹IIngressMetrics›

    -

    Defined in src/renderer/api/endpoints/ingress.api.ts:7

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:7

    Parameters:

    @@ -1397,7 +1409,7 @@

    getResourceVersion#

    ▸ getResourceVersion(namespace: string): string

    Inherited from KubeApi.getResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:227

    +

    Defined in src/renderer/api/kube-api.ts:227

    Parameters:

    @@ -1420,7 +1432,7 @@

    getUrl#

    ▸ getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    Inherited from KubeApi.getUrl

    -

    Defined in src/renderer/api/kube-api.ts:235

    +

    Defined in src/renderer/api/kube-api.ts:235

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1450,7 +1462,7 @@

    getWatchUrl#

    ▸ getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    Inherited from KubeApi.getWatchUrl

    -

    Defined in src/renderer/api/kube-api.ts:338

    +

    Defined in src/renderer/api/kube-api.ts:338

    Parameters:

    @@ -1478,7 +1490,7 @@

    list#

    ▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Ingress[]›

    Inherited from KubeApi.list

    -

    Defined in src/renderer/api/kube-api.ts:288

    +

    Defined in src/renderer/api/kube-api.ts:288

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1503,7 +1515,7 @@

    Protected normalizeQuery#

    ▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    Inherited from KubeApi.normalizeQuery

    -

    Defined in src/renderer/api/kube-api.ts:247

    +

    Defined in src/renderer/api/kube-api.ts:247

    Parameters:

    @@ -1526,7 +1538,7 @@

    Protected parseResponse#

    ▸ parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    Inherited from KubeApi.parseResponse

    -

    Defined in src/renderer/api/kube-api.ts:259

    +

    Defined in src/renderer/api/kube-api.ts:259

    Parameters:

    @@ -1551,7 +1563,7 @@

    refreshResourceVersion#

    ▸ refreshResourceVersion(params?: object): Promise‹T[]›

    Inherited from KubeApi.refreshResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:231

    +

    Defined in src/renderer/api/kube-api.ts:231

    Parameters:

    ▪Optional params: object

    @@ -1573,7 +1585,7 @@

    setResourceVersion#

    ▸ setResourceVersion(namespace: string, newVersion: string): void

    Inherited from KubeApi.setResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:223

    +

    Defined in src/renderer/api/kube-api.ts:223

    Parameters:

    @@ -1601,7 +1613,7 @@

    update#

    ▸ update(__namedParameters: object, data?: Partial‹Ingress›): Promise‹Ingress›

    Inherited from KubeApi.update

    -

    Defined in src/renderer/api/kube-api.ts:322

    +

    Defined in src/renderer/api/kube-api.ts:322

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1631,14 +1643,14 @@

    watch#

    ▸ watch(): function

    Inherited from KubeApi.watch

    -

    Defined in src/renderer/api/kube-api.ts:346

    +

    Defined in src/renderer/api/kube-api.ts:346

    Returns: function

    ▸ (): void

    Static watchAll#

    ▸ watchAll(...apis: KubeApi[]): (Anonymous function)

    Inherited from KubeApi.watchAll

    -

    Defined in src/renderer/api/kube-api.ts:85

    +

    Defined in src/renderer/api/kube-api.ts:85

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html index d9ab1b417f..99bff4d4c3 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1304,75 +1316,75 @@

    constructor#

    + new IngressStore(): IngressStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: IngressStore

    Properties#

    api#

    • api: IngressApi‹› = ingressApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:9

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:9

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    metrics#

    • metrics: IIngressMetrics = null

    -

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:10

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:10

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): Ingress[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Ingress[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1395,7 +1407,7 @@

    create#

    ▸ create(params: object, data?: Partial‹Ingress›): Promise‹Ingress›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1423,7 +1435,7 @@

    ▸ createItem(params: object, data?: Partial‹Ingress›): Promise‹Ingress›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1450,7 +1462,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: Ingress): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1471,7 +1483,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: Ingress[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1492,7 +1504,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Ingress[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1520,7 +1532,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): Ingress[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1542,7 +1554,7 @@

    ▸ getByName(name: string, namespace?: string): Ingress

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1567,7 +1579,7 @@

    getByPath#

    ▸ getByPath(path: string): Ingress

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1588,7 +1600,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: Ingress[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1609,7 +1621,7 @@

    isSelected#

    ▸ isSelected(item: Ingress): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1630,7 +1642,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: Ingress[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1653,7 +1665,7 @@

    load#

    ▸ load(params: object): Promise‹Ingress›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1680,13 +1692,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1708,7 +1720,7 @@

    ▸ loadItem(params: object): Promise‹Ingress›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1735,7 +1747,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹Ingress[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

    @@ -1755,7 +1767,7 @@

    loadMetrics#

    ▸ loadMetrics(ingress: Ingress): Promise‹void›

    -

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:12

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:12

    Parameters:

    @@ -1776,7 +1788,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1797,7 +1809,7 @@

    remove#

    ▸ remove(item: Ingress): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1818,7 +1830,7 @@

    Protected removeItem#

    ▸ removeItem(item: Ingress, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: Ingress

    ▪ request: function

    @@ -1829,25 +1841,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:16

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:16

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: Ingress): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1868,7 +1880,7 @@

    Protected sortItems#

    ▸ sortItems(items: Ingress[], sorting?: function[], order?: "asc" | "desc"): Ingress[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1902,7 +1914,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1925,7 +1937,7 @@

    toggleSelection#

    ▸ toggleSelection(item: Ingress): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1946,7 +1958,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: Ingress[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1969,7 +1981,7 @@

    unselect#

    ▸ unselect(item: Ingress): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1990,7 +2002,7 @@

    update#

    ▸ update(item: Ingress, data: Partial‹Ingress›): Promise‹Ingress›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -2015,13 +2027,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: Ingress, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: Ingress

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.job/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.job/index.html index 7742ce0143..63656858f7 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.job/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.job/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1261,7 +1273,7 @@

    constructor#

    + new Job(data: KubeJsonApiData): Job

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1282,22 +1294,22 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    spec#

    • spec: object

    Overrides void

    -

    Defined in src/renderer/api/endpoints/job.api.ts:14

    +

    Defined in src/renderer/api/endpoints/job.api.ts:14

    Type declaration:

    @@ -1481,7 +1493,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1503,12 +1515,12 @@

    getCompletions#

    ▸ getCompletions(): number

    -

    Defined in src/renderer/api/endpoints/job.api.ts:77

    +

    Defined in src/renderer/api/endpoints/job.api.ts:77

    Returns: number

    getCondition#

    ▸ getCondition(): object

    -

    Defined in src/renderer/api/endpoints/job.api.ts:85

    +

    Defined in src/renderer/api/endpoints/job.api.ts:85

    Returns: object

    @@ -1668,7 +1680,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1689,7 +1701,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1710,7 +1722,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1731,7 +1743,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html index 6c263ea1c9..2e366f5851 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1304,71 +1316,71 @@

    constructor#

    + new JobStore(): JobStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: JobStore

    Properties#

    api#

    • api: KubeApi‹Job‹›› = jobApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:10

    +

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:10

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): Job[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Job[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1391,7 +1403,7 @@

    create#

    ▸ create(params: object, data?: Partial‹Job›): Promise‹Job›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1419,7 +1431,7 @@

    ▸ createItem(params: object, data?: Partial‹Job›): Promise‹Job›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1446,7 +1458,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: Job): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1467,7 +1479,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: Job[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1488,7 +1500,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Job[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1516,7 +1528,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): Job[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1538,7 +1550,7 @@

    ▸ getByName(name: string, namespace?: string): Job

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1563,7 +1575,7 @@

    getByPath#

    ▸ getByPath(path: string): Job

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1583,7 +1595,7 @@

    getChildPods#

    ▸ getChildPods(job: Job): Pod[]

    -

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:12

    +

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:12

    Parameters:

    @@ -1603,7 +1615,7 @@

    getJobsByOwner#

    ▸ getJobsByOwner(cronJob: CronJob): Job‹›[]

    -

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:16

    +

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:16

    Parameters:

    @@ -1624,7 +1636,7 @@

    getStatuses#

    ▸ getStatuses(jobs?: Job[]): object

    Overrides KubeObjectStore.getStatuses

    -

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:23

    +

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:23

    Parameters:

    @@ -1659,7 +1671,7 @@

    isSelected#

    ▸ isSelected(item: Job): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1680,7 +1692,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: Job[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1703,7 +1715,7 @@

    load#

    ▸ load(params: object): Promise‹Job›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1730,13 +1742,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1758,7 +1770,7 @@

    ▸ loadItem(params: object): Promise‹Job›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1785,7 +1797,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹Job[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

    @@ -1806,7 +1818,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1827,7 +1839,7 @@

    remove#

    ▸ remove(item: Job): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1848,7 +1860,7 @@

    Protected removeItem#

    ▸ removeItem(item: Job, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: Job

    ▪ request: function

    @@ -1859,25 +1871,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: Job): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1898,7 +1910,7 @@

    Protected sortItems#

    ▸ sortItems(items: Job[], sorting?: function[], order?: "asc" | "desc"): Job[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1932,7 +1944,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1955,7 +1967,7 @@

    toggleSelection#

    ▸ toggleSelection(item: Job): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1976,7 +1988,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: Job[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1999,7 +2011,7 @@

    unselect#

    ▸ unselect(item: Job): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -2020,7 +2032,7 @@

    update#

    ▸ update(item: Job, data: Partial‹Job›): Promise‹Job›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -2045,13 +2057,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: Job, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: Job

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html index dbb223eb5e..7cbc3f4a18 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1190,7 +1202,7 @@

    Constructors#

    constructor#

    + new KubeApi(options: IKubeApiOptions‹T›): KubeApi

    -

    Defined in src/renderer/api/kube-api.ts:102

    +

    Defined in src/renderer/api/kube-api.ts:102

    Parameters:

    @@ -1210,69 +1222,69 @@

    Properties#

    apiBase#

    • apiBase: string

    -

    Defined in src/renderer/api/kube-api.ts:92

    +

    Defined in src/renderer/api/kube-api.ts:92

    apiGroup#

    • apiGroup: string

    -

    Defined in src/renderer/api/kube-api.ts:94

    +

    Defined in src/renderer/api/kube-api.ts:94

    apiPrefix#

    • apiPrefix: string

    -

    Defined in src/renderer/api/kube-api.ts:93

    +

    Defined in src/renderer/api/kube-api.ts:93

    apiResource#

    • apiResource: string

    -

    Defined in src/renderer/api/kube-api.ts:97

    +

    Defined in src/renderer/api/kube-api.ts:97

    apiVersion#

    • apiVersion: string

    -

    Defined in src/renderer/api/kube-api.ts:95

    +

    Defined in src/renderer/api/kube-api.ts:95

    Optional apiVersionPreferred#

    • apiVersionPreferred? : string

    -

    Defined in src/renderer/api/kube-api.ts:96

    +

    Defined in src/renderer/api/kube-api.ts:96

    isNamespaced#

    • isNamespaced: boolean

    -

    Defined in src/renderer/api/kube-api.ts:98

    +

    Defined in src/renderer/api/kube-api.ts:98

    kind#

    • kind: string

    -

    Defined in src/renderer/api/kube-api.ts:91

    +

    Defined in src/renderer/api/kube-api.ts:91

    objectConstructor#

    • objectConstructor: IKubeObjectConstructor‹T›

    -

    Defined in src/renderer/api/kube-api.ts:100

    +

    Defined in src/renderer/api/kube-api.ts:100

    Protected options#

    • options: IKubeApiOptions‹T›

    -

    Defined in src/renderer/api/kube-api.ts:104

    +

    Defined in src/renderer/api/kube-api.ts:104

    Protected request#

    • request: KubeJsonApi

    -

    Defined in src/renderer/api/kube-api.ts:101

    +

    Defined in src/renderer/api/kube-api.ts:101

    Protected resourceVersions#

    • resourceVersions: Map‹string, string› = new Map()

    -

    Defined in src/renderer/api/kube-api.ts:102

    +

    Defined in src/renderer/api/kube-api.ts:102

    Static parseApi#

    ▪ parseApi: parseKubeApi = parseKubeApi

    -

    Defined in src/renderer/api/kube-api.ts:83

    +

    Defined in src/renderer/api/kube-api.ts:83

    Accessors#

    apiVersionWithGroup#

    • get apiVersionWithGroup(): string

    -

    Defined in src/renderer/api/kube-api.ts:132

    +

    Defined in src/renderer/api/kube-api.ts:132

    Returns: string

    Methods#

    Protected checkPreferredVersion#

    ▸ checkPreferredVersion(): Promise‹void›

    -

    Defined in src/renderer/api/kube-api.ts:194

    +

    Defined in src/renderer/api/kube-api.ts:194

    Returns: Promise‹void›

    create#

    ▸ create(__namedParameters: object, data?: Partial‹T›): Promise‹T›

    -

    Defined in src/renderer/api/kube-api.ts:304

    +

    Defined in src/renderer/api/kube-api.ts:304

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1301,7 +1313,7 @@

    delete#

    ▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

    -

    Defined in src/renderer/api/kube-api.ts:331

    +

    Defined in src/renderer/api/kube-api.ts:331

    Parameters:

    ▪ __namedParameters: object

    @@ -1329,7 +1341,7 @@

    get#

    ▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹T›

    -

    Defined in src/renderer/api/kube-api.ts:296

    +

    Defined in src/renderer/api/kube-api.ts:296

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1358,7 +1370,7 @@

    getResourceVersion#

    ▸ getResourceVersion(namespace: string): string

    -

    Defined in src/renderer/api/kube-api.ts:227

    +

    Defined in src/renderer/api/kube-api.ts:227

    Parameters:

    @@ -1380,7 +1392,7 @@

    getUrl#

    ▸ getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    -

    Defined in src/renderer/api/kube-api.ts:235

    +

    Defined in src/renderer/api/kube-api.ts:235

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1409,7 +1421,7 @@

    getWatchUrl#

    ▸ getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    -

    Defined in src/renderer/api/kube-api.ts:338

    +

    Defined in src/renderer/api/kube-api.ts:338

    Parameters:

    @@ -1436,7 +1448,7 @@

    list#

    ▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹T[]›

    -

    Defined in src/renderer/api/kube-api.ts:288

    +

    Defined in src/renderer/api/kube-api.ts:288

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1460,7 +1472,7 @@

    Protected normalizeQuery#

    ▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    -

    Defined in src/renderer/api/kube-api.ts:247

    +

    Defined in src/renderer/api/kube-api.ts:247

    Parameters:

    @@ -1482,7 +1494,7 @@

    Protected parseResponse#

    ▸ parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    -

    Defined in src/renderer/api/kube-api.ts:259

    +

    Defined in src/renderer/api/kube-api.ts:259

    Parameters:

    @@ -1506,7 +1518,7 @@

    refreshResourceVersion#

    ▸ refreshResourceVersion(params?: object): Promise‹T[]›

    -

    Defined in src/renderer/api/kube-api.ts:231

    +

    Defined in src/renderer/api/kube-api.ts:231

    Parameters:

    ▪Optional params: object

    @@ -1527,7 +1539,7 @@

    setResourceVersion#

    ▸ setResourceVersion(namespace: string, newVersion: string): void

    -

    Defined in src/renderer/api/kube-api.ts:223

    +

    Defined in src/renderer/api/kube-api.ts:223

    Parameters:

    @@ -1554,7 +1566,7 @@

    update#

    ▸ update(__namedParameters: object, data?: Partial‹T›): Promise‹T›

    -

    Defined in src/renderer/api/kube-api.ts:322

    +

    Defined in src/renderer/api/kube-api.ts:322

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1583,13 +1595,13 @@

    watch#

    ▸ watch(): function

    -

    Defined in src/renderer/api/kube-api.ts:346

    +

    Defined in src/renderer/api/kube-api.ts:346

    Returns: function

    ▸ (): void

    Static watchAll#

    ▸ watchAll(...apis: KubeApi[]): (Anonymous function)

    -

    Defined in src/renderer/api/kube-api.ts:85

    +

    Defined in src/renderer/api/kube-api.ts:85

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html index abb06c5848..410691bc5c 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1285,7 +1297,7 @@

    constructor#

    + new KubeEvent(data: KubeJsonApiData): KubeEvent

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1306,23 +1318,23 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    count#

    • count: number

    -

    Defined in src/renderer/api/endpoints/events.api.ts:30

    +

    Defined in src/renderer/api/endpoints/events.api.ts:30

    eventTime#

    • eventTime: null

    -

    Defined in src/renderer/api/endpoints/events.api.ts:32

    +

    Defined in src/renderer/api/endpoints/events.api.ts:32

    firstTimestamp#

    • firstTimestamp: string

    -

    Defined in src/renderer/api/endpoints/events.api.ts:28

    +

    Defined in src/renderer/api/endpoints/events.api.ts:28

    involvedObject#

    • involvedObject: object

    -

    Defined in src/renderer/api/endpoints/events.api.ts:13

    +

    Defined in src/renderer/api/endpoints/events.api.ts:13

    Type declaration:

    @@ -1444,7 +1456,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1477,7 +1489,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1500,81 +1512,81 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getFirstSeenTime#

    ▸ getFirstSeenTime(): string

    -

    Defined in src/renderer/api/endpoints/events.api.ts:46

    +

    Defined in src/renderer/api/endpoints/events.api.ts:46

    Returns: string

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getLastSeenTime#

    ▸ getLastSeenTime(): string

    -

    Defined in src/renderer/api/endpoints/events.api.ts:52

    +

    Defined in src/renderer/api/endpoints/events.api.ts:52

    Returns: string

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getSource#

    ▸ getSource(): string

    -

    Defined in src/renderer/api/endpoints/events.api.ts:40

    +

    Defined in src/renderer/api/endpoints/events.api.ts:40

    Returns: string

    isWarning#

    ▸ isWarning(): boolean

    -

    Defined in src/renderer/api/endpoints/events.api.ts:36

    +

    Defined in src/renderer/api/endpoints/events.api.ts:36

    Returns: boolean

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1597,7 +1609,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1618,7 +1630,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1639,7 +1651,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1660,7 +1672,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1681,7 +1693,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html index 3044c65289..603b578c74 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1175,7 +1187,7 @@

    Constructors#

    constructor#

    + new KubeObject(data: KubeJsonApiData): KubeObject

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1195,36 +1207,36 @@

    Properties#

    apiVersion#

    • apiVersion: string

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    Optional status#

    • status? : any

    -

    Defined in src/renderer/api/kube-object.ts:79

    +

    Defined in src/renderer/api/kube-object.ts:79

    Static kind#

    ▪ kind: string

    -

    Defined in src/renderer/api/kube-object.ts:47

    +

    Defined in src/renderer/api/kube-object.ts:47

    Static namespaced#

    ▪ namespaced: boolean

    -

    Defined in src/renderer/api/kube-object.ts:48

    +

    Defined in src/renderer/api/kube-object.ts:48

    Accessors#

    • get selfLink(): string

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Returns: string

    Methods#

    delete#

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    -

    Defined in src/renderer/api/kube-object.ts:167

    +

    Defined in src/renderer/api/kube-object.ts:167

    Parameters:

    @@ -1244,7 +1256,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1276,7 +1288,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1298,52 +1310,52 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    toPlainObject#

    ▸ toPlainObject(): object

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1365,7 +1377,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1385,7 +1397,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1405,7 +1417,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1425,7 +1437,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1445,7 +1457,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html index e1d44e77a4..946d292170 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1325,65 +1337,65 @@

    Constructors#

    constructor#

    + new KubeObjectStore(): KubeObjectStore

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: KubeObjectStore

    Properties#

    Abstract api#

    • api: KubeApi‹T›

    -

    Defined in src/renderer/kube-object.store.ts:13

    +

    Defined in src/renderer/kube-object.store.ts:13

    bufferSize#

    • bufferSize: number = 50000

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): T[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: T[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1405,7 +1417,7 @@

    create#

    ▸ create(params: object, data?: Partial‹T›): Promise‹T›

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1432,7 +1444,7 @@

    Protected createItem#

    ▸ createItem(params: object, data?: Partial‹T›): Promise‹T›

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1459,7 +1471,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: T): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1479,7 +1491,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: T[]): T[]

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1499,7 +1511,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): T[]

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1526,7 +1538,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): T[]

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1547,7 +1559,7 @@

    getByName#

    ▸ getByName(name: string, namespace?: string): T

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1571,7 +1583,7 @@

    getByPath#

    ▸ getByPath(path: string): T

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1591,7 +1603,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: T[]): Record‹string, number›

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1612,7 +1624,7 @@

    isSelected#

    ▸ isSelected(item: T): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1633,7 +1645,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: T[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1655,7 +1667,7 @@

    load#

    ▸ load(params: object): Promise‹T›

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1681,12 +1693,12 @@

    loadAll#

    ▸ loadAll(): Promise‹void›

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1707,7 +1719,7 @@

    Protected loadItem#

    ▸ loadItem(params: object): Promise‹T›

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1733,7 +1745,7 @@

    Protected loadItems#

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹T[]›

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

    @@ -1753,7 +1765,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1773,7 +1785,7 @@

    remove#

    ▸ remove(item: T): Promise‹void›

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1794,7 +1806,7 @@

    Protected removeItem#

    ▸ removeItem(item: T, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: T

    ▪ request: function

    @@ -1804,25 +1816,25 @@

    removeSelectedItems#

    ▸ removeSelectedItems(): Promise‹void[]›

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: T): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1843,7 +1855,7 @@

    Protected sortItems#

    ▸ sortItems(items: T[], sorting?: function[], order?: "asc" | "desc"): T[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1876,7 +1888,7 @@

    subscribe#

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1899,7 +1911,7 @@

    toggleSelection#

    ▸ toggleSelection(item: T): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1920,7 +1932,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: T[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1943,7 +1955,7 @@

    unselect#

    ▸ unselect(item: T): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1963,7 +1975,7 @@

    update#

    ▸ update(item: T, data: Partial‹T›): Promise‹T›

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -1987,13 +1999,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: T, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: T

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html index c6579c5244..7364fc5e0c 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1173,7 +1185,7 @@

    constructor#

    + new Namespace(data: KubeJsonApiData): Namespace

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1194,22 +1206,22 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    Optional status#

    • status? : object

    Overrides KubeObject.status

    -

    Defined in src/renderer/api/endpoints/namespaces.api.ts:16

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:16

    Type declaration:

    @@ -1259,7 +1271,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1292,7 +1304,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1315,66 +1327,66 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getStatus#

    ▸ getStatus(): string

    -

    Defined in src/renderer/api/endpoints/namespaces.api.ts:20

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:20

    Returns: string

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1397,7 +1409,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1418,7 +1430,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1439,7 +1451,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1460,7 +1472,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1481,7 +1493,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html index c5085b3284..0361b8db5a 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1360,84 +1372,84 @@

    constructor#

    + new NamespaceStore(): NamespaceStore

    Overrides KubeObjectStore.constructor

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:21

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:21

    Returns: NamespaceStore

    Properties#

    api#

    • api: KubeApi‹Namespace‹›› = namespacesApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:12

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:12

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    contextNs#

    • contextNs: IObservableArray‹string› = observable.array()

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:13

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:13

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Protected storage#

    • storage: StorageHelper‹string[]› = createStorage("context_ns", this.contextNs)

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:15

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:15

    Accessors#

    initNamespaces#

    • get initNamespaces(): string[]

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:17

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:17

    Returns: string[]

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): Namespace[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Namespace[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1460,7 +1472,7 @@

    create#

    ▸ create(params: object, data?: Partial‹Namespace›): Promise‹Namespace›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1488,7 +1500,7 @@

    ▸ createItem(params: object, data?: Partial‹Namespace›): Promise‹Namespace›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1515,7 +1527,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: Namespace): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1536,7 +1548,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: Namespace[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1557,7 +1569,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Namespace[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1585,7 +1597,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): Namespace[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1607,7 +1619,7 @@

    ▸ getByName(name: string, namespace?: string): Namespace

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1632,7 +1644,7 @@

    getByPath#

    ▸ getByPath(path: string): Namespace

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1652,12 +1664,12 @@

    getContextParams#

    ▸ getContextParams(): Partial‹IQueryParams›

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:39

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:39

    Returns: Partial‹IQueryParams›

    Protected getDummyNamespace#

    ▸ getDummyNamespace(name: string): Namespace‹›

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:74

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:74

    Parameters:

    @@ -1678,7 +1690,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: Namespace[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1698,7 +1710,7 @@

    hasContext#

    ▸ hasContext(namespace: string | string[]): boolean

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:91

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:91

    Parameters:

    @@ -1719,7 +1731,7 @@

    isSelected#

    ▸ isSelected(item: Namespace): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1740,7 +1752,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: Namespace[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1763,7 +1775,7 @@

    load#

    ▸ load(params: object): Promise‹Namespace›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1790,13 +1802,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1818,7 +1830,7 @@

    ▸ loadItem(params: object): Promise‹Namespace›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1844,7 +1856,7 @@

    Protected loadItems#

    ▸ loadItems(namespaces?: string[]): Promise‹Namespace‹›[]›

    Overrides KubeObjectStore.loadItems

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:60

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:60

    Parameters:

    @@ -1865,7 +1877,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1886,7 +1898,7 @@

    remove#

    ▸ remove(item: Namespace): Promise‹void›

    Overrides KubeObjectStore.remove

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:108

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:108

    Parameters:

    @@ -1907,7 +1919,7 @@

    Protected removeItem#

    ▸ removeItem(item: Namespace, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: Namespace

    ▪ request: function

    @@ -1918,25 +1930,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:103

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:103

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: Namespace): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1956,7 +1968,7 @@

    setContext#

    ▸ setContext(namespaces: string[]): void

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:87

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:87

    Parameters:

    @@ -1977,7 +1989,7 @@

    Protected sortItems#

    ▸ sortItems(items: Namespace[], sorting?: function[], order?: "asc" | "desc"): Namespace[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -2010,7 +2022,7 @@

    subscribe#

    ▸ subscribe(apis: KubeApi‹Namespace‹››[]): (Anonymous function)

    Overrides KubeObjectStore.subscribe

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:45

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:45

    Parameters:

    @@ -2032,7 +2044,7 @@

    toggleContext#

    ▸ toggleContext(namespace: string): void

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:97

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:97

    Parameters:

    @@ -2053,7 +2065,7 @@

    toggleSelection#

    ▸ toggleSelection(item: Namespace): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2074,7 +2086,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: Namespace[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2097,7 +2109,7 @@

    unselect#

    ▸ unselect(item: Namespace): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -2118,7 +2130,7 @@

    update#

    ▸ update(item: Namespace, data: Partial‹Namespace›): Promise‹Namespace›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -2143,13 +2155,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: Namespace, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: Namespace

    ▪ request: function

    @@ -2158,7 +2170,7 @@

    Protected updateUrl#

    ▸ updateUrl(namespaces: string[]): void

    -

    Defined in src/renderer/components/+namespaces/namespace.store.ts:56

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:56

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html index 0ee9256543..15ed9cc619 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1189,7 +1201,7 @@

    constructor#

    + new NetworkPolicy(data: KubeJsonApiData): NetworkPolicy

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1210,21 +1222,21 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    spec#

    • spec: object

    -

    Defined in src/renderer/api/endpoints/network-policy.api.ts:44

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:44

    Type declaration:

    @@ -1296,7 +1308,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1329,7 +1341,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1352,71 +1364,71 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getMatchLabels#

    ▸ getMatchLabels(): string[]

    -

    Defined in src/renderer/api/endpoints/network-policy.api.ts:56

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:56

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getTypes#

    ▸ getTypes(): string[]

    -

    Defined in src/renderer/api/endpoints/network-policy.api.ts:64

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:64

    Returns: string[]

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1439,7 +1451,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1460,7 +1472,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1481,7 +1493,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1502,7 +1514,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1523,7 +1535,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html index 0a43e7d4a6..c1796893b9 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1288,71 +1300,71 @@

    constructor#

    + new NetworkPolicyStore(): NetworkPolicyStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: NetworkPolicyStore

    Properties#

    api#

    • api: KubeApi‹NetworkPolicy‹›› = networkPolicyApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+network-policies/network-policy.store.ts:8

    +

    Defined in src/renderer/components/+network-policies/network-policy.store.ts:8

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): NetworkPolicy[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: NetworkPolicy[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1375,7 +1387,7 @@

    create#

    ▸ create(params: object, data?: Partial‹NetworkPolicy›): Promise‹NetworkPolicy›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1403,7 +1415,7 @@

    ▸ createItem(params: object, data?: Partial‹NetworkPolicy›): Promise‹NetworkPolicy›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1430,7 +1442,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: NetworkPolicy): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1451,7 +1463,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: NetworkPolicy[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1472,7 +1484,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): NetworkPolicy[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1500,7 +1512,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): NetworkPolicy[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1522,7 +1534,7 @@

    ▸ getByName(name: string, namespace?: string): NetworkPolicy

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1547,7 +1559,7 @@

    getByPath#

    ▸ getByPath(path: string): NetworkPolicy

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1568,7 +1580,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: NetworkPolicy[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1589,7 +1601,7 @@

    isSelected#

    ▸ isSelected(item: NetworkPolicy): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1610,7 +1622,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: NetworkPolicy[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1633,7 +1645,7 @@

    load#

    ▸ load(params: object): Promise‹NetworkPolicy›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1660,13 +1672,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1688,7 +1700,7 @@

    ▸ loadItem(params: object): Promise‹NetworkPolicy›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1715,7 +1727,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹NetworkPolicy[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

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

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1757,7 +1769,7 @@

    remove#

    ▸ remove(item: NetworkPolicy): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1778,7 +1790,7 @@

    Protected removeItem#

    ▸ removeItem(item: NetworkPolicy, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: NetworkPolicy

    ▪ request: function

    @@ -1789,25 +1801,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: NetworkPolicy): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1828,7 +1840,7 @@

    Protected sortItems#

    ▸ sortItems(items: NetworkPolicy[], sorting?: function[], order?: "asc" | "desc"): NetworkPolicy[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1862,7 +1874,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1885,7 +1897,7 @@

    toggleSelection#

    ▸ toggleSelection(item: NetworkPolicy): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1906,7 +1918,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: NetworkPolicy[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1929,7 +1941,7 @@

    unselect#

    ▸ unselect(item: NetworkPolicy): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1950,7 +1962,7 @@

    update#

    ▸ update(item: NetworkPolicy, data: Partial‹NetworkPolicy›): Promise‹NetworkPolicy›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -1975,13 +1987,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: NetworkPolicy, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: NetworkPolicy

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.node/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.node/index.html index 1ea4ca1479..0d78bf80f0 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.node/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.node/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1261,7 +1273,7 @@

    constructor#

    + new Node(data: KubeJsonApiData): Node

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1282,21 +1294,21 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    spec#

    • spec: object

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:37

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:37

    Type declaration:

    @@ -1430,13 +1442,13 @@

    getActiveConditions#

    ▸ getActiveConditions(): object[]

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:138

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:138

    Returns: object[]

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1469,7 +1481,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1491,112 +1503,112 @@

    getConditions#

    ▸ getConditions(): object[]

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:128

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:128

    Returns: object[]

    getCpuCapacity#

    ▸ getCpuCapacity(): number

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:116

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:116

    Returns: number

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getKubeletVersion#

    ▸ getKubeletVersion(): string

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:150

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:150

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getMemoryCapacity#

    ▸ getMemoryCapacity(): number

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:122

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:122

    Returns: number

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNodeConditionText#

    ▸ getNodeConditionText(): string

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:88

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:88

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOperatingSystem#

    ▸ getOperatingSystem(): string

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:154

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:154

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getRoleLabels#

    ▸ getRoleLabels(): string

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:104

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:104

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getTaints#

    ▸ getTaints(): object[]

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:100

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:100

    Returns: object[]

    getWarningConditions#

    ▸ getWarningConditions(): object[]

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:142

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:142

    Returns: object[]

    isUnschedulable#

    ▸ isUnschedulable(): boolean

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:164

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:164

    Returns: boolean

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1619,7 +1631,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1640,7 +1652,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1661,7 +1673,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1682,7 +1694,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1703,7 +1715,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html index de7b1c6eeb..f81b29188a 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1186,7 +1198,7 @@

    constructor#

    + new NodesApi(options: IKubeApiOptions‹Node›): NodesApi

    Inherited from KubeApi.constructor

    -

    Defined in src/renderer/api/kube-api.ts:102

    +

    Defined in src/renderer/api/kube-api.ts:102

    Parameters:

    @@ -1207,84 +1219,84 @@

    apiBase#

    • apiBase: string

    Inherited from KubeApi.apiBase

    -

    Defined in src/renderer/api/kube-api.ts:92

    +

    Defined in src/renderer/api/kube-api.ts:92

    apiGroup#

    • apiGroup: string

    Inherited from KubeApi.apiGroup

    -

    Defined in src/renderer/api/kube-api.ts:94

    +

    Defined in src/renderer/api/kube-api.ts:94

    apiPrefix#

    • apiPrefix: string

    Inherited from KubeApi.apiPrefix

    -

    Defined in src/renderer/api/kube-api.ts:93

    +

    Defined in src/renderer/api/kube-api.ts:93

    apiResource#

    • apiResource: string

    Inherited from KubeApi.apiResource

    -

    Defined in src/renderer/api/kube-api.ts:97

    +

    Defined in src/renderer/api/kube-api.ts:97

    apiVersion#

    • apiVersion: string

    Inherited from KubeApi.apiVersion

    -

    Defined in src/renderer/api/kube-api.ts:95

    +

    Defined in src/renderer/api/kube-api.ts:95

    Optional apiVersionPreferred#

    • apiVersionPreferred? : string

    Inherited from KubeApi.apiVersionPreferred

    -

    Defined in src/renderer/api/kube-api.ts:96

    +

    Defined in src/renderer/api/kube-api.ts:96

    isNamespaced#

    • isNamespaced: boolean

    Inherited from KubeApi.isNamespaced

    -

    Defined in src/renderer/api/kube-api.ts:98

    +

    Defined in src/renderer/api/kube-api.ts:98

    kind#

    • kind: string

    Inherited from KubeApi.kind

    -

    Defined in src/renderer/api/kube-api.ts:91

    +

    Defined in src/renderer/api/kube-api.ts:91

    objectConstructor#

    • objectConstructor: IKubeObjectConstructor‹Node›

    Inherited from KubeApi.objectConstructor

    -

    Defined in src/renderer/api/kube-api.ts:100

    +

    Defined in src/renderer/api/kube-api.ts:100

    Protected options#

    • options: IKubeApiOptions‹Node›

    Inherited from KubeApi.options

    -

    Defined in src/renderer/api/kube-api.ts:104

    +

    Defined in src/renderer/api/kube-api.ts:104

    Protected request#

    • request: KubeJsonApi

    Inherited from KubeApi.request

    -

    Defined in src/renderer/api/kube-api.ts:101

    +

    Defined in src/renderer/api/kube-api.ts:101

    Protected resourceVersions#

    • resourceVersions: Map‹string, string› = new Map()

    Inherited from KubeApi.resourceVersions

    -

    Defined in src/renderer/api/kube-api.ts:102

    +

    Defined in src/renderer/api/kube-api.ts:102

    Static parseApi#

    ▪ parseApi: parseKubeApi = parseKubeApi

    Inherited from KubeApi.parseApi

    -

    Defined in src/renderer/api/kube-api.ts:83

    +

    Defined in src/renderer/api/kube-api.ts:83

    Accessors#

    apiVersionWithGroup#

    • get apiVersionWithGroup(): string

    Inherited from KubeApi.apiVersionWithGroup

    -

    Defined in src/renderer/api/kube-api.ts:132

    +

    Defined in src/renderer/api/kube-api.ts:132

    Returns: string

    Methods#

    Protected checkPreferredVersion#

    ▸ checkPreferredVersion(): Promise‹void›

    Inherited from KubeApi.checkPreferredVersion

    -

    Defined in src/renderer/api/kube-api.ts:194

    +

    Defined in src/renderer/api/kube-api.ts:194

    Returns: Promise‹void›

    create#

    ▸ create(__namedParameters: object, data?: Partial‹Node›): Promise‹Node›

    Inherited from KubeApi.create

    -

    Defined in src/renderer/api/kube-api.ts:304

    +

    Defined in src/renderer/api/kube-api.ts:304

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1314,7 +1326,7 @@

    delete#

    ▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

    Inherited from KubeApi.delete

    -

    Defined in src/renderer/api/kube-api.ts:331

    +

    Defined in src/renderer/api/kube-api.ts:331

    Parameters:

    ▪ __namedParameters: object

    @@ -1343,7 +1355,7 @@

    get#

    ▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Node›

    Inherited from KubeApi.get

    -

    Defined in src/renderer/api/kube-api.ts:296

    +

    Defined in src/renderer/api/kube-api.ts:296

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1372,13 +1384,13 @@

    getMetrics#

    ▸ getMetrics(): Promise‹INodeMetrics›

    -

    Defined in src/renderer/api/endpoints/nodes.api.ts:7

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:7

    Returns: Promise‹INodeMetrics›

    getResourceVersion#

    ▸ getResourceVersion(namespace: string): string

    Inherited from KubeApi.getResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:227

    +

    Defined in src/renderer/api/kube-api.ts:227

    Parameters:

    @@ -1401,7 +1413,7 @@

    getUrl#

    ▸ getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    Inherited from KubeApi.getUrl

    -

    Defined in src/renderer/api/kube-api.ts:235

    +

    Defined in src/renderer/api/kube-api.ts:235

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1431,7 +1443,7 @@

    getWatchUrl#

    ▸ getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    Inherited from KubeApi.getWatchUrl

    -

    Defined in src/renderer/api/kube-api.ts:338

    +

    Defined in src/renderer/api/kube-api.ts:338

    Parameters:

    @@ -1459,7 +1471,7 @@

    list#

    ▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Node[]›

    Inherited from KubeApi.list

    -

    Defined in src/renderer/api/kube-api.ts:288

    +

    Defined in src/renderer/api/kube-api.ts:288

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1484,7 +1496,7 @@

    Protected normalizeQuery#

    ▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    Inherited from KubeApi.normalizeQuery

    -

    Defined in src/renderer/api/kube-api.ts:247

    +

    Defined in src/renderer/api/kube-api.ts:247

    Parameters:

    @@ -1507,7 +1519,7 @@

    Protected parseResponse#

    ▸ parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    Inherited from KubeApi.parseResponse

    -

    Defined in src/renderer/api/kube-api.ts:259

    +

    Defined in src/renderer/api/kube-api.ts:259

    Parameters:

    @@ -1532,7 +1544,7 @@

    refreshResourceVersion#

    ▸ refreshResourceVersion(params?: object): Promise‹T[]›

    Inherited from KubeApi.refreshResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:231

    +

    Defined in src/renderer/api/kube-api.ts:231

    Parameters:

    ▪Optional params: object

    @@ -1554,7 +1566,7 @@

    setResourceVersion#

    ▸ setResourceVersion(namespace: string, newVersion: string): void

    Inherited from KubeApi.setResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:223

    +

    Defined in src/renderer/api/kube-api.ts:223

    Parameters:

    @@ -1582,7 +1594,7 @@

    update#

    ▸ update(__namedParameters: object, data?: Partial‹Node›): Promise‹Node›

    Inherited from KubeApi.update

    -

    Defined in src/renderer/api/kube-api.ts:322

    +

    Defined in src/renderer/api/kube-api.ts:322

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1612,14 +1624,14 @@

    watch#

    ▸ watch(): function

    Inherited from KubeApi.watch

    -

    Defined in src/renderer/api/kube-api.ts:346

    +

    Defined in src/renderer/api/kube-api.ts:346

    Returns: function

    ▸ (): void

    Static watchAll#

    ▸ watchAll(...apis: KubeApi[]): (Anonymous function)

    Inherited from KubeApi.watchAll

    -

    Defined in src/renderer/api/kube-api.ts:85

    +

    Defined in src/renderer/api/kube-api.ts:85

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html index 45581ae2f3..f5644b566e 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1360,97 +1372,97 @@

    constructor#

    + new NodesStore(): NodesStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: NodesStore

    Properties#

    api#

    • api: NodesApi‹› = nodesApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:9

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:9

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    metrics#

    • metrics: Partial‹INodeMetrics›

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:11

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:11

    metricsLoaded#

    • metricsLoaded: boolean = false

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:14

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:14

    metricsLoading#

    • metricsLoading: boolean = false

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:13

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:13

    nodeMetrics#

    • nodeMetrics: Partial‹IClusterMetrics› = null

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:12

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:12

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    masterNodes#

    • get masterNodes(): Node‹›[]

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:33

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:33

    Returns: Node‹›[]

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): Node[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Node[]

    workerNodes#

    • get workerNodes(): Node‹›[]

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:37

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:37

    Returns: Node‹›[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1473,7 +1485,7 @@

    create#

    ▸ create(params: object, data?: Partial‹Node›): Promise‹Node›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1501,7 +1513,7 @@

    ▸ createItem(params: object, data?: Partial‹Node›): Promise‹Node›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1528,7 +1540,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: Node): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1549,7 +1561,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: Node[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1570,7 +1582,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Node[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1598,7 +1610,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): Node[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1620,7 +1632,7 @@

    ▸ getByName(name: string, namespace?: string): Node

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1645,7 +1657,7 @@

    getByPath#

    ▸ getByPath(path: string): Node

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1665,7 +1677,7 @@

    getLastMetricValues#

    ▸ getLastMetricValues(node: Node, metricNames: string[]): number[]

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:41

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:41

    Parameters:

    @@ -1690,7 +1702,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: Node[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1711,7 +1723,7 @@

    isSelected#

    ▸ isSelected(item: Node): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1732,7 +1744,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: Node[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1755,7 +1767,7 @@

    load#

    ▸ load(params: object): Promise‹Node›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1782,13 +1794,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1810,7 +1822,7 @@

    ▸ loadItem(params: object): Promise‹Node›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1837,7 +1849,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹Node[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

    @@ -1857,7 +1869,7 @@

    loadMetrics#

    ▸ loadMetrics(nodeName: string): Promise‹void›

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:29

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:29

    Parameters:

    @@ -1877,13 +1889,13 @@

    loadUsageMetrics#

    ▸ loadUsageMetrics(): Promise‹void›

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:17

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:17

    Returns: Promise‹void›

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1904,7 +1916,7 @@

    remove#

    ▸ remove(item: Node): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1925,7 +1937,7 @@

    Protected removeItem#

    ▸ removeItem(item: Node, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: Node

    ▪ request: function

    @@ -1936,25 +1948,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+nodes/nodes.store.ts:65

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:65

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: Node): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1975,7 +1987,7 @@

    Protected sortItems#

    ▸ sortItems(items: Node[], sorting?: function[], order?: "asc" | "desc"): Node[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -2009,7 +2021,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -2032,7 +2044,7 @@

    toggleSelection#

    ▸ toggleSelection(item: Node): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2053,7 +2065,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: Node[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2076,7 +2088,7 @@

    unselect#

    ▸ unselect(item: Node): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -2097,7 +2109,7 @@

    update#

    ▸ update(item: Node, data: Partial‹Node›): Promise‹Node›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -2122,13 +2134,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: Node, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: Node

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html index b9b3c89423..6271613c3a 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1197,7 +1209,7 @@

    constructor#

    + new PersistentVolume(data: KubeJsonApiData): PersistentVolume

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1218,21 +1230,21 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    spec#

    • spec: object

    -

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:12

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:12

    Type declaration:

    @@ -1366,7 +1378,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1399,7 +1411,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1421,7 +1433,7 @@

    getCapacity#

    ▸ getCapacity(inBytes: boolean): string | number

    -

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:48

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:48

    Parameters:

    @@ -1443,72 +1455,72 @@

    getClaimRefName#

    ▸ getClaimRefName(): string

    -

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:66

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:66

    Returns: string

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getStatus#

    ▸ getStatus(): string

    -

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:60

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:60

    Returns: string

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1531,7 +1543,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1552,7 +1564,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1573,7 +1585,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1594,7 +1606,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1615,7 +1627,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html index 448aa970f6..4a05be951e 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1213,7 +1225,7 @@

    constructor#

    + new PersistentVolumeClaim(data: KubeJsonApiData): PersistentVolumeClaim

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1234,21 +1246,21 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    spec#

    • spec: object

    -

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:30

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:30

    Type declaration:

    @@ -1333,7 +1345,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1366,7 +1378,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1389,52 +1401,52 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getMatchExpressions#

    ▸ getMatchExpressions(): object[]

    -

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:77

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:77

    Returns: object[]

    getMatchLabels#

    ▸ getMatchLabels(): string[]

    -

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:70

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:70

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getPods#

    ▸ getPods(allPods: Pod[]): Pod[]

    -

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:53

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:53

    Parameters:

    @@ -1455,35 +1467,35 @@

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getStatus#

    ▸ getStatus(): string

    -

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:83

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:83

    Returns: string

    getStorage#

    ▸ getStorage(): string

    -

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:64

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:64

    Returns: string

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1506,7 +1518,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1527,7 +1539,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1548,7 +1560,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1569,7 +1581,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1590,7 +1602,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html index f6f36ef2b8..c88acde22e 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1186,7 +1198,7 @@

    constructor#

    + new PersistentVolumeClaimsApi(options: IKubeApiOptions‹PersistentVolumeClaim›): PersistentVolumeClaimsApi

    Inherited from KubeApi.constructor

    -

    Defined in src/renderer/api/kube-api.ts:102

    +

    Defined in src/renderer/api/kube-api.ts:102

    Parameters:

    @@ -1207,84 +1219,84 @@

    apiBase#

    • apiBase: string

    Inherited from KubeApi.apiBase

    -

    Defined in src/renderer/api/kube-api.ts:92

    +

    Defined in src/renderer/api/kube-api.ts:92

    apiGroup#

    • apiGroup: string

    Inherited from KubeApi.apiGroup

    -

    Defined in src/renderer/api/kube-api.ts:94

    +

    Defined in src/renderer/api/kube-api.ts:94

    apiPrefix#

    • apiPrefix: string

    Inherited from KubeApi.apiPrefix

    -

    Defined in src/renderer/api/kube-api.ts:93

    +

    Defined in src/renderer/api/kube-api.ts:93

    apiResource#

    • apiResource: string

    Inherited from KubeApi.apiResource

    -

    Defined in src/renderer/api/kube-api.ts:97

    +

    Defined in src/renderer/api/kube-api.ts:97

    apiVersion#

    • apiVersion: string

    Inherited from KubeApi.apiVersion

    -

    Defined in src/renderer/api/kube-api.ts:95

    +

    Defined in src/renderer/api/kube-api.ts:95

    Optional apiVersionPreferred#

    • apiVersionPreferred? : string

    Inherited from KubeApi.apiVersionPreferred

    -

    Defined in src/renderer/api/kube-api.ts:96

    +

    Defined in src/renderer/api/kube-api.ts:96

    isNamespaced#

    • isNamespaced: boolean

    Inherited from KubeApi.isNamespaced

    -

    Defined in src/renderer/api/kube-api.ts:98

    +

    Defined in src/renderer/api/kube-api.ts:98

    kind#

    • kind: string

    Inherited from KubeApi.kind

    -

    Defined in src/renderer/api/kube-api.ts:91

    +

    Defined in src/renderer/api/kube-api.ts:91

    objectConstructor#

    • objectConstructor: IKubeObjectConstructor‹PersistentVolumeClaim›

    Inherited from KubeApi.objectConstructor

    -

    Defined in src/renderer/api/kube-api.ts:100

    +

    Defined in src/renderer/api/kube-api.ts:100

    Protected options#

    • options: IKubeApiOptions‹PersistentVolumeClaim›

    Inherited from KubeApi.options

    -

    Defined in src/renderer/api/kube-api.ts:104

    +

    Defined in src/renderer/api/kube-api.ts:104

    Protected request#

    • request: KubeJsonApi

    Inherited from KubeApi.request

    -

    Defined in src/renderer/api/kube-api.ts:101

    +

    Defined in src/renderer/api/kube-api.ts:101

    Protected resourceVersions#

    • resourceVersions: Map‹string, string› = new Map()

    Inherited from KubeApi.resourceVersions

    -

    Defined in src/renderer/api/kube-api.ts:102

    +

    Defined in src/renderer/api/kube-api.ts:102

    Static parseApi#

    ▪ parseApi: parseKubeApi = parseKubeApi

    Inherited from KubeApi.parseApi

    -

    Defined in src/renderer/api/kube-api.ts:83

    +

    Defined in src/renderer/api/kube-api.ts:83

    Accessors#

    apiVersionWithGroup#

    • get apiVersionWithGroup(): string

    Inherited from KubeApi.apiVersionWithGroup

    -

    Defined in src/renderer/api/kube-api.ts:132

    +

    Defined in src/renderer/api/kube-api.ts:132

    Returns: string

    Methods#

    Protected checkPreferredVersion#

    ▸ checkPreferredVersion(): Promise‹void›

    Inherited from KubeApi.checkPreferredVersion

    -

    Defined in src/renderer/api/kube-api.ts:194

    +

    Defined in src/renderer/api/kube-api.ts:194

    Returns: Promise‹void›

    create#

    ▸ create(__namedParameters: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim›

    Inherited from KubeApi.create

    -

    Defined in src/renderer/api/kube-api.ts:304

    +

    Defined in src/renderer/api/kube-api.ts:304

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1314,7 +1326,7 @@

    delete#

    ▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

    Inherited from KubeApi.delete

    -

    Defined in src/renderer/api/kube-api.ts:331

    +

    Defined in src/renderer/api/kube-api.ts:331

    Parameters:

    ▪ __namedParameters: object

    @@ -1343,7 +1355,7 @@

    get#

    ▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹PersistentVolumeClaim›

    Inherited from KubeApi.get

    -

    Defined in src/renderer/api/kube-api.ts:296

    +

    Defined in src/renderer/api/kube-api.ts:296

    Parameters:

    ▪Default value __namedParameters: object= {}

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

    getMetrics#

    ▸ getMetrics(pvcName: string, namespace: string): Promise‹IPvcMetrics›

    -

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:8

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:8

    Parameters:

    @@ -1397,7 +1409,7 @@

    getResourceVersion#

    ▸ getResourceVersion(namespace: string): string

    Inherited from KubeApi.getResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:227

    +

    Defined in src/renderer/api/kube-api.ts:227

    Parameters:

    @@ -1420,7 +1432,7 @@

    getUrl#

    ▸ getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    Inherited from KubeApi.getUrl

    -

    Defined in src/renderer/api/kube-api.ts:235

    +

    Defined in src/renderer/api/kube-api.ts:235

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1450,7 +1462,7 @@

    getWatchUrl#

    ▸ getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    Inherited from KubeApi.getWatchUrl

    -

    Defined in src/renderer/api/kube-api.ts:338

    +

    Defined in src/renderer/api/kube-api.ts:338

    Parameters:

    @@ -1478,7 +1490,7 @@

    list#

    ▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹PersistentVolumeClaim[]›

    Inherited from KubeApi.list

    -

    Defined in src/renderer/api/kube-api.ts:288

    +

    Defined in src/renderer/api/kube-api.ts:288

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1503,7 +1515,7 @@

    Protected normalizeQuery#

    ▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    Inherited from KubeApi.normalizeQuery

    -

    Defined in src/renderer/api/kube-api.ts:247

    +

    Defined in src/renderer/api/kube-api.ts:247

    Parameters:

    @@ -1526,7 +1538,7 @@

    Protected parseResponse#

    ▸ parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    Inherited from KubeApi.parseResponse

    -

    Defined in src/renderer/api/kube-api.ts:259

    +

    Defined in src/renderer/api/kube-api.ts:259

    Parameters:

    @@ -1551,7 +1563,7 @@

    refreshResourceVersion#

    ▸ refreshResourceVersion(params?: object): Promise‹T[]›

    Inherited from KubeApi.refreshResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:231

    +

    Defined in src/renderer/api/kube-api.ts:231

    Parameters:

    ▪Optional params: object

    @@ -1573,7 +1585,7 @@

    setResourceVersion#

    ▸ setResourceVersion(namespace: string, newVersion: string): void

    Inherited from KubeApi.setResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:223

    +

    Defined in src/renderer/api/kube-api.ts:223

    Parameters:

    @@ -1601,7 +1613,7 @@

    update#

    ▸ update(__namedParameters: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim›

    Inherited from KubeApi.update

    -

    Defined in src/renderer/api/kube-api.ts:322

    +

    Defined in src/renderer/api/kube-api.ts:322

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1631,14 +1643,14 @@

    watch#

    ▸ watch(): function

    Inherited from KubeApi.watch

    -

    Defined in src/renderer/api/kube-api.ts:346

    +

    Defined in src/renderer/api/kube-api.ts:346

    Returns: function

    ▸ (): void

    Static watchAll#

    ▸ watchAll(...apis: KubeApi[]): (Anonymous function)

    Inherited from KubeApi.watchAll

    -

    Defined in src/renderer/api/kube-api.ts:85

    +

    Defined in src/renderer/api/kube-api.ts:85

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html index 575a2611ec..21176dce22 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1288,71 +1300,71 @@

    constructor#

    + new PersistentVolumesStore(): PersistentVolumesStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: PersistentVolumesStore

    Properties#

    api#

    • api: KubeApi‹PersistentVolume‹›› = persistentVolumeApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+storage-volumes/volumes.store.ts:8

    +

    Defined in src/renderer/components/+storage-volumes/volumes.store.ts:8

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): PersistentVolume[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: PersistentVolume[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1375,7 +1387,7 @@

    create#

    ▸ create(params: object, data?: Partial‹PersistentVolume›): Promise‹PersistentVolume›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1403,7 +1415,7 @@

    ▸ createItem(params: object, data?: Partial‹PersistentVolume›): Promise‹PersistentVolume›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1430,7 +1442,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: PersistentVolume): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1451,7 +1463,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: PersistentVolume[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1472,7 +1484,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): PersistentVolume[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1500,7 +1512,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): PersistentVolume[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1522,7 +1534,7 @@

    ▸ getByName(name: string, namespace?: string): PersistentVolume

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1547,7 +1559,7 @@

    getByPath#

    ▸ getByPath(path: string): PersistentVolume

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1568,7 +1580,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: PersistentVolume[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1589,7 +1601,7 @@

    isSelected#

    ▸ isSelected(item: PersistentVolume): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1610,7 +1622,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: PersistentVolume[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1633,7 +1645,7 @@

    load#

    ▸ load(params: object): Promise‹PersistentVolume›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1660,13 +1672,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1688,7 +1700,7 @@

    ▸ loadItem(params: object): Promise‹PersistentVolume›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1715,7 +1727,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹PersistentVolume[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

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

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1757,7 +1769,7 @@

    remove#

    ▸ remove(item: PersistentVolume): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1778,7 +1790,7 @@

    Protected removeItem#

    ▸ removeItem(item: PersistentVolume, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: PersistentVolume

    ▪ request: function

    @@ -1789,25 +1801,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: PersistentVolume): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1828,7 +1840,7 @@

    Protected sortItems#

    ▸ sortItems(items: PersistentVolume[], sorting?: function[], order?: "asc" | "desc"): PersistentVolume[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1862,7 +1874,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1885,7 +1897,7 @@

    toggleSelection#

    ▸ toggleSelection(item: PersistentVolume): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1906,7 +1918,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: PersistentVolume[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1929,7 +1941,7 @@

    unselect#

    ▸ unselect(item: PersistentVolume): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1950,7 +1962,7 @@

    update#

    ▸ update(item: PersistentVolume, data: Partial‹PersistentVolume›): Promise‹PersistentVolume›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -1975,13 +1987,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: PersistentVolume, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: PersistentVolume

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html index 482b8dd807..80dec611b5 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1389,7 +1401,7 @@

    constructor#

    + new Pod(data: KubeJsonApiData): Pod

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1410,22 +1422,22 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    spec#

    • spec: object

    Overrides void

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:179

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:179

    Type declaration:

    @@ -1557,19 +1569,19 @@

    getAffinity#

    ▸ getAffinity(): IAffinity

    Overrides Deployment.getAffinity

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:380

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:380

    Returns: IAffinity

    getAffinityNumber#

    ▸ getAffinityNumber(): number

    Inherited from Pod.getAffinityNumber

    -

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    Returns: number

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1601,13 +1613,13 @@

    getAllContainers#

    ▸ getAllContainers(): IPodContainer[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:245

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:245

    Returns: IPodContainer[]

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1629,12 +1641,12 @@

    getConditions#

    ▸ getConditions(): object[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:354

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:354

    Returns: object[]

    getContainerStatuses#

    ▸ getContainerStatuses(includeInitContainers: boolean): IPodContainerStatus[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:258

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:258

    Parameters:

    @@ -1656,35 +1668,35 @@

    getContainers#

    ▸ getContainers(): IPodContainer[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:241

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:241

    Returns: IPodContainer[]

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getInitContainers#

    ▸ getInitContainers(): IPodContainer[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:237

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:237

    Returns: IPodContainer[]

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getLivenessProbe#

    ▸ getLivenessProbe(container: IPodContainer): string[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:401

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:401

    Parameters:

    @@ -1705,40 +1717,40 @@

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNodeName#

    ▸ getNodeName(): string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:447

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:447

    Returns: string

    getNodeSelectors#

    ▸ getNodeSelectors(): string[]

    Overrides Deployment.getNodeSelectors

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:368

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:368

    Returns: string[]

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getPriorityClassName#

    ▸ getPriorityClassName(): string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:289

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:289

    Returns: string

    getProbe#

    ▸ getProbe(probeData: IContainerProbe): string[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:409

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:409

    Parameters:

    @@ -1758,12 +1770,12 @@

    getQosClass#

    ▸ getQosClass(): string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:281

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:281

    Returns: string

    getReadinessProbe#

    ▸ getReadinessProbe(container: IPodContainer): string[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:405

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:405

    Parameters:

    @@ -1783,94 +1795,94 @@

    getReason#

    ▸ getReason(): string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:285

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:285

    Returns: string

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getRestartsCount#

    ▸ getRestartsCount(): number

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:273

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:273

    Returns: number

    getRunningContainers#

    ▸ getRunningContainers(): IPodContainer[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:249

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:249

    Returns: IPodContainer[]

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getSecrets#

    ▸ getSecrets(): string[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:362

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:362

    Returns: string[]

    getSelectedNodeOs#

    ▸ getSelectedNodeOs(): string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:451

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:451

    Returns: string

    getSelectors#

    ▸ getSelectors(): string[]

    Inherited from Pod.getSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    Returns: string[]

    getStatus#

    ▸ getStatus(): FAILED | PENDING | RUNNING | SUCCEEDED | EVICTED

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:294

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:294

    Returns: FAILED | PENDING | RUNNING | SUCCEEDED | EVICTED

    getStatusMessage#

    ▸ getStatusMessage(): string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:321

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:321

    Returns: string

    getStatusPhase#

    ▸ getStatusPhase(): string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:350

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:350

    Returns: string

    getTemplateLabels#

    ▸ getTemplateLabels(): string[]

    Inherited from Pod.getTemplateLabels

    -

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    Returns: string[]

    getTolerations#

    ▸ getTolerations(): object[]

    Overrides Deployment.getTolerations

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:376

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:376

    Returns: object[]

    getVolumes#

    ▸ getVolumes(): object[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:358

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:358

    Returns: object[]

    hasIssues#

    ▸ hasIssues(): boolean

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:384

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:384

    Returns: boolean

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1893,7 +1905,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1914,7 +1926,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1935,7 +1947,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1956,7 +1968,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1977,7 +1989,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html index 783dfa8d6b..616a666cc5 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1213,7 +1225,7 @@

    constructor#

    + new PodDisruptionBudget(data: KubeJsonApiData): PodDisruptionBudget

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1234,21 +1246,21 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    spec#

    • spec: object

    -

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:11

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:11

    Type declaration:

    @@ -1329,7 +1341,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1362,7 +1374,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1384,87 +1396,87 @@

    getCurrentHealthy#

    ▸ getCurrentHealthy(): number

    -

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:37

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:37

    Returns: number

    getDesiredHealthy#

    ▸ getDesiredHealthy(): number

    -

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:41

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:41

    Returns: number

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getMaxUnavailable#

    ▸ getMaxUnavailable(): string

    -

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:33

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:33

    Returns: string

    getMinAvailable#

    ▸ getMinAvailable(): string

    -

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:29

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:29

    Returns: string

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getSelectors#

    ▸ getSelectors(): string[]

    -

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:23

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:23

    Returns: string[]

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1487,7 +1499,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1508,7 +1520,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1529,7 +1541,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1550,7 +1562,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1571,7 +1583,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html index 3d88bea7b0..27da662d29 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1288,71 +1300,71 @@

    constructor#

    + new PodDisruptionBudgetsStore(): PodDisruptionBudgetsStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: PodDisruptionBudgetsStore

    Properties#

    api#

    • api: KubeApi‹PodDisruptionBudget‹›› = pdbApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+config-pod-disruption-budgets/pod-disruption-budgets.store.ts:8

    +

    Defined in src/renderer/components/+config-pod-disruption-budgets/pod-disruption-budgets.store.ts:8

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): PodDisruptionBudget[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: PodDisruptionBudget[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1375,7 +1387,7 @@

    create#

    ▸ create(params: object, data?: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1403,7 +1415,7 @@

    ▸ createItem(params: object, data?: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1430,7 +1442,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: PodDisruptionBudget): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1451,7 +1463,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: PodDisruptionBudget[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1472,7 +1484,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): PodDisruptionBudget[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1500,7 +1512,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): PodDisruptionBudget[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1522,7 +1534,7 @@

    ▸ getByName(name: string, namespace?: string): PodDisruptionBudget

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1547,7 +1559,7 @@

    getByPath#

    ▸ getByPath(path: string): PodDisruptionBudget

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1568,7 +1580,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: PodDisruptionBudget[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1589,7 +1601,7 @@

    isSelected#

    ▸ isSelected(item: PodDisruptionBudget): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1610,7 +1622,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: PodDisruptionBudget[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1633,7 +1645,7 @@

    load#

    ▸ load(params: object): Promise‹PodDisruptionBudget›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1660,13 +1672,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1688,7 +1700,7 @@

    ▸ loadItem(params: object): Promise‹PodDisruptionBudget›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1715,7 +1727,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹PodDisruptionBudget[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

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

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1757,7 +1769,7 @@

    remove#

    ▸ remove(item: PodDisruptionBudget): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1778,7 +1790,7 @@

    Protected removeItem#

    ▸ removeItem(item: PodDisruptionBudget, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: PodDisruptionBudget

    ▪ request: function

    @@ -1789,25 +1801,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: PodDisruptionBudget): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1828,7 +1840,7 @@

    Protected sortItems#

    ▸ sortItems(items: PodDisruptionBudget[], sorting?: function[], order?: "asc" | "desc"): PodDisruptionBudget[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1862,7 +1874,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1885,7 +1897,7 @@

    toggleSelection#

    ▸ toggleSelection(item: PodDisruptionBudget): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1906,7 +1918,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: PodDisruptionBudget[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1929,7 +1941,7 @@

    unselect#

    ▸ unselect(item: PodDisruptionBudget): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1950,7 +1962,7 @@

    update#

    ▸ update(item: PodDisruptionBudget, data: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -1975,13 +1987,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: PodDisruptionBudget, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: PodDisruptionBudget

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html index ad0a9f00ce..99c4f1444c 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1194,7 +1206,7 @@

    constructor#

    + new PodsApi(options: IKubeApiOptions‹Pod›): PodsApi

    Inherited from KubeApi.constructor

    -

    Defined in src/renderer/api/kube-api.ts:102

    +

    Defined in src/renderer/api/kube-api.ts:102

    Parameters:

    @@ -1215,84 +1227,84 @@

    apiBase#

    • apiBase: string

    Inherited from KubeApi.apiBase

    -

    Defined in src/renderer/api/kube-api.ts:92

    +

    Defined in src/renderer/api/kube-api.ts:92

    apiGroup#

    • apiGroup: string

    Inherited from KubeApi.apiGroup

    -

    Defined in src/renderer/api/kube-api.ts:94

    +

    Defined in src/renderer/api/kube-api.ts:94

    apiPrefix#

    • apiPrefix: string

    Inherited from KubeApi.apiPrefix

    -

    Defined in src/renderer/api/kube-api.ts:93

    +

    Defined in src/renderer/api/kube-api.ts:93

    apiResource#

    • apiResource: string

    Inherited from KubeApi.apiResource

    -

    Defined in src/renderer/api/kube-api.ts:97

    +

    Defined in src/renderer/api/kube-api.ts:97

    apiVersion#

    • apiVersion: string

    Inherited from KubeApi.apiVersion

    -

    Defined in src/renderer/api/kube-api.ts:95

    +

    Defined in src/renderer/api/kube-api.ts:95

    Optional apiVersionPreferred#

    • apiVersionPreferred? : string

    Inherited from KubeApi.apiVersionPreferred

    -

    Defined in src/renderer/api/kube-api.ts:96

    +

    Defined in src/renderer/api/kube-api.ts:96

    isNamespaced#

    • isNamespaced: boolean

    Inherited from KubeApi.isNamespaced

    -

    Defined in src/renderer/api/kube-api.ts:98

    +

    Defined in src/renderer/api/kube-api.ts:98

    kind#

    • kind: string

    Inherited from KubeApi.kind

    -

    Defined in src/renderer/api/kube-api.ts:91

    +

    Defined in src/renderer/api/kube-api.ts:91

    objectConstructor#

    • objectConstructor: IKubeObjectConstructor‹Pod›

    Inherited from KubeApi.objectConstructor

    -

    Defined in src/renderer/api/kube-api.ts:100

    +

    Defined in src/renderer/api/kube-api.ts:100

    Protected options#

    • options: IKubeApiOptions‹Pod›

    Inherited from KubeApi.options

    -

    Defined in src/renderer/api/kube-api.ts:104

    +

    Defined in src/renderer/api/kube-api.ts:104

    Protected request#

    • request: KubeJsonApi

    Inherited from KubeApi.request

    -

    Defined in src/renderer/api/kube-api.ts:101

    +

    Defined in src/renderer/api/kube-api.ts:101

    Protected resourceVersions#

    • resourceVersions: Map‹string, string› = new Map()

    Inherited from KubeApi.resourceVersions

    -

    Defined in src/renderer/api/kube-api.ts:102

    +

    Defined in src/renderer/api/kube-api.ts:102

    Static parseApi#

    ▪ parseApi: parseKubeApi = parseKubeApi

    Inherited from KubeApi.parseApi

    -

    Defined in src/renderer/api/kube-api.ts:83

    +

    Defined in src/renderer/api/kube-api.ts:83

    Accessors#

    apiVersionWithGroup#

    • get apiVersionWithGroup(): string

    Inherited from KubeApi.apiVersionWithGroup

    -

    Defined in src/renderer/api/kube-api.ts:132

    +

    Defined in src/renderer/api/kube-api.ts:132

    Returns: string

    Methods#

    Protected checkPreferredVersion#

    ▸ checkPreferredVersion(): Promise‹void›

    Inherited from KubeApi.checkPreferredVersion

    -

    Defined in src/renderer/api/kube-api.ts:194

    +

    Defined in src/renderer/api/kube-api.ts:194

    Returns: Promise‹void›

    create#

    ▸ create(__namedParameters: object, data?: Partial‹Pod›): Promise‹Pod›

    Inherited from KubeApi.create

    -

    Defined in src/renderer/api/kube-api.ts:304

    +

    Defined in src/renderer/api/kube-api.ts:304

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1322,7 +1334,7 @@

    delete#

    ▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

    Inherited from KubeApi.delete

    -

    Defined in src/renderer/api/kube-api.ts:331

    +

    Defined in src/renderer/api/kube-api.ts:331

    Parameters:

    ▪ __namedParameters: object

    @@ -1351,7 +1363,7 @@

    get#

    ▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Pod›

    Inherited from KubeApi.get

    -

    Defined in src/renderer/api/kube-api.ts:296

    +

    Defined in src/renderer/api/kube-api.ts:296

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1380,7 +1392,7 @@

    getLogs#

    ▸ getLogs(params: object, query?: IPodLogsQuery): Promise‹string›

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:7

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:7

    Parameters:

    ▪ params: object

    @@ -1406,7 +1418,7 @@

    getMetrics#

    ▸ getMetrics(pods: Pod[], namespace: string, selector: string): Promise‹IPodMetrics›

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:13

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:13

    Parameters:

    @@ -1439,7 +1451,7 @@

    getResourceVersion#

    ▸ getResourceVersion(namespace: string): string

    Inherited from KubeApi.getResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:227

    +

    Defined in src/renderer/api/kube-api.ts:227

    Parameters:

    @@ -1462,7 +1474,7 @@

    getUrl#

    ▸ getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    Inherited from KubeApi.getUrl

    -

    Defined in src/renderer/api/kube-api.ts:235

    +

    Defined in src/renderer/api/kube-api.ts:235

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1492,7 +1504,7 @@

    getWatchUrl#

    ▸ getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    Inherited from KubeApi.getWatchUrl

    -

    Defined in src/renderer/api/kube-api.ts:338

    +

    Defined in src/renderer/api/kube-api.ts:338

    Parameters:

    @@ -1520,7 +1532,7 @@

    list#

    ▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Pod[]›

    Inherited from KubeApi.list

    -

    Defined in src/renderer/api/kube-api.ts:288

    +

    Defined in src/renderer/api/kube-api.ts:288

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1545,7 +1557,7 @@

    Protected normalizeQuery#

    ▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    Inherited from KubeApi.normalizeQuery

    -

    Defined in src/renderer/api/kube-api.ts:247

    +

    Defined in src/renderer/api/kube-api.ts:247

    Parameters:

    @@ -1568,7 +1580,7 @@

    Protected parseResponse#

    ▸ parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    Inherited from KubeApi.parseResponse

    -

    Defined in src/renderer/api/kube-api.ts:259

    +

    Defined in src/renderer/api/kube-api.ts:259

    Parameters:

    @@ -1593,7 +1605,7 @@

    refreshResourceVersion#

    ▸ refreshResourceVersion(params?: object): Promise‹T[]›

    Inherited from KubeApi.refreshResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:231

    +

    Defined in src/renderer/api/kube-api.ts:231

    Parameters:

    ▪Optional params: object

    @@ -1615,7 +1627,7 @@

    setResourceVersion#

    ▸ setResourceVersion(namespace: string, newVersion: string): void

    Inherited from KubeApi.setResourceVersion

    -

    Defined in src/renderer/api/kube-api.ts:223

    +

    Defined in src/renderer/api/kube-api.ts:223

    Parameters:

    @@ -1643,7 +1655,7 @@

    update#

    ▸ update(__namedParameters: object, data?: Partial‹Pod›): Promise‹Pod›

    Inherited from KubeApi.update

    -

    Defined in src/renderer/api/kube-api.ts:322

    +

    Defined in src/renderer/api/kube-api.ts:322

    Parameters:

    ▪Default value __namedParameters: object= {}

    @@ -1673,14 +1685,14 @@

    watch#

    ▸ watch(): function

    Inherited from KubeApi.watch

    -

    Defined in src/renderer/api/kube-api.ts:346

    +

    Defined in src/renderer/api/kube-api.ts:346

    Returns: function

    ▸ (): void

    Static watchAll#

    ▸ watchAll(...apis: KubeApi[]): (Anonymous function)

    Inherited from KubeApi.watchAll

    -

    Defined in src/renderer/api/kube-api.ts:85

    +

    Defined in src/renderer/api/kube-api.ts:85

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html index 499a8468e8..7af2d78e32 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1352,79 +1364,79 @@

    constructor#

    + new PodsStore(): PodsStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: PodsStore

    Properties#

    api#

    • api: PodsApi‹› = podsApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:11

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:11

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    kubeMetrics#

    • kubeMetrics: IObservableArray‹PodMetrics‹›› = observable.array([])

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:14

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:14

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    metrics#

    • metrics: IPodMetrics = null

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:13

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:13

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): Pod[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Pod[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1447,7 +1459,7 @@

    create#

    ▸ create(params: object, data?: Partial‹Pod›): Promise‹Pod›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1475,7 +1487,7 @@

    ▸ createItem(params: object, data?: Partial‹Pod›): Promise‹Pod›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1502,7 +1514,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: Pod): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1523,7 +1535,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: Pod[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1544,7 +1556,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Pod[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1572,7 +1584,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): Pod[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1594,7 +1606,7 @@

    ▸ getByName(name: string, namespace?: string): Pod

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1619,7 +1631,7 @@

    getByPath#

    ▸ getByPath(path: string): Pod

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1639,7 +1651,7 @@

    getPodKubeMetrics#

    ▸ getPodKubeMetrics(pod: Pod): object

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:53

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:53

    Parameters:

    @@ -1667,7 +1679,7 @@

    getPodsByNode#

    ▸ getPodsByNode(node: string): Pod‹›[]

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:43

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:43

    Parameters:

    @@ -1687,7 +1699,7 @@

    getPodsByOwner#

    ▸ getPodsByOwner(workload: WorkloadKubeObject): Pod[]

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:31

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:31

    Parameters:

    @@ -1708,7 +1720,7 @@

    getStatuses#

    ▸ getStatuses(pods: Pod[]): Dictionary‹number›

    Overrides KubeObjectStore.getStatuses

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:49

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:49

    Parameters:

    @@ -1729,7 +1741,7 @@

    isSelected#

    ▸ isSelected(item: Pod): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1750,7 +1762,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: Pod[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1773,7 +1785,7 @@

    load#

    ▸ load(params: object): Promise‹Pod›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1800,12 +1812,12 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadContainerMetrics#

    ▸ loadContainerMetrics(pod: Pod): Promise‹IPodMetrics‹IMetrics››

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:21

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:21

    Parameters:

    @@ -1826,7 +1838,7 @@

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1848,7 +1860,7 @@

    ▸ loadItem(params: object): Promise‹Pod›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

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

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹Pod[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

    @@ -1895,7 +1907,7 @@

    loadKubeMetrics#

    ▸ loadKubeMetrics(namespace?: string): Promise‹void›

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:25

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:25

    Parameters:

    @@ -1915,7 +1927,7 @@

    loadMetrics#

    ▸ loadMetrics(pod: Pod): Promise‹void›

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:17

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:17

    Parameters:

    @@ -1936,7 +1948,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1957,7 +1969,7 @@

    remove#

    ▸ remove(item: Pod): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1978,7 +1990,7 @@

    Protected removeItem#

    ▸ removeItem(item: Pod, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: Pod

    ▪ request: function

    @@ -1989,25 +2001,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:82

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:82

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: Pod): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -2028,7 +2040,7 @@

    Protected sortItems#

    ▸ sortItems(items: Pod[], sorting?: function[], order?: "asc" | "desc"): Pod[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -2062,7 +2074,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -2085,7 +2097,7 @@

    toggleSelection#

    ▸ toggleSelection(item: Pod): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2106,7 +2118,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: Pod[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2129,7 +2141,7 @@

    unselect#

    ▸ unselect(item: Pod): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -2150,7 +2162,7 @@

    update#

    ▸ update(item: Pod, data: Partial‹Pod›): Promise‹Pod›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -2175,13 +2187,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: Pod, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: Pod

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html index a616f83bd0..f1197d0ff6 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1229,7 +1241,7 @@

    constructor#

    + new ReplicaSet(data: KubeJsonApiData): ReplicaSet

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1250,22 +1262,22 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    spec#

    • spec: object

    Overrides void

    -

    Defined in src/renderer/api/endpoints/replica-set.api.ts:13

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:13

    Type declaration:

    @@ -1381,19 +1393,19 @@

    getAffinity#

    ▸ getAffinity(): IAffinity

    Inherited from Deployment.getAffinity

    -

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    Returns: IAffinity

    getAffinityNumber#

    ▸ getAffinityNumber(): number

    Inherited from Pod.getAffinityNumber

    -

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    Returns: number

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1426,7 +1438,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1449,90 +1461,90 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getImages#

    ▸ getImages(): string[]

    -

    Defined in src/renderer/api/endpoints/replica-set.api.ts:49

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:49

    Returns: string[]

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNodeSelectors#

    ▸ getNodeSelectors(): string[]

    Inherited from Deployment.getNodeSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    Returns: string[]

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getSelectors#

    ▸ getSelectors(): string[]

    Inherited from Pod.getSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    Returns: string[]

    getTemplateLabels#

    ▸ getTemplateLabels(): string[]

    Inherited from Pod.getTemplateLabels

    -

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    Returns: string[]

    getTolerations#

    ▸ getTolerations(): IToleration[]

    Inherited from Deployment.getTolerations

    -

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    Returns: IToleration[]

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1555,7 +1567,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1576,7 +1588,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1597,7 +1609,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1618,7 +1630,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1639,7 +1651,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html index 9c8b63baed..a96e35ac1c 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1320,75 +1332,75 @@

    constructor#

    + new ReplicaSetStore(): ReplicaSetStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: ReplicaSetStore

    Properties#

    api#

    • api: KubeApi‹ReplicaSet‹›› = replicaSetApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:10

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:10

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    metrics#

    • metrics: IPodMetrics = null

    -

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:11

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:11

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): ReplicaSet[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: ReplicaSet[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1411,7 +1423,7 @@

    create#

    ▸ create(params: object, data?: Partial‹ReplicaSet›): Promise‹ReplicaSet›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1439,7 +1451,7 @@

    ▸ createItem(params: object, data?: Partial‹ReplicaSet›): Promise‹ReplicaSet›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1466,7 +1478,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: ReplicaSet): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1487,7 +1499,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: ReplicaSet[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1508,7 +1520,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): ReplicaSet[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1536,7 +1548,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): ReplicaSet[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1558,7 +1570,7 @@

    ▸ getByName(name: string, namespace?: string): ReplicaSet

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1583,7 +1595,7 @@

    getByPath#

    ▸ getByPath(path: string): ReplicaSet

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1603,7 +1615,7 @@

    getChildPods#

    ▸ getChildPods(replicaSet: ReplicaSet): Pod‹›[]

    -

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:19

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:19

    Parameters:

    @@ -1623,7 +1635,7 @@

    getReplicaSetsByOwner#

    ▸ getReplicaSetsByOwner(deployment: Deployment): ReplicaSet‹›[]

    -

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:23

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:23

    Parameters:

    @@ -1644,7 +1656,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: ReplicaSet[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1665,7 +1677,7 @@

    isSelected#

    ▸ isSelected(item: ReplicaSet): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1686,7 +1698,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: ReplicaSet[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1709,7 +1721,7 @@

    load#

    ▸ load(params: object): Promise‹ReplicaSet›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1736,13 +1748,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1764,7 +1776,7 @@

    ▸ loadItem(params: object): Promise‹ReplicaSet›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1791,7 +1803,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹ReplicaSet[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

    @@ -1811,7 +1823,7 @@

    loadMetrics#

    ▸ loadMetrics(replicaSet: ReplicaSet): Promise‹void›

    -

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:13

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:13

    Parameters:

    @@ -1832,7 +1844,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1853,7 +1865,7 @@

    remove#

    ▸ remove(item: ReplicaSet): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1874,7 +1886,7 @@

    Protected removeItem#

    ▸ removeItem(item: ReplicaSet, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: ReplicaSet

    ▪ request: function

    @@ -1885,25 +1897,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:29

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:29

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: ReplicaSet): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1924,7 +1936,7 @@

    Protected sortItems#

    ▸ sortItems(items: ReplicaSet[], sorting?: function[], order?: "asc" | "desc"): ReplicaSet[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1958,7 +1970,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1981,7 +1993,7 @@

    toggleSelection#

    ▸ toggleSelection(item: ReplicaSet): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -2002,7 +2014,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: ReplicaSet[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2025,7 +2037,7 @@

    unselect#

    ▸ unselect(item: ReplicaSet): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -2046,7 +2058,7 @@

    update#

    ▸ update(item: ReplicaSet, data: Partial‹ReplicaSet›): Promise‹ReplicaSet›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -2071,13 +2083,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: ReplicaSet, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: ReplicaSet

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html index 7533559fe5..49c68c1e4e 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1181,7 +1193,7 @@

    constructor#

    + new ResourceQuota(data: KubeJsonApiData): ResourceQuota

    Overrides KubeObject.constructor

    -

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:36

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:36

    Parameters:

    @@ -1202,21 +1214,21 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    spec#

    • spec: object

    -

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:43

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:43

    Type declaration:

    @@ -1288,7 +1300,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1321,7 +1333,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1344,66 +1356,66 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getScopeSelector#

    ▸ getScopeSelector(): object[]

    -

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:59

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:59

    Returns: object[]

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1426,7 +1438,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1447,7 +1459,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1468,7 +1480,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1489,7 +1501,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1510,7 +1522,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html index 4b9aeaa43f..bb88b8d502 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1288,71 +1300,71 @@

    constructor#

    + new ResourceQuotasStore(): ResourceQuotasStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: ResourceQuotasStore

    Properties#

    api#

    • api: KubeApi‹ResourceQuota‹›› = resourceQuotaApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+config-resource-quotas/resource-quotas.store.ts:8

    +

    Defined in src/renderer/components/+config-resource-quotas/resource-quotas.store.ts:8

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): ResourceQuota[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: ResourceQuota[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1375,7 +1387,7 @@

    create#

    ▸ create(params: object, data?: Partial‹ResourceQuota›): Promise‹ResourceQuota›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1403,7 +1415,7 @@

    ▸ createItem(params: object, data?: Partial‹ResourceQuota›): Promise‹ResourceQuota›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1430,7 +1442,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: ResourceQuota): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1451,7 +1463,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: ResourceQuota[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1472,7 +1484,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): ResourceQuota[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1500,7 +1512,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): ResourceQuota[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1522,7 +1534,7 @@

    ▸ getByName(name: string, namespace?: string): ResourceQuota

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1547,7 +1559,7 @@

    getByPath#

    ▸ getByPath(path: string): ResourceQuota

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1568,7 +1580,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: ResourceQuota[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1589,7 +1601,7 @@

    isSelected#

    ▸ isSelected(item: ResourceQuota): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1610,7 +1622,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: ResourceQuota[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1633,7 +1645,7 @@

    load#

    ▸ load(params: object): Promise‹ResourceQuota›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1660,13 +1672,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1688,7 +1700,7 @@

    ▸ loadItem(params: object): Promise‹ResourceQuota›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1715,7 +1727,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹ResourceQuota[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

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

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1757,7 +1769,7 @@

    remove#

    ▸ remove(item: ResourceQuota): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1778,7 +1790,7 @@

    Protected removeItem#

    ▸ removeItem(item: ResourceQuota, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: ResourceQuota

    ▪ request: function

    @@ -1789,25 +1801,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: ResourceQuota): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1828,7 +1840,7 @@

    Protected sortItems#

    ▸ sortItems(items: ResourceQuota[], sorting?: function[], order?: "asc" | "desc"): ResourceQuota[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1862,7 +1874,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1885,7 +1897,7 @@

    toggleSelection#

    ▸ toggleSelection(item: ResourceQuota): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1906,7 +1918,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: ResourceQuota[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1929,7 +1941,7 @@

    unselect#

    ▸ unselect(item: ResourceQuota): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1950,7 +1962,7 @@

    update#

    ▸ update(item: ResourceQuota, data: Partial‹ResourceQuota›): Promise‹ResourceQuota›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -1975,13 +1987,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: ResourceQuota, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: ResourceQuota

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.role/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.role/index.html index 8665c0a9e4..3f7435023f 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.role/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.role/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1182,7 +1194,7 @@

    constructor#

    + new Role(data: KubeJsonApiData): Role

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1203,51 +1215,51 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    rules#

    • rules: object[]

    -

    Defined in src/renderer/api/endpoints/role.api.ts:9

    +

    Defined in src/renderer/api/endpoints/role.api.ts:9

    Optional status#

    • status? : any

    Inherited from KubeObject.status

    -

    Defined in src/renderer/api/kube-object.ts:79

    +

    Defined in src/renderer/api/kube-object.ts:79

    Static apiBase#

    ▪ apiBase: string = "/apis/rbac.authorization.k8s.io/v1/roles"

    -

    Defined in src/renderer/api/endpoints/role.api.ts:7

    +

    Defined in src/renderer/api/endpoints/role.api.ts:7

    Static kind#

    ▪ kind: string = "Role"

    Overrides KubeObject.kind

    -

    Defined in src/renderer/api/endpoints/role.api.ts:5

    +

    Defined in src/renderer/api/endpoints/role.api.ts:5

    Static namespaced#

    ▪ namespaced: boolean = true

    Overrides KubeObject.namespaced

    -

    Defined in src/renderer/api/endpoints/role.api.ts:6

    +

    Defined in src/renderer/api/endpoints/role.api.ts:6

    Accessors#

    • get selfLink(): string

    Inherited from KubeObject.selfLink

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Returns: string

    Methods#

    delete#

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    Inherited from KubeObject.delete

    -

    Defined in src/renderer/api/kube-object.ts:167

    +

    Defined in src/renderer/api/kube-object.ts:167

    Parameters:

    @@ -1268,7 +1280,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1301,7 +1313,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1324,66 +1336,66 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getRules#

    ▸ getRules(): object[]

    -

    Defined in src/renderer/api/endpoints/role.api.ts:16

    +

    Defined in src/renderer/api/endpoints/role.api.ts:16

    Returns: object[]

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1406,7 +1418,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1427,7 +1439,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1448,7 +1460,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1469,7 +1481,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1490,7 +1502,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html index 2f700245b7..3e411232d4 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1198,7 +1210,7 @@

    constructor#

    + new RoleBinding(data: KubeJsonApiData): RoleBinding

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1219,21 +1231,21 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    roleRef#

    • roleRef: object

    -

    Defined in src/renderer/api/endpoints/role-binding.api.ts:19

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:19

    Type declaration:

    @@ -1300,7 +1312,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1333,7 +1345,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1356,71 +1368,71 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getSubjectNames#

    ▸ getSubjectNames(): string

    -

    Defined in src/renderer/api/endpoints/role-binding.api.ts:29

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:29

    Returns: string

    getSubjects#

    ▸ getSubjects(): IRoleBindingSubject[]

    -

    Defined in src/renderer/api/endpoints/role-binding.api.ts:25

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:25

    Returns: IRoleBindingSubject[]

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1443,7 +1455,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1464,7 +1476,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1485,7 +1497,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1506,7 +1518,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1527,7 +1539,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html index 2e62adb591..32a478705f 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1296,71 +1308,71 @@

    constructor#

    + new RoleBindingsStore(): RoleBindingsStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: RoleBindingsStore

    Properties#

    api#

    • api: KubeApi‹ClusterRoleBinding‹›› = clusterRoleBindingApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:10

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:10

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): RoleBinding[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: RoleBinding[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1383,7 +1395,7 @@

    create#

    ▸ create(params: object, data?: Partial‹RoleBinding›): Promise‹RoleBinding›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1410,7 +1422,7 @@

    Protected createItem#

    ▸ createItem(params: object, data?: Partial‹RoleBinding›): Promise‹RoleBinding‹››

    Overrides KubeObjectStore.createItem

    -

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:40

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:40

    Parameters:

    ▪ params: object

    @@ -1437,7 +1449,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: RoleBinding): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1458,7 +1470,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: RoleBinding[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1479,7 +1491,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): RoleBinding[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1507,7 +1519,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): RoleBinding[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1529,7 +1541,7 @@

    ▸ getByName(name: string, namespace?: string): RoleBinding

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1554,7 +1566,7 @@

    getByPath#

    ▸ getByPath(path: string): RoleBinding

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1575,7 +1587,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: RoleBinding[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1596,7 +1608,7 @@

    isSelected#

    ▸ isSelected(item: RoleBinding): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1617,7 +1629,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: RoleBinding[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1640,7 +1652,7 @@

    load#

    ▸ load(params: object): Promise‹RoleBinding›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1667,13 +1679,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1694,7 +1706,7 @@

    Protected loadItem#

    ▸ loadItem(params: object): Promise‹RoleBinding‹››

    Overrides KubeObjectStore.loadItem

    -

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:23

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:23

    Parameters:

    ▪ params: object

    @@ -1720,7 +1732,7 @@

    Protected loadItems#

    ▸ loadItems(namespaces?: string[]): Promise‹RoleBinding‹›[]›

    Overrides KubeObjectStore.loadItems

    -

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:29

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:29

    Parameters:

    @@ -1741,7 +1753,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1762,7 +1774,7 @@

    remove#

    ▸ remove(item: RoleBinding): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1783,7 +1795,7 @@

    Protected removeItem#

    ▸ removeItem(item: RoleBinding, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: RoleBinding

    ▪ request: function

    @@ -1794,25 +1806,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: RoleBinding): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1833,7 +1845,7 @@

    Protected sortItems#

    ▸ sortItems(items: RoleBinding[]): RoleBinding‹›[]

    Overrides KubeObjectStore.sortItems

    -

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:16

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:16

    Parameters:

    @@ -1854,13 +1866,13 @@

    subscribe#

    ▸ subscribe(): (Anonymous function)

    Overrides KubeObjectStore.subscribe

    -

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:12

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:12

    Returns: (Anonymous function)

    toggleSelection#

    ▸ toggleSelection(item: RoleBinding): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1881,7 +1893,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: RoleBinding[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1904,7 +1916,7 @@

    unselect#

    ▸ unselect(item: RoleBinding): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1925,7 +1937,7 @@

    update#

    ▸ update(item: RoleBinding, data: Partial‹RoleBinding›): Promise‹RoleBinding›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -1950,13 +1962,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: RoleBinding, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: RoleBinding

    ▪ request: function

    @@ -1965,7 +1977,7 @@

    updateSubjects#

    ▸ updateSubjects(params: object): Promise‹RoleBinding‹››

    -

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:48

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:48

    Parameters:

    ▪ params: object

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html index c9df2607bf..ec94587287 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1288,71 +1300,71 @@

    constructor#

    + new RolesStore(): RolesStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: RolesStore

    Properties#

    api#

    • api: KubeApi‹ClusterRole‹›› = clusterRoleApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:8

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:8

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): Role[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Role[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1375,7 +1387,7 @@

    create#

    ▸ create(params: object, data?: Partial‹Role›): Promise‹Role›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1402,7 +1414,7 @@

    Protected createItem#

    ▸ createItem(params: object, data?: Partial‹Role›): Promise‹Role‹››

    Overrides KubeObjectStore.createItem

    -

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:38

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:38

    Parameters:

    ▪ params: object

    @@ -1429,7 +1441,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: Role): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1450,7 +1462,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: Role[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1471,7 +1483,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Role[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1499,7 +1511,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): Role[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1521,7 +1533,7 @@

    ▸ getByName(name: string, namespace?: string): Role

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1546,7 +1558,7 @@

    getByPath#

    ▸ getByPath(path: string): Role

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1567,7 +1579,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: Role[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1588,7 +1600,7 @@

    isSelected#

    ▸ isSelected(item: Role): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1609,7 +1621,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: Role[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1632,7 +1644,7 @@

    load#

    ▸ load(params: object): Promise‹Role›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1659,13 +1671,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1686,7 +1698,7 @@

    Protected loadItem#

    ▸ loadItem(params: object): Promise‹Role‹››

    Overrides KubeObjectStore.loadItem

    -

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:21

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:21

    Parameters:

    ▪ params: object

    @@ -1712,7 +1724,7 @@

    Protected loadItems#

    ▸ loadItems(namespaces?: string[]): Promise‹Role[]›

    Overrides KubeObjectStore.loadItems

    -

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:27

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:27

    Parameters:

    @@ -1733,7 +1745,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1754,7 +1766,7 @@

    remove#

    ▸ remove(item: Role): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1775,7 +1787,7 @@

    Protected removeItem#

    ▸ removeItem(item: Role, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: Role

    ▪ request: function

    @@ -1786,25 +1798,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: Role): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1825,7 +1837,7 @@

    Protected sortItems#

    ▸ sortItems(items: Role[]): Role‹›[]

    Overrides KubeObjectStore.sortItems

    -

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:14

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:14

    Parameters:

    @@ -1846,13 +1858,13 @@

    subscribe#

    ▸ subscribe(): (Anonymous function)

    Overrides KubeObjectStore.subscribe

    -

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:10

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:10

    Returns: (Anonymous function)

    toggleSelection#

    ▸ toggleSelection(item: Role): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1873,7 +1885,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: Role[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1896,7 +1908,7 @@

    unselect#

    ▸ unselect(item: Role): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1917,7 +1929,7 @@

    update#

    ▸ update(item: Role, data: Partial‹Role›): Promise‹Role›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -1942,13 +1954,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: Role, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: Role

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html index 5442ff99c8..a68a26ecd7 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1197,7 +1209,7 @@

    constructor#

    + new Secret(data: KubeJsonApiData): Secret

    Overrides KubeObject.constructor

    -

    Defined in src/renderer/api/endpoints/secret.api.ts:32

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:32

    Parameters:

    @@ -1218,11 +1230,11 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    data#

    • data: object

    -

    Defined in src/renderer/api/endpoints/secret.api.ts:29

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:29

    Type declaration:

    @@ -1296,7 +1308,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1329,7 +1341,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1352,71 +1364,71 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getKeys#

    ▸ getKeys(): string[]

    -

    Defined in src/renderer/api/endpoints/secret.api.ts:39

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:39

    Returns: string[]

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getToken#

    ▸ getToken(): string

    -

    Defined in src/renderer/api/endpoints/secret.api.ts:43

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:43

    Returns: string

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1439,7 +1451,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1460,7 +1472,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1481,7 +1493,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1502,7 +1514,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1523,7 +1535,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html index 11718ae4bd..1896c6c69e 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1288,71 +1300,71 @@

    constructor#

    + new SecretsStore(): SecretsStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: SecretsStore

    Properties#

    api#

    • api: KubeApi‹Secret‹›› = secretsApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+config-secrets/secrets.store.ts:8

    +

    Defined in src/renderer/components/+config-secrets/secrets.store.ts:8

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): Secret[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Secret[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1375,7 +1387,7 @@

    create#

    ▸ create(params: object, data?: Partial‹Secret›): Promise‹Secret›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1403,7 +1415,7 @@

    ▸ createItem(params: object, data?: Partial‹Secret›): Promise‹Secret›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1430,7 +1442,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: Secret): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1451,7 +1463,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: Secret[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1472,7 +1484,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Secret[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1500,7 +1512,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): Secret[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1522,7 +1534,7 @@

    ▸ getByName(name: string, namespace?: string): Secret

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1547,7 +1559,7 @@

    getByPath#

    ▸ getByPath(path: string): Secret

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1568,7 +1580,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: Secret[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1589,7 +1601,7 @@

    isSelected#

    ▸ isSelected(item: Secret): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1610,7 +1622,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: Secret[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1633,7 +1645,7 @@

    load#

    ▸ load(params: object): Promise‹Secret›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1660,13 +1672,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1688,7 +1700,7 @@

    ▸ loadItem(params: object): Promise‹Secret›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1715,7 +1727,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹Secret[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

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

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1757,7 +1769,7 @@

    remove#

    ▸ remove(item: Secret): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1778,7 +1790,7 @@

    Protected removeItem#

    ▸ removeItem(item: Secret, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: Secret

    ▪ request: function

    @@ -1789,25 +1801,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: Secret): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1828,7 +1840,7 @@

    Protected sortItems#

    ▸ sortItems(items: Secret[], sorting?: function[], order?: "asc" | "desc"): Secret[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1862,7 +1874,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1885,7 +1897,7 @@

    toggleSelection#

    ▸ toggleSelection(item: Secret): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1906,7 +1918,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: Secret[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1929,7 +1941,7 @@

    unselect#

    ▸ unselect(item: Secret): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1950,7 +1962,7 @@

    update#

    ▸ update(item: Secret, data: Partial‹Secret›): Promise‹Secret›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -1975,13 +1987,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: Secret, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: Secret

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.service/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.service/index.html index ac3c834810..f726ea7a51 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.service/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.service/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1237,7 +1249,7 @@

    constructor#

    + new Service(data: KubeJsonApiData): Service

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1258,21 +1270,21 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    spec#

    • spec: object

    -

    Defined in src/renderer/api/endpoints/service.api.ts:38

    +

    Defined in src/renderer/api/endpoints/service.api.ts:38

    Type declaration:

    @@ -1359,7 +1371,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1392,7 +1404,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1414,35 +1426,35 @@

    getClusterIp#

    ▸ getClusterIp(): string

    -

    Defined in src/renderer/api/endpoints/service.api.ts:58

    +

    Defined in src/renderer/api/endpoints/service.api.ts:58

    Returns: string

    getExternalIps#

    ▸ getExternalIps(): string[]

    -

    Defined in src/renderer/api/endpoints/service.api.ts:62

    +

    Defined in src/renderer/api/endpoints/service.api.ts:62

    Returns: string[]

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getLoadBalancer#

    ▸ getLoadBalancer(): object

    -

    Defined in src/renderer/api/endpoints/service.api.ts:88

    +

    Defined in src/renderer/api/endpoints/service.api.ts:88

    Returns: object

    @@ -1556,7 +1568,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1577,7 +1589,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1598,7 +1610,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1619,7 +1631,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html index 8102ec280e..040fbb5a5d 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1197,7 +1209,7 @@

    constructor#

    + new ServiceAccount(data: KubeJsonApiData): ServiceAccount

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1218,55 +1230,55 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    Optional imagePullSecrets#

    • imagePullSecrets? : object[]

    -

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:14

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:14

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    Optional secrets#

    • secrets? : object[]

    -

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:11

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:11

    Optional status#

    • status? : any

    Inherited from KubeObject.status

    -

    Defined in src/renderer/api/kube-object.ts:79

    +

    Defined in src/renderer/api/kube-object.ts:79

    Static apiBase#

    ▪ apiBase: string = "/api/v1/serviceaccounts"

    -

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:9

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:9

    Static kind#

    ▪ kind: string = "ServiceAccount"

    Overrides KubeObject.kind

    -

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:7

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:7

    Static namespaced#

    ▪ namespaced: boolean = true

    Overrides KubeObject.namespaced

    -

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:8

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:8

    Accessors#

    • get selfLink(): string

    Inherited from KubeObject.selfLink

    -

    Defined in src/renderer/api/kube-object.ts:81

    +

    Defined in src/renderer/api/kube-object.ts:81

    Returns: string

    Methods#

    delete#

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    Inherited from KubeObject.delete

    -

    Defined in src/renderer/api/kube-object.ts:167

    +

    Defined in src/renderer/api/kube-object.ts:167

    Parameters:

    @@ -1287,7 +1299,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1320,7 +1332,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1343,71 +1355,71 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getImagePullSecrets#

    ▸ getImagePullSecrets(): object[]

    -

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:22

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:22

    Returns: object[]

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getSecrets#

    ▸ getSecrets(): object[]

    -

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:18

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:18

    Returns: object[]

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1430,7 +1442,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1451,7 +1463,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1472,7 +1484,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1493,7 +1505,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1514,7 +1526,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html index 00ad39d7d8..a9badc2a2b 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1288,71 +1300,71 @@

    constructor#

    + new ServiceAccountsStore(): ServiceAccountsStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: ServiceAccountsStore

    Properties#

    api#

    • api: KubeApi‹ServiceAccount‹›› = serviceAccountsApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:8

    +

    Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:8

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): ServiceAccount[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: ServiceAccount[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1375,7 +1387,7 @@

    create#

    ▸ create(params: object, data?: Partial‹ServiceAccount›): Promise‹ServiceAccount›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1402,7 +1414,7 @@

    Protected createItem#

    ▸ createItem(params: object): Promise‹ServiceAccount‹››

    Overrides KubeObjectStore.createItem

    -

    Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:10

    +

    Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:10

    Parameters:

    ▪ params: object

    @@ -1428,7 +1440,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: ServiceAccount): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1449,7 +1461,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: ServiceAccount[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1470,7 +1482,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): ServiceAccount[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1498,7 +1510,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): ServiceAccount[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1520,7 +1532,7 @@

    ▸ getByName(name: string, namespace?: string): ServiceAccount

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1545,7 +1557,7 @@

    getByPath#

    ▸ getByPath(path: string): ServiceAccount

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1566,7 +1578,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: ServiceAccount[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1587,7 +1599,7 @@

    isSelected#

    ▸ isSelected(item: ServiceAccount): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1608,7 +1620,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: ServiceAccount[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1631,7 +1643,7 @@

    load#

    ▸ load(params: object): Promise‹ServiceAccount›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1658,13 +1670,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1686,7 +1698,7 @@

    ▸ loadItem(params: object): Promise‹ServiceAccount›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1713,7 +1725,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹ServiceAccount[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

    @@ -1734,7 +1746,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1755,7 +1767,7 @@

    remove#

    ▸ remove(item: ServiceAccount): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1776,7 +1788,7 @@

    Protected removeItem#

    ▸ removeItem(item: ServiceAccount, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: ServiceAccount

    ▪ request: function

    @@ -1787,25 +1799,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: ServiceAccount): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1826,7 +1838,7 @@

    Protected sortItems#

    ▸ sortItems(items: ServiceAccount[], sorting?: function[], order?: "asc" | "desc"): ServiceAccount[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1860,7 +1872,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1883,7 +1895,7 @@

    toggleSelection#

    ▸ toggleSelection(item: ServiceAccount): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1904,7 +1916,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: ServiceAccount[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1927,7 +1939,7 @@

    unselect#

    ▸ unselect(item: ServiceAccount): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1948,7 +1960,7 @@

    update#

    ▸ update(item: ServiceAccount, data: Partial‹ServiceAccount›): Promise‹ServiceAccount›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -1973,13 +1985,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: ServiceAccount, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: ServiceAccount

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html index 46da1044b7..0ccde4a91c 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1288,71 +1300,71 @@

    constructor#

    + new ServiceStore(): ServiceStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: ServiceStore

    Properties#

    api#

    • api: KubeApi‹Service‹›› = serviceApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+network-services/services.store.ts:8

    +

    Defined in src/renderer/components/+network-services/services.store.ts:8

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): Service[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: Service[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1375,7 +1387,7 @@

    create#

    ▸ create(params: object, data?: Partial‹Service›): Promise‹Service›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1403,7 +1415,7 @@

    ▸ createItem(params: object, data?: Partial‹Service›): Promise‹Service›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1430,7 +1442,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: Service): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1451,7 +1463,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: Service[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1472,7 +1484,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Service[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1500,7 +1512,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): Service[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1522,7 +1534,7 @@

    ▸ getByName(name: string, namespace?: string): Service

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1547,7 +1559,7 @@

    getByPath#

    ▸ getByPath(path: string): Service

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1568,7 +1580,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: Service[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1589,7 +1601,7 @@

    isSelected#

    ▸ isSelected(item: Service): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1610,7 +1622,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: Service[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1633,7 +1645,7 @@

    load#

    ▸ load(params: object): Promise‹Service›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1660,13 +1672,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1688,7 +1700,7 @@

    ▸ loadItem(params: object): Promise‹Service›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1715,7 +1727,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹Service[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

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

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1757,7 +1769,7 @@

    remove#

    ▸ remove(item: Service): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1778,7 +1790,7 @@

    Protected removeItem#

    ▸ removeItem(item: Service, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: Service

    ▪ request: function

    @@ -1789,25 +1801,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: Service): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1828,7 +1840,7 @@

    Protected sortItems#

    ▸ sortItems(items: Service[], sorting?: function[], order?: "asc" | "desc"): Service[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1862,7 +1874,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1885,7 +1897,7 @@

    toggleSelection#

    ▸ toggleSelection(item: Service): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1906,7 +1918,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: Service[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1929,7 +1941,7 @@

    unselect#

    ▸ unselect(item: Service): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1950,7 +1962,7 @@

    update#

    ▸ update(item: Service, data: Partial‹Service›): Promise‹Service›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -1975,13 +1987,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: Service, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: Service

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html index 9d40b71511..07885334f9 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1237,7 +1249,7 @@

    constructor#

    + new StatefulSet(data: KubeJsonApiData): StatefulSet

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1258,22 +1270,22 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    spec#

    • spec: object

    Overrides void

    -

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:36

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:36

    Type declaration:

    @@ -1397,19 +1409,19 @@

    getAffinity#

    ▸ getAffinity(): IAffinity

    Inherited from Deployment.getAffinity

    -

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    Returns: IAffinity

    getAffinityNumber#

    ▸ getAffinityNumber(): number

    Inherited from Pod.getAffinityNumber

    -

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    Returns: number

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1442,7 +1454,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1465,95 +1477,95 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getImages#

    ▸ getImages(): string[]

    -

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:103

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:103

    Returns: string[]

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNodeSelectors#

    ▸ getNodeSelectors(): string[]

    Inherited from Deployment.getNodeSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    Returns: string[]

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getReplicas#

    ▸ getReplicas(): number

    -

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:99

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:99

    Returns: number

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getSelectors#

    ▸ getSelectors(): string[]

    Inherited from Pod.getSelectors

    -

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    Returns: string[]

    getTemplateLabels#

    ▸ getTemplateLabels(): string[]

    Inherited from Pod.getTemplateLabels

    -

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    Returns: string[]

    getTolerations#

    ▸ getTolerations(): IToleration[]

    Inherited from Deployment.getTolerations

    -

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    Returns: IToleration[]

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1576,7 +1588,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1597,7 +1609,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1618,7 +1630,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1639,7 +1651,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1660,7 +1672,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html index cf6f790e83..6defe0057b 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1312,75 +1324,75 @@

    constructor#

    + new StatefulSetStore(): StatefulSetStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: StatefulSetStore

    Properties#

    api#

    • api: StatefulSetApi‹› = statefulSetApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:10

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:10

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    metrics#

    • metrics: IPodMetrics = null

    -

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:11

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:11

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): StatefulSet[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: StatefulSet[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1403,7 +1415,7 @@

    create#

    ▸ create(params: object, data?: Partial‹StatefulSet›): Promise‹StatefulSet›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1431,7 +1443,7 @@

    ▸ createItem(params: object, data?: Partial‹StatefulSet›): Promise‹StatefulSet›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1458,7 +1470,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: StatefulSet): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1479,7 +1491,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: StatefulSet[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1500,7 +1512,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): StatefulSet[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1528,7 +1540,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): StatefulSet[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1550,7 +1562,7 @@

    ▸ getByName(name: string, namespace?: string): StatefulSet

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1575,7 +1587,7 @@

    getByPath#

    ▸ getByPath(path: string): StatefulSet

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1595,7 +1607,7 @@

    getChildPods#

    ▸ getChildPods(statefulSet: StatefulSet): Pod‹›[]

    -

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:19

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:19

    Parameters:

    @@ -1616,7 +1628,7 @@

    getStatuses#

    ▸ getStatuses(statefulSets: StatefulSet[]): object

    Overrides KubeObjectStore.getStatuses

    -

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:23

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:23

    Parameters:

    @@ -1648,7 +1660,7 @@

    isSelected#

    ▸ isSelected(item: StatefulSet): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1669,7 +1681,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: StatefulSet[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1692,7 +1704,7 @@

    load#

    ▸ load(params: object): Promise‹StatefulSet›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1719,13 +1731,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1747,7 +1759,7 @@

    ▸ loadItem(params: object): Promise‹StatefulSet›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1774,7 +1786,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹StatefulSet[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

    @@ -1794,7 +1806,7 @@

    loadMetrics#

    ▸ loadMetrics(statefulSet: StatefulSet): Promise‹void›

    -

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:13

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:13

    Parameters:

    @@ -1815,7 +1827,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1836,7 +1848,7 @@

    remove#

    ▸ remove(item: StatefulSet): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1857,7 +1869,7 @@

    Protected removeItem#

    ▸ removeItem(item: StatefulSet, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: StatefulSet

    ▪ request: function

    @@ -1868,25 +1880,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:43

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:43

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: StatefulSet): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1907,7 +1919,7 @@

    Protected sortItems#

    ▸ sortItems(items: StatefulSet[], sorting?: function[], order?: "asc" | "desc"): StatefulSet[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1941,7 +1953,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1964,7 +1976,7 @@

    toggleSelection#

    ▸ toggleSelection(item: StatefulSet): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1985,7 +1997,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: StatefulSet[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -2008,7 +2020,7 @@

    unselect#

    ▸ unselect(item: StatefulSet): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -2029,7 +2041,7 @@

    update#

    ▸ update(item: StatefulSet, data: Partial‹StatefulSet›): Promise‹StatefulSet›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -2054,13 +2066,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: StatefulSet, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: StatefulSet

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html index e2a3d5caf1..49950fbcba 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1229,7 +1241,7 @@

    constructor#

    + new StorageClass(data: KubeJsonApiData): StorageClass

    Inherited from KubeObject.constructor

    -

    Defined in src/renderer/api/kube-object.ts:70

    +

    Defined in src/renderer/api/kube-object.ts:70

    Parameters:

    @@ -1250,25 +1262,25 @@

    apiVersion#

    • apiVersion: string

    Inherited from KubeObject.apiVersion

    -

    Defined in src/renderer/api/kube-object.ts:76

    +

    Defined in src/renderer/api/kube-object.ts:76

    kind#

    • kind: string

    Inherited from KubeObject.kind

    -

    Defined in src/renderer/api/kube-object.ts:77

    +

    Defined in src/renderer/api/kube-object.ts:77

    metadata#

    • metadata: IKubeObjectMetadata

    Inherited from KubeObject.metadata

    -

    Defined in src/renderer/api/kube-object.ts:78

    +

    Defined in src/renderer/api/kube-object.ts:78

    Optional mountOptions#

    • mountOptions? : string[]

    -

    Defined in src/renderer/api/endpoints/storage-class.api.ts:12

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:12

    parameters#

    • parameters: object

    -

    Defined in src/renderer/api/endpoints/storage-class.api.ts:15

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:15

    Type declaration:

    @@ -1335,7 +1347,7 @@

    getAge#

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    Inherited from KubeObject.getAge

    -

    Defined in src/renderer/api/kube-object.ts:103

    +

    Defined in src/renderer/api/kube-object.ts:103

    Parameters:

    @@ -1368,7 +1380,7 @@

    getAnnotations#

    ▸ getAnnotations(filter: boolean): string[]

    Inherited from KubeObject.getAnnotations

    -

    Defined in src/renderer/api/kube-object.ts:124

    +

    Defined in src/renderer/api/kube-object.ts:124

    Parameters:

    @@ -1391,76 +1403,76 @@

    getFinalizers#

    ▸ getFinalizers(): string[]

    Inherited from KubeObject.getFinalizers

    -

    Defined in src/renderer/api/kube-object.ts:116

    +

    Defined in src/renderer/api/kube-object.ts:116

    Returns: string[]

    getId#

    ▸ getId(): string

    Inherited from KubeObject.getId

    -

    Defined in src/renderer/api/kube-object.ts:85

    +

    Defined in src/renderer/api/kube-object.ts:85

    Returns: string

    getLabels#

    ▸ getLabels(): string[]

    Inherited from KubeObject.getLabels

    -

    Defined in src/renderer/api/kube-object.ts:120

    +

    Defined in src/renderer/api/kube-object.ts:120

    Returns: string[]

    getName#

    ▸ getName(): string

    Inherited from KubeObject.getName

    -

    Defined in src/renderer/api/kube-object.ts:93

    +

    Defined in src/renderer/api/kube-object.ts:93

    Returns: string

    getNs#

    ▸ getNs(): string

    Inherited from KubeObject.getNs

    -

    Defined in src/renderer/api/kube-object.ts:97

    +

    Defined in src/renderer/api/kube-object.ts:97

    Returns: string

    getOwnerRefs#

    ▸ getOwnerRefs(): object[]

    Inherited from KubeObject.getOwnerRefs

    -

    Defined in src/renderer/api/kube-object.ts:134

    +

    Defined in src/renderer/api/kube-object.ts:134

    Returns: object[]

    getReclaimPolicy#

    ▸ getReclaimPolicy(): string

    -

    Defined in src/renderer/api/endpoints/storage-class.api.ts:32

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:32

    Returns: string

    getResourceVersion#

    ▸ getResourceVersion(): string

    Inherited from KubeObject.getResourceVersion

    -

    Defined in src/renderer/api/kube-object.ts:89

    +

    Defined in src/renderer/api/kube-object.ts:89

    Returns: string

    getSearchFields#

    ▸ getSearchFields(): string[]

    Inherited from KubeObject.getSearchFields

    -

    Defined in src/renderer/api/kube-object.ts:143

    +

    Defined in src/renderer/api/kube-object.ts:143

    Returns: string[]

    getVolumeBindingMode#

    ▸ getVolumeBindingMode(): string

    -

    Defined in src/renderer/api/endpoints/storage-class.api.ts:28

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:28

    Returns: string

    isDefault#

    ▸ isDefault(): boolean

    -

    Defined in src/renderer/api/endpoints/storage-class.api.ts:19

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:19

    Returns: boolean

    toPlainObject#

    ▸ toPlainObject(): object

    Inherited from KubeObject.toPlainObject

    -

    Defined in src/renderer/api/kube-object.ts:155

    +

    Defined in src/renderer/api/kube-object.ts:155

    Returns: object

    update#

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    Inherited from KubeObject.update

    -

    Defined in src/renderer/api/kube-object.ts:160

    +

    Defined in src/renderer/api/kube-object.ts:160

    Type parameters:

    ▪ T: KubeObject

    Parameters:

    @@ -1483,7 +1495,7 @@

    Static create#

    ▸ create(data: any): KubeObject‹›

    Inherited from KubeObject.create

    -

    Defined in src/renderer/api/kube-object.ts:50

    +

    Defined in src/renderer/api/kube-object.ts:50

    Parameters:

    @@ -1504,7 +1516,7 @@

    Static isJsonApiData#

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    Inherited from KubeObject.isJsonApiData

    -

    Defined in src/renderer/api/kube-object.ts:58

    +

    Defined in src/renderer/api/kube-object.ts:58

    Parameters:

    @@ -1525,7 +1537,7 @@

    Static isJsonApiDataList#

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    Inherited from KubeObject.isJsonApiDataList

    -

    Defined in src/renderer/api/kube-object.ts:62

    +

    Defined in src/renderer/api/kube-object.ts:62

    Parameters:

    @@ -1546,7 +1558,7 @@

    Static isNonSystem#

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    Inherited from KubeObject.isNonSystem

    -

    Defined in src/renderer/api/kube-object.ts:54

    +

    Defined in src/renderer/api/kube-object.ts:54

    Parameters:

    @@ -1567,7 +1579,7 @@

    Static stringifyLabels#

    ▸ stringifyLabels(labels: object): string[]

    Inherited from KubeObject.stringifyLabels

    -

    Defined in src/renderer/api/kube-object.ts:66

    +

    Defined in src/renderer/api/kube-object.ts:66

    Parameters:

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html index 6149b439bc..60f22da3f0 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1288,71 +1300,71 @@

    constructor#

    + new StorageClassStore(): StorageClassStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: StorageClassStore

    Properties#

    api#

    • api: KubeApi‹StorageClass‹›› = storageClassApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+storage-classes/storage-class.store.ts:8

    +

    Defined in src/renderer/components/+storage-classes/storage-class.store.ts:8

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): StorageClass[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: StorageClass[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1375,7 +1387,7 @@

    create#

    ▸ create(params: object, data?: Partial‹StorageClass›): Promise‹StorageClass›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1403,7 +1415,7 @@

    ▸ createItem(params: object, data?: Partial‹StorageClass›): Promise‹StorageClass›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1430,7 +1442,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: StorageClass): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1451,7 +1463,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: StorageClass[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1472,7 +1484,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): StorageClass[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1500,7 +1512,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): StorageClass[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1522,7 +1534,7 @@

    ▸ getByName(name: string, namespace?: string): StorageClass

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1547,7 +1559,7 @@

    getByPath#

    ▸ getByPath(path: string): StorageClass

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1568,7 +1580,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: StorageClass[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1589,7 +1601,7 @@

    isSelected#

    ▸ isSelected(item: StorageClass): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1610,7 +1622,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: StorageClass[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1633,7 +1645,7 @@

    load#

    ▸ load(params: object): Promise‹StorageClass›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1660,13 +1672,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1688,7 +1700,7 @@

    ▸ loadItem(params: object): Promise‹StorageClass›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1715,7 +1727,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹StorageClass[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

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

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1757,7 +1769,7 @@

    remove#

    ▸ remove(item: StorageClass): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1778,7 +1790,7 @@

    Protected removeItem#

    ▸ removeItem(item: StorageClass, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: StorageClass

    ▪ request: function

    @@ -1789,25 +1801,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Inherited from KubeObjectStore.reset

    -

    Defined in src/renderer/item.store.ts:163

    +

    Defined in src/renderer/item.store.ts:163

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: StorageClass): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1828,7 +1840,7 @@

    Protected sortItems#

    ▸ sortItems(items: StorageClass[], sorting?: function[], order?: "asc" | "desc"): StorageClass[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1862,7 +1874,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1885,7 +1897,7 @@

    toggleSelection#

    ▸ toggleSelection(item: StorageClass): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1906,7 +1918,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: StorageClass[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1929,7 +1941,7 @@

    unselect#

    ▸ unselect(item: StorageClass): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1950,7 +1962,7 @@

    update#

    ▸ update(item: StorageClass, data: Partial‹StorageClass›): Promise‹StorageClass›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -1975,13 +1987,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: StorageClass, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: StorageClass

    ▪ request: function

    diff --git a/latest/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html b/latest/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html index 90d335091a..3f41c2f1d7 100644 --- a/latest/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html +++ b/latest/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1304,75 +1316,75 @@

    constructor#

    + new VolumeClaimStore(): VolumeClaimStore

    Inherited from KubeObjectStore.constructor

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Returns: VolumeClaimStore

    Properties#

    api#

    • api: PersistentVolumeClaimsApi‹› = pvcApi

    Overrides KubeObjectStore.api

    -

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:9

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:9

    bufferSize#

    • bufferSize: number = 50000

    Inherited from KubeObjectStore.bufferSize

    -

    Defined in src/renderer/kube-object.store.ts:15

    +

    Defined in src/renderer/kube-object.store.ts:15

    Protected eventsBuffer#

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    Inherited from KubeObjectStore.eventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:167

    +

    Defined in src/renderer/kube-object.store.ts:172

    isLoaded#

    • isLoaded: boolean = false

    Inherited from KubeObjectStore.isLoaded

    -

    Defined in src/renderer/item.store.ts:17

    +

    Defined in src/renderer/item.store.ts:17

    isLoading#

    • isLoading: boolean = false

    Inherited from KubeObjectStore.isLoading

    -

    Defined in src/renderer/item.store.ts:16

    +

    Defined in src/renderer/item.store.ts:16

    items#

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    Inherited from KubeObjectStore.items

    -

    Defined in src/renderer/item.store.ts:18

    +

    Defined in src/renderer/item.store.ts:18

    Optional limit#

    • limit? : number

    Inherited from KubeObjectStore.limit

    -

    Defined in src/renderer/kube-object.store.ts:14

    +

    Defined in src/renderer/kube-object.store.ts:14

    metrics#

    • metrics: IPvcMetrics = null

    -

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:10

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:10

    selectedItemsIds#

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    Inherited from KubeObjectStore.selectedItemsIds

    -

    Defined in src/renderer/item.store.ts:19

    +

    Defined in src/renderer/item.store.ts:19

    Accessors#

    query#

    • get query(): IKubeApiQueryParams

    Inherited from KubeObjectStore.query

    -

    Defined in src/renderer/kube-object.store.ts:23

    +

    Defined in src/renderer/kube-object.store.ts:23

    Returns: IKubeApiQueryParams

    selectedItems#

    • get selectedItems(): PersistentVolumeClaim[]

    Inherited from KubeObjectStore.selectedItems

    -

    Defined in src/renderer/item.store.ts:21

    +

    Defined in src/renderer/item.store.ts:21

    Returns: PersistentVolumeClaim[]

    Methods#

    [Symbol.iterator]#

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    Inherited from KubeObjectStore.[Symbol.iterator]

    -

    Defined in src/renderer/item.store.ts:178

    +

    Defined in src/renderer/item.store.ts:178

    Returns: Generator‹T, void, undefined›

    Protected bindWatchEventsUpdater#

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    -

    Defined in src/renderer/kube-object.store.ts:169

    +

    Defined in src/renderer/kube-object.store.ts:174

    Parameters:

    @@ -1395,7 +1407,7 @@

    create#

    ▸ create(params: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim›

    Inherited from KubeObjectStore.create

    -

    Defined in src/renderer/kube-object.store.ts:138

    +

    Defined in src/renderer/kube-object.store.ts:143

    Parameters:

    ▪ params: object

    @@ -1423,7 +1435,7 @@

    ▸ createItem(params: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim›

    Inherited from KubeObjectStore.createItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:134

    +

    Defined in src/renderer/kube-object.store.ts:139

    Parameters:

    ▪ params: object

    @@ -1450,7 +1462,7 @@

    Protected defaultSorting#

    ▸ defaultSorting(item: PersistentVolumeClaim): string

    Inherited from KubeObjectStore.defaultSorting

    -

    Defined in src/renderer/item.store.ts:14

    +

    Defined in src/renderer/item.store.ts:14

    Parameters:

    @@ -1471,7 +1483,7 @@

    Protected filterItemsOnLoad#

    ▸ filterItemsOnLoad(items: PersistentVolumeClaim[]): T[]

    Inherited from KubeObjectStore.filterItemsOnLoad

    -

    Defined in src/renderer/kube-object.store.ts:84

    +

    Defined in src/renderer/kube-object.store.ts:84

    Parameters:

    @@ -1492,7 +1504,7 @@

    getAllByNs#

    ▸ getAllByNs(namespace: string | string[], strict: boolean): PersistentVolumeClaim[]

    Inherited from KubeObjectStore.getAllByNs

    -

    Defined in src/renderer/kube-object.store.ts:35

    +

    Defined in src/renderer/kube-object.store.ts:35

    Parameters:

    @@ -1520,7 +1532,7 @@

    getByLabel#

    ▸ getByLabel(labels: string[] | object): PersistentVolumeClaim[]

    Inherited from KubeObjectStore.getByLabel

    -

    Defined in src/renderer/kube-object.store.ts:57

    +

    Defined in src/renderer/kube-object.store.ts:57

    Parameters:

    @@ -1542,7 +1554,7 @@

    ▸ getByName(name: string, namespace?: string): PersistentVolumeClaim

    Inherited from KubeObjectStore.getByName

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:45

    +

    Defined in src/renderer/kube-object.store.ts:45

    Parameters:

    @@ -1567,7 +1579,7 @@

    getByPath#

    ▸ getByPath(path: string): PersistentVolumeClaim

    Inherited from KubeObjectStore.getByPath

    -

    Defined in src/renderer/kube-object.store.ts:53

    +

    Defined in src/renderer/kube-object.store.ts:53

    Parameters:

    @@ -1588,7 +1600,7 @@

    Optional getStatuses#

    ▸ getStatuses(items: PersistentVolumeClaim[]): Record‹string, number›

    Inherited from KubeObjectStore.getStatuses

    -

    Defined in src/renderer/kube-object.store.ts:33

    +

    Defined in src/renderer/kube-object.store.ts:33

    Parameters:

    @@ -1609,7 +1621,7 @@

    isSelected#

    ▸ isSelected(item: PersistentVolumeClaim): boolean

    Inherited from KubeObjectStore.isSelected

    -

    Defined in src/renderer/item.store.ts:115

    +

    Defined in src/renderer/item.store.ts:115

    Parameters:

    @@ -1630,7 +1642,7 @@

    isSelectedAll#

    ▸ isSelectedAll(visibleItems: PersistentVolumeClaim[]): boolean

    Inherited from KubeObjectStore.isSelectedAll

    -

    Defined in src/renderer/item.store.ts:151

    +

    Defined in src/renderer/item.store.ts:151

    Parameters:

    @@ -1653,7 +1665,7 @@

    load#

    ▸ load(params: object): Promise‹PersistentVolumeClaim›

    Inherited from KubeObjectStore.load

    -

    Defined in src/renderer/kube-object.store.ts:113

    +

    Defined in src/renderer/kube-object.store.ts:118

    Parameters:

    ▪ params: object

    @@ -1680,13 +1692,13 @@

    ▸ loadAll(): Promise‹void›

    Inherited from KubeObjectStore.loadAll

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:89

    +

    Defined in src/renderer/kube-object.store.ts:89

    Returns: Promise‹void›

    loadFromPath#

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    Inherited from KubeObjectStore.loadFromPath

    -

    Defined in src/renderer/kube-object.store.ts:128

    +

    Defined in src/renderer/kube-object.store.ts:133

    Parameters:

    @@ -1708,7 +1720,7 @@

    ▸ loadItem(params: object): Promise‹PersistentVolumeClaim›

    Inherited from KubeObjectStore.loadItem

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:108

    +

    Defined in src/renderer/kube-object.store.ts:113

    Parameters:

    ▪ params: object

    @@ -1735,7 +1747,7 @@

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹PersistentVolumeClaim[]›

    Inherited from KubeObjectStore.loadItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:74

    +

    Defined in src/renderer/kube-object.store.ts:74

    Parameters:

    @@ -1755,7 +1767,7 @@

    loadMetrics#

    ▸ loadMetrics(pvc: PersistentVolumeClaim): Promise‹void›

    -

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:13

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:13

    Parameters:

    @@ -1776,7 +1788,7 @@

    Protected onWatchApiEvent#

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    Inherited from KubeObjectStore.onWatchApiEvent

    -

    Defined in src/renderer/kube-object.store.ts:179

    +

    Defined in src/renderer/kube-object.store.ts:184

    Parameters:

    @@ -1797,7 +1809,7 @@

    remove#

    ▸ remove(item: PersistentVolumeClaim): Promise‹void›

    Inherited from KubeObjectStore.remove

    -

    Defined in src/renderer/kube-object.store.ts:156

    +

    Defined in src/renderer/kube-object.store.ts:161

    Parameters:

    @@ -1818,7 +1830,7 @@

    Protected removeItem#

    ▸ removeItem(item: PersistentVolumeClaim, request: function): Promise‹void›

    Inherited from KubeObjectStore.removeItem

    -

    Defined in src/renderer/item.store.ts:109

    +

    Defined in src/renderer/item.store.ts:109

    Parameters:

    ▪ item: PersistentVolumeClaim

    ▪ request: function

    @@ -1829,25 +1841,25 @@

    ▸ removeSelectedItems(): Promise‹void[]›

    Inherited from KubeObjectStore.removeSelectedItems

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:162

    +

    Defined in src/renderer/kube-object.store.ts:167

    Returns: Promise‹void[]›

    reset#

    ▸ reset(): void

    Overrides KubeObjectStore.reset

    -

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:17

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:17

    Returns: void

    resetSelection#

    ▸ resetSelection(): void

    Inherited from KubeObjectStore.resetSelection

    -

    Defined in src/renderer/item.store.ts:158

    +

    Defined in src/renderer/item.store.ts:158

    Returns: void

    select#

    ▸ select(item: PersistentVolumeClaim): void

    Inherited from KubeObjectStore.select

    -

    Defined in src/renderer/item.store.ts:120

    +

    Defined in src/renderer/item.store.ts:120

    Parameters:

    @@ -1868,7 +1880,7 @@

    Protected sortItems#

    ▸ sortItems(items: PersistentVolumeClaim[], sorting?: function[], order?: "asc" | "desc"): PersistentVolumeClaim[]

    Inherited from KubeObjectStore.sortItems

    -

    Defined in src/renderer/item.store.ts:31

    +

    Defined in src/renderer/item.store.ts:31

    Parameters:

    @@ -1902,7 +1914,7 @@

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    Inherited from KubeObjectStore.subscribe

    Overrides void

    -

    Defined in src/renderer/kube-object.store.ts:175

    +

    Defined in src/renderer/kube-object.store.ts:180

    Parameters:

    @@ -1925,7 +1937,7 @@

    toggleSelection#

    ▸ toggleSelection(item: PersistentVolumeClaim): void

    Inherited from KubeObjectStore.toggleSelection

    -

    Defined in src/renderer/item.store.ts:130

    +

    Defined in src/renderer/item.store.ts:130

    Parameters:

    @@ -1946,7 +1958,7 @@

    toggleSelectionAll#

    ▸ toggleSelectionAll(visibleItems: PersistentVolumeClaim[]): void

    Inherited from KubeObjectStore.toggleSelectionAll

    -

    Defined in src/renderer/item.store.ts:140

    +

    Defined in src/renderer/item.store.ts:140

    Parameters:

    @@ -1969,7 +1981,7 @@

    unselect#

    ▸ unselect(item: PersistentVolumeClaim): void

    Inherited from KubeObjectStore.unselect

    -

    Defined in src/renderer/item.store.ts:125

    +

    Defined in src/renderer/item.store.ts:125

    Parameters:

    @@ -1990,7 +2002,7 @@

    update#

    ▸ update(item: PersistentVolumeClaim, data: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim›

    Inherited from KubeObjectStore.update

    -

    Defined in src/renderer/kube-object.store.ts:147

    +

    Defined in src/renderer/kube-object.store.ts:152

    Parameters:

    @@ -2015,13 +2027,13 @@

    Protected updateFromEventsBuffer#

    ▸ updateFromEventsBuffer(): void

    Inherited from KubeObjectStore.updateFromEventsBuffer

    -

    Defined in src/renderer/kube-object.store.ts:185

    +

    Defined in src/renderer/kube-object.store.ts:190

    Returns: void

    Protected updateItem#

    ▸ updateItem(item: PersistentVolumeClaim, request: function): Promise‹T›

    Inherited from KubeObjectStore.updateItem

    -

    Defined in src/renderer/item.store.ts:99

    +

    Defined in src/renderer/item.store.ts:99

    Parameters:

    ▪ item: PersistentVolumeClaim

    ▪ request: function

    diff --git a/latest/extensions/api/classes/lensmainextension/index.html b/latest/extensions/api/classes/lensmainextension/index.html index d2ef5d8617..c29b9f9b56 100644 --- a/latest/extensions/api/classes/lensmainextension/index.html +++ b/latest/extensions/api/classes/lensmainextension/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1074,7 +1086,7 @@

    constructor#

    + new LensMainExtension(__namedParameters: object): LensMainExtension

    Inherited from LensMainExtension.constructor

    -

    Defined in src/extensions/lens-extension.ts:24

    +

    Defined in src/extensions/lens-extension.ts:24

    Parameters:

    ▪ __namedParameters: object

    @@ -1107,62 +1119,62 @@

    Properties#

    appMenus#

    • appMenus: MenuRegistration[] = []

    -

    Defined in src/extensions/lens-main-extension.ts:7

    +

    Defined in src/extensions/lens-main-extension.ts:7

    id#

    • id: LensExtensionId

    Inherited from LensMainExtension.id

    -

    Defined in src/extensions/lens-extension.ts:19

    +

    Defined in src/extensions/lens-extension.ts:19

    isBundled#

    • isBundled: boolean

    Inherited from LensMainExtension.isBundled

    -

    Defined in src/extensions/lens-extension.ts:22

    +

    Defined in src/extensions/lens-extension.ts:22

    manifest#

    • manifest: LensExtensionManifest

    Inherited from LensMainExtension.manifest

    -

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

    +

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

    manifestPath#

    • manifestPath: string

    Inherited from LensMainExtension.manifestPath

    -

    Defined in src/extensions/lens-extension.ts:21

    +

    Defined in src/extensions/lens-extension.ts:21

    Accessors#

    description#

    • get description(): string

    Inherited from LensMainExtension.description

    -

    Defined in src/extensions/lens-extension.ts:52

    +

    Defined in src/extensions/lens-extension.ts:52

    Returns: string

    name#

    • get name(): string

    Inherited from LensMainExtension.name

    -

    Defined in src/extensions/lens-extension.ts:33

    +

    Defined in src/extensions/lens-extension.ts:33

    Returns: string

    version#

    • get version(): string

    Inherited from LensMainExtension.version

    -

    Defined in src/extensions/lens-extension.ts:37

    +

    Defined in src/extensions/lens-extension.ts:37

    Returns: string

    Methods#

    disable#

    ▸ disable(): Promise‹void›

    Inherited from LensMainExtension.disable

    -

    Defined in src/extensions/lens-extension.ts:65

    +

    Defined in src/extensions/lens-extension.ts:65

    Returns: Promise‹void›

    enable#

    ▸ enable(): Promise‹void›

    Inherited from LensMainExtension.enable

    -

    Defined in src/extensions/lens-extension.ts:57

    +

    Defined in src/extensions/lens-extension.ts:57

    Returns: Promise‹void›

    getExtensionFileFolder#

    ▸ getExtensionFileFolder(): Promise‹string›

    Inherited from LensMainExtension.getExtensionFileFolder

    -

    Defined in src/extensions/lens-extension.ts:48

    +

    Defined in src/extensions/lens-extension.ts:48

    getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension.

    Note: there is no security done on this folder, only obfiscation of the @@ -1171,7 +1183,7 @@ folder name.

    ▸ navigate‹P›(pageId?: string, params?: P, frameId?: number): Promise‹void›

    -

    Defined in src/extensions/lens-main-extension.ts:9

    +

    Defined in src/extensions/lens-main-extension.ts:9

    Type parameters:

    ▪ P: object

    Parameters:

    @@ -1202,19 +1214,19 @@ folder name.

    Protected onActivate#

    ▸ onActivate(): void

    Inherited from LensMainExtension.onActivate

    -

    Defined in src/extensions/lens-extension.ts:104

    +

    Defined in src/extensions/lens-extension.ts:104

    Returns: void

    Protected onDeactivate#

    ▸ onDeactivate(): void

    Inherited from LensMainExtension.onDeactivate

    -

    Defined in src/extensions/lens-extension.ts:108

    +

    Defined in src/extensions/lens-extension.ts:108

    Returns: void

    toggle#

    ▸ toggle(enable?: boolean): void

    Inherited from LensMainExtension.toggle

    -

    Defined in src/extensions/lens-extension.ts:72

    +

    Defined in src/extensions/lens-extension.ts:72

    Parameters:

    @@ -1235,7 +1247,7 @@ folder name.

    whenEnabled#

    ▸ whenEnabled(handlers: function): Promise‹(Anonymous function)›

    Inherited from LensMainExtension.whenEnabled

    -

    Defined in src/extensions/lens-extension.ts:80

    +

    Defined in src/extensions/lens-extension.ts:80

    Parameters:

    ▪ handlers: function

    ▸ (): Promise‹Function[]›

    diff --git a/latest/extensions/api/classes/lensrendererextension/index.html b/latest/extensions/api/classes/lensrendererextension/index.html index 984f2ade13..cd342416ff 100644 --- a/latest/extensions/api/classes/lensrendererextension/index.html +++ b/latest/extensions/api/classes/lensrendererextension/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1154,7 +1166,7 @@

    constructor#

    + new LensRendererExtension(__namedParameters: object): LensRendererExtension

    Inherited from LensMainExtension.constructor

    -

    Defined in src/extensions/lens-extension.ts:24

    +

    Defined in src/extensions/lens-extension.ts:24

    Parameters:

    ▪ __namedParameters: object

    @@ -1187,98 +1199,98 @@

    Properties#

    appPreferences#

    • appPreferences: AppPreferenceRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:13

    +

    Defined in src/extensions/lens-renderer-extension.ts:13

    clusterFeatures#

    • clusterFeatures: ClusterFeatureRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:14

    +

    Defined in src/extensions/lens-renderer-extension.ts:14

    clusterPageMenus#

    • clusterPageMenus: PageMenuRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:11

    +

    Defined in src/extensions/lens-renderer-extension.ts:11

    clusterPages#

    • clusterPages: PageRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:9

    +

    Defined in src/extensions/lens-renderer-extension.ts:9

    globalPageMenus#

    • globalPageMenus: PageMenuRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:10

    +

    Defined in src/extensions/lens-renderer-extension.ts:10

    globalPages#

    • globalPages: PageRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:8

    +

    Defined in src/extensions/lens-renderer-extension.ts:8

    id#

    • id: LensExtensionId

    Inherited from LensMainExtension.id

    -

    Defined in src/extensions/lens-extension.ts:19

    +

    Defined in src/extensions/lens-extension.ts:19

    isBundled#

    • isBundled: boolean

    Inherited from LensMainExtension.isBundled

    -

    Defined in src/extensions/lens-extension.ts:22

    +

    Defined in src/extensions/lens-extension.ts:22

    kubeObjectDetailItems#

    • kubeObjectDetailItems: KubeObjectDetailRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:16

    +

    Defined in src/extensions/lens-renderer-extension.ts:16

    kubeObjectMenuItems#

    • kubeObjectMenuItems: KubeObjectMenuRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:17

    +

    Defined in src/extensions/lens-renderer-extension.ts:17

    kubeObjectStatusTexts#

    • kubeObjectStatusTexts: KubeObjectStatusRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:12

    +

    Defined in src/extensions/lens-renderer-extension.ts:12

    manifest#

    • manifest: LensExtensionManifest

    Inherited from LensMainExtension.manifest

    -

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

    +

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

    manifestPath#

    • manifestPath: string

    Inherited from LensMainExtension.manifestPath

    -

    Defined in src/extensions/lens-extension.ts:21

    +

    Defined in src/extensions/lens-extension.ts:21

    statusBarItems#

    • statusBarItems: StatusBarRegistration[] = []

    -

    Defined in src/extensions/lens-renderer-extension.ts:15

    +

    Defined in src/extensions/lens-renderer-extension.ts:15

    Accessors#

    description#

    • get description(): string

    Inherited from LensMainExtension.description

    -

    Defined in src/extensions/lens-extension.ts:52

    +

    Defined in src/extensions/lens-extension.ts:52

    Returns: string

    name#

    • get name(): string

    Inherited from LensMainExtension.name

    -

    Defined in src/extensions/lens-extension.ts:33

    +

    Defined in src/extensions/lens-extension.ts:33

    Returns: string

    version#

    • get version(): string

    Inherited from LensMainExtension.version

    -

    Defined in src/extensions/lens-extension.ts:37

    +

    Defined in src/extensions/lens-extension.ts:37

    Returns: string

    Methods#

    disable#

    ▸ disable(): Promise‹void›

    Inherited from LensMainExtension.disable

    -

    Defined in src/extensions/lens-extension.ts:65

    +

    Defined in src/extensions/lens-extension.ts:65

    Returns: Promise‹void›

    enable#

    ▸ enable(): Promise‹void›

    Inherited from LensMainExtension.enable

    -

    Defined in src/extensions/lens-extension.ts:57

    +

    Defined in src/extensions/lens-extension.ts:57

    Returns: Promise‹void›

    getExtensionFileFolder#

    ▸ getExtensionFileFolder(): Promise‹string›

    Inherited from LensMainExtension.getExtensionFileFolder

    -

    Defined in src/extensions/lens-extension.ts:48

    +

    Defined in src/extensions/lens-extension.ts:48

    getExtensionFileFolder returns the path to an already created folder. This folder is for the sole use of this extension.

    Note: there is no security done on this folder, only obfiscation of the @@ -1287,7 +1299,7 @@ folder name.

    isEnabledForCluster#

    ▸ isEnabledForCluster(cluster: Cluster): Promise‹Boolean›

    -

    Defined in src/extensions/lens-renderer-extension.ts:34

    +

    Defined in src/extensions/lens-renderer-extension.ts:34

    Defines if extension is enabled for a given cluster. Defaults to true.

    Parameters:

    @@ -1308,7 +1320,7 @@ folder name.

    ▸ navigate‹P›(pageId?: string, params?: P): Promise‹void›

    -

    Defined in src/extensions/lens-renderer-extension.ts:19

    +

    Defined in src/extensions/lens-renderer-extension.ts:19

    Type parameters:

    ▪ P: object

    Parameters:

    @@ -1335,19 +1347,19 @@ folder name.

    Protected onActivate#

    ▸ onActivate(): void

    Inherited from LensMainExtension.onActivate

    -

    Defined in src/extensions/lens-extension.ts:104

    +

    Defined in src/extensions/lens-extension.ts:104

    Returns: void

    Protected onDeactivate#

    ▸ onDeactivate(): void

    Inherited from LensMainExtension.onDeactivate

    -

    Defined in src/extensions/lens-extension.ts:108

    +

    Defined in src/extensions/lens-extension.ts:108

    Returns: void

    toggle#

    ▸ toggle(enable?: boolean): void

    Inherited from LensMainExtension.toggle

    -

    Defined in src/extensions/lens-extension.ts:72

    +

    Defined in src/extensions/lens-extension.ts:72

    Parameters:

    @@ -1368,7 +1380,7 @@ folder name.

    whenEnabled#

    ▸ whenEnabled(handlers: function): Promise‹(Anonymous function)›

    Inherited from LensMainExtension.whenEnabled

    -

    Defined in src/extensions/lens-extension.ts:80

    +

    Defined in src/extensions/lens-extension.ts:80

    Parameters:

    ▪ handlers: function

    ▸ (): Promise‹Function[]›

    diff --git a/latest/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html b/latest/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html index 565268f4bb..eb4ddc4f8c 100644 --- a/latest/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html +++ b/latest/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -880,15 +892,15 @@

    Enumeration members#

    ERROR#

    • ERROR: = "error"

    -

    Defined in src/renderer/components/notifications/notifications.store.ts:12

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:12

    INFO#

    • INFO: = "info"

    -

    Defined in src/renderer/components/notifications/notifications.store.ts:13

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:13

    OK#

    • OK: = "ok"

    -

    Defined in src/renderer/components/notifications/notifications.store.ts:11

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:11

    diff --git a/latest/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html b/latest/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html index f8a56af65d..12d334511a 100644 --- a/latest/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html +++ b/latest/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -920,35 +932,35 @@

    Enumeration members#

    BOTTOM#

    • BOTTOM: = "bottom"

    -

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

    +

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

    BOTTOM_LEFT#

    • BOTTOM_LEFT: = "bottom_left"

    -

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

    +

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

    BOTTOM_RIGHT#

    • BOTTOM_RIGHT: = "bottom_right"

    -

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

    +

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

    LEFT#

    • LEFT: = "left"

    -

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

    +

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

    • RIGHT: = "right"

    -

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

    +

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

    TOP#

    • TOP: = "top"

    -

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

    +

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

    TOP_LEFT#

    • TOP_LEFT: = "top_left"

    -

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

    +

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

    TOP_RIGHT#

    • TOP_RIGHT: = "top_right"

    -

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

    +

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

    diff --git a/latest/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html b/latest/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html index da325d8d3d..7fb6e2631e 100644 --- a/latest/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html +++ b/latest/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -880,15 +892,15 @@

    Enumeration members#

    CRITICAL#

    • CRITICAL: = 3

    -

    Defined in src/extensions/renderer-api/kube-object-status.ts:10

    +

    Defined in src/extensions/renderer-api/kube-object-status.ts:10

    INFO#

    • INFO: = 1

    -

    Defined in src/extensions/renderer-api/kube-object-status.ts:8

    +

    Defined in src/extensions/renderer-api/kube-object-status.ts:8

    WARNING#

    • WARNING: = 2

    -

    Defined in src/extensions/renderer-api/kube-object-status.ts:9

    +

    Defined in src/extensions/renderer-api/kube-object-status.ts:9

    diff --git a/latest/extensions/api/globals/index.html b/latest/extensions/api/globals/index.html index c2f61564ff..9e95e9fe6a 100644 --- a/latest/extensions/api/globals/index.html +++ b/latest/extensions/api/globals/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/api/index.html b/latest/extensions/api/index.html index b044e66faa..8f9d3578f9 100644 --- a/latest/extensions/api/index.html +++ b/latest/extensions/api/index.html @@ -550,6 +550,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -575,8 +587,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html b/latest/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html index d5631db362..064ea4fde8 100644 --- a/latest/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html +++ b/latest/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -899,22 +911,22 @@

    Properties#

    canUpgrade#

    • canUpgrade: boolean

    -

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

    +

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

    whether the feature can be upgraded or not, as set by the implementation

    currentVersion#

    • currentVersion: string

    -

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

    +

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

    feature's current version, as set by the implementation

    installed#

    • installed: boolean

    -

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

    +

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

    whether the feature is installed or not, as set by the implementation

    latestVersion#

    • latestVersion: string

    -

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

    +

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

    feature's latest version, as set by the implementation

    diff --git a/latest/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html b/latest/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html index 07bf41174a..ef0126ca08 100644 --- a/latest/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html +++ b/latest/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -950,47 +962,47 @@

    Properties#

    Optional accessibleNamespaces#

    • accessibleNamespaces? : string[]

    -

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

    +

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

    List of accessible namespaces

    Optional contextName#

    • contextName? : string

    -

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

    +

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

    User context in kubeconfig

    id#

    • id: ClusterId

    -

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

    +

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

    Unique id for a cluster

    Optional kubeConfig#

    • kubeConfig? : string

    -

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

    +

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

    deprecated

    kubeConfigPath#

    • kubeConfigPath: string

    -

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

    +

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

    Path to cluster kubeconfig

    Optional metadata#

    • metadata? : ClusterMetadata

    -

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

    +

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

    Metadata

    Optional ownerRef#

    • ownerRef? : string

    -

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

    +

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

    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:56

    +

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

    Preferences

    Optional workspace#

    • workspace? : WorkspaceId

    -

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

    +

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

    Workspace id

    diff --git a/latest/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html b/latest/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html index 6ede4367e8..6619166823 100644 --- a/latest/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html +++ b/latest/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -918,23 +930,23 @@

    Properties#

    Optional description#

    • description? : string

    -

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

    +

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

    id#

    • id: WorkspaceId

    -

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

    +

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

    Optional lastActiveClusterId#

    • lastActiveClusterId? : ClusterId

    -

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

    +

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

    name#

    • name: string

    -

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

    +

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

    Optional ownerRef#

    • ownerRef? : string

    -

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

    +

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

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html index 36a5b0bc2d..a42171e7bf 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -883,11 +895,11 @@

    Properties#

    Hint#

    • Hint: React.ComponentType‹any›

    -

    Defined in src/extensions/registries/app-preference-registry.ts:5

    +

    Defined in src/extensions/registries/app-preference-registry.ts:5

    Input#

    • Input: React.ComponentType‹any›

    -

    Defined in src/extensions/registries/app-preference-registry.ts:6

    +

    Defined in src/extensions/registries/app-preference-registry.ts:6

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html index c705f9a7be..165dfdc204 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -883,11 +895,11 @@

    Properties#

    components#

    • components: AppPreferenceComponents

    -

    Defined in src/extensions/registries/app-preference-registry.ts:11

    +

    Defined in src/extensions/registries/app-preference-registry.ts:11

    title#

    • title: string

    -

    Defined in src/extensions/registries/app-preference-registry.ts:10

    +

    Defined in src/extensions/registries/app-preference-registry.ts:10

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html index 0e052cabaa..4b99e19c30 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -875,7 +887,7 @@

    Properties#

    Description#

    • Description: React.ComponentType‹any›

    -

    Defined in src/extensions/registries/cluster-feature-registry.ts:6

    +

    Defined in src/extensions/registries/cluster-feature-registry.ts:6

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html index 92091ba7f5..8b975f18a4 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -891,15 +903,15 @@

    Properties#

    components#

    • components: ClusterFeatureComponents

    -

    Defined in src/extensions/registries/cluster-feature-registry.ts:11

    +

    Defined in src/extensions/registries/cluster-feature-registry.ts:11

    feature#

    • feature: ClusterFeature

    -

    Defined in src/extensions/registries/cluster-feature-registry.ts:12

    +

    Defined in src/extensions/registries/cluster-feature-registry.ts:12

    title#

    • title: string

    -

    Defined in src/extensions/registries/cluster-feature-registry.ts:10

    +

    Defined in src/extensions/registries/cluster-feature-registry.ts:10

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html index ae10000b93..0b047e6684 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -875,7 +887,7 @@

    Properties#

    Details#

    • Details: React.ComponentType‹any›

    -

    Defined in src/extensions/registries/kube-object-detail-registry.ts:5

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:5

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html index 5afef1243c..8654eac829 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -899,19 +911,19 @@

    Properties#

    apiVersions#

    • apiVersions: string[]

    -

    Defined in src/extensions/registries/kube-object-detail-registry.ts:10

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:10

    components#

    • components: KubeObjectDetailComponents

    -

    Defined in src/extensions/registries/kube-object-detail-registry.ts:11

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:11

    kind#

    • kind: string

    -

    Defined in src/extensions/registries/kube-object-detail-registry.ts:9

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:9

    Optional priority#

    • priority? : number

    -

    Defined in src/extensions/registries/kube-object-detail-registry.ts:12

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:12

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html index 3110ce4fa4..d9d364ba04 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -875,7 +887,7 @@

    Properties#

    • MenuItem: React.ComponentType‹any›

    -

    Defined in src/extensions/registries/kube-object-menu-registry.ts:5

    +

    Defined in src/extensions/registries/kube-object-menu-registry.ts:5

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html index fa9637a132..37c223b4bf 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -891,15 +903,15 @@

    Properties#

    apiVersions#

    • apiVersions: string[]

    -

    Defined in src/extensions/registries/kube-object-menu-registry.ts:10

    +

    Defined in src/extensions/registries/kube-object-menu-registry.ts:10

    components#

    • components: KubeObjectMenuComponents

    -

    Defined in src/extensions/registries/kube-object-menu-registry.ts:11

    +

    Defined in src/extensions/registries/kube-object-menu-registry.ts:11

    kind#

    • kind: string

    -

    Defined in src/extensions/registries/kube-object-menu-registry.ts:9

    +

    Defined in src/extensions/registries/kube-object-menu-registry.ts:9

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html index e136643c7c..2cdb5ea80c 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -891,15 +903,15 @@

    Properties#

    apiVersions#

    • apiVersions: string[]

    -

    Defined in src/extensions/registries/kube-object-status-registry.ts:6

    +

    Defined in src/extensions/registries/kube-object-status-registry.ts:6

    kind#

    • kind: string

    -

    Defined in src/extensions/registries/kube-object-status-registry.ts:5

    +

    Defined in src/extensions/registries/kube-object-status-registry.ts:5

    resolve#

    • resolve: function

    -

    Defined in src/extensions/registries/kube-object-status-registry.ts:7

    +

    Defined in src/extensions/registries/kube-object-status-registry.ts:7

    Type declaration:

    ▸ (object: KubeObject): KubeObjectStatus

    Parameters:

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html index 4fbc975130..f65c70d6d5 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -875,7 +887,7 @@

    Properties#

    Page#

    • Page: React.ComponentType‹any›

    -

    Defined in src/extensions/registries/page-registry.ts:40

    +

    Defined in src/extensions/registries/page-registry.ts:40

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html index 63a41df04d..c12a716793 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -875,7 +887,7 @@

    Properties#

    Icon#

    • Icon: React.ComponentType‹IconProps›

    -

    Defined in src/extensions/registries/page-menu-registry.ts:27

    +

    Defined in src/extensions/registries/page-menu-registry.ts:27

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html index 682ae6afbe..c01721ae97 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -891,15 +903,15 @@

    Properties#

    components#

    • components: PageMenuComponents

    -

    Defined in src/extensions/registries/page-menu-registry.ts:18

    +

    Defined in src/extensions/registries/page-menu-registry.ts:18

    Optional target#

    • target? : PageMenuTarget

    -

    Defined in src/extensions/registries/page-menu-registry.ts:16

    +

    Defined in src/extensions/registries/page-menu-registry.ts:16

    title#

    • title: React.ReactNode

    -

    Defined in src/extensions/registries/page-menu-registry.ts:17

    +

    Defined in src/extensions/registries/page-menu-registry.ts:17

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html index 423cfbe46c..5dccdea01a 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -891,11 +903,11 @@

    Properties#

    components#

    • components: PageComponents

    -

    Defined in src/extensions/registries/page-registry.ts:31

    +

    Defined in src/extensions/registries/page-registry.ts:31

    Optional exact#

    • exact? : boolean

    -

    Defined in src/extensions/registries/page-registry.ts:30

    +

    Defined in src/extensions/registries/page-registry.ts:30

    Strict route matching to provided page-id, read also: https://reactrouter.com/web/api/NavLink/exact-bool In case when more than one page registered at same extension "pageId" is required to identify different pages, It might be useful to provide exact: true in some cases to avoid overlapping routes. @@ -908,7 +920,7 @@ Pro-tip: registering pages in opposite order will make same effect without "exac

    Optional id#

    • id? : string

    -

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

    +

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

    Page ID or additional route path to indicate uniqueness within current extension registered pages Might contain special url placeholders, e.g. "/users/:userId?" (? - marks as optional param) When not provided, first registered page without "id" would be used for page-menus without target.pageId for same extension

    diff --git a/latest/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html b/latest/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html index 41285b3412..70e5239c30 100644 --- a/latest/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html +++ b/latest/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -875,7 +887,7 @@

    Properties#

    Optional item#

    • item? : React.ReactNode

    -

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

    +

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

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html index 59fab8b939..eb5cfc6a58 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -3414,7 +3426,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:9

    +

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

    Optional lang#

    • lang? : string

    @@ -4268,7 +4280,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

    @@ -4303,12 +4315,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/latest/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html index 7c91a508e9..96720c5900 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -3118,7 +3130,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

    @@ -3127,7 +3139,7 @@

    Optional active#

    • active? : boolean

    -

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

    +

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

    Optional aria-activedescendant#

    • aria-activedescendant? : string

    @@ -3469,7 +3481,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:15

    +

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

    • checkedLink? : ReactLink‹boolean›

    @@ -3573,11 +3585,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:13

    +

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

    Optional href#

    • href? : string

    -

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

    +

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

    Optional id#

    • id? : string

    @@ -3630,7 +3642,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

    @@ -4444,7 +4456,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:12

    +

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

    Optional placeholder#

    • placeholder? : string

    @@ -4453,7 +4465,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:11

    +

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

    Optional prefix#

    • prefix? : string

    @@ -4462,7 +4474,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

    @@ -4491,7 +4503,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:16

    +

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

    Optional security#

    • security? : string

    @@ -4530,7 +4542,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:18

    +

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

    Optional title#

    • title? : string

    @@ -4540,12 +4552,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"

    @@ -4586,7 +4598,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/latest/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html index 11779ec6e0..55c3443e41 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -955,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/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html index ae768945b6..6629f09178 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -923,33 +935,33 @@

    Properties#

    Optional cancelButtonProps#

    • cancelButtonProps? : Partial‹ButtonProps›

    -

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

    +

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

    Optional icon#

    • icon? : ReactNode

    -

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

    +

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

    Optional labelCancel#

    • labelCancel? : ReactNode

    -

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

    +

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

    Optional labelOk#

    • labelOk? : ReactNode

    -

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

    +

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

    Optional message#

    • message? : ReactNode

    -

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

    +

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

    Optional ok#

    • ok? : function

    -

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

    +

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

    Type declaration:

    ▸ (): void

    Optional okButtonProps#

    • okButtonProps? : Partial‹ButtonProps›

    -

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

    +

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

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html index f32f63d48b..c5cfb10782 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html index cd2a215121..c4d1abbd1a 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -883,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/latest/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html index 11848e1d31..01eeac6fb8 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -939,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/latest/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html index 1e3f6f4cfa..0dd5ae7b55 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -3301,7 +3313,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

    @@ -3356,7 +3368,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

    @@ -3409,12 +3421,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

    @@ -3424,7 +3436,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›

    @@ -4249,7 +4261,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

    @@ -4305,7 +4317,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/latest/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html index 7bfadac9fb..b3ab7d8147 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -3295,7 +3307,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

    @@ -3349,7 +3361,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

    @@ -3402,7 +3414,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

    @@ -3411,7 +3423,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›

    @@ -4235,7 +4247,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

    @@ -4290,7 +4302,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/latest/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html index 03575e7a69..3a9530c521 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -875,7 +887,7 @@

    Properties#

    label#

    • label: string | number

    -

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

    +

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

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html index 8289b11ba2..edb87021f9 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -947,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/latest/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html index cfe59c86dd..325dfde72f 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -883,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/latest/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html index 4bf6851b7e..50fbfe8037 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -892,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/latest/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html index 85556fbeb9..43a3d50ad7 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -3051,7 +3063,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

    @@ -3388,7 +3400,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

    • checkedLink? : ReactLink‹boolean›

    @@ -3451,7 +3463,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

    @@ -3460,7 +3472,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

    @@ -3469,7 +3481,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

    @@ -3490,7 +3502,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

    @@ -3531,11 +3543,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›

    @@ -4379,7 +4391,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

    @@ -4388,11 +4400,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

    @@ -4401,7 +4413,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

    @@ -4420,7 +4432,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

    @@ -4435,12 +4447,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/latest/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html index 3b081b10c2..f6294cfc29 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -922,15 +934,15 @@

    Properties#

    Optional debounce#

    • debounce? : number

    -

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

    +

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

    Optional message#

    • message? : ReactNode | function

    -

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

    +

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

    Methods#

    Optional condition#

    ▸ condition(props: InputProps): boolean

    -

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

    +

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

    Parameters:

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

    validate#

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

    -

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

    +

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

    Parameters:

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html index 8498ebc55b..8e95386892 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -875,7 +887,7 @@

    Properties#

    object#

    • object: KubeObject

    -

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

    +

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

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html index 4796fda4d5..f4e3646037 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -892,11 +904,11 @@

    Properties#

    Optional className#

    • className? : string

    -

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

    +

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

    object#

    • object: T

    -

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

    +

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

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html index fe5c57a96f..37ec3cc278 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1102,22 +1114,22 @@

    Optional addRemoveButtons#

    • addRemoveButtons? : Partial‹AddRemoveButtonsProps›

    Inherited from KubeObjectListLayoutProps.addRemoveButtons

    -

    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

    className#

    • className: IClassName

    Inherited from KubeObjectListLayoutProps.className

    -

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

    +

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

    Optional copyClassNameFromHeadCells#

    • copyClassNameFromHeadCells? : boolean

    Inherited from KubeObjectListLayoutProps.copyClassNameFromHeadCells

    -

    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 customizeHeader#

    • customizeHeader? : function

    Inherited from KubeObjectListLayoutProps.customizeHeader

    -

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

    +

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

    Type declaration:

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

    Parameters:

    @@ -1143,7 +1155,7 @@

    Optional customizeRemoveDialog#

    • customizeRemoveDialog? : function

    Inherited from KubeObjectListLayoutProps.customizeRemoveDialog

    -

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

    +

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

    Type declaration:

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

    Parameters:

    @@ -1165,7 +1177,7 @@

    Optional customizeTableRowProps#

    • customizeTableRowProps? : function

    Inherited from KubeObjectListLayoutProps.customizeTableRowProps

    -

    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

    Type declaration:

    ▸ (item: T): Partial‹TableRowProps›

    Parameters:

    @@ -1187,57 +1199,57 @@

    Optional dependentStores#

    • dependentStores? : ItemStore[]

    Inherited from KubeObjectListLayoutProps.dependentStores

    -

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

    +

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

    Optional detailsItem#

    • detailsItem? : T

    Inherited from KubeObjectListLayoutProps.detailsItem

    -

    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

    Optional filterItems#

    • filterItems? : ItemsFilter‹T›[]

    Inherited from KubeObjectListLayoutProps.filterItems

    -

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

    +

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

    Optional hasDetailsView#

    • hasDetailsView? : boolean

    Inherited from KubeObjectListLayoutProps.hasDetailsView

    -

    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 headerClassName#

    • headerClassName? : IClassName

    Inherited from KubeObjectListLayoutProps.headerClassName

    -

    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 hideFilters#

    • hideFilters? : boolean

    Inherited from KubeObjectListLayoutProps.hideFilters

    -

    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 isClusterScoped#

    • isClusterScoped? : boolean

    Inherited from KubeObjectListLayoutProps.isClusterScoped

    -

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

    +

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

    Optional isReady#

    • isReady? : boolean

    Inherited from KubeObjectListLayoutProps.isReady

    -

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

    +

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

    Optional isSearchable#

    • isSearchable? : boolean

    Inherited from KubeObjectListLayoutProps.isSearchable

    -

    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 isSelectable#

    • isSelectable? : boolean

    Inherited from KubeObjectListLayoutProps.isSelectable

    -

    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 onDetails#

    • onDetails? : function

    Inherited from KubeObjectListLayoutProps.onDetails

    -

    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): void

    Parameters:

    @@ -1259,7 +1271,7 @@

    Optional renderFooter#

    • renderFooter? : function

    Inherited from KubeObjectListLayoutProps.renderFooter

    -

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

    +

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

    Type declaration:

    ▸ (parent: ItemListLayout): React.ReactNode

    Parameters:

    @@ -1281,12 +1293,12 @@

    Optional renderHeaderTitle#

    • renderHeaderTitle? : ReactNode | function

    Inherited from KubeObjectListLayoutProps.renderHeaderTitle

    -

    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 renderItemMenu#

    • renderItemMenu? : function

    Inherited from KubeObjectListLayoutProps.renderItemMenu

    -

    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

    Type declaration:

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

    Parameters:

    @@ -1312,7 +1324,7 @@

    renderTableContents#

    • renderTableContents: function

    Inherited from KubeObjectListLayoutProps.renderTableContents

    -

    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

    Type declaration:

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

    Parameters:

    @@ -1334,22 +1346,22 @@

    renderTableHeader#

    • renderTableHeader: TableCellProps[] | null

    Inherited from KubeObjectListLayoutProps.renderTableHeader

    -

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

    +

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

    Optional searchFilters#

    • searchFilters? : SearchFilter‹T›[]

    Inherited from KubeObjectListLayoutProps.searchFilters

    -

    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 showHeader#

    • showHeader? : boolean

    Inherited from KubeObjectListLayoutProps.showHeader

    -

    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 sortingCallbacks#

    • sortingCallbacks? : object

    Inherited from KubeObjectListLayoutProps.sortingCallbacks

    -

    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:

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html index 93872c9c15..42664f231c 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -892,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/latest/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html index 97776f672c..84da6acce8 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1528,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

    @@ -1736,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

    @@ -1875,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

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

    Optional themeName#

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

    -

    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/latest/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html index 65515f75f5..1fb011ccf4 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -907,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/latest/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html index 2916d725b0..97877a6f11 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -4209,11 +4221,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

    @@ -5561,7 +5573,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/latest/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html index c5f52e8d15..d6b9c343c4 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -4279,12 +4291,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/latest/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html index b05c77e84b..43cb9f402f 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -5588,11 +5600,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/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html index f70a6f802f..4dea4fcad3 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -899,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/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html index bb69846c70..cd0c0640dc 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -915,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/latest/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html index 583e46ab37..42f9d45eff 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -2259,15 +2271,15 @@

    Properties#

    Optional _nowrap#

    • _nowrap? : boolean

    -

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

    +

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

    Optional _sorting#

    • _sorting? : Partial‹TableSortParams›

    -

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

    +

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

    Optional checkbox#

    • checkbox? : boolean

    -

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

    +

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

    Optional children#

    • children? : ReactNode

    @@ -2276,7 +2288,7 @@

    Optional className#

    • className? : string

    -

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

    +

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

    Optional dangerouslySetInnerHTML#

    • dangerouslySetInnerHTML? : object

    @@ -2289,7 +2301,7 @@

    Optional isChecked#

    • isChecked? : boolean

    -

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

    +

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

    Optional onAbort#

    • onAbort? : ReactEventHandler‹HTMLDivElement›

    @@ -3093,19 +3105,19 @@

    Optional renderBoolean#

    • renderBoolean? : boolean

    -

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

    +

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

    Optional sortBy#

    • sortBy? : TableSortBy

    -

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

    +

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

    Optional title#

    • title? : ReactNode

    -

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

    +

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

    Methods#

    Optional _sort#

    ▸ _sort(sortBy: TableSortBy): void

    -

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

    +

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

    Parameters:

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html index 5cf1cc3426..83e3db75da 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -2201,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

    @@ -2214,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›

    @@ -3018,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/latest/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html index 982ae8eea6..bfe024736a 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -2300,7 +2312,7 @@

    Properties#

    Optional autoSize#

    • autoSize? : boolean

    -

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

    +

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

    Optional children#

    • children? : ReactNode

    @@ -2309,11 +2321,11 @@

    Optional className#

    • className? : string

    -

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

    +

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

    Optional customRowHeights#

    • customRowHeights? : function

    -

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

    +

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

    Type declaration:

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

    Parameters:

    @@ -2351,7 +2363,7 @@

    Optional getTableRow#

    • getTableRow? : function

    -

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

    +

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

    Type declaration:

    ▸ (uid: string): ReactElement‹TableRowProps›

    Parameters:

    @@ -2372,11 +2384,11 @@

    Optional items#

    • items? : ItemObject[]

    -

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

    +

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

    Optional noItems#

    • noItems? : React.ReactNode

    -

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

    +

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

    Optional onAbort#

    • onAbort? : ReactEventHandler‹HTMLDivElement›

    @@ -3060,7 +3072,7 @@

    Optional onSort#

    • onSort? : function

    -

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

    +

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

    Type declaration:

    ▸ (params: TableSortParams): void

    Parameters:

    @@ -3201,35 +3213,35 @@

    Optional rowLineHeight#

    • rowLineHeight? : string

    -

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

    +

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

    Optional rowPadding#

    • rowPadding? : string

    -

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

    +

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

    Optional scrollable#

    • scrollable? : boolean

    -

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

    +

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

    Optional selectable#

    • selectable? : boolean

    -

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

    +

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

    Optional selectedItemId#

    • selectedItemId? : string

    -

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

    +

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

    Optional sortByDefault#

    • sortByDefault? : Partial‹TableSortParams›

    -

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

    +

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

    Optional sortSyncWithUrl#

    • sortSyncWithUrl? : boolean

    -

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

    +

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

    Optional sortable#

    • sortable? : object

    -

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

    +

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

    Type declaration:

    diff --git a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html index 1658be7f4d..cff05112a1 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -907,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/latest/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html index 511f3ed2b6..f3120469de 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -888,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/latest/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html index 1decbf50e0..5f90d9656d 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -947,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/latest/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html b/latest/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html index ea9a0c7cb2..730a2beea3 100644 --- a/latest/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -2220,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

    @@ -2229,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

    @@ -2246,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/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html b/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html index 69bdf20b6c..8401680a9f 100644 --- a/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -875,7 +887,7 @@

    Properties#

    id#

    • id: string

    -

    Defined in src/renderer/api/kube-api.ts:63

    +

    Defined in src/renderer/api/kube-api.ts:63

    diff --git a/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html b/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html index d3788f1dc9..95f4457a52 100644 --- a/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html +++ b/latest/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -963,47 +975,47 @@

    Properties#

    Optional args#

    • args? : string[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:69

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:69

    Optional command#

    • command? : string[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:68

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:68

    Optional env#

    • env? : object[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:85

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:85

    Optional envFrom#

    • envFrom? : object[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:103

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:103

    image#

    • image: string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:67

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:67

    imagePullPolicy#

    • imagePullPolicy: string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:115

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:115

    Optional livenessProbe#

    • livenessProbe? : IContainerProbe

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:113

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:113

    name#

    • name: string

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:66

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:66

    ports#

    • ports: object[]

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:70

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:70

    Optional readinessProbe#

    • readinessProbe? : IContainerProbe

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:114

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:114

    Optional resources#

    • resources? : object

    -

    Defined in src/renderer/api/endpoints/pods.api.ts:75

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:75

    Type declaration:

    @@ -919,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:

    @@ -939,7 +951,7 @@

    prevDefault#

    ▸ prevDefault‹E›(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:

    @@ -964,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/latest/extensions/api/modules/_interfaces_index_/index.html b/latest/extensions/api/modules/_interfaces_index_/index.html index fc29f8d91e..f80c8a2986 100644 --- a/latest/extensions/api/modules/_interfaces_index_/index.html +++ b/latest/extensions/api/modules/_interfaces_index_/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/api/modules/_renderer_api_components_/index.html b/latest/extensions/api/modules/_renderer_api_components_/index.html index 22806ff425..5584709bd7 100644 --- a/latest/extensions/api/modules/_renderer_api_components_/index.html +++ b/latest/extensions/api/modules/_renderer_api_components_/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1195,47 +1207,47 @@

    Type aliases#

    InputProps#

    Ƭ InputProps: Omit‹InputElementProps, "onChange" | "onSubmit"› & object

    -

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

    +

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

    Ƭ MenuContextValue: Menu

    -

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

    +

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

    NotificationId#

    Ƭ NotificationId: string | number

    -

    Defined in src/renderer/components/notifications/notifications.store.ts:7

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:7

    NotificationMessage#

    Ƭ NotificationMessage: React.ReactNode | React.ReactNode[] | JsonApiErrorParsed

    -

    Defined in src/renderer/components/notifications/notifications.store.ts:8

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:8

    RadioProps#

    Ƭ RadioProps: HTMLProps‹any› & object

    -

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

    +

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

    TableCellElem#

    Ƭ TableCellElem: ReactElement‹TableCellProps›

    -

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

    +

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

    TableHeadElem#

    Ƭ TableHeadElem: ReactElement‹TableHeadProps›

    -

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

    +

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

    TableOrderBy#

    Ƭ TableOrderBy: "asc" | "desc" | string

    -

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

    +

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

    TableRowElem#

    Ƭ TableRowElem: ReactElement‹TableRowProps›

    -

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

    +

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

    TableSortBy#

    Ƭ TableSortBy: string

    -

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

    +

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

    TableSortCallback#

    Ƭ TableSortCallback: function

    -

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

    +

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

    Type declaration:

    ▸ (data: D): string | number | (string | number)[]

    Parameters:

    @@ -1256,7 +1268,7 @@

    TableSortParams#

    Ƭ TableSortParams: object

    -

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

    +

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

    Type declaration:

    @@ -1339,7 +1351,7 @@

    ▸ SubMenu(props: Partial‹MenuProps›): Element‹›

    -

    Defined in src/renderer/components/menu/menu.tsx:275

    +

    Defined in src/renderer/components/menu/menu.tsx:275

    Parameters:

    @@ -1359,7 +1371,7 @@

    createPodLogsTab#

    ▸ createPodLogsTab(data: IPodLogsData, tabParams: Partial‹IDockTab›): IDockTab

    -

    Defined in src/renderer/components/dock/pod-logs.store.ts:190

    +

    Defined in src/renderer/components/dock/pod-logs.store.ts:190

    Parameters:

    @@ -1386,7 +1398,7 @@

    createTerminalTab#

    ▸ createTerminalTab(tabParams: Partial‹ITerminalTab›): IDockTab

    -

    Defined in src/renderer/components/dock/terminal.store.ts:18

    +

    Defined in src/renderer/components/dock/terminal.store.ts:18

    Parameters:

    @@ -1408,7 +1420,7 @@

    withTooltip#

    ▸ withTooltip‹T›(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/latest/extensions/api/modules/_renderer_api_k8s_api_/index.html b/latest/extensions/api/modules/_renderer_api_k8s_api_/index.html index 983b1bdc53..44221dffed 100644 --- a/latest/extensions/api/modules/_renderer_api_k8s_api_/index.html +++ b/latest/extensions/api/modules/_renderer_api_k8s_api_/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -1256,7 +1268,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/latest/extensions/api/modules/_renderer_api_navigation_/index.html b/latest/extensions/api/modules/_renderer_api_navigation_/index.html index 1d76759ea8..be902574a4 100644 --- a/latest/extensions/api/modules/_renderer_api_navigation_/index.html +++ b/latest/extensions/api/modules/_renderer_api_navigation_/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -899,7 +911,7 @@

    Functions#

    getDetailsUrl#

    ▸ getDetailsUrl(details: string): string

    -

    Defined in src/renderer/navigation.ts:71

    +

    Defined in src/renderer/navigation.ts:71

    Parameters:

    @@ -919,13 +931,13 @@

    hideDetails#

    ▸ hideDetails(): void

    -

    Defined in src/renderer/navigation.ts:93

    +

    Defined in src/renderer/navigation.ts:93

    Hide details. Works only in renderer.

    Returns: void

    ▸ navigate(location: LocationDescriptor): void

    -

    Defined in src/renderer/navigation.ts:17

    +

    Defined in src/renderer/navigation.ts:17

    Navigate to a location. Works only in renderer.

    Parameters:

    @@ -946,7 +958,7 @@

    showDetails#

    ▸ showDetails(path: string, resetSelected: boolean): void

    -

    Defined in src/renderer/navigation.ts:83

    +

    Defined in src/renderer/navigation.ts:83

    Show details. Works only in renderer.

    Parameters:

    diff --git a/latest/extensions/api/modules/_renderer_api_theming_/index.html b/latest/extensions/api/modules/_renderer_api_theming_/index.html index d4f7293acb..0f0b624281 100644 --- a/latest/extensions/api/modules/_renderer_api_theming_/index.html +++ b/latest/extensions/api/modules/_renderer_api_theming_/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • @@ -864,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/latest/extensions/capabilities/color-reference/index.html b/latest/extensions/capabilities/color-reference/index.html index 5d9a581fb8..fae59b8c0c 100644 --- a/latest/extensions/capabilities/color-reference/index.html +++ b/latest/extensions/capabilities/color-reference/index.html @@ -674,6 +674,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -699,8 +711,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/capabilities/common-capabilities/index.html b/latest/extensions/capabilities/common-capabilities/index.html index a47dcb8ae4..215d21352e 100644 --- a/latest/extensions/capabilities/common-capabilities/index.html +++ b/latest/extensions/capabilities/common-capabilities/index.html @@ -693,6 +693,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -718,8 +730,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/capabilities/index.html b/latest/extensions/capabilities/index.html index c3ce01c857..82e819ca43 100644 --- a/latest/extensions/capabilities/index.html +++ b/latest/extensions/capabilities/index.html @@ -543,6 +543,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -568,8 +580,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/capabilities/styling/index.html b/latest/extensions/capabilities/styling/index.html index c31d6d8dc2..5a13ad45cd 100644 --- a/latest/extensions/capabilities/styling/index.html +++ b/latest/extensions/capabilities/styling/index.html @@ -651,6 +651,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -676,8 +688,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/get-started/anatomy/index.html b/latest/extensions/get-started/anatomy/index.html index ca75d8fc8d..79b070e3f4 100644 --- a/latest/extensions/get-started/anatomy/index.html +++ b/latest/extensions/get-started/anatomy/index.html @@ -610,6 +610,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -635,8 +647,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/get-started/overview/index.html b/latest/extensions/get-started/overview/index.html index 5e3da2664a..2e466f45ee 100644 --- a/latest/extensions/get-started/overview/index.html +++ b/latest/extensions/get-started/overview/index.html @@ -597,6 +597,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -622,8 +634,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/get-started/wrapping-up/index.html b/latest/extensions/get-started/wrapping-up/index.html index be2c01d6c5..ec4eb5e3d4 100644 --- a/latest/extensions/get-started/wrapping-up/index.html +++ b/latest/extensions/get-started/wrapping-up/index.html @@ -604,6 +604,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -629,8 +641,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/get-started/your-first-extension/index.html b/latest/extensions/get-started/your-first-extension/index.html index ac3308202d..5c7ee69211 100644 --- a/latest/extensions/get-started/your-first-extension/index.html +++ b/latest/extensions/get-started/your-first-extension/index.html @@ -638,6 +638,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -663,8 +675,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/guides/anatomy/index.html b/latest/extensions/guides/anatomy/index.html index 8b7da67526..1c0aa7320e 100644 --- a/latest/extensions/guides/anatomy/index.html +++ b/latest/extensions/guides/anatomy/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/guides/components/index.html b/latest/extensions/guides/components/index.html index 468e80442f..b32d1c7e23 100644 --- a/latest/extensions/guides/components/index.html +++ b/latest/extensions/guides/components/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/guides/generator/index.html b/latest/extensions/guides/generator/index.html index 17fc27fac2..3f6e14c04f 100644 --- a/latest/extensions/guides/generator/index.html +++ b/latest/extensions/guides/generator/index.html @@ -551,30 +551,6 @@ - -
  • - - Main Extension - -
    • - - - - - - - -
  • - - Renderer Extension - -
    • - - - - - - @@ -640,6 +616,42 @@ +
  • + + Main Extension + +
    • + + + + + + + +
  • + + Renderer Extension + +
    • + + + + + + + +
  • + + Stores + +
    • + + + + + + +
  • Working with mobx @@ -952,7 +964,7 @@ npm start # start the webpack server in watch mode
    -
  • + Generator + +
    • + + + + + + +
  • Main Extension @@ -622,8 +634,8 @@
  • - - Generator + + Stores
    • @@ -995,13 +1007,13 @@ -
  • + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/guides/main-extension/index.html b/latest/extensions/guides/main-extension/index.html index e940131a10..d2eb020e0b 100644 --- a/latest/extensions/guides/main-extension/index.html +++ b/latest/extensions/guides/main-extension/index.html @@ -551,6 +551,18 @@ + +
  • + + Generator + +
    • + + + + + + @@ -628,8 +640,8 @@
  • - - Generator + + Stores
    • @@ -969,7 +981,7 @@
    diff --git a/latest/extensions/guides/renderer-extension/index.html b/latest/extensions/guides/renderer-extension/index.html index 000f7d74a3..fdb605a5a9 100644 --- a/latest/extensions/guides/renderer-extension/index.html +++ b/latest/extensions/guides/renderer-extension/index.html @@ -552,6 +552,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -684,8 +696,8 @@
  • - - Generator + + Stores
    • @@ -1729,13 +1741,13 @@ See Component documentation for further details. -
    + Skip to content @@ -345,10 +345,12 @@ + -
  • + +
  • - +
  • + +
  • - +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -571,11 +587,49 @@ + -
  • - - Generator + +
  • + + + + + + + + + + Stores + + + +
    • @@ -785,6 +839,36 @@ +
    +
    +
    + + +
    +
    +
    +
    @@ -792,12 +876,143 @@ -
    -

    WIP#

    -

    Stores#

    -

    ClusterStore#

    -

    WorkspaceStore#

    +

    Stores#

    +

    Stores are components that persist and synchronize state data. Lens utilizes a number of stores for maintaining a variety of state information. +A few of these are exposed by the extensions api for use by the extension developer.

    +
      +
    • The ClusterStore manages cluster state data such as cluster details, and which cluster is active.
      • +
    • The WorkspaceStore similarly manages workspace state data, such as workspace name, and which clusters belong to a given workspace.
      • +
    • The ExtensionStore is a store for managing custom extension state data.
      • +

    ExtensionStore#

    +

    Extension developers can create their own store for managing state data by extending the ExtensionStore class. +This guide shows how to create a store for the appPreferences guide example, which demonstrates how to add a custom preference to the Preferences page. +The preference is a simple boolean that indicates whether something is enabled or not. +The problem with that example is that the enabled state is not stored anywhere, and reverts to the default the next time Lens is started.

    +

    The following example code creates a store for the appPreferences guide example:

    +
    import { Store } from "@k8slens/extensions";
+import { observable, toJS } from "mobx";
+
+export type ExamplePreferencesModel = {
+  enabled: boolean;
+};
+
+export class ExamplePreferencesStore extends Store.ExtensionStore<ExamplePreferencesModel> {
+
+  @observable  enabled = false;
+
+  private constructor() {
+    super({
+      configName: "example-preferences-store",
+      defaults: {
+        enabled: false
+      }
+    });
+  }
+
+  protected fromStore({ enabled }: ExamplePreferencesModel): void {
+    this.enabled = enabled;
+  }
+
+  toJSON(): ExamplePreferencesModel {
+    return toJS({
+      enabled: this.enabled
+    }, {
+      recurseEverything: true
+    });
+  }
+}
+
+export const examplePreferencesStore = ExamplePreferencesStore.getInstance<ExamplePreferencesStore>();
+
    +

    First the extension's data model is defined using a simple type, ExamplePreferencesModel, which has a single field, enabled, representing the preference's state. +ExamplePreferencesStore extends Store.ExtensionStore, based on the ExamplePreferencesModel. +The field enabled is added to the ExamplePreferencesStore class to hold the "live" or current state of the preference. +Note the use of the observer decorator on the enabled field. +As for the appPreferences guide example, mobx is used for the UI state management, ensuring the checkbox updates when activated by the user.

    +

    Then the constructor and two abstract methods are implemented. +In the constructor, the name of the store ("example-preferences-store"), and the default (initial) value for the preference state (enabled: false) are specified. +The fromStore() method is called by Lens internals when the store is loaded, and gives the extension the opportunity to retrieve the stored state data values based on the defined data model. +Here, the enabled field of the ExamplePreferencesStore is set to the value from the store whenever fromStore() is invoked. +The toJSON() method is complementary to fromStore(), and is called when the store is being saved. +toJSON() must provide a JSON serializable object, facilitating its storage in JSON format. +The toJS() function from mobx is convenient for this purpose, and is used here.

    +

    Finally, examplePreferencesStore is created by calling ExamplePreferencesStore.getInstance<ExamplePreferencesStore>(), and exported for use by other parts of the extension. +Note that examplePreferencesStore is a singleton, calling this function again will not create a new store.

    +

    The following example code, modified from the appPreferences guide example demonstrates how to use the extension store. +examplePreferencesStore must be loaded in the main process, where loaded stores are automatically saved when exiting Lens. This can be done in ./main.ts:

    +
    import { LensMainExtension } from "@k8slens/extensions";
+import { examplePreferencesStore } from "./src/example-preference-store";
+
+export default class ExampleMainExtension extends LensMainExtension {
+  async onActivate() {
+    await examplePreferencesStore.loadExtension(this);
+  }
+}
+
    +

    Here, examplePreferencesStore is loaded with examplePreferencesStore.loadExtension(this), which is conveniently called from the onActivate() method of ExampleMainExtension. +Similarly, examplePreferencesStore must be loaded in the renderer process where the appPreferences are handled. This can be done in ./renderer.ts:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
+import { ExamplePreferenceHint, ExamplePreferenceInput } from "./src/example-preference";
+import { examplePreferencesStore } from "./src/example-preference-store";
+import React from "react";
+
+export default class ExampleRendererExtension extends LensRendererExtension {
+
+  async onActivate() {
+    await examplePreferencesStore.loadExtension(this);
+  }
+
+  appPreferences = [
+    {
+      title: "Example Preferences",
+      components: {
+        Input: () => <ExamplePreferenceInput preference={examplePreferencesStore}/>,
+        Hint: () => <ExamplePreferenceHint/>
+      }
+    }
+  ];
+}
+
    +

    Again, examplePreferencesStore.loadExtension(this) is called to load examplePreferencesStore, this time from the onActivate() method of ExampleRendererExtension. +Also, there is no longer the need for the preference field in the ExampleRendererExtension class, as the props for ExamplePreferenceInput is now examplePreferencesStore. +ExamplePreferenceInput is defined in ./src/example-preference.tsx:

    +
    import { Component } from "@k8slens/extensions";
+import { observer } from "mobx-react";
+import React from "react";
+import { ExamplePreferencesStore } from "./example-preference-store";
+
+export class ExamplePreferenceProps {
+  preference: ExamplePreferencesStore;
+}
+
+@observer
+export class ExamplePreferenceInput extends React.Component<ExamplePreferenceProps> {
+
+  render() {
+    const { preference } = this.props;
+
+    return (
+      <Component.Checkbox
+        label="I understand appPreferences"
+        value={preference.enabled}
+        onChange={v => { preference.enabled = v; }}
+      />
+    );
+  }
+}
+
+export class ExamplePreferenceHint extends React.Component {
+  render() {
+    return (
+      <span>This is an example of an appPreference for extensions.</span>
+    );
+  }
+}
+
    +

    The only change here is that ExamplePreferenceProps defines its preference field as an ExamplePreferencesStore type. +Everything else works as before except now the enabled state persists across Lens restarts because it is managed by the +examplePreferencesStore.

    @@ -813,6 +1028,41 @@
    +
    + +
    +
    diff --git a/latest/extensions/guides/working-with-mobx/index.html b/latest/extensions/guides/working-with-mobx/index.html index 694a7b1d5d..a66a54fb1d 100644 --- a/latest/extensions/guides/working-with-mobx/index.html +++ b/latest/extensions/guides/working-with-mobx/index.html @@ -552,6 +552,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -577,8 +589,8 @@
  • - - Generator + + Stores
    • @@ -915,7 +927,7 @@ However, if you do not, here is a quick overview.

    diff --git a/latest/extensions/index.html b/latest/extensions/index.html index 2c8a246a13..8e7ab470e2 100644 --- a/latest/extensions/index.html +++ b/latest/extensions/index.html @@ -616,6 +616,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -641,8 +653,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/testing-and-publishing/bundling/index.html b/latest/extensions/testing-and-publishing/bundling/index.html index 2bc5925fd9..695330de32 100644 --- a/latest/extensions/testing-and-publishing/bundling/index.html +++ b/latest/extensions/testing-and-publishing/bundling/index.html @@ -543,6 +543,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -568,8 +580,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/testing-and-publishing/publishing/index.html b/latest/extensions/testing-and-publishing/publishing/index.html index 3748ba7576..6aadfb7045 100644 --- a/latest/extensions/testing-and-publishing/publishing/index.html +++ b/latest/extensions/testing-and-publishing/publishing/index.html @@ -550,6 +550,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -575,8 +587,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/testing-and-publishing/testing/index.html b/latest/extensions/testing-and-publishing/testing/index.html index 28c9a87944..98070834c8 100644 --- a/latest/extensions/testing-and-publishing/testing/index.html +++ b/latest/extensions/testing-and-publishing/testing/index.html @@ -550,6 +550,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -575,8 +587,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/extensions/usage/index.html b/latest/extensions/usage/index.html index 7403ef0786..d54873e4a1 100644 --- a/latest/extensions/usage/index.html +++ b/latest/extensions/usage/index.html @@ -600,6 +600,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -625,8 +637,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/faq/index.html b/latest/faq/index.html index ef2fac44e8..721af409c3 100644 --- a/latest/faq/index.html +++ b/latest/faq/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/getting-started/index.html b/latest/getting-started/index.html index 22e5b46bfd..d58119479b 100644 --- a/latest/getting-started/index.html +++ b/latest/getting-started/index.html @@ -634,6 +634,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -659,8 +671,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/getting-started/introductory-videos/index.html b/latest/getting-started/introductory-videos/index.html index e1ae3753fb..5af60ccc38 100644 --- a/latest/getting-started/introductory-videos/index.html +++ b/latest/getting-started/introductory-videos/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/getting-started/preferences/index.html b/latest/getting-started/preferences/index.html index 96b0ce2d6b..1af14c5219 100644 --- a/latest/getting-started/preferences/index.html +++ b/latest/getting-started/preferences/index.html @@ -606,6 +606,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -631,8 +643,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/helm/index.html b/latest/helm/index.html index ece7ed3069..eae2c310f2 100644 --- a/latest/helm/index.html +++ b/latest/helm/index.html @@ -607,6 +607,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -632,8 +644,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/index.html b/latest/index.html index 27896ba2f5..3330334f75 100644 --- a/latest/index.html +++ b/latest/index.html @@ -593,6 +593,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -618,8 +630,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/search/search_index.json b/latest/search/search_index.json index 255228fee2..1c66258f2f 100644 --- a/latest/search/search_index.json +++ b/latest/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). 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). 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 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/#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
    ); }) Defined in src/renderer/components/layout/tab-layout.tsx:27 Const notificationsStore # \u2022 notificationsStore : NotificationsStore \u2039\u203a = new NotificationsStore() Defined in src/renderer/components/notifications/notifications.store.ts:77 Const terminalStore # \u2022 terminalStore : TerminalStore\u2039\u203a = new TerminalStore() Defined in src/renderer/components/dock/terminal.store.ts:124 Functions # DrawerItemLabels # \u25b8 DrawerItemLabels ( props : DrawerItemLabelsProps ): Element\u2039\u203a Defined in src/renderer/components/drawer/drawer-item-labels.tsx:9 Parameters: Name Type props DrawerItemLabelsProps Returns: Element\u2039\u203a SubMenu # \u25b8 SubMenu ( props : Partial\u2039 MenuProps \u203a): Element\u2039\u203a Defined in src/renderer/components/menu/menu.tsx:275 Parameters: Name Type props Partial\u2039 MenuProps \u203a Returns: Element\u2039\u203a createPodLogsTab # \u25b8 createPodLogsTab ( data : IPodLogsData, tabParams : Partial\u2039IDockTab\u203a): IDockTab Defined in src/renderer/components/dock/pod-logs.store.ts:190 Parameters: Name Type Default data IPodLogsData - tabParams Partial\u2039IDockTab\u203a {} Returns: IDockTab createTerminalTab # \u25b8 createTerminalTab ( tabParams : Partial\u2039ITerminalTab\u203a): IDockTab Defined in src/renderer/components/dock/terminal.store.ts:18 Parameters: Name Type Default tabParams Partial\u2039ITerminalTab\u203a {} Returns: IDockTab withTooltip # \u25b8 withTooltip \u2039 T \u203a( Target : T): T Defined in src/renderer/components/tooltip/withTooltip.tsx:18 Type parameters: \u25aa T : React.ComponentType\u2039any\u203a Parameters: Name Type Target T Returns: T","title":"Module: \"renderer-api/components\""},{"location":"extensions/api/modules/_renderer_api_components_/#module-renderer-apicomponents","text":"","title":"Module: \"renderer-api/components\""},{"location":"extensions/api/modules/_renderer_api_components_/#index","text":"","title":"Index"},{"location":"extensions/api/modules/_renderer_api_components_/#enumerations","text":"NotificationStatus TooltipPosition","title":"Enumerations"},{"location":"extensions/api/modules/_renderer_api_components_/#classes","text":"Badge Button Checkbox ConfirmDialog CubeSpinner Dialog Drawer DrawerItem DrawerParamToggler DrawerTitle Icon Input KubeEventDetails KubeObjectDetails KubeObjectListLayout KubeObjectMenu KubeObjectMeta LineProgress Menu MenuActions MenuItem Notifications NotificationsStore PageLayout Radio RadioGroup Select Slider Spinner StatusBrick Stepper Tab Table TableCell TableHead TableRow Tabs Tooltip WizardLayout","title":"Classes"},{"location":"extensions/api/modules/_renderer_api_components_/#interfaces","text":"BadgeProps ButtonProps CheckboxProps ConfirmDialogParams ConfirmDialogProps CubeSpinnerProps DialogProps DrawerItemLabelsProps DrawerItemProps DrawerParamTogglerProps DrawerProps DrawerTitleProps GroupSelectOption IconProps InputValidator KubeEventDetailsProps KubeObjectDetailsProps KubeObjectListLayoutProps KubeObjectMenuProps KubeObjectMetaProps LineProgressProps MenuActionsProps MenuItemProps MenuPosition MenuProps Notification PageLayoutProps RadioGroupProps SelectOption SelectProps SliderProps SpinnerProps StatusBrickProps StepperProps TabLayoutProps TabLayoutRoute TabProps TableCellProps TableHeadProps TableProps TableRowProps TabsProps TooltipContentFormatters TooltipDecoratorProps TooltipProps WizardLayoutProps","title":"Interfaces"},{"location":"extensions/api/modules/_renderer_api_components_/#type-aliases","text":"InputProps MenuContextValue NotificationId NotificationMessage RadioProps TableCellElem TableHeadElem TableOrderBy TableRowElem TableSortBy TableSortCallback TableSortParams","title":"Type aliases"},{"location":"extensions/api/modules/_renderer_api_components_/#variables","text":"InputValidators MenuContext TabLayout notificationsStore terminalStore","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_components_/#functions","text":"DrawerItemLabels SubMenu createPodLogsTab createTerminalTab withTooltip","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_components_/#type-aliases_1","text":"","title":"Type aliases"},{"location":"extensions/api/modules/_renderer_api_components_/#inputprops","text":"\u01ac InputProps : Omit\u2039InputElementProps, \"onChange\" | \"onSubmit\"\u203a & object Defined in src/renderer/components/input/input.tsx:21","title":"InputProps"},{"location":"extensions/api/modules/_renderer_api_components_/#menucontextvalue","text":"\u01ac MenuContextValue : Menu Defined in src/renderer/components/menu/menu.tsx:11","title":"MenuContextValue"},{"location":"extensions/api/modules/_renderer_api_components_/#notificationid","text":"\u01ac NotificationId : string | number Defined in src/renderer/components/notifications/notifications.store.ts:7","title":"NotificationId"},{"location":"extensions/api/modules/_renderer_api_components_/#notificationmessage","text":"\u01ac NotificationMessage : React.ReactNode | React.ReactNode[] | JsonApiErrorParsed Defined in src/renderer/components/notifications/notifications.store.ts:8","title":"NotificationMessage"},{"location":"extensions/api/modules/_renderer_api_components_/#radioprops","text":"\u01ac RadioProps : HTMLProps\u2039any\u203a & object Defined in src/renderer/components/radio/radio.tsx:40","title":"RadioProps"},{"location":"extensions/api/modules/_renderer_api_components_/#tablecellelem","text":"\u01ac TableCellElem : ReactElement\u2039 TableCellProps \u203a Defined in src/renderer/components/table/table-cell.tsx:9","title":"TableCellElem"},{"location":"extensions/api/modules/_renderer_api_components_/#tableheadelem","text":"\u01ac TableHeadElem : ReactElement\u2039 TableHeadProps \u203a Defined in src/renderer/components/table/table-head.tsx:6","title":"TableHeadElem"},{"location":"extensions/api/modules/_renderer_api_components_/#tableorderby","text":"\u01ac TableOrderBy : \"asc\" | \"desc\" | string Defined in src/renderer/components/table/table.tsx:18","title":"TableOrderBy"},{"location":"extensions/api/modules/_renderer_api_components_/#tablerowelem","text":"\u01ac TableRowElem : ReactElement\u2039 TableRowProps \u203a Defined in src/renderer/components/table/table-row.tsx:7","title":"TableRowElem"},{"location":"extensions/api/modules/_renderer_api_components_/#tablesortby","text":"\u01ac TableSortBy : string Defined in src/renderer/components/table/table.tsx:17","title":"TableSortBy"},{"location":"extensions/api/modules/_renderer_api_components_/#tablesortcallback","text":"\u01ac TableSortCallback : function Defined in src/renderer/components/table/table.tsx:20","title":"TableSortCallback"},{"location":"extensions/api/modules/_renderer_api_components_/#tablesortparams","text":"\u01ac TableSortParams : object Defined in src/renderer/components/table/table.tsx:19","title":"TableSortParams"},{"location":"extensions/api/modules/_renderer_api_components_/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_components_/#inputvalidators","text":"\u2022 InputValidators : InputValidators Defined in src/renderer/components/input/input.tsx:14","title":"InputValidators"},{"location":"extensions/api/modules/_renderer_api_components_/#const-menucontext","text":"\u2022 MenuContext : Context\u2039 Menu \u2039\u203a\u203a = React.createContext (null) Defined in src/renderer/components/menu/menu.tsx:10","title":"Const MenuContext"},{"location":"extensions/api/modules/_renderer_api_components_/#const-tablayout","text":"\u2022 TabLayout : (Anonymous function) = observer(({ className, contentClass, tabs = [], children }: TabLayoutProps) => { const currentLocation = navigation.location.pathname; const hasTabs = tabs.length > 0; const startTabUrl = hasTabs ? (tabs.find(tab => tab.default) || tabs[0])?.url : null; return ( {hasTabs && ( navigate(url)}> {tabs.map(({ title, routePath, url = routePath, exact }) => { const isActive = !!matchPath(currentLocation, { path: routePath, exact }); return ; })} )}
    {hasTabs && ( {tabs.map(({ routePath, exact, component }) => { return ; })} )} {children}
    ); }) Defined in src/renderer/components/layout/tab-layout.tsx:27","title":"Const TabLayout"},{"location":"extensions/api/modules/_renderer_api_components_/#const-notificationsstore","text":"\u2022 notificationsStore : NotificationsStore \u2039\u203a = new NotificationsStore() Defined in src/renderer/components/notifications/notifications.store.ts:77","title":"Const notificationsStore"},{"location":"extensions/api/modules/_renderer_api_components_/#const-terminalstore","text":"\u2022 terminalStore : TerminalStore\u2039\u203a = new TerminalStore() Defined in src/renderer/components/dock/terminal.store.ts:124","title":"Const terminalStore"},{"location":"extensions/api/modules/_renderer_api_components_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_components_/#draweritemlabels","text":"\u25b8 DrawerItemLabels ( props : DrawerItemLabelsProps ): Element\u2039\u203a Defined in src/renderer/components/drawer/drawer-item-labels.tsx:9 Parameters: Name Type props DrawerItemLabelsProps Returns: Element\u2039\u203a","title":"DrawerItemLabels"},{"location":"extensions/api/modules/_renderer_api_components_/#submenu","text":"\u25b8 SubMenu ( props : Partial\u2039 MenuProps \u203a): Element\u2039\u203a Defined in src/renderer/components/menu/menu.tsx:275 Parameters: Name Type props Partial\u2039 MenuProps \u203a Returns: Element\u2039\u203a","title":"SubMenu"},{"location":"extensions/api/modules/_renderer_api_components_/#createpodlogstab","text":"\u25b8 createPodLogsTab ( data : IPodLogsData, tabParams : Partial\u2039IDockTab\u203a): IDockTab Defined in src/renderer/components/dock/pod-logs.store.ts:190 Parameters: Name Type Default data IPodLogsData - tabParams Partial\u2039IDockTab\u203a {} Returns: IDockTab","title":"createPodLogsTab"},{"location":"extensions/api/modules/_renderer_api_components_/#createterminaltab","text":"\u25b8 createTerminalTab ( tabParams : Partial\u2039ITerminalTab\u203a): IDockTab Defined in src/renderer/components/dock/terminal.store.ts:18 Parameters: Name Type Default tabParams Partial\u2039ITerminalTab\u203a {} Returns: IDockTab","title":"createTerminalTab"},{"location":"extensions/api/modules/_renderer_api_components_/#withtooltip","text":"\u25b8 withTooltip \u2039 T \u203a( Target : T): T Defined in src/renderer/components/tooltip/withTooltip.tsx:18 Type parameters: \u25aa T : React.ComponentType\u2039any\u203a Parameters: Name Type Target T Returns: T","title":"withTooltip"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/","text":"Module: \"renderer-api/k8s-api\" # Index # Enumerations # KubeObjectStatusLevel Classes # CRDResourceStore CRDStore ClusterRole ClusterRoleBinding ConfigMap ConfigMapsStore CronJob CronJobStore CustomResourceDefinition DaemonSet DaemonSetStore Deployment DeploymentApi DeploymentStore Endpoint EndpointStore EventStore HPAStore HorizontalPodAutoscaler Ingress IngressApi IngressStore Job JobStore KubeApi KubeEvent KubeObject KubeObjectStore Namespace NamespaceStore NetworkPolicy NetworkPolicyStore Node NodesApi NodesStore PersistentVolume PersistentVolumeClaim PersistentVolumeClaimsApi PersistentVolumesStore Pod PodDisruptionBudget PodDisruptionBudgetsStore PodsApi PodsStore ReplicaSet ReplicaSetStore ResourceQuota ResourceQuotasStore Role RoleBinding RoleBindingsStore RolesStore Secret SecretsStore Service ServiceAccount ServiceAccountsStore ServiceStore StatefulSet StatefulSetStore StorageClass StorageClassStore VolumeClaimStore Interfaces # IKubeApiCluster IPodContainer IPodContainerStatus ISecretRef Type aliases # KubeObjectStatus Variables # apiManager clusterRoleApi clusterRoleBindingApi configMapApi crdApi cronJobApi daemonSetApi deploymentApi endpointApi eventApi hpaApi ingressApi jobApi namespacesApi networkPolicyApi nodesApi pdbApi persistentVolumeApi podsApi pvcApi replicaSetApi resourceQuotaApi roleApi roleBindingApi secretsApi serviceAccountsApi serviceApi statefulSetApi storageClassApi Functions # forCluster isAllowedResource Type aliases # KubeObjectStatus # \u01ac KubeObjectStatus : object Defined in src/extensions/renderer-api/kube-object-status.ts:1 Type declaration: level : KubeObjectStatusLevel text : string timestamp ? : string Variables # Const apiManager # \u2022 apiManager : ApiManager\u2039\u203a = new ApiManager() Defined in src/renderer/api/api-manager.ts:54 Const clusterRoleApi # \u2022 clusterRoleApi : KubeApi \u2039 ClusterRole \u2039\u203a\u203a = new KubeApi({ objectConstructor: ClusterRole, }) Defined in src/renderer/api/endpoints/cluster-role.api.ts:12 Const clusterRoleBindingApi # \u2022 clusterRoleBindingApi : KubeApi \u2039 ClusterRoleBinding \u2039\u203a\u203a = new KubeApi({ objectConstructor: ClusterRoleBinding, }) Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:10 Const configMapApi # \u2022 configMapApi : KubeApi \u2039 ConfigMap \u2039\u203a\u203a = new KubeApi({ objectConstructor: ConfigMap, }) Defined in src/renderer/api/endpoints/configmap.api.ts:26 Const crdApi # \u2022 crdApi : KubeApi \u2039 CustomResourceDefinition \u2039\u203a\u203a = new KubeApi ({ objectConstructor: CustomResourceDefinition, checkPreferredVersion: true, }) Defined in src/renderer/api/endpoints/crd.api.ts:154 Const cronJobApi # \u2022 cronJobApi : KubeApi \u2039 CronJob \u2039\u203a\u203a = new KubeApi({ objectConstructor: CronJob, }) Defined in src/renderer/api/endpoints/cron-job.api.ts:95 Const daemonSetApi # \u2022 daemonSetApi : KubeApi \u2039 DaemonSet \u2039\u203a\u203a = new KubeApi({ objectConstructor: DaemonSet, }) Defined in src/renderer/api/endpoints/daemon-set.api.ts:74 Const deploymentApi # \u2022 deploymentApi : DeploymentApi \u2039\u203a = new DeploymentApi({ objectConstructor: Deployment, }) Defined in src/renderer/api/endpoints/deployment.api.ts:193 Const endpointApi # \u2022 endpointApi : KubeApi \u2039 Endpoint \u2039\u203a\u203a = new KubeApi({ objectConstructor: Endpoint, }) Defined in src/renderer/api/endpoints/endpoint.api.ts:127 Const eventApi # \u2022 eventApi : KubeApi \u2039 KubeEvent \u2039\u203a\u203a = new KubeApi({ objectConstructor: KubeEvent, }) Defined in src/renderer/api/endpoints/events.api.ts:59 Const hpaApi # \u2022 hpaApi : KubeApi \u2039 HorizontalPodAutoscaler \u2039\u203a\u203a = new KubeApi({ objectConstructor: HorizontalPodAutoscaler, }) Defined in src/renderer/api/endpoints/hpa.api.ts:143 Const ingressApi # \u2022 ingressApi : IngressApi \u2039\u203a = new IngressApi({ objectConstructor: Ingress, // Add fallback for Kubernetes <1.19 checkPreferredVersion: true, fallbackApiBases: [\"/apis/extensions/v1beta1/ingresses\"], logStuff: true } as any) Defined in src/renderer/api/endpoints/ingress.api.ts:177 Const jobApi # \u2022 jobApi : KubeApi \u2039 Job \u2039\u203a\u203a = new KubeApi({ objectConstructor: Job, }) Defined in src/renderer/api/endpoints/job.api.ts:110 Const namespacesApi # \u2022 namespacesApi : KubeApi \u2039 Namespace \u2039\u203a\u203a = new KubeApi({ objectConstructor: Namespace, }) Defined in src/renderer/api/endpoints/namespaces.api.ts:25 Const networkPolicyApi # \u2022 networkPolicyApi : KubeApi \u2039 NetworkPolicy \u2039\u203a\u203a = new KubeApi({ objectConstructor: NetworkPolicy, }) Defined in src/renderer/api/endpoints/network-policy.api.ts:71 Const nodesApi # \u2022 nodesApi : NodesApi \u2039\u203a = new NodesApi({ objectConstructor: Node, }) Defined in src/renderer/api/endpoints/nodes.api.ts:169 Const pdbApi # \u2022 pdbApi : KubeApi \u2039 PodDisruptionBudget \u2039\u203a\u203a = new KubeApi({ objectConstructor: PodDisruptionBudget, }) Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:47 Const persistentVolumeApi # \u2022 persistentVolumeApi : KubeApi \u2039 PersistentVolume \u2039\u203a\u203a = new KubeApi({ objectConstructor: PersistentVolume, }) Defined in src/renderer/api/endpoints/persistent-volume.api.ts:73 Const podsApi # \u2022 podsApi : PodsApi \u2039\u203a = new PodsApi({ objectConstructor: Pod, }) Defined in src/renderer/api/endpoints/pods.api.ts:459 Const pvcApi # \u2022 pvcApi : PersistentVolumeClaimsApi \u2039\u203a = new PersistentVolumeClaimsApi({ objectConstructor: PersistentVolumeClaim, }) Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:90 Const replicaSetApi # \u2022 replicaSetApi : KubeApi \u2039 ReplicaSet \u2039\u203a\u203a = new KubeApi({ objectConstructor: ReplicaSet, }) Defined in src/renderer/api/endpoints/replica-set.api.ts:56 Const resourceQuotaApi # \u2022 resourceQuotaApi : KubeApi \u2039 ResourceQuota \u2039\u203a\u203a = new KubeApi({ objectConstructor: ResourceQuota, }) Defined in src/renderer/api/endpoints/resource-quota.api.ts:66 Const roleApi # \u2022 roleApi : KubeApi \u2039 Role \u2039\u203a\u203a = new KubeApi({ objectConstructor: Role, }) Defined in src/renderer/api/endpoints/role.api.ts:21 Const roleBindingApi # \u2022 roleBindingApi : KubeApi \u2039 RoleBinding \u2039\u203a\u203a = new KubeApi({ objectConstructor: RoleBinding, }) Defined in src/renderer/api/endpoints/role-binding.api.ts:34 Const secretsApi # \u2022 secretsApi : KubeApi \u2039 Secret \u2039\u203a\u203a = new KubeApi({ objectConstructor: Secret, }) Defined in src/renderer/api/endpoints/secret.api.ts:48 Const serviceAccountsApi # \u2022 serviceAccountsApi : KubeApi \u2039 ServiceAccount \u2039\u203a\u203a = new KubeApi ({ objectConstructor: ServiceAccount, }) Defined in src/renderer/api/endpoints/service-accounts.api.ts:27 Const serviceApi # \u2022 serviceApi : KubeApi \u2039 Service \u2039\u203a\u203a = new KubeApi({ objectConstructor: Service, }) Defined in src/renderer/api/endpoints/service.api.ts:101 Const statefulSetApi # \u2022 statefulSetApi : StatefulSetApi\u2039\u203a = new StatefulSetApi({ objectConstructor: StatefulSet, }) Defined in src/renderer/api/endpoints/stateful-set.api.ts:110 Const storageClassApi # \u2022 storageClassApi : KubeApi \u2039 StorageClass \u2039\u203a\u203a = new KubeApi({ objectConstructor: StorageClass, }) Defined in src/renderer/api/endpoints/storage-class.api.ts:37 Functions # forCluster # \u25b8 forCluster \u2039 T \u203a( cluster : IKubeApiCluster , kubeClass : IKubeObjectConstructor\u2039T\u203a): KubeApi \u2039T\u203a Defined in src/renderer/api/kube-api.ts:66 Type parameters: \u25aa T : KubeObject Parameters: Name Type cluster IKubeApiCluster kubeClass IKubeObjectConstructor\u2039T\u203a Returns: KubeApi \u2039T\u203a isAllowedResource # \u25b8 isAllowedResource ( resources : KubeResource | KubeResource[]): boolean Defined in src/common/rbac.ts:40 Parameters: Name Type resources KubeResource | KubeResource[] Returns: boolean","title":"Module: \"renderer-api/k8s-api\""},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#module-renderer-apik8s-api","text":"","title":"Module: \"renderer-api/k8s-api\""},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#index","text":"","title":"Index"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#enumerations","text":"KubeObjectStatusLevel","title":"Enumerations"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#classes","text":"CRDResourceStore CRDStore ClusterRole ClusterRoleBinding ConfigMap ConfigMapsStore CronJob CronJobStore CustomResourceDefinition DaemonSet DaemonSetStore Deployment DeploymentApi DeploymentStore Endpoint EndpointStore EventStore HPAStore HorizontalPodAutoscaler Ingress IngressApi IngressStore Job JobStore KubeApi KubeEvent KubeObject KubeObjectStore Namespace NamespaceStore NetworkPolicy NetworkPolicyStore Node NodesApi NodesStore PersistentVolume PersistentVolumeClaim PersistentVolumeClaimsApi PersistentVolumesStore Pod PodDisruptionBudget PodDisruptionBudgetsStore PodsApi PodsStore ReplicaSet ReplicaSetStore ResourceQuota ResourceQuotasStore Role RoleBinding RoleBindingsStore RolesStore Secret SecretsStore Service ServiceAccount ServiceAccountsStore ServiceStore StatefulSet StatefulSetStore StorageClass StorageClassStore VolumeClaimStore","title":"Classes"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#interfaces","text":"IKubeApiCluster IPodContainer IPodContainerStatus ISecretRef","title":"Interfaces"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#type-aliases","text":"KubeObjectStatus","title":"Type aliases"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#variables","text":"apiManager clusterRoleApi clusterRoleBindingApi configMapApi crdApi cronJobApi daemonSetApi deploymentApi endpointApi eventApi hpaApi ingressApi jobApi namespacesApi networkPolicyApi nodesApi pdbApi persistentVolumeApi podsApi pvcApi replicaSetApi resourceQuotaApi roleApi roleBindingApi secretsApi serviceAccountsApi serviceApi statefulSetApi storageClassApi","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#functions","text":"forCluster isAllowedResource","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#type-aliases_1","text":"","title":"Type aliases"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#kubeobjectstatus","text":"\u01ac KubeObjectStatus : object Defined in src/extensions/renderer-api/kube-object-status.ts:1","title":"KubeObjectStatus"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-apimanager","text":"\u2022 apiManager : ApiManager\u2039\u203a = new ApiManager() Defined in src/renderer/api/api-manager.ts:54","title":"Const apiManager"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-clusterroleapi","text":"\u2022 clusterRoleApi : KubeApi \u2039 ClusterRole \u2039\u203a\u203a = new KubeApi({ objectConstructor: ClusterRole, }) Defined in src/renderer/api/endpoints/cluster-role.api.ts:12","title":"Const clusterRoleApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-clusterrolebindingapi","text":"\u2022 clusterRoleBindingApi : KubeApi \u2039 ClusterRoleBinding \u2039\u203a\u203a = new KubeApi({ objectConstructor: ClusterRoleBinding, }) Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:10","title":"Const clusterRoleBindingApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-configmapapi","text":"\u2022 configMapApi : KubeApi \u2039 ConfigMap \u2039\u203a\u203a = new KubeApi({ objectConstructor: ConfigMap, }) Defined in src/renderer/api/endpoints/configmap.api.ts:26","title":"Const configMapApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-crdapi","text":"\u2022 crdApi : KubeApi \u2039 CustomResourceDefinition \u2039\u203a\u203a = new KubeApi ({ objectConstructor: CustomResourceDefinition, checkPreferredVersion: true, }) Defined in src/renderer/api/endpoints/crd.api.ts:154","title":"Const crdApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-cronjobapi","text":"\u2022 cronJobApi : KubeApi \u2039 CronJob \u2039\u203a\u203a = new KubeApi({ objectConstructor: CronJob, }) Defined in src/renderer/api/endpoints/cron-job.api.ts:95","title":"Const cronJobApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-daemonsetapi","text":"\u2022 daemonSetApi : KubeApi \u2039 DaemonSet \u2039\u203a\u203a = new KubeApi({ objectConstructor: DaemonSet, }) Defined in src/renderer/api/endpoints/daemon-set.api.ts:74","title":"Const daemonSetApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-deploymentapi","text":"\u2022 deploymentApi : DeploymentApi \u2039\u203a = new DeploymentApi({ objectConstructor: Deployment, }) Defined in src/renderer/api/endpoints/deployment.api.ts:193","title":"Const deploymentApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-endpointapi","text":"\u2022 endpointApi : KubeApi \u2039 Endpoint \u2039\u203a\u203a = new KubeApi({ objectConstructor: Endpoint, }) Defined in src/renderer/api/endpoints/endpoint.api.ts:127","title":"Const endpointApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-eventapi","text":"\u2022 eventApi : KubeApi \u2039 KubeEvent \u2039\u203a\u203a = new KubeApi({ objectConstructor: KubeEvent, }) Defined in src/renderer/api/endpoints/events.api.ts:59","title":"Const eventApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-hpaapi","text":"\u2022 hpaApi : KubeApi \u2039 HorizontalPodAutoscaler \u2039\u203a\u203a = new KubeApi({ objectConstructor: HorizontalPodAutoscaler, }) Defined in src/renderer/api/endpoints/hpa.api.ts:143","title":"Const hpaApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-ingressapi","text":"\u2022 ingressApi : IngressApi \u2039\u203a = new IngressApi({ objectConstructor: Ingress, // Add fallback for Kubernetes <1.19 checkPreferredVersion: true, fallbackApiBases: [\"/apis/extensions/v1beta1/ingresses\"], logStuff: true } as any) Defined in src/renderer/api/endpoints/ingress.api.ts:177","title":"Const ingressApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-jobapi","text":"\u2022 jobApi : KubeApi \u2039 Job \u2039\u203a\u203a = new KubeApi({ objectConstructor: Job, }) Defined in src/renderer/api/endpoints/job.api.ts:110","title":"Const jobApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-namespacesapi","text":"\u2022 namespacesApi : KubeApi \u2039 Namespace \u2039\u203a\u203a = new KubeApi({ objectConstructor: Namespace, }) Defined in src/renderer/api/endpoints/namespaces.api.ts:25","title":"Const namespacesApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-networkpolicyapi","text":"\u2022 networkPolicyApi : KubeApi \u2039 NetworkPolicy \u2039\u203a\u203a = new KubeApi({ objectConstructor: NetworkPolicy, }) Defined in src/renderer/api/endpoints/network-policy.api.ts:71","title":"Const networkPolicyApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-nodesapi","text":"\u2022 nodesApi : NodesApi \u2039\u203a = new NodesApi({ objectConstructor: Node, }) Defined in src/renderer/api/endpoints/nodes.api.ts:169","title":"Const nodesApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-pdbapi","text":"\u2022 pdbApi : KubeApi \u2039 PodDisruptionBudget \u2039\u203a\u203a = new KubeApi({ objectConstructor: PodDisruptionBudget, }) Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:47","title":"Const pdbApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-persistentvolumeapi","text":"\u2022 persistentVolumeApi : KubeApi \u2039 PersistentVolume \u2039\u203a\u203a = new KubeApi({ objectConstructor: PersistentVolume, }) Defined in src/renderer/api/endpoints/persistent-volume.api.ts:73","title":"Const persistentVolumeApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-podsapi","text":"\u2022 podsApi : PodsApi \u2039\u203a = new PodsApi({ objectConstructor: Pod, }) Defined in src/renderer/api/endpoints/pods.api.ts:459","title":"Const podsApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-pvcapi","text":"\u2022 pvcApi : PersistentVolumeClaimsApi \u2039\u203a = new PersistentVolumeClaimsApi({ objectConstructor: PersistentVolumeClaim, }) Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:90","title":"Const pvcApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-replicasetapi","text":"\u2022 replicaSetApi : KubeApi \u2039 ReplicaSet \u2039\u203a\u203a = new KubeApi({ objectConstructor: ReplicaSet, }) Defined in src/renderer/api/endpoints/replica-set.api.ts:56","title":"Const replicaSetApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-resourcequotaapi","text":"\u2022 resourceQuotaApi : KubeApi \u2039 ResourceQuota \u2039\u203a\u203a = new KubeApi({ objectConstructor: ResourceQuota, }) Defined in src/renderer/api/endpoints/resource-quota.api.ts:66","title":"Const resourceQuotaApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-roleapi","text":"\u2022 roleApi : KubeApi \u2039 Role \u2039\u203a\u203a = new KubeApi({ objectConstructor: Role, }) Defined in src/renderer/api/endpoints/role.api.ts:21","title":"Const roleApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-rolebindingapi","text":"\u2022 roleBindingApi : KubeApi \u2039 RoleBinding \u2039\u203a\u203a = new KubeApi({ objectConstructor: RoleBinding, }) Defined in src/renderer/api/endpoints/role-binding.api.ts:34","title":"Const roleBindingApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-secretsapi","text":"\u2022 secretsApi : KubeApi \u2039 Secret \u2039\u203a\u203a = new KubeApi({ objectConstructor: Secret, }) Defined in src/renderer/api/endpoints/secret.api.ts:48","title":"Const secretsApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-serviceaccountsapi","text":"\u2022 serviceAccountsApi : KubeApi \u2039 ServiceAccount \u2039\u203a\u203a = new KubeApi ({ objectConstructor: ServiceAccount, }) Defined in src/renderer/api/endpoints/service-accounts.api.ts:27","title":"Const serviceAccountsApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-serviceapi","text":"\u2022 serviceApi : KubeApi \u2039 Service \u2039\u203a\u203a = new KubeApi({ objectConstructor: Service, }) Defined in src/renderer/api/endpoints/service.api.ts:101","title":"Const serviceApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-statefulsetapi","text":"\u2022 statefulSetApi : StatefulSetApi\u2039\u203a = new StatefulSetApi({ objectConstructor: StatefulSet, }) Defined in src/renderer/api/endpoints/stateful-set.api.ts:110","title":"Const statefulSetApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-storageclassapi","text":"\u2022 storageClassApi : KubeApi \u2039 StorageClass \u2039\u203a\u203a = new KubeApi({ objectConstructor: StorageClass, }) Defined in src/renderer/api/endpoints/storage-class.api.ts:37","title":"Const storageClassApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#forcluster","text":"\u25b8 forCluster \u2039 T \u203a( cluster : IKubeApiCluster , kubeClass : IKubeObjectConstructor\u2039T\u203a): KubeApi \u2039T\u203a Defined in src/renderer/api/kube-api.ts:66 Type parameters: \u25aa T : KubeObject Parameters: Name Type cluster IKubeApiCluster kubeClass IKubeObjectConstructor\u2039T\u203a Returns: KubeApi \u2039T\u203a","title":"forCluster"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#isallowedresource","text":"\u25b8 isAllowedResource ( resources : KubeResource | KubeResource[]): boolean Defined in src/common/rbac.ts:40 Parameters: Name Type resources KubeResource | KubeResource[] Returns: boolean","title":"isAllowedResource"},{"location":"extensions/api/modules/_renderer_api_navigation_/","text":"Module: \"renderer-api/navigation\" # Index # Interfaces # IURLParams Functions # getDetailsUrl hideDetails navigate showDetails Functions # getDetailsUrl # \u25b8 getDetailsUrl ( details : string): string Defined in src/renderer/navigation.ts:71 Parameters: Name Type details string Returns: string hideDetails # \u25b8 hideDetails (): void Defined in src/renderer/navigation.ts:93 Hide details. Works only in renderer. Returns: void navigate # \u25b8 navigate ( location : LocationDescriptor): void Defined in src/renderer/navigation.ts:17 Navigate to a location. Works only in renderer. Parameters: Name Type location LocationDescriptor Returns: void showDetails # \u25b8 showDetails ( path : string, resetSelected : boolean): void Defined in src/renderer/navigation.ts:83 Show details. Works only in renderer. Parameters: Name Type Default path string - resetSelected boolean true Returns: void","title":"Module: \"renderer-api/navigation\""},{"location":"extensions/api/modules/_renderer_api_navigation_/#module-renderer-apinavigation","text":"","title":"Module: \"renderer-api/navigation\""},{"location":"extensions/api/modules/_renderer_api_navigation_/#index","text":"","title":"Index"},{"location":"extensions/api/modules/_renderer_api_navigation_/#interfaces","text":"IURLParams","title":"Interfaces"},{"location":"extensions/api/modules/_renderer_api_navigation_/#functions","text":"getDetailsUrl hideDetails navigate showDetails","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_navigation_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_navigation_/#getdetailsurl","text":"\u25b8 getDetailsUrl ( details : string): string Defined in src/renderer/navigation.ts:71 Parameters: Name Type details string Returns: string","title":"getDetailsUrl"},{"location":"extensions/api/modules/_renderer_api_navigation_/#hidedetails","text":"\u25b8 hideDetails (): void Defined in src/renderer/navigation.ts:93 Hide details. Works only in renderer. Returns: void","title":"hideDetails"},{"location":"extensions/api/modules/_renderer_api_navigation_/#navigate","text":"\u25b8 navigate ( location : LocationDescriptor): void Defined in src/renderer/navigation.ts:17 Navigate to a location. Works only in renderer. Parameters: Name Type location LocationDescriptor Returns: void","title":"navigate"},{"location":"extensions/api/modules/_renderer_api_navigation_/#showdetails","text":"\u25b8 showDetails ( path : string, resetSelected : boolean): void Defined in src/renderer/navigation.ts:83 Show details. Works only in renderer. Parameters: Name Type Default path string - resetSelected boolean true Returns: void","title":"showDetails"},{"location":"extensions/api/modules/_renderer_api_theming_/","text":"Module: \"renderer-api/theming\" # Index # Functions # getActiveTheme Functions # getActiveTheme # \u25b8 getActiveTheme (): Theme Defined in src/extensions/renderer-api/theming.ts:3 Returns: Theme","title":"Module: \"renderer-api/theming\""},{"location":"extensions/api/modules/_renderer_api_theming_/#module-renderer-apitheming","text":"","title":"Module: \"renderer-api/theming\""},{"location":"extensions/api/modules/_renderer_api_theming_/#index","text":"","title":"Index"},{"location":"extensions/api/modules/_renderer_api_theming_/#functions","text":"getActiveTheme","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_theming_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_theming_/#getactivetheme","text":"\u25b8 getActiveTheme (): Theme Defined in src/extensions/renderer-api/theming.ts:3 Returns: Theme","title":"getActiveTheme"},{"location":"extensions/capabilities/","text":"","title":"Index"},{"location":"extensions/capabilities/color-reference/","text":"Theme Color Reference # You can use theme-based CSS Variables to style an extension according to the active theme. Base Colors # --blue : blue color. --magenta : magenta color. --golden : gold/yellow color. --halfGray : gray with some apacity applied. --primary : Lens brand (blue) color. --colorSuccess : successfull operations color. --colorOk : successfull operations (bright version) color. --colorInfo : informational, in-progress color. --colorError : critical error color. --colorSoftError : error color. --colorWarning : warning color. --colorVague : soft gray color for notices, hints etc. --colorTerminated : terminated, closed, stale color. --boxShadow : semi-transparent box-shadow color. Text Colors # --textColorPrimary : foreground text color. --textColorSecondary : foreground text color for different paragraps, parts of text. --textColorAccent : foreground text color to highlight its parts. Border Colors # --borderColor : border color. --borderFaintColor : fainted (lighter or darker, which depends on the theme) border color. Layout Colors # --mainBackground : main background color for the app. --contentColor : background color for panels contains some data. --layoutBackground : background color for layout parts. --layoutTabsBackground : background color for general tabs. --layoutTabsActiveColor : foreground color for general tabs. --layoutTabsLineColor : background color for lines under general tabs. Sidebar Colors # --sidebarLogoBackground : background color behind logo in sidebar. --sidebarActiveColor : foreground color for active menu items in sidebar. --sidebarSubmenuActiveColor : foreground color for active submenu items in sidebar. --sidebarBackground : background color for sidebar. Button Colors # --buttonPrimaryBackground : button background color for primary actions. --buttonDefaultBackground : default button background color. --buttonAccentBackground : accent button background color. --buttonDisabledBackground : disabled button background color. Table Colors # --tableBgcStripe : background color for odd rows in table. --tableBgcSelected : background color for selected row in table. --tableHeaderBackground : background color for table header. --tableHeaderBorderWidth : border width under table header. --tableHeaderBorderColor : border color for line under table header. --tableHeaderColor : foreground color for table header. --tableSelectedRowColor : foreground color for selected row in table. Dock Colors # --dockHeadBackground : background color for dock's header. --dockInfoBackground : background color for dock's info panel. --dockInfoBorderColor : border color for dock's info panel. Helm Chart Colors # --helmLogoBackground : background color for chart logo. --helmImgBackground : background color for chart image. --helmStableRepo : background color for stable repo. --helmIncubatorRepo : background color for incubator repo. --helmDescriptionHr : Helm chart description separator line color. --helmDescriptionBlockqouteColor : Helm chart description blockquote color. --helmDescriptionBlockqouteBorder : Helm chart description blockquote border color. --helmDescriptionBlockquoteBackground : Helm chart description blockquote background color. --helmDescriptionHeaders : Helm chart description headers color. --helmDescriptionH6 : Helm chart description header foreground color. --helmDescriptionTdBorder : Helm chart description table cell border color. --helmDescriptionTrBackground : Helm chart description table row background color. --helmDescriptionCodeBackground : Helm chart description code background color. --helmDescriptionPreBackground : Helm chart description pre background color. --helmDescriptionPreColor : Helm chart description pre foreground color. Terminal Colors # --terminalBackground : Terminal background color. --terminalForeground : Terminal foreground color. --terminalCursor : Terminal cursor color. --terminalCursorAccent : Terminal cursor accent color. --terminalSelection : Terminal selection background color. --terminalBlack : Terminal black color. --terminalRed : Terminal red color. --terminalGreen : Terminal green color. --terminalYellow : Terminal yellow color. --terminalBlue : Terminal blue color. --terminalMagenta : Terminal magenta color. --terminalCyan : Terminal cyan color. --terminalWhite : Terminal white color. --terminalBrightBlack : Terminal bright black color. --terminalBrightRed : Terminal bright red color. --terminalBrightGreen : Terminal bright green color. --terminalBrightYellow : Terminal bright yellow color. --terminalBrightBlue : Terminal bright blue color. --terminalBrightMagenta : Terminal bright magenta color. --terminalBrightCyan : Terminal bright cyan color. --terminalBrightWhite : Terminal bright white color. Dialog Colors # --dialogHeaderBackground : background color for dialog header. --dialogFooterBackground : background color for dialog footer. Detail Panel (Drawer) Colors # --drawerTitleText : drawer title foreground color. --drawerSubtitleBackground : drawer subtitle foreground color. --drawerItemNameColor : foreground color for item name in drawer. --drawerItemValueColor : foreground color for item value in drawer. Misc Colors # --logsBackground : background color for pod logs. --clusterMenuBackground : background color for cluster menu. --clusterMenuBorderColor : border color for cluster menu. --clusterSettingsBackground : background color for cluster settings. --addClusterIconColor : add cluster button background color. --iconActiveColor : active cluster icon foreground color. --iconActiveBackground : active cluster icon background color. --filterAreaBackground : page filter area (where selected namespaces are lister) background color. --chartStripesColor : bar chart zebra stripes background color. --chartCapacityColor : background color for capacity values in bar charts. --pieChartDefaultColor : default background color for pie chart values. --selectOptionHoveredColor : foregrond color for selected element in dropdown list. --lineProgressBackground : background color for progress line. --radioActiveBackground : background color for active radio buttons. --menuActiveBackground : background color for active menu items. In most cases you would only need base, text and some of the layout colors.","title":"Color Reference"},{"location":"extensions/capabilities/color-reference/#theme-color-reference","text":"You can use theme-based CSS Variables to style an extension according to the active theme.","title":"Theme Color Reference"},{"location":"extensions/capabilities/color-reference/#base-colors","text":"--blue : blue color. --magenta : magenta color. --golden : gold/yellow color. --halfGray : gray with some apacity applied. --primary : Lens brand (blue) color. --colorSuccess : successfull operations color. --colorOk : successfull operations (bright version) color. --colorInfo : informational, in-progress color. --colorError : critical error color. --colorSoftError : error color. --colorWarning : warning color. --colorVague : soft gray color for notices, hints etc. --colorTerminated : terminated, closed, stale color. --boxShadow : semi-transparent box-shadow color.","title":"Base Colors"},{"location":"extensions/capabilities/color-reference/#text-colors","text":"--textColorPrimary : foreground text color. --textColorSecondary : foreground text color for different paragraps, parts of text. --textColorAccent : foreground text color to highlight its parts.","title":"Text Colors"},{"location":"extensions/capabilities/color-reference/#border-colors","text":"--borderColor : border color. --borderFaintColor : fainted (lighter or darker, which depends on the theme) border color.","title":"Border Colors"},{"location":"extensions/capabilities/color-reference/#layout-colors","text":"--mainBackground : main background color for the app. --contentColor : background color for panels contains some data. --layoutBackground : background color for layout parts. --layoutTabsBackground : background color for general tabs. --layoutTabsActiveColor : foreground color for general tabs. --layoutTabsLineColor : background color for lines under general tabs.","title":"Layout Colors"},{"location":"extensions/capabilities/color-reference/#sidebar-colors","text":"--sidebarLogoBackground : background color behind logo in sidebar. --sidebarActiveColor : foreground color for active menu items in sidebar. --sidebarSubmenuActiveColor : foreground color for active submenu items in sidebar. --sidebarBackground : background color for sidebar.","title":"Sidebar Colors"},{"location":"extensions/capabilities/color-reference/#button-colors","text":"--buttonPrimaryBackground : button background color for primary actions. --buttonDefaultBackground : default button background color. --buttonAccentBackground : accent button background color. --buttonDisabledBackground : disabled button background color.","title":"Button Colors"},{"location":"extensions/capabilities/color-reference/#table-colors","text":"--tableBgcStripe : background color for odd rows in table. --tableBgcSelected : background color for selected row in table. --tableHeaderBackground : background color for table header. --tableHeaderBorderWidth : border width under table header. --tableHeaderBorderColor : border color for line under table header. --tableHeaderColor : foreground color for table header. --tableSelectedRowColor : foreground color for selected row in table.","title":"Table Colors"},{"location":"extensions/capabilities/color-reference/#dock-colors","text":"--dockHeadBackground : background color for dock's header. --dockInfoBackground : background color for dock's info panel. --dockInfoBorderColor : border color for dock's info panel.","title":"Dock Colors"},{"location":"extensions/capabilities/color-reference/#helm-chart-colors","text":"--helmLogoBackground : background color for chart logo. --helmImgBackground : background color for chart image. --helmStableRepo : background color for stable repo. --helmIncubatorRepo : background color for incubator repo. --helmDescriptionHr : Helm chart description separator line color. --helmDescriptionBlockqouteColor : Helm chart description blockquote color. --helmDescriptionBlockqouteBorder : Helm chart description blockquote border color. --helmDescriptionBlockquoteBackground : Helm chart description blockquote background color. --helmDescriptionHeaders : Helm chart description headers color. --helmDescriptionH6 : Helm chart description header foreground color. --helmDescriptionTdBorder : Helm chart description table cell border color. --helmDescriptionTrBackground : Helm chart description table row background color. --helmDescriptionCodeBackground : Helm chart description code background color. --helmDescriptionPreBackground : Helm chart description pre background color. --helmDescriptionPreColor : Helm chart description pre foreground color.","title":"Helm Chart Colors"},{"location":"extensions/capabilities/color-reference/#terminal-colors","text":"--terminalBackground : Terminal background color. --terminalForeground : Terminal foreground color. --terminalCursor : Terminal cursor color. --terminalCursorAccent : Terminal cursor accent color. --terminalSelection : Terminal selection background color. --terminalBlack : Terminal black color. --terminalRed : Terminal red color. --terminalGreen : Terminal green color. --terminalYellow : Terminal yellow color. --terminalBlue : Terminal blue color. --terminalMagenta : Terminal magenta color. --terminalCyan : Terminal cyan color. --terminalWhite : Terminal white color. --terminalBrightBlack : Terminal bright black color. --terminalBrightRed : Terminal bright red color. --terminalBrightGreen : Terminal bright green color. --terminalBrightYellow : Terminal bright yellow color. --terminalBrightBlue : Terminal bright blue color. --terminalBrightMagenta : Terminal bright magenta color. --terminalBrightCyan : Terminal bright cyan color. --terminalBrightWhite : Terminal bright white color.","title":"Terminal Colors"},{"location":"extensions/capabilities/color-reference/#dialog-colors","text":"--dialogHeaderBackground : background color for dialog header. --dialogFooterBackground : background color for dialog footer.","title":"Dialog Colors"},{"location":"extensions/capabilities/color-reference/#detail-panel-drawer-colors","text":"--drawerTitleText : drawer title foreground color. --drawerSubtitleBackground : drawer subtitle foreground color. --drawerItemNameColor : foreground color for item name in drawer. --drawerItemValueColor : foreground color for item value in drawer.","title":"Detail Panel (Drawer) Colors"},{"location":"extensions/capabilities/color-reference/#misc-colors","text":"--logsBackground : background color for pod logs. --clusterMenuBackground : background color for cluster menu. --clusterMenuBorderColor : border color for cluster menu. --clusterSettingsBackground : background color for cluster settings. --addClusterIconColor : add cluster button background color. --iconActiveColor : active cluster icon foreground color. --iconActiveBackground : active cluster icon background color. --filterAreaBackground : page filter area (where selected namespaces are lister) background color. --chartStripesColor : bar chart zebra stripes background color. --chartCapacityColor : background color for capacity values in bar charts. --pieChartDefaultColor : default background color for pie chart values. --selectOptionHoveredColor : foregrond color for selected element in dropdown list. --lineProgressBackground : background color for progress line. --radioActiveBackground : background color for active radio buttons. --menuActiveBackground : background color for active menu items. In most cases you would only need base, text and some of the layout colors.","title":"Misc Colors"},{"location":"extensions/capabilities/common-capabilities/","text":"Common Capabilities # Here we will discuss common and important building blocks for your extensions, and explain how you can use them. Almost all extensions use some of these functionalities. Main Extension # The main extension runs in the background. It adds app menu items to the Lens UI. In order to see logs from this extension, you need to start Lens from the command line. Activate # This extension can register a custom callback that is executed when an extension is activated (started). import { LensMainExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { async onActivate () { console . log ( \"hello world\" ) } } Deactivate # This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { LensMainExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { async onDeactivate () { console . log ( \"bye bye\" ) } } App Menus # This extension can register custom app menus that will be displayed on OS native menus. Example: import { LensMainExtension , windowManager } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { appMenus = [ { parentId : \"help\" , label : \"Example item\" , click() { windowManager . navigate ( \"https://k8slens.dev\" ); } } ] } Renderer Extension # The renderer extension runs in a browser context, and is visible in Lens's main window. In order to see logs from this extension you need to check them via View > Toggle Developer Tools > Console . Activate # This extension can register a custom callback that is executed when an extension is activated (started). import { LensRendererExtension } from \"@k8slens/extensions\" export default class ExampleExtension extends LensRendererExtension { async onActivate () { console . log ( \"hello world\" ) } } Deactivate # This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { LensRendererExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensRendererExtension { async onDeactivate () { console . log ( \"bye bye\" ) } } Global Pages # This extension can register custom global pages (views) to Lens's main window. The global page is a full-screen page that hides all other content from a window. import React from \"react\" import { Component , LensRendererExtension } from \"@k8slens/extensions\" import { ExamplePage } from \"./src/example-page\" export default class ExampleRendererExtension extends LensRendererExtension { globalPages = [ { id : \"example\" , components : { Page : ExamplePage , } } ] globalPageMenus = [ { title : \"Example page\" , // used in icon's tooltip target : { pageId : \"example\" } components : { Icon : () => < Component . Icon material = \"arrow\" /> , } } ] } App Preferences # This extension can register custom app preferences. It is responsible for storing a state for custom preferences. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" import { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\" import { MyCustomPreferenceHint , MyCustomPreferenceInput } from \"./src/my-custom-preference\" export default class ExampleRendererExtension extends LensRendererExtension { appPreferences = [ { title : \"My Custom Preference\" , components : { Hint : () => < MyCustomPreferenceHint /> , Input : () => < MyCustomPreferenceInput store = { myCustomPreferencesStore } /> } } ] } Cluster Pages # This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./src/page\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"extension-example\" , // optional exact : true , // optional components : { Page : () => < ExamplePage extension = { this } /> , } } ] clusterPageMenus = [ { url : \"/extension-example\" , // optional title : \"Example Extension\" , components : { Icon : ExampleIcon , } } ] } Cluster Features # This extension can register installable features for a cluster. These features are visible in the \"Cluster Settings\" page. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" import { MyCustomFeature } from \"./src/my-custom-feature\" export default class ExampleExtension extends LensRendererExtension { clusterFeatures = [ { title : \"My Custom Feature\" , components : { Description : () => { return ( < span > Just an example . < /span> ) } }, feature : new MyCustomFeature () } ] } Status Bar Items # This extension can register custom icons and text to a status bar area. import React from \"react\" ; import { Component , LensRendererExtension , Navigation } from \"@k8slens/extensions\" ; export default class ExampleExtension extends LensRendererExtension { statusBarItems = [ { item : ( < div className = \"flex align-center gaps hover-highlight\" onClick = {() => this . navigate ( \"/example-page\" )} > < Component . Icon material = \"favorite\" /> < /div> ) } ] } Kubernetes Object Menu Items # This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { CustomMenuItem , CustomMenuItemProps } from \"./src/custom-menu-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectMenuItems = [ { kind : \"Node\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : CustomMenuItemProps ) => < CustomMenuItem {... props } /> } } ] } Kubernetes Object Details # This extension can register custom details (content) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { CustomKindDetails , CustomKindDetailsProps } from \"./src/custom-kind-details\" export default class ExampleExtension extends LensRendererExtension { kubeObjectDetailItems = [ { kind : \"CustomKind\" , apiVersions : [ \"custom.acme.org/v1\" ], components : { Details : ( props : CustomKindDetailsProps ) => < CustomKindDetails {... props } /> } } ] }","title":"Common Capabilities"},{"location":"extensions/capabilities/common-capabilities/#common-capabilities","text":"Here we will discuss common and important building blocks for your extensions, and explain how you can use them. Almost all extensions use some of these functionalities.","title":"Common Capabilities"},{"location":"extensions/capabilities/common-capabilities/#main-extension","text":"The main extension runs in the background. It adds app menu items to the Lens UI. In order to see logs from this extension, you need to start Lens from the command line.","title":"Main Extension"},{"location":"extensions/capabilities/common-capabilities/#activate","text":"This extension can register a custom callback that is executed when an extension is activated (started). import { LensMainExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { async onActivate () { console . log ( \"hello world\" ) } }","title":"Activate"},{"location":"extensions/capabilities/common-capabilities/#deactivate","text":"This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { LensMainExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { async onDeactivate () { console . log ( \"bye bye\" ) } }","title":"Deactivate"},{"location":"extensions/capabilities/common-capabilities/#app-menus","text":"This extension can register custom app menus that will be displayed on OS native menus. Example: import { LensMainExtension , windowManager } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { appMenus = [ { parentId : \"help\" , label : \"Example item\" , click() { windowManager . navigate ( \"https://k8slens.dev\" ); } } ] }","title":"App Menus"},{"location":"extensions/capabilities/common-capabilities/#renderer-extension","text":"The renderer extension runs in a browser context, and is visible in Lens's main window. In order to see logs from this extension you need to check them via View > Toggle Developer Tools > Console .","title":"Renderer Extension"},{"location":"extensions/capabilities/common-capabilities/#activate_1","text":"This extension can register a custom callback that is executed when an extension is activated (started). import { LensRendererExtension } from \"@k8slens/extensions\" export default class ExampleExtension extends LensRendererExtension { async onActivate () { console . log ( \"hello world\" ) } }","title":"Activate"},{"location":"extensions/capabilities/common-capabilities/#deactivate_1","text":"This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { LensRendererExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensRendererExtension { async onDeactivate () { console . log ( \"bye bye\" ) } }","title":"Deactivate"},{"location":"extensions/capabilities/common-capabilities/#global-pages","text":"This extension can register custom global pages (views) to Lens's main window. The global page is a full-screen page that hides all other content from a window. import React from \"react\" import { Component , LensRendererExtension } from \"@k8slens/extensions\" import { ExamplePage } from \"./src/example-page\" export default class ExampleRendererExtension extends LensRendererExtension { globalPages = [ { id : \"example\" , components : { Page : ExamplePage , } } ] globalPageMenus = [ { title : \"Example page\" , // used in icon's tooltip target : { pageId : \"example\" } components : { Icon : () => < Component . Icon material = \"arrow\" /> , } } ] }","title":"Global Pages"},{"location":"extensions/capabilities/common-capabilities/#app-preferences","text":"This extension can register custom app preferences. It is responsible for storing a state for custom preferences. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" import { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\" import { MyCustomPreferenceHint , MyCustomPreferenceInput } from \"./src/my-custom-preference\" export default class ExampleRendererExtension extends LensRendererExtension { appPreferences = [ { title : \"My Custom Preference\" , components : { Hint : () => < MyCustomPreferenceHint /> , Input : () => < MyCustomPreferenceInput store = { myCustomPreferencesStore } /> } } ] }","title":"App Preferences"},{"location":"extensions/capabilities/common-capabilities/#cluster-pages","text":"This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./src/page\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"extension-example\" , // optional exact : true , // optional components : { Page : () => < ExamplePage extension = { this } /> , } } ] clusterPageMenus = [ { url : \"/extension-example\" , // optional title : \"Example Extension\" , components : { Icon : ExampleIcon , } } ] }","title":"Cluster Pages"},{"location":"extensions/capabilities/common-capabilities/#cluster-features","text":"This extension can register installable features for a cluster. These features are visible in the \"Cluster Settings\" page. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" import { MyCustomFeature } from \"./src/my-custom-feature\" export default class ExampleExtension extends LensRendererExtension { clusterFeatures = [ { title : \"My Custom Feature\" , components : { Description : () => { return ( < span > Just an example . < /span> ) } }, feature : new MyCustomFeature () } ] }","title":"Cluster Features"},{"location":"extensions/capabilities/common-capabilities/#status-bar-items","text":"This extension can register custom icons and text to a status bar area. import React from \"react\" ; import { Component , LensRendererExtension , Navigation } from \"@k8slens/extensions\" ; export default class ExampleExtension extends LensRendererExtension { statusBarItems = [ { item : ( < div className = \"flex align-center gaps hover-highlight\" onClick = {() => this . navigate ( \"/example-page\" )} > < Component . Icon material = \"favorite\" /> < /div> ) } ] }","title":"Status Bar Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-menu-items","text":"This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { CustomMenuItem , CustomMenuItemProps } from \"./src/custom-menu-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectMenuItems = [ { kind : \"Node\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : CustomMenuItemProps ) => < CustomMenuItem {... props } /> } } ] }","title":"Kubernetes Object Menu Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-details","text":"This extension can register custom details (content) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { CustomKindDetails , CustomKindDetailsProps } from \"./src/custom-kind-details\" export default class ExampleExtension extends LensRendererExtension { kubeObjectDetailItems = [ { kind : \"CustomKind\" , apiVersions : [ \"custom.acme.org/v1\" ], components : { Details : ( props : CustomKindDetailsProps ) => < CustomKindDetails {... props } /> } } ] }","title":"Kubernetes Object Details"},{"location":"extensions/capabilities/styling/","text":"Styling an Extension # Lens provides a set of global styles and UI components that can be used by any extension to preserve the look and feel of the application. Layout # For layout tasks, Lens uses the flex.box library which provides helpful class names to specify some of the flexbox properties. For example, consider the following HTML and its associated CSS properties: < div className = \"flex column align-center\" > div { display : flex ; flex-direction : column ; align-items : center ; } However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS. Layout Variables # There is a set of CSS variables available for for basic layout needs. They are located inside :root and are defined in app.scss : --unit : 8px ; --padding : var ( --unit ); --margin : var ( --unit ); --border-radius : 3px ; These variables are intended to set consistent margins and paddings across components. For example: . status { padding-left : calc ( var ( -- padding ) * 2 ); border-radius : var ( -- border - radius ); } Themes # Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark. Theme Variables # When Lens is loaded, it transforms the selected theme's json file into a list of CSS Custom Properties (CSS Variables) . This list then gets injected into the :root element so that any of the down-level components can use them. When the user changes the theme, the above process is repeated, and new CSS variables appear, replacing the previous ones. If you want to preserve Lens's native look and feel, with respect to the lightness or darkness of your extension, you can use the provided variables and built-in Lens components such as Button , Select , Table , and so on. There is a set of CSS variables available for extensions to use for theming. They are all located inside :root and are defined in app.scss : --font-main : 'Roboto' , 'Helvetica' , 'Arial' , sans-serif ; --font-monospace : Lucida Console , Monaco , Consolas , monospace ; --font-size-small : calc ( 1 . 5 * var ( --unit )); --font-size : calc ( 1 . 75 * var ( --unit )); --font-size-big : calc ( 2 * var ( --unit )); --font-weight-thin : 300 ; --font-weight-normal : 400 ; --font-weight-bold : 500 ; as well as in the theme modules : --blue: #3d90ce; --magenta: #c93dce; --golden: #ffc63d; --halfGray: #87909c80; --primary: #3d90ce; --textColorPrimary: #555555; --textColorSecondary: #51575d; --textColorAccent: #333333; --borderColor: #c9cfd3; --borderFaintColor: #dfdfdf; --mainBackground: #f1f1f1; --contentColor: #ffffff; --layoutBackground: #e8e8e8; --layoutTabsBackground: #f8f8f8; --layoutTabsActiveColor: #333333; --layoutTabsLineColor: #87909c80; ... These variables can be used in the following form: var(--magenta) . For example: . status { font-size : var ( -- font - size - small ); background-color : var ( -- colorSuccess ); } A complete list of themable colors can be found in the Color Reference . Theme Switching # When the light theme is active, the element gets a \"theme-light\" class, or: . If the class isn't there, the theme defaults to dark. The active theme can be changed in the Preferences page: There is a way of detect active theme and its changes in JS. MobX observer function/decorator can be used for this purpose. import React from \"react\" import { observer } from \"mobx-react\" import { App , Component , Theme } from \"@k8slens/extensions\" ; @ observer export class SupportPage extends React . Component { render () { return ( < div className = \"SupportPage\" > < h1 > Active theme is { Theme . getActiveTheme (). name } < /h1> < /div> ); } } Theme entity from @k8slens/extensions provides active theme object and @observer decorator makes component reactive - so it will rerender each time any of the observables (active theme in our case) will be changed. Working example provided in Styling with Emotion sample extension. Injected Styles # Every extension is affected by the list of default global styles defined in app.scss . These are basic browser resets and element styles, including: setting the box-sizing property for every element default text and background colors default font sizes basic heading (h1, h2, etc) formatting custom scrollbar styling Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy. CSS-in-JS # If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows: const Container = styled . div (() => ({ backgroundColor : 'var(--mainBackground)' })); Examples # You can explore samples for each styling technique that you can use for extensions: Styling with Sass Styling with Emotion Styling with CSS Modules","title":"Styling"},{"location":"extensions/capabilities/styling/#styling-an-extension","text":"Lens provides a set of global styles and UI components that can be used by any extension to preserve the look and feel of the application.","title":"Styling an Extension"},{"location":"extensions/capabilities/styling/#layout","text":"For layout tasks, Lens uses the flex.box library which provides helpful class names to specify some of the flexbox properties. For example, consider the following HTML and its associated CSS properties: < div className = \"flex column align-center\" > div { display : flex ; flex-direction : column ; align-items : center ; } However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS.","title":"Layout"},{"location":"extensions/capabilities/styling/#layout-variables","text":"There is a set of CSS variables available for for basic layout needs. They are located inside :root and are defined in app.scss : --unit : 8px ; --padding : var ( --unit ); --margin : var ( --unit ); --border-radius : 3px ; These variables are intended to set consistent margins and paddings across components. For example: . status { padding-left : calc ( var ( -- padding ) * 2 ); border-radius : var ( -- border - radius ); }","title":"Layout Variables"},{"location":"extensions/capabilities/styling/#themes","text":"Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark.","title":"Themes"},{"location":"extensions/capabilities/styling/#theme-variables","text":"When Lens is loaded, it transforms the selected theme's json file into a list of CSS Custom Properties (CSS Variables) . This list then gets injected into the :root element so that any of the down-level components can use them. When the user changes the theme, the above process is repeated, and new CSS variables appear, replacing the previous ones. If you want to preserve Lens's native look and feel, with respect to the lightness or darkness of your extension, you can use the provided variables and built-in Lens components such as Button , Select , Table , and so on. There is a set of CSS variables available for extensions to use for theming. They are all located inside :root and are defined in app.scss : --font-main : 'Roboto' , 'Helvetica' , 'Arial' , sans-serif ; --font-monospace : Lucida Console , Monaco , Consolas , monospace ; --font-size-small : calc ( 1 . 5 * var ( --unit )); --font-size : calc ( 1 . 75 * var ( --unit )); --font-size-big : calc ( 2 * var ( --unit )); --font-weight-thin : 300 ; --font-weight-normal : 400 ; --font-weight-bold : 500 ; as well as in the theme modules : --blue: #3d90ce; --magenta: #c93dce; --golden: #ffc63d; --halfGray: #87909c80; --primary: #3d90ce; --textColorPrimary: #555555; --textColorSecondary: #51575d; --textColorAccent: #333333; --borderColor: #c9cfd3; --borderFaintColor: #dfdfdf; --mainBackground: #f1f1f1; --contentColor: #ffffff; --layoutBackground: #e8e8e8; --layoutTabsBackground: #f8f8f8; --layoutTabsActiveColor: #333333; --layoutTabsLineColor: #87909c80; ... These variables can be used in the following form: var(--magenta) . For example: . status { font-size : var ( -- font - size - small ); background-color : var ( -- colorSuccess ); } A complete list of themable colors can be found in the Color Reference .","title":"Theme Variables"},{"location":"extensions/capabilities/styling/#theme-switching","text":"When the light theme is active, the element gets a \"theme-light\" class, or: . If the class isn't there, the theme defaults to dark. The active theme can be changed in the Preferences page: There is a way of detect active theme and its changes in JS. MobX observer function/decorator can be used for this purpose. import React from \"react\" import { observer } from \"mobx-react\" import { App , Component , Theme } from \"@k8slens/extensions\" ; @ observer export class SupportPage extends React . Component { render () { return ( < div className = \"SupportPage\" > < h1 > Active theme is { Theme . getActiveTheme (). name } < /h1> < /div> ); } } Theme entity from @k8slens/extensions provides active theme object and @observer decorator makes component reactive - so it will rerender each time any of the observables (active theme in our case) will be changed. Working example provided in Styling with Emotion sample extension.","title":"Theme Switching"},{"location":"extensions/capabilities/styling/#injected-styles","text":"Every extension is affected by the list of default global styles defined in app.scss . These are basic browser resets and element styles, including: setting the box-sizing property for every element default text and background colors default font sizes basic heading (h1, h2, etc) formatting custom scrollbar styling Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy.","title":"Injected Styles"},{"location":"extensions/capabilities/styling/#css-in-js","text":"If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows: const Container = styled . div (() => ({ backgroundColor : 'var(--mainBackground)' }));","title":"CSS-in-JS"},{"location":"extensions/capabilities/styling/#examples","text":"You can explore samples for each styling technique that you can use for extensions: Styling with Sass Styling with Emotion Styling with CSS Modules","title":"Examples"},{"location":"extensions/get-started/anatomy/","text":"Extension Anatomy # In the previous section you learned how to create your first extension. In this section you will learn how this extension works under the hood. The Hello World sample extension does three things: Implements onActivate() and outputs a message to the console. Implements onDectivate() and outputs a message to the console. Registers ClusterPage so that the page is visible in the left-side menu of the cluster dashboard. Let's take a closer look at our Hello World sample's source code and see how these three things are achieved. Extension File Structure # . \u251c\u2500\u2500 .gitignore // Ignore build output and node_modules \u251c\u2500\u2500 Makefile // Config for build tasks that compiles the extension \u251c\u2500\u2500 README.md // Readable description of your extension's functionality \u251c\u2500\u2500 src \u2502 \u2514\u2500\u2500 page.tsx // Extension's additional source code \u251c\u2500\u2500 main.ts // Source code for extension's main entrypoint \u251c\u2500\u2500 package.json // Extension manifest and dependencies \u251c\u2500\u2500 renderer.tsx // Source code for extension's renderer entrypoint \u251c\u2500\u2500 tsconfig.json // TypeScript configuration \u251c\u2500\u2500 webpack.config.js // Webpack configuration The extension directory contains the extension's entry files and a few configuration files. Three files: package.json , main.ts and renderer.tsx are essential to understanding the Hello World sample extension. We'll look at those first. Extension Manifest # Each Lens extension must have a package.json file. It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as publisher and contributes . Some of the most-important fields include: name and publisher : Lens uses @/ as a unique ID for the extension. For example, the Hello World sample has the ID @lensapp-samples/helloworld-sample . Lens uses this ID to uniquely identify your extension. main : the extension's entry point run in main process. renderer : the extension's entry point run in renderer process. engines.lens : the minimum version of Lens API that the extension depends upon. { \"name\" : \"helloworld-sample\" , \"publisher\" : \"lens-samples\" , \"version\" : \"0.0.1\" , \"description\" : \"Lens helloworld-sample\" , \"license\" : \"MIT\" , \"homepage\" : \"https://github.com/lensapp/lens-extension-samples\" , \"engines\" : { \"lens\" : \"^4.0.0\" }, \"main\" : \"dist/main.js\" , \"renderer\" : \"dist/renderer.js\" , \"scripts\" : { \"build\" : \"webpack --config webpack.config.js\" , \"dev\" : \"npm run build --watch\" }, \"dependencies\" : { \"react-open-doodles\" : \"^1.0.5\" }, \"devDependencies\" : { \"@k8slens/extensions\" : \"^4.0.0-alpha.2\" , \"ts-loader\" : \"^8.0.4\" , \"typescript\" : \"^4.0.3\" , \"@types/react\" : \"^16.9.35\" , \"@types/node\" : \"^12.0.0\" , \"webpack\" : \"^4.44.2\" , \"webpack-cli\" : \"^3.3.11\" } } Extension Entry Files # Lens extensions can have two separate entry files. One file is used in the main process of the Lens application and the other is used in the renderer process. The main entry file exports the class that extends LensMainExtension , and the renderer entry file exports the class that extends LensRendererExtension . Both extension classes have onActivate and onDeactivate methods. The onActivate method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The onDeactivate method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur. The Hello World sample extension does not do anything on the main process, so we'll focus on the renderer process, instead. On the renderer entry point, the Hello World sample extension defines the Cluster Page object. The Cluster Page object registers the /extension-example path, and this path renders the ExamplePage React component. It also registers the MenuItem component that displays the ExampleIcon React component and the \"Hello World\" text in the left-side menu of the cluster dashboard. These React components are defined in the additional ./src/page.tsx file. import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"extension-example\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ] } The Hello World sample extension uses the Cluster Page capability, which is just one of the Lens extension API's capabilities. The Common Capabilities page will help you home in on the right capabilities to use with your own extensions.","title":"Extension Anatomy"},{"location":"extensions/get-started/anatomy/#extension-anatomy","text":"In the previous section you learned how to create your first extension. In this section you will learn how this extension works under the hood. The Hello World sample extension does three things: Implements onActivate() and outputs a message to the console. Implements onDectivate() and outputs a message to the console. Registers ClusterPage so that the page is visible in the left-side menu of the cluster dashboard. Let's take a closer look at our Hello World sample's source code and see how these three things are achieved.","title":"Extension Anatomy"},{"location":"extensions/get-started/anatomy/#extension-file-structure","text":". \u251c\u2500\u2500 .gitignore // Ignore build output and node_modules \u251c\u2500\u2500 Makefile // Config for build tasks that compiles the extension \u251c\u2500\u2500 README.md // Readable description of your extension's functionality \u251c\u2500\u2500 src \u2502 \u2514\u2500\u2500 page.tsx // Extension's additional source code \u251c\u2500\u2500 main.ts // Source code for extension's main entrypoint \u251c\u2500\u2500 package.json // Extension manifest and dependencies \u251c\u2500\u2500 renderer.tsx // Source code for extension's renderer entrypoint \u251c\u2500\u2500 tsconfig.json // TypeScript configuration \u251c\u2500\u2500 webpack.config.js // Webpack configuration The extension directory contains the extension's entry files and a few configuration files. Three files: package.json , main.ts and renderer.tsx are essential to understanding the Hello World sample extension. We'll look at those first.","title":"Extension File Structure"},{"location":"extensions/get-started/anatomy/#extension-manifest","text":"Each Lens extension must have a package.json file. It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as publisher and contributes . Some of the most-important fields include: name and publisher : Lens uses @/ as a unique ID for the extension. For example, the Hello World sample has the ID @lensapp-samples/helloworld-sample . Lens uses this ID to uniquely identify your extension. main : the extension's entry point run in main process. renderer : the extension's entry point run in renderer process. engines.lens : the minimum version of Lens API that the extension depends upon. { \"name\" : \"helloworld-sample\" , \"publisher\" : \"lens-samples\" , \"version\" : \"0.0.1\" , \"description\" : \"Lens helloworld-sample\" , \"license\" : \"MIT\" , \"homepage\" : \"https://github.com/lensapp/lens-extension-samples\" , \"engines\" : { \"lens\" : \"^4.0.0\" }, \"main\" : \"dist/main.js\" , \"renderer\" : \"dist/renderer.js\" , \"scripts\" : { \"build\" : \"webpack --config webpack.config.js\" , \"dev\" : \"npm run build --watch\" }, \"dependencies\" : { \"react-open-doodles\" : \"^1.0.5\" }, \"devDependencies\" : { \"@k8slens/extensions\" : \"^4.0.0-alpha.2\" , \"ts-loader\" : \"^8.0.4\" , \"typescript\" : \"^4.0.3\" , \"@types/react\" : \"^16.9.35\" , \"@types/node\" : \"^12.0.0\" , \"webpack\" : \"^4.44.2\" , \"webpack-cli\" : \"^3.3.11\" } }","title":"Extension Manifest"},{"location":"extensions/get-started/anatomy/#extension-entry-files","text":"Lens extensions can have two separate entry files. One file is used in the main process of the Lens application and the other is used in the renderer process. The main entry file exports the class that extends LensMainExtension , and the renderer entry file exports the class that extends LensRendererExtension . Both extension classes have onActivate and onDeactivate methods. The onActivate method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The onDeactivate method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur. The Hello World sample extension does not do anything on the main process, so we'll focus on the renderer process, instead. On the renderer entry point, the Hello World sample extension defines the Cluster Page object. The Cluster Page object registers the /extension-example path, and this path renders the ExamplePage React component. It also registers the MenuItem component that displays the ExampleIcon React component and the \"Hello World\" text in the left-side menu of the cluster dashboard. These React components are defined in the additional ./src/page.tsx file. import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"extension-example\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ] } The Hello World sample extension uses the Cluster Page capability, which is just one of the Lens extension API's capabilities. The Common Capabilities page will help you home in on the right capabilities to use with your own extensions.","title":"Extension Entry Files"},{"location":"extensions/get-started/overview/","text":"Extension Development Overview # This is a general overview to how the development of an extension will procede. For building extensions there will be a few things that you should have installed, and some other things that might be of help. Required: # Node.js Git Some sort of text editor \u2013 we recommend VSCode We use Webpack for compilation. All extension need to be at least compatable with a webpack system. Recommended: # All Lens extensions are javascript packages. We recommend that you program in Typescript because it catches many common errors. Lens is a standard Electron application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work. Lens uses React as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is resonsible for the lifetime of any resources it spins up. If an extension's main part starts new processes they all must be stopped and cleaned up when the extension is deactivated or unloaded. See Your First Extension to get started.","title":"Overview"},{"location":"extensions/get-started/overview/#extension-development-overview","text":"This is a general overview to how the development of an extension will procede. For building extensions there will be a few things that you should have installed, and some other things that might be of help.","title":"Extension Development Overview"},{"location":"extensions/get-started/overview/#required","text":"Node.js Git Some sort of text editor \u2013 we recommend VSCode We use Webpack for compilation. All extension need to be at least compatable with a webpack system.","title":"Required:"},{"location":"extensions/get-started/overview/#recommended","text":"All Lens extensions are javascript packages. We recommend that you program in Typescript because it catches many common errors. Lens is a standard Electron application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work. Lens uses React as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is resonsible for the lifetime of any resources it spins up. If an extension's main part starts new processes they all must be stopped and cleaned up when the extension is deactivated or unloaded. See Your First Extension to get started.","title":"Recommended:"},{"location":"extensions/get-started/wrapping-up/","text":"Wrapping Up # In Your First Extension , you learned how to create and run an extension. In Extension Anatomy , you learned in detail how a basic extension works. This is just a glimpse into what can be created with Lens extensions. Below are some suggested routes for learning more. Extension Capabilities # In this section, you'll find information on common extension capabilities, styling information, and a color reference guide. Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the Common Capabilities page. Guides and Samples # Here you'll find a collection of sample extensions that you can use as a base to work from. Some of these samples include a detailed guide that explains the source code. You can find all samples and guides in the lens-extension-samples repository. Testing and Publishing # In this section, you can learn: How to add integration tests to your extension How to publish your extension","title":"Wrapping Up"},{"location":"extensions/get-started/wrapping-up/#wrapping-up","text":"In Your First Extension , you learned how to create and run an extension. In Extension Anatomy , you learned in detail how a basic extension works. This is just a glimpse into what can be created with Lens extensions. Below are some suggested routes for learning more.","title":"Wrapping Up"},{"location":"extensions/get-started/wrapping-up/#extension-capabilities","text":"In this section, you'll find information on common extension capabilities, styling information, and a color reference guide. Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the Common Capabilities page.","title":"Extension Capabilities"},{"location":"extensions/get-started/wrapping-up/#guides-and-samples","text":"Here you'll find a collection of sample extensions that you can use as a base to work from. Some of these samples include a detailed guide that explains the source code. You can find all samples and guides in the lens-extension-samples repository.","title":"Guides and Samples"},{"location":"extensions/get-started/wrapping-up/#testing-and-publishing","text":"In this section, you can learn: How to add integration tests to your extension How to publish your extension","title":"Testing and Publishing"},{"location":"extensions/get-started/your-first-extension/","text":"Your First Extension # We recommend to always use Yeoman generator for Lens Extension to start new extension project. Read the generator guide here . If you want to setup the project manually, please continue reading. First Extension # In this topic, you'll learn the basics of building extensions by creating an extension that adds a \"Hello World\" page to a cluster menu. Install the Extension # To install the extension, clone the Lens Extension samples repository to your local machine: git clone https://github.com/lensapp/lens-extension-samples.git Next you need to create a symlink. A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension. In this case the sample extension is helloworld-sample . Linux & macOS # mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s lens-extension-samples/helloworld-sample helloworld-sample Windows # Create the directory that Lens will monitor for user-installed extensions: mkdir C: \\U sers \\< user> \\. k8slens \\e xtensions -force cd C: \\U sers \\< user> \\. k8slens \\e xtensions If you have administrator rights, you can create symlink to the sample extension \u2013 in this case helloworld-sample : cmd /c mklink /D helloworld-sample lens-extension-samples \\h elloworld-sample Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\\\.k8slens\\extensions : Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\\\.k8slens\\extensions\\helloworld-sample' Build the Extension # To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build To run the npm commands, enter: cd /helloworld-sample npm install npm run build Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter: cd /helloworld-sample npm run dev You must restart Lens for the extension to load. After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds. With Lens running, either connect to an existing cluster or create a new one . You will see the \"Hello World\" page in the left-side cluster menu. Develop the Extension # Finally, you'll make a change to the message that our Hello World sample extension displays: Navigate to /helloworld-sample . In page.tsx , change the message from HelloWorld! to Hello Lens Extensions . Rebuild the extension. If you used npm run dev , the extension will rebuild automatically. Reload the Lens window. Click on the Hello World page. The updated message will appear. Next Steps # In the next topic , we'll take a closer look at the source code of our Hello World sample. You can find the source code for this tutorial at: lensapp/lens-extension-samples . Extension Guides contains additional samples.","title":"Your First Extension"},{"location":"extensions/get-started/your-first-extension/#your-first-extension","text":"We recommend to always use Yeoman generator for Lens Extension to start new extension project. Read the generator guide here . If you want to setup the project manually, please continue reading.","title":"Your First Extension"},{"location":"extensions/get-started/your-first-extension/#first-extension","text":"In this topic, you'll learn the basics of building extensions by creating an extension that adds a \"Hello World\" page to a cluster menu.","title":"First Extension"},{"location":"extensions/get-started/your-first-extension/#install-the-extension","text":"To install the extension, clone the Lens Extension samples repository to your local machine: git clone https://github.com/lensapp/lens-extension-samples.git Next you need to create a symlink. A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension. In this case the sample extension is helloworld-sample .","title":"Install the Extension"},{"location":"extensions/get-started/your-first-extension/#linux-macos","text":"mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s lens-extension-samples/helloworld-sample helloworld-sample","title":"Linux & macOS"},{"location":"extensions/get-started/your-first-extension/#windows","text":"Create the directory that Lens will monitor for user-installed extensions: mkdir C: \\U sers \\< user> \\. k8slens \\e xtensions -force cd C: \\U sers \\< user> \\. k8slens \\e xtensions If you have administrator rights, you can create symlink to the sample extension \u2013 in this case helloworld-sample : cmd /c mklink /D helloworld-sample lens-extension-samples \\h elloworld-sample Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\\\.k8slens\\extensions : Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\\\.k8slens\\extensions\\helloworld-sample'","title":"Windows"},{"location":"extensions/get-started/your-first-extension/#build-the-extension","text":"To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build To run the npm commands, enter: cd /helloworld-sample npm install npm run build Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter: cd /helloworld-sample npm run dev You must restart Lens for the extension to load. After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds. With Lens running, either connect to an existing cluster or create a new one . You will see the \"Hello World\" page in the left-side cluster menu.","title":"Build the Extension"},{"location":"extensions/get-started/your-first-extension/#develop-the-extension","text":"Finally, you'll make a change to the message that our Hello World sample extension displays: Navigate to /helloworld-sample . In page.tsx , change the message from HelloWorld! to Hello Lens Extensions . Rebuild the extension. If you used npm run dev , the extension will rebuild automatically. Reload the Lens window. Click on the Hello World page. The updated message will appear.","title":"Develop the Extension"},{"location":"extensions/get-started/your-first-extension/#next-steps","text":"In the next topic , we'll take a closer look at the source code of our Hello World sample. You can find the source code for this tutorial at: lensapp/lens-extension-samples . Extension Guides contains additional samples.","title":"Next Steps"},{"location":"extensions/guides/","text":"Extension Guides # The basics of the Lens Extension API are covered in Your First Extension . In this section detailed code guides and samples are used to explain how to use specific Lens Extension APIs. Each guide or sample will include: Clearly commented source code. Instructions for running the sample extension. Image of the sample extension's appearance and usage. Listing of Extension API being used. Explanation of Extension API concepts. Guides # Guide APIs Generate new extension project Main process extension LensMainExtension Renderer process extension LensRendererExtension Stores Components KubeObjectListLayout Working with mobx Samples # Sample APIs helloworld LensMainExtension LensRendererExtension Component.Icon Component.IconProps minikube LensMainExtension Store.clusterStore Store.workspaceStore styling-css-modules-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps styling-emotion-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps styling-sass-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps custom-resource-page LensRendererExtension K8sApi.KubeApi K8sApi.KubeObjectStore Component.KubeObjectListLayout Component.KubeObjectDetailsProps Component.IconProps","title":"Overview"},{"location":"extensions/guides/#extension-guides","text":"The basics of the Lens Extension API are covered in Your First Extension . In this section detailed code guides and samples are used to explain how to use specific Lens Extension APIs. Each guide or sample will include: Clearly commented source code. Instructions for running the sample extension. Image of the sample extension's appearance and usage. Listing of Extension API being used. Explanation of Extension API concepts.","title":"Extension Guides"},{"location":"extensions/guides/#guides","text":"Guide APIs Generate new extension project Main process extension LensMainExtension Renderer process extension LensRendererExtension Stores Components KubeObjectListLayout Working with mobx","title":"Guides"},{"location":"extensions/guides/#samples","text":"Sample APIs helloworld LensMainExtension LensRendererExtension Component.Icon Component.IconProps minikube LensMainExtension Store.clusterStore Store.workspaceStore styling-css-modules-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps styling-emotion-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps styling-sass-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps custom-resource-page LensRendererExtension K8sApi.KubeApi K8sApi.KubeObjectStore Component.KubeObjectListLayout Component.KubeObjectDetailsProps Component.IconProps","title":"Samples"},{"location":"extensions/guides/anatomy/","text":"WIP #","title":"Anatomy"},{"location":"extensions/guides/anatomy/#wip","text":"","title":"WIP"},{"location":"extensions/guides/components/","text":"WIP #","title":"Components"},{"location":"extensions/guides/components/#wip","text":"","title":"WIP"},{"location":"extensions/guides/generator/","text":"New Extension Project with Generator # The Lens Extension Generator scaffolds a project ready for development. Install Yeoman and Lens Extension Generator with: npm install -g yo generator-lens-ext Run the generator and fill out a few fields for a TypeScript project: yo lens-ext # ? What type of extension do you want to create? New Extension (TypeScript) # ? What's the name of your extension? my-first-lens-ext # ? What's the description of your extension? My hello world extension # ? What's your extension's publisher name? @my-org/my-first-lens-ext # ? Initialize a git repository? Yes # ? Install dependencies after initialization? Yes # ? Which package manager to use? yarn # ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :User s \\< user> \\. k8slens \\e xtensions ( windows ) ? Yes Start webpack, which watches the my-first-lens-ext folder. cd my-first-lens-ext npm start # start the webpack server in watch mode Then, open Lens, you should see a Hello World item in the menu: Developing the Extension # Try to change my-first-lens-ext/renderer.tsx to \"Hello Lens!\": clusterPageMenus = [ { target: { pageId: \"hello\" }, title: \"Hello Lens\", components: { Icon: ExampleIcon, } } ] Then, Reload Lens by CMD+R (Mac) / Ctrl+R (Linux/Windows), you should see the menu item text changes: Debugging the Extension # Testing Next steps # You can take a closer look at Common Capabilities of extension, how to style the extension. Or the Extension Anatomy . You are welcome to raise an issue for Lens Extension Generator, if you find problems, or have feature requests. The source code of the generator is hosted at Github","title":"Generator"},{"location":"extensions/guides/generator/#new-extension-project-with-generator","text":"The Lens Extension Generator scaffolds a project ready for development. Install Yeoman and Lens Extension Generator with: npm install -g yo generator-lens-ext Run the generator and fill out a few fields for a TypeScript project: yo lens-ext # ? What type of extension do you want to create? New Extension (TypeScript) # ? What's the name of your extension? my-first-lens-ext # ? What's the description of your extension? My hello world extension # ? What's your extension's publisher name? @my-org/my-first-lens-ext # ? Initialize a git repository? Yes # ? Install dependencies after initialization? Yes # ? Which package manager to use? yarn # ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :User s \\< user> \\. k8slens \\e xtensions ( windows ) ? Yes Start webpack, which watches the my-first-lens-ext folder. cd my-first-lens-ext npm start # start the webpack server in watch mode Then, open Lens, you should see a Hello World item in the menu:","title":"New Extension Project with Generator"},{"location":"extensions/guides/generator/#developing-the-extension","text":"Try to change my-first-lens-ext/renderer.tsx to \"Hello Lens!\": clusterPageMenus = [ { target: { pageId: \"hello\" }, title: \"Hello Lens\", components: { Icon: ExampleIcon, } } ] Then, Reload Lens by CMD+R (Mac) / Ctrl+R (Linux/Windows), you should see the menu item text changes:","title":"Developing the Extension"},{"location":"extensions/guides/generator/#debugging-the-extension","text":"Testing","title":"Debugging the Extension"},{"location":"extensions/guides/generator/#next-steps","text":"You can take a closer look at Common Capabilities of extension, how to style the extension. Or the Extension Anatomy . You are welcome to raise an issue for Lens Extension Generator, if you find problems, or have feature requests. The source code of the generator is hosted at Github","title":"Next steps"},{"location":"extensions/guides/kube-object-list-layout/","text":"KubeObjectListLayout Sample # In this guide we will learn how to list Kubernetes CRD objects on the cluster dashboard. You can see the complete source code for this guide here . Next, we will go the implementation through in steps. To achieve our goal, we need to: Register ClustePage and ClusterPageMenu objects List Certificate Objects on the Cluster Page Customize Details Panel Register clusterPage and clusterPageMenu Objects # First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class: export default class CrdSampleExtension extends LensRendererExtension { } To register menu item in the cluster menu we need to register PageMenuRegistration object. This object will register a menu item with \"Certificates\" text. It will also use CertificateIcon component to render an icon and navigate to cluster page that is having certificates page id. export function CertificateIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"security\" tooltip = \"Certificates\" /> } export default class CrdSampleExtension extends LensRendererExtension { clusterPageMenus = [ { target : { pageId : \"certificates\" }, title : \"Certificates\" , components : { Icon : CertificateIcon , } }, ] } Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates. export default class CrdSampleExtension extends LensRendererExtension { ... clusterPages = [{ id : \"certificates\" , components : { Page : () => < CertificatePage extension = { this } /> , MenuIcon : CertificateIcon , } }] } List Certificate Objects on the Cluster Page # In the previous step we defined CertificatePage component to render certificates. In this step we will actually implement that. CertificatePage is a React component that will render Component.KubeObjectListLayout component to list Certificate CRD objects. Get CRD objects # In order to list CRD objects, we need first fetch those from Kubernetes API. Lens Extensions API provides easy mechanism to do this. We just need to define Certificate class derived from K8sApi.KubeObject , CertificatesApi derived from K8sApi.KubeApi and CertificatesStore derived from K8sApi.KubeObjectStore . Certificate class defines properties found in the CRD object: export class Certificate extends K8sApi . KubeObject { static kind = \"Certificate\" static namespaced = true static apiBase = \"/apis/cert-manager.io/v1alpha2/certificates\" kind : string apiVersion : string metadata : { name : string ; namespace : string ; selfLink : string ; uid : string ; resourceVersion : string ; creationTimestamp : string ; labels : { [ key : string ] : string ; }; annotations : { [ key : string ] : string ; }; } spec : { dnsNames : string []; issuerRef : { group : string ; kind : string ; name : string ; } secretName : string } status : { conditions : { lastTransitionTime : string ; message : string ; reason : string ; status : string ; type? : string ; }[]; } } With CertificatesApi class we are able to manage Certificate objects in Kubernetes API: export class CertificatesApi extends K8sApi . KubeApi < Certificate > { } export const certificatesApi = new CertificatesApi ({ objectConstructor : Certificate }); CertificateStore defines storage for Certificate objects export class CertificatesStore extends K8sApi . KubeObjectStore < Certificate > { api = certificatesApi } export const certificatesStore = new CertificatesStore (); And, finally, we register this store to Lens's API manager. K8sApi . apiManager . registerStore ( certificatesStore ); Create CertificatePage component # Now we have created mechanism to manage Certificate objects in Kubernetes API. Then we need to fetch those and render them in the UI. First we define CertificatePage class that extends React.Component . import { Component , LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" ; import { certificatesStore } from \"../certificate-store\" ; import { Certificate } from \"../certificate\" export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { } Next we will implement render method that will display certificates in a list. To do that, we just need to add Component.KubeObjectListLayout component inside Component.TabLayout component in render method. To define which objects the list is showing, we need to pass certificateStore object to Component.KubeObjectListLayout in store property. Component.KubeObjectListLayout will fetch automacially items from the given store when component is mounted. Also, we can define needed sorting callbacks and search filters for the list: enum sortBy { name = \"name\" , namespace = \"namespace\" , issuer = \"issuer\" } export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { // ... render() { return ( < Component . TabLayout > < Component . KubeObjectListLayout className = \"Certicates\" store = { certificatesStore } sortingCallbacks = {{ [ sortBy . name ] : ( certificate : Certificate ) => certificate . getName (), [ sortBy . namespace ] : ( certificate : Certificate ) => certificate . metadata . namespace , [ sortBy . issuer ] : ( certificate : Certificate ) => certificate . spec . issuerRef . name }} searchFilters = {[ ( certificate : Certificate ) => certificate . getSearchFields () ]} renderHeaderTitle = \"Certificates\" renderTableHeader = {[ { title : \"Name\" , className : \"name\" , sortBy : sortBy.name }, { title : \"Namespace\" , className : \"namespace\" , sortBy : sortBy.namespace }, { title : \"Issuer\" , className : \"issuer\" , sortBy : sortBy.namespace }, ]} renderTableContents = {( certificate : Certificate ) => [ certificate . getName (), certificate . metadata . namespace , certificate . spec . issuerRef . name ]} /> < /Component.TabLayout> ) } } Customize Details panel # We have learned now, how to list CRD objects in a list view. Next, we will learn how to customize details panel that will be opened when the object is clicked in the list. First, we need to register our custom component to render details for the specific Kubernetes custom resource, in our case Certificate . We will do this again in CrdSampleExtension class: export default class CrdSampleExtension extends LensRendererExtension { //... kubeObjectDetailItems = [{ kind : Certificate.kind , apiVersions : [ \"cert-manager.io/v1alpha2\" ], components : { Details : ( props : CertificateDetailsProps ) => < CertificateDetails {... props } /> } }] } Here we defined that CertificateDetails component will render the resource details. So, next we need to implement that component. Lens will inject Certificate object into our component so we just need to render some information out of it. We can use Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere: import { Component , K8sApi } from \"@k8slens/extensions\" ; import React from \"react\" ; import { Certificate } from \"../certificate\" ; export interface CertificateDetailsProps extends Component . KubeObjectDetailsProps < Certificate > { } export class CertificateDetails extends React . Component < CertificateDetailsProps > { render() { const { object : certificate } = this . props ; if ( ! certificate ) return null ; return ( < div className = \"Certificate\" > < Component . DrawerItem name = \"Created\" > { certificate . getAge ( true , false )} ago ({ certificate . metadata . creationTimestamp }) < /Component.DrawerItem> < Component . DrawerItem name = \"DNS Names\" > { certificate . spec . dnsNames . join ( \",\" )} < /Component.DrawerItem> < Component . DrawerItem name = \"Secret\" > { certificate . spec . secretName } < /Component.DrawerItem> < Component . DrawerItem name = \"Status\" className = \"status\" labelsOnly > { certificate . status . conditions . map (( condition , index ) => { const { type , reason , message , status } = condition ; const kind = type || reason ; if ( ! kind ) return null ; return ( < Component . Badge key = { kind + index } label = { kind } className = { \"success \" + kind . toLowerCase ()} tooltip = { message } /> ); })} < /Component.DrawerItem> < /div> ) } } Summary # Like we can see above, it's very easy to add custom pages and fetch Kubernetes resources by using Extensions API. Please see the complete source code to test it out.","title":"KubeObjectListLayout Sample"},{"location":"extensions/guides/kube-object-list-layout/#kubeobjectlistlayout-sample","text":"In this guide we will learn how to list Kubernetes CRD objects on the cluster dashboard. You can see the complete source code for this guide here . Next, we will go the implementation through in steps. To achieve our goal, we need to: Register ClustePage and ClusterPageMenu objects List Certificate Objects on the Cluster Page Customize Details Panel","title":"KubeObjectListLayout Sample"},{"location":"extensions/guides/kube-object-list-layout/#register-clusterpage-and-clusterpagemenu-objects","text":"First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class: export default class CrdSampleExtension extends LensRendererExtension { } To register menu item in the cluster menu we need to register PageMenuRegistration object. This object will register a menu item with \"Certificates\" text. It will also use CertificateIcon component to render an icon and navigate to cluster page that is having certificates page id. export function CertificateIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"security\" tooltip = \"Certificates\" /> } export default class CrdSampleExtension extends LensRendererExtension { clusterPageMenus = [ { target : { pageId : \"certificates\" }, title : \"Certificates\" , components : { Icon : CertificateIcon , } }, ] } Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates. export default class CrdSampleExtension extends LensRendererExtension { ... clusterPages = [{ id : \"certificates\" , components : { Page : () => < CertificatePage extension = { this } /> , MenuIcon : CertificateIcon , } }] }","title":"Register clusterPage and clusterPageMenu Objects"},{"location":"extensions/guides/kube-object-list-layout/#list-certificate-objects-on-the-cluster-page","text":"In the previous step we defined CertificatePage component to render certificates. In this step we will actually implement that. CertificatePage is a React component that will render Component.KubeObjectListLayout component to list Certificate CRD objects.","title":"List Certificate Objects on the Cluster Page"},{"location":"extensions/guides/kube-object-list-layout/#get-crd-objects","text":"In order to list CRD objects, we need first fetch those from Kubernetes API. Lens Extensions API provides easy mechanism to do this. We just need to define Certificate class derived from K8sApi.KubeObject , CertificatesApi derived from K8sApi.KubeApi and CertificatesStore derived from K8sApi.KubeObjectStore . Certificate class defines properties found in the CRD object: export class Certificate extends K8sApi . KubeObject { static kind = \"Certificate\" static namespaced = true static apiBase = \"/apis/cert-manager.io/v1alpha2/certificates\" kind : string apiVersion : string metadata : { name : string ; namespace : string ; selfLink : string ; uid : string ; resourceVersion : string ; creationTimestamp : string ; labels : { [ key : string ] : string ; }; annotations : { [ key : string ] : string ; }; } spec : { dnsNames : string []; issuerRef : { group : string ; kind : string ; name : string ; } secretName : string } status : { conditions : { lastTransitionTime : string ; message : string ; reason : string ; status : string ; type? : string ; }[]; } } With CertificatesApi class we are able to manage Certificate objects in Kubernetes API: export class CertificatesApi extends K8sApi . KubeApi < Certificate > { } export const certificatesApi = new CertificatesApi ({ objectConstructor : Certificate }); CertificateStore defines storage for Certificate objects export class CertificatesStore extends K8sApi . KubeObjectStore < Certificate > { api = certificatesApi } export const certificatesStore = new CertificatesStore (); And, finally, we register this store to Lens's API manager. K8sApi . apiManager . registerStore ( certificatesStore );","title":"Get CRD objects"},{"location":"extensions/guides/kube-object-list-layout/#create-certificatepage-component","text":"Now we have created mechanism to manage Certificate objects in Kubernetes API. Then we need to fetch those and render them in the UI. First we define CertificatePage class that extends React.Component . import { Component , LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" ; import { certificatesStore } from \"../certificate-store\" ; import { Certificate } from \"../certificate\" export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { } Next we will implement render method that will display certificates in a list. To do that, we just need to add Component.KubeObjectListLayout component inside Component.TabLayout component in render method. To define which objects the list is showing, we need to pass certificateStore object to Component.KubeObjectListLayout in store property. Component.KubeObjectListLayout will fetch automacially items from the given store when component is mounted. Also, we can define needed sorting callbacks and search filters for the list: enum sortBy { name = \"name\" , namespace = \"namespace\" , issuer = \"issuer\" } export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { // ... render() { return ( < Component . TabLayout > < Component . KubeObjectListLayout className = \"Certicates\" store = { certificatesStore } sortingCallbacks = {{ [ sortBy . name ] : ( certificate : Certificate ) => certificate . getName (), [ sortBy . namespace ] : ( certificate : Certificate ) => certificate . metadata . namespace , [ sortBy . issuer ] : ( certificate : Certificate ) => certificate . spec . issuerRef . name }} searchFilters = {[ ( certificate : Certificate ) => certificate . getSearchFields () ]} renderHeaderTitle = \"Certificates\" renderTableHeader = {[ { title : \"Name\" , className : \"name\" , sortBy : sortBy.name }, { title : \"Namespace\" , className : \"namespace\" , sortBy : sortBy.namespace }, { title : \"Issuer\" , className : \"issuer\" , sortBy : sortBy.namespace }, ]} renderTableContents = {( certificate : Certificate ) => [ certificate . getName (), certificate . metadata . namespace , certificate . spec . issuerRef . name ]} /> < /Component.TabLayout> ) } }","title":"Create CertificatePage component"},{"location":"extensions/guides/kube-object-list-layout/#customize-details-panel","text":"We have learned now, how to list CRD objects in a list view. Next, we will learn how to customize details panel that will be opened when the object is clicked in the list. First, we need to register our custom component to render details for the specific Kubernetes custom resource, in our case Certificate . We will do this again in CrdSampleExtension class: export default class CrdSampleExtension extends LensRendererExtension { //... kubeObjectDetailItems = [{ kind : Certificate.kind , apiVersions : [ \"cert-manager.io/v1alpha2\" ], components : { Details : ( props : CertificateDetailsProps ) => < CertificateDetails {... props } /> } }] } Here we defined that CertificateDetails component will render the resource details. So, next we need to implement that component. Lens will inject Certificate object into our component so we just need to render some information out of it. We can use Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere: import { Component , K8sApi } from \"@k8slens/extensions\" ; import React from \"react\" ; import { Certificate } from \"../certificate\" ; export interface CertificateDetailsProps extends Component . KubeObjectDetailsProps < Certificate > { } export class CertificateDetails extends React . Component < CertificateDetailsProps > { render() { const { object : certificate } = this . props ; if ( ! certificate ) return null ; return ( < div className = \"Certificate\" > < Component . DrawerItem name = \"Created\" > { certificate . getAge ( true , false )} ago ({ certificate . metadata . creationTimestamp }) < /Component.DrawerItem> < Component . DrawerItem name = \"DNS Names\" > { certificate . spec . dnsNames . join ( \",\" )} < /Component.DrawerItem> < Component . DrawerItem name = \"Secret\" > { certificate . spec . secretName } < /Component.DrawerItem> < Component . DrawerItem name = \"Status\" className = \"status\" labelsOnly > { certificate . status . conditions . map (( condition , index ) => { const { type , reason , message , status } = condition ; const kind = type || reason ; if ( ! kind ) return null ; return ( < Component . Badge key = { kind + index } label = { kind } className = { \"success \" + kind . toLowerCase ()} tooltip = { message } /> ); })} < /Component.DrawerItem> < /div> ) } }","title":"Customize Details panel"},{"location":"extensions/guides/kube-object-list-layout/#summary","text":"Like we can see above, it's very easy to add custom pages and fetch Kubernetes resources by using Extensions API. Please see the complete source code to test it out.","title":"Summary"},{"location":"extensions/guides/main-extension/","text":"Main Extension # The main extension api is the interface to Lens' main process (Lens runs in main and renderer processes). It allows you to access, configure, and customize Lens data, add custom application menu items, and generally run custom code in Lens' main process. LensMainExtension Class # To create a main extension simply extend the LensMainExtension class: import { LensMainExtension } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends LensMainExtension { onActivate() { console . log ( 'custom main process extension code started' ); } onDeactivate() { console . log ( 'custom main process extension de-activated' ); } } There are two methods that you can implement to facilitate running your custom code. onActivate() is called when your extension has been successfully enabled. By implementing onActivate() you can initiate your custom code. onDeactivate() is called when the extension is disabled (typically from the Lens Extensions Page ) and when implemented gives you a chance to clean up after your extension, if necessary. The example above simply logs messages when the extension is enabled and disabled. Note that to see standard output from the main process there must be a console connected to it. This is typically achieved by starting Lens from the command prompt. The following example is a little more interesting in that it accesses some Lens state data and periodically logs the name of the currently active cluster in Lens. import { LensMainExtension , Store } from \"@k8slens/extensions\" ; const clusterStore = Store . clusterStore export default class ActiveClusterExtensionMain extends LensMainExtension { timer : NodeJS.Timeout onActivate() { console . log ( \"Cluster logger activated\" ); this . timer = setInterval (() => { if ( ! clusterStore . active ) { console . log ( \"No active cluster\" ); return ; } console . log ( \"active cluster is\" , clusterStore . active . contextName ) }, 5000 ) } onDeactivate() { clearInterval ( this . timer ) console . log ( \"Cluster logger deactivated\" ); } } See the Stores guide for more details on accessing Lens state data. appMenus # The only UI feature customizable in the main extension api is the application menu. Custom menu items can be inserted and linked to custom functionality, such as navigating to a specific page. The following example demonstrates adding a menu item to the Help menu. import { LensMainExtension } from \"@k8slens/extensions\" ; export default class SamplePageMainExtension extends LensMainExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click() { console . log ( \"Sample clicked\" ); } } ] } appMenus is an array of objects satisfying the MenuRegistration interface. MenuRegistration extends React's MenuItemConstructorOptions interface. parentId is the id of the menu to put this menu item under (todo: is this case sensitive and how do we know what the available ids are?), label is the text to show on the menu item, and click() is called when the menu item is selected. In this example we simply log a message, but typically you would navigate to a specific page or perform some operation. Pages are associated with the LensRendererExtension class and can be defined when you extend it.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#main-extension","text":"The main extension api is the interface to Lens' main process (Lens runs in main and renderer processes). It allows you to access, configure, and customize Lens data, add custom application menu items, and generally run custom code in Lens' main process.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#lensmainextension-class","text":"To create a main extension simply extend the LensMainExtension class: import { LensMainExtension } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends LensMainExtension { onActivate() { console . log ( 'custom main process extension code started' ); } onDeactivate() { console . log ( 'custom main process extension de-activated' ); } } There are two methods that you can implement to facilitate running your custom code. onActivate() is called when your extension has been successfully enabled. By implementing onActivate() you can initiate your custom code. onDeactivate() is called when the extension is disabled (typically from the Lens Extensions Page ) and when implemented gives you a chance to clean up after your extension, if necessary. The example above simply logs messages when the extension is enabled and disabled. Note that to see standard output from the main process there must be a console connected to it. This is typically achieved by starting Lens from the command prompt. The following example is a little more interesting in that it accesses some Lens state data and periodically logs the name of the currently active cluster in Lens. import { LensMainExtension , Store } from \"@k8slens/extensions\" ; const clusterStore = Store . clusterStore export default class ActiveClusterExtensionMain extends LensMainExtension { timer : NodeJS.Timeout onActivate() { console . log ( \"Cluster logger activated\" ); this . timer = setInterval (() => { if ( ! clusterStore . active ) { console . log ( \"No active cluster\" ); return ; } console . log ( \"active cluster is\" , clusterStore . active . contextName ) }, 5000 ) } onDeactivate() { clearInterval ( this . timer ) console . log ( \"Cluster logger deactivated\" ); } } See the Stores guide for more details on accessing Lens state data.","title":"LensMainExtension Class"},{"location":"extensions/guides/main-extension/#appmenus","text":"The only UI feature customizable in the main extension api is the application menu. Custom menu items can be inserted and linked to custom functionality, such as navigating to a specific page. The following example demonstrates adding a menu item to the Help menu. import { LensMainExtension } from \"@k8slens/extensions\" ; export default class SamplePageMainExtension extends LensMainExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click() { console . log ( \"Sample clicked\" ); } } ] } appMenus is an array of objects satisfying the MenuRegistration interface. MenuRegistration extends React's MenuItemConstructorOptions interface. parentId is the id of the menu to put this menu item under (todo: is this case sensitive and how do we know what the available ids are?), label is the text to show on the menu item, and click() is called when the menu item is selected. In this example we simply log a message, but typically you would navigate to a specific page or perform some operation. Pages are associated with the LensRendererExtension class and can be defined when you extend it.","title":"appMenus"},{"location":"extensions/guides/renderer-extension/","text":"Renderer Extension # The renderer extension api is the interface to Lens's renderer process (Lens runs in main and renderer processes). It allows you to access, configure, and customize Lens data, add custom Lens UI elements, and generally run custom code in Lens's renderer process. The custom Lens UI elements that can be added include global pages, cluster pages, cluster page menus, cluster features, app preferences, status bar items, KubeObject menu items, and KubeObject details items. These UI elements are based on React components. LensRendererExtension Class # To create a renderer extension simply extend the LensRendererExtension class: import { LensRendererExtension } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends LensRendererExtension { onActivate() { console . log ( 'custom renderer process extension code started' ); } onDeactivate() { console . log ( 'custom renderer process extension de-activated' ); } } There are two methods that you can implement to facilitate running your custom code. onActivate() is called when your extension has been successfully enabled. By implementing onActivate() you can initiate your custom code. onDeactivate() is called when the extension is disabled (typically from the Lens Extensions Page ) and when implemented gives you a chance to clean up after your extension, if necessary. The example above simply logs messages when the extension is enabled and disabled. clusterPages # Cluster pages appear as part of the cluster dashboard. They are accessible from the side bar, and are shown in the menu list after Custom Resources . It is conventional to use a cluster page to show information or provide functionality pertaining to the active cluster, along with custom data and functionality your extension may have. However, it is not limited to the active cluster. Also, your extension can gain access to the Kubernetes resources in the active cluster in a straightforward manner using the clusterStore . The following example adds a cluster page definition to a LensRendererExtension subclass: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; } Cluster pages are objects matching the PageRegistration interface. The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. The 'id' field can also convey route path details, such as variable parameters provided to a page ( See example below ). The components field matches the PageComponents interface for wich there is one field, Page . Page is of type React.ComponentType , which gives you great flexibility in defining the appearance and behaviour of your page. For the example above ExamplePage can be defined in page.tsx : import { LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Hello world !< /p> < /div> ) } } Note that the ExamplePage class defines a property named extension . This allows the ExampleExtension object to be passed in React-style in the cluster page definition, so that ExamplePage can access any ExampleExtension subclass data. clusterPageMenus # The above example code shows how to create a cluster page but not how to make it available to the Lens user. Cluster pages are typically made available through a menu item in the cluster dashboard sidebar. Expanding on the above example a cluster page menu is added to the ExampleExtension definition: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; clusterPageMenus = [ { target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , } }, ]; } Cluster page menus are objects matching the ClusterPageMenuRegistration interface. They define the appearance of the cluster page menu item in the cluster dashboard sidebar and the behaviour when the cluster page menu item is activated (typically by a mouse click). The example above uses the target field to set the behaviour as a link to the cluster page with id of \"hello\" . This is done by setting target 's pageId field to \"hello\" . The cluster page menu item's appearance is defined by setting the title field to the text that is to be displayed in the cluster dashboard sidebar. The components field is used to set an icon that appears to the left of the title text in the sidebar. Thus when the \"Hello World\" menu item is activated the cluster dashboard will show the contents of ExamplePage . This example requires the definition of another React-based component, ExampleIcon , which has been added to page.tsx : import { LensRendererExtension , Component } from \"@k8slens/extensions\" ; import React from \"react\" export function ExampleIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"pages\" tooltip = { \"Hi!\" } /> } export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Hello world !< /p> < /div> ) } } ExampleIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon . Built in are the Material Design icons . One can be selected by name via the material field. ExampleIcon also sets a tooltip, shown when the Lens user hovers over the icon with a mouse, by setting the tooltip field. A cluster page menu can also be used to define a foldout submenu in the cluster dashboard sidebar. This enables the grouping of cluster pages. The following example shows how to specify a submenu having two menu items: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } }, { id : \"bonjour\" , components : { Page : () => < ExemplePage extension = { this } /> , } } ]; clusterPageMenus = [ { id : \"example\" , title : \"Greetings\" , components : { Icon : ExampleIcon , } }, { parentId : \"example\" , target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , } }, { parentId : \"example\" , target : { pageId : \"bonjour\" }, title : \"Bonjour le monde\" , components : { Icon : ExempleIcon , } } ]; } The above defines two cluster pages and three cluster page menu objects. The cluster page definitons are straightforward. The first cluster page menu object defines the parent of a foldout submenu. Setting the id field in a cluster page menu definition implies that it is defining a foldout submenu. Also note that the target field is not specified (it is ignored if the id field is specified). This cluster page menu object specifies the title and components fields, which are used in displaying the menu item in the cluster dashboard sidebar. Initially the submenu is hidden. Activating this menu item toggles on and off the appearance of the submenu below it. The remaining two cluster page menu objects define the contents of the submenu. A cluster page menu object is defined to be a submenu item by setting the parentId field to the id of the parent of a foldout submenu, \"example\" in this case globalPages # Global pages appear independently of the cluster dashboard and they fill the Lens UI space. A global page is typically triggered from the cluster menu using a global page menu . They can also be triggered by a custom app menu selection from a Main Extension or a custom status bar item . Global pages can appear even when there is no active cluster, unlike cluster pages. It is conventional to use a global page to show information and provide functionality relevant across clusters, along with custom data and functionality that your extension may have. The following example defines a LensRendererExtension subclass with a single global page definition: import { LensRendererExtension } from '@k8slens/extensions' ; import { HelpPage } from './page' ; import React from 'react' ; export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; } Global pages are objects matching the PageRegistration interface. The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. The 'id' field can also convey route path details, such as variable parameters provided to a page ( See example below ). The components field matches the PageComponents interface for which there is one field, Page . Page is of type React.ComponentType , which gives you great flexibility in defining the appearance and behaviour of your page. For the example above HelpPage can be defined in page.tsx : import { LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" export class HelpPage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Help yourself < /p> < /div> ) } } Note that the HelpPage class defines a property named extension . This allows the HelpExtension object to be passed in React-style in the global page definition, so that HelpPage can access any HelpExtension subclass data. This example code shows how to create a global page but not how to make it available to the Lens user. Global pages are typically made available through a number of ways. Menu items can be added to the Lens app menu system and set to open a global page when activated (See appMenus in the Main Extension guide ). Interactive elements can be placed on the status bar (the blue strip along the bottom of the Lens UI) and can be configured to link to a global page when activated (See statusBarItems ). As well, global pages can be made accessible from the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Global page menu icons that are defined using globalPageMenus appear below the Add Cluster icon. globalPageMenus # Global page menus connect a global page to the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Expanding on the example from globalPages a global page menu is added to the HelpExtension definition: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { HelpIcon , HelpPage } from \"./page\" import React from \"react\" export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; globalPageMenus = [ { target : { pageId : \"help\" }, title : \"Help\" , components : { Icon : HelpIcon , } }, ]; } Global page menus are objects matching the PageMenuRegistration interface. They define the appearance of the global page menu item in the cluster menu and the behaviour when the global page menu item is activated (typically by a mouse click). The example above uses the target field to set the behaviour as a link to the global page with id of \"help\" . This is done by setting target 's pageId field to \"help\" . The global page menu item's appearance is defined by setting the title field to the text that is to be displayed as a tooltip in the cluster menu. The components field is used to set an icon that appears in the cluster menu. Thus when the \"Help\" icon is activated the contents of ExamplePage will be shown. This example requires the definition of another React-based component, HelpIcon , which has been added to page.tsx : import { LensRendererExtension , Component } from \"@k8slens/extensions\" ; import React from \"react\" export function HelpIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"help\" /> } export class HelpPage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Help < /p> < /div> ) } } HelpIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon . Built in are the Material Design icons . One can be selected by name via the material field. clusterFeatures # Cluster features are Kubernetes resources that can be applied to and managed within the active cluster. They can be installed/uninstalled by the Lens user from the cluster settings page . The following example shows how to add a cluster feature as part of a LensRendererExtension : import { LensRendererExtension } from \"@k8slens/extensions\" import { ExampleFeature } from \"./src/example-feature\" import React from \"react\" export default class ExampleFeatureExtension extends LensRendererExtension { clusterFeatures = [ { title : \"Example Feature\" , components : { Description : () => { return ( < span > Enable an example feature . < /span> ) } }, feature : new ExampleFeature () } ]; } The title and components.Description fields provide content that appears on the cluster settings page, in the Features section. The feature field must specify an instance which extends the abstract class ClusterFeature.Feature , and specifically implement the following methods: abstract install ( cluster : Cluster ) : Promise < void > ; abstract upgrade ( cluster : Cluster ) : Promise < void > ; abstract uninstall ( cluster : Cluster ) : Promise < void > ; abstract updateStatus ( cluster : Cluster ) : Promise < ClusterFeatureStatus > ; The install() method is typically called by Lens when a user has indicated that this feature is to be installed (i.e. clicked Install for the feature on the cluster settings page). The implementation of this method should install kubernetes resources using the applyResources() method, or by directly accessing the kubernetes api ( K8sApi ). The upgrade() method is typically called by Lens when a user has indicated that this feature is to be upgraded (i.e. clicked Upgrade for the feature on the cluster settings page). The implementation of this method should upgrade the kubernetes resources already installed, if relevant to the feature. The uninstall() method is typically called by Lens when a user has indicated that this feature is to be uninstalled (i.e. clicked Uninstall for the feature on the cluster settings page). The implementation of this method should uninstall kubernetes resources using the kubernetes api ( K8sApi ) The updateStatus() 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 in the status field of the ClusterFeature.Feature parent class. The status.currentVersion and status.latestVersion fields may be displayed by Lens in describing the feature. The status.installed field should be set to true if the feature is currently installed, otherwise false. Also, Lens relies on the status.canUpgrade field to determine if the feature can be upgraded (i.e a new version could be available) so the implementation should set the status.canUpgrade field according to specific rules for the feature, if relevant. The following shows a very simple implementation of a ClusterFeature : import { ClusterFeature , Store , K8sApi } from \"@k8slens/extensions\" ; import * as path from \"path\" ; export class ExampleFeature extends ClusterFeature . Feature { async install ( cluster : Store.Cluster ) : Promise < void > { super . applyResources ( cluster , path . join ( __dirname , \"../resources/\" )); } async upgrade ( cluster : Store.Cluster ) : Promise < void > { return this . install ( cluster ); } async updateStatus ( cluster : Store.Cluster ) : Promise < ClusterFeature . FeatureStatus > { try { const pod = K8sApi . forCluster ( cluster , K8sApi . Pod ); const examplePod = await pod . get ({ name : \"example-pod\" , namespace : \"default\" }); if ( examplePod ? . kind ) { this . status . installed = true ; this . status . currentVersion = examplePod . spec . containers [ 0 ]. image . split ( \":\" )[ 1 ]; this . status . canUpgrade = true ; // a real implementation would perform a check here that is relevant to the specific feature } else { this . status . installed = false ; this . status . canUpgrade = false ; } } catch ( e ) { if ( e ? . error ? . code === 404 ) { this . status . installed = false ; this . status . canUpgrade = false ; } } return this . status ; } async uninstall ( cluster : Store.Cluster ) : Promise < void > { const podApi = K8sApi . forCluster ( cluster , K8sApi . Pod ); await podApi . delete ({ name : \"example-pod\" , namespace : \"default\" }); } } This example implements the install() method by simply invoking the helper applyResources() method. applyResources() tries to apply all resources read from all files found in the folder path provided. In this case this folder path is the ../resources subfolder relative to current source code's folder. The file ../resources/example-pod.yml could contain: apiVersion : v1 kind : Pod metadata : name : example-pod spec : containers : - name : example-pod image : nginx The upgrade() method in the example above is implemented by simply invoking the install() method. Depending on the feature to be supported by an extension, upgrading may require additional and/or different steps. The uninstall() method is implemented in the example above by utilizing the K8sApi provided by Lens to simply delete the example-pod pod applied by the install() method. The updateStatus() method is implemented above by using the K8sApi as well, this time to get information from the example-pod pod, in particular to determine if it is installed, what version is associated with it, and if it can be upgraded. How the status is updated for a specific cluster feature is up to the implementation. appPreferences # The Preferences page is a built-in global page. Extensions can add custom preferences to the Preferences page, thus providing a single location for users to configure global options, for Lens and extensions alike. The following example demonstrates adding a custom preference: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { observable } from \"mobx\" ; import React from \"react\" ; export default class ExampleRendererExtension extends LensRendererExtension { @observable preference = { enabled : false }; appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { this . preference } /> , Hint : () => < ExamplePreferenceHint /> } } ]; } App preferences are objects matching the AppPreferenceRegistration interface. The title field specifies the text to show as the heading on the Preferences page. The components field specifies two React.Component objects defining the interface for the preference. Input should specify an interactive input element for your preference and Hint should provide descriptive information for the preference, which is shown below the Input element. ExamplePreferenceInput expects its React props set to an ExamplePreferenceProps instance, which is how ExampleRendererExtension handles the state of the preference input. ExampleRendererExtension has the field preference , which is provided to ExamplePreferenceInput when it is created. In this example ExamplePreferenceInput , ExamplePreferenceHint , and ExamplePreferenceProps are defined in ./src/example-preference.tsx : import { Component } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; export class ExamplePreferenceProps { preference : { enabled : boolean ; } } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { render() { const { preference } = this . props ; return ( < Component . Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = { v => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render() { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } ExamplePreferenceInput implements a simple checkbox (using Lens's Component.Checkbox ). It provides label as the text to display next to the checkbox and an onChange function, which reacts to the checkbox state change. The checkbox's value is initially set to preference.enabled . ExamplePreferenceInput is defined with React props of ExamplePreferenceProps type, which is an object with a single field, enabled . This is used to indicate the state of the preference, and is bound to the checkbox state in onChange . ExamplePreferenceHint is a simple text span. Note that the input and the hint could comprise of more sophisticated elements, according to the needs of the extension. Note that the above example introduces decorators observable and observer from the mobx and mobx-react packages. mobx simplifies state management and without it this example would not visually update the checkbox properly when the user activates it. Lens uses mobx extensively for state management of its own UI elements and it is recommended that extensions rely on it too. Alternatively, React's state management can be used, though mobx is typically simpler to use. Also note that an extension's state data can be managed using an ExtensionStore object, which conveniently handles persistence and synchronization. The example above defined a preference field in the ExampleRendererExtension class definition to hold the extension's state primarily to simplify the code for this guide, but it is recommended to manage your extension's state data using ExtensionStore statusBarItems # The Status bar is the blue strip along the bottom of the Lens UI. Status bar items are React.ReactNode types, which can be used to convey status information, or act as a link to a global page, or even an external page. The following example adds a status bar item definition, as well as a global page definition, to a LensRendererExtension subclass, and configures the status bar item to navigate to the global page upon activation (normally a mouse click): import { LensRendererExtension } from '@k8slens/extensions' ; import { HelpIcon , HelpPage } from \"./page\" import React from 'react' ; export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; statusBarItems = [ { item : ( < div className = \"flex align-center gaps\" onClick = {() => this . navigate ( \"help\" )} > < HelpIcon /> My Status Bar Item < /div> ), }, ]; } The item field of a status bar item specifies the React.Component to be shown on the status bar. By default items are added starting from the right side of the status bar. Typically, item would specify an icon and/or a short string of text, considering the limited space on the status bar. In the example above the HelpIcon from the globalPageMenus guide is reused. Also, the item provides a link to the global page by setting the onClick property to a function that calls the LensRendererExtension navigate() method. navigate() takes as a parameter the id of the global page, which is shown when navigate() is called. kubeObjectMenuItems # An extension can add custom menu items (including actions) for specific Kubernetes resource kinds/apiVersions. These menu items appear under the ... for each listed resource in the cluster dashboard, and on the title bar of the details page for a specific resource: The following example shows how to add a menu for Namespace resources, and associate an action with it: import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { NamespaceMenuItem } from \"./src/namespace-menu-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectMenuItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : Component.KubeObjectMenuProps < K8sApi . Namespace > ) => < NamespaceMenuItem {... props } /> } } ]; } Kube object menu items are objects matching the KubeObjectMenuRegistration interface. The kind field specifies the kubernetes resource type to apply this menu item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. This example adds a menu item for namespaces in the cluster dashboard. The components field defines the menu item's appearance and behaviour. The MenuItem field provides a function that returns a React.Component given a set of menu item properties. In this example a NamespaceMenuItem object is returned. NamespaceMenuItem is defined in ./src/namespace-menu-item.tsx : import React from \"react\" ; import { Component , K8sApi , Navigation } from \"@k8slens/extensions\" ; export function NamespaceMenuItem ( props : Component.KubeObjectMenuProps < K8sApi . Namespace > ) { const { object : namespace , toolbar } = props ; if ( ! namespace ) return null ; const namespaceName = namespace . getName (); const sendToTerminal = ( command : string ) => { Component . terminalStore . sendCommand ( command , { enter : true , newTab : true , }); Navigation . hideDetails (); }; const getPods = () => { sendToTerminal ( `kubectl get pods -n ${ namespaceName } ` ); }; return ( < Component . MenuItem onClick = { getPods } > < Component . Icon material = \"speaker_group\" interactive = { toolbar } title = \"Get pods in terminal\" /> < span className = \"title\" > Get Pods < /span> < /Component.MenuItem> ); } NamespaceMenuItem returns a Component.MenuItem defining the menu item's appearance (icon and text) and behaviour when activated via the onClick property. getPods() shows how to open a terminal tab and run a command, specifically it runs kubectl to get a list of pods running in the current namespace. See Component.terminalStore.sendCommand for more details on running terminal commands. The name of the namespace is retrieved from props passed into NamespaceMenuItem() . namespace is the props.object , which is of type K8sApi.Namespace . This is the api for accessing namespaces, and the current namespace in this example is simply given by namespace.getName() . Thus kube object menu items are afforded convenient access to the specific resource selected by the user. kubeObjectDetailItems # An extension can add custom details (content) for specified Kubernetes resource kinds/apiVersions. These custom details appear on the details page for a specific resource, such as a Namespace: The following example shows how to add a tabulated list of pods to the Namespace resource details page: import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { NamespaceDetailsItem } from \"./src/namespace-details-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectDetailItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], priority : 10 , components : { Details : ( props : Component.KubeObjectDetailsProps < K8sApi . Namespace > ) => < NamespaceDetailsItem {... props } /> } } ]; } Kube object detail items are objects matching the KubeObjectDetailRegistration interface. The kind field specifies the kubernetes resource type to apply this detail item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. This example adds a detail item for namespaces in the cluster dashboard. The components field defines the detail item's appearance and behaviour. The Details field provides a function that returns a React.Component given a set of detail item properties. In this example a NamespaceDetailsItem object is returned. NamespaceDetailsItem is defined in ./src/namespace-details-item.tsx : import { Component , K8sApi } from \"@k8slens/extensions\" ; import { PodsDetailsList } from \"./pods-details-list\" ; import React from \"react\" ; import { observable } from \"mobx\" ; import { observer } from \"mobx-react\" ; @observer export class NamespaceDetailsItem extends React . Component < Component . KubeObjectDetailsProps < K8sApi . Namespace >> { @observable private pods : K8sApi.Pod []; async componentDidMount() { this . pods = await K8sApi . podsApi . list ({ namespace : this.props.object.getName ()}); } render() { return ( < div > < Component . DrawerTitle title = \"Pods\" /> < PodsDetailsList pods = { this . pods } /> < /div> ) } } Since NamespaceDetailsItem extends React.Component> it can access the current namespace object (type K8sApi.Namespace ) through this.props.object . This object can be queried for many details about the current namespace. In this example the namespace's name is obtained in componentDidMount() using the K8sApi.Namespace getName() method. The namespace's name is needed to limit the list of pods to only those in this namespace. To get the list of pods this example uses the kubernetes pods api, specifically the K8sApi.podsApi.list() method. The K8sApi.podsApi is automatically configured for the currently active cluster. Note that K8sApi.podsApi.list() is an asynchronous method, and ideally getting the pods list should be done before rendering the NamespaceDetailsItem . It is a common technique in React development to await async calls in componentDidMount() . However, componentDidMount() is called right after the first call to render() . In order to effect a subsequent render() call React must be made aware of a state change. Like in the appPreferences guide , mobx and mobx-react are used to ensure NamespaceDetailsItem renders when the pods list is updated. This is done simply by marking the pods field as an observable and the NamespaceDetailsItem class itself as an observer . Finally, the NamespaceDetailsItem is rendered using the render() method. Details are placed in drawers, and using Component.DrawerTitle provides a separator from details above this one. Multiple details in a drawer can be placed in elements for further separation, if desired. The rest of this example's details are defined in PodsDetailsList , found in ./pods-details-list.tsx : import React from \"react\" ; import { Component , K8sApi } from \"@k8slens/extensions\" ; interface Props { pods : K8sApi.Pod []; } export class PodsDetailsList extends React . Component < Props > { getTableRow ( index : number ) { const { pods } = this . props ; return ( < Component . TableRow key = { index } nowrap > < Component . TableCell className = \"podName\" > { pods [ index ]. getName ()} < /Component.TableCell> < Component . TableCell className = \"podAge\" > { pods [ index ]. getAge ()} < /Component.TableCell> < Component . TableCell className = \"podStatus\" > { pods [ index ]. getStatus ()} < /Component.TableCell> < /Component.TableRow> ) } render() { const { pods } = this . props if ( ! pods ? . length ) { return null ; } return ( < div > < Component . Table > < Component . TableHead > < Component . TableCell className = \"podName\" > Name < /Component.TableCell> < Component . TableCell className = \"podAge\" > Age < /Component.TableCell> < Component . TableCell className = \"podStatus\" > Status < /Component.TableCell> < /Component.TableHead> { pods . map (( pod , index ) => this . getTableRow ( index )) } < /Component.Table> < /div> ) } } PodsDetailsList produces a simple table showing a list of the pods found in this namespace: For each pod the name, age, and status are obtained using the K8sApi.Pod methods. The table is constructed using the Component.Table and related elements. See Component documentation for further details.","title":"Renderer Extension"},{"location":"extensions/guides/renderer-extension/#renderer-extension","text":"The renderer extension api is the interface to Lens's renderer process (Lens runs in main and renderer processes). It allows you to access, configure, and customize Lens data, add custom Lens UI elements, and generally run custom code in Lens's renderer process. The custom Lens UI elements that can be added include global pages, cluster pages, cluster page menus, cluster features, app preferences, status bar items, KubeObject menu items, and KubeObject details items. These UI elements are based on React components.","title":"Renderer Extension"},{"location":"extensions/guides/renderer-extension/#lensrendererextension-class","text":"To create a renderer extension simply extend the LensRendererExtension class: import { LensRendererExtension } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends LensRendererExtension { onActivate() { console . log ( 'custom renderer process extension code started' ); } onDeactivate() { console . log ( 'custom renderer process extension de-activated' ); } } There are two methods that you can implement to facilitate running your custom code. onActivate() is called when your extension has been successfully enabled. By implementing onActivate() you can initiate your custom code. onDeactivate() is called when the extension is disabled (typically from the Lens Extensions Page ) and when implemented gives you a chance to clean up after your extension, if necessary. The example above simply logs messages when the extension is enabled and disabled.","title":"LensRendererExtension Class"},{"location":"extensions/guides/renderer-extension/#clusterpages","text":"Cluster pages appear as part of the cluster dashboard. They are accessible from the side bar, and are shown in the menu list after Custom Resources . It is conventional to use a cluster page to show information or provide functionality pertaining to the active cluster, along with custom data and functionality your extension may have. However, it is not limited to the active cluster. Also, your extension can gain access to the Kubernetes resources in the active cluster in a straightforward manner using the clusterStore . The following example adds a cluster page definition to a LensRendererExtension subclass: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; } Cluster pages are objects matching the PageRegistration interface. The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. The 'id' field can also convey route path details, such as variable parameters provided to a page ( See example below ). The components field matches the PageComponents interface for wich there is one field, Page . Page is of type React.ComponentType , which gives you great flexibility in defining the appearance and behaviour of your page. For the example above ExamplePage can be defined in page.tsx : import { LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Hello world !< /p> < /div> ) } } Note that the ExamplePage class defines a property named extension . This allows the ExampleExtension object to be passed in React-style in the cluster page definition, so that ExamplePage can access any ExampleExtension subclass data.","title":"clusterPages"},{"location":"extensions/guides/renderer-extension/#clusterpagemenus","text":"The above example code shows how to create a cluster page but not how to make it available to the Lens user. Cluster pages are typically made available through a menu item in the cluster dashboard sidebar. Expanding on the above example a cluster page menu is added to the ExampleExtension definition: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; clusterPageMenus = [ { target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , } }, ]; } Cluster page menus are objects matching the ClusterPageMenuRegistration interface. They define the appearance of the cluster page menu item in the cluster dashboard sidebar and the behaviour when the cluster page menu item is activated (typically by a mouse click). The example above uses the target field to set the behaviour as a link to the cluster page with id of \"hello\" . This is done by setting target 's pageId field to \"hello\" . The cluster page menu item's appearance is defined by setting the title field to the text that is to be displayed in the cluster dashboard sidebar. The components field is used to set an icon that appears to the left of the title text in the sidebar. Thus when the \"Hello World\" menu item is activated the cluster dashboard will show the contents of ExamplePage . This example requires the definition of another React-based component, ExampleIcon , which has been added to page.tsx : import { LensRendererExtension , Component } from \"@k8slens/extensions\" ; import React from \"react\" export function ExampleIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"pages\" tooltip = { \"Hi!\" } /> } export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Hello world !< /p> < /div> ) } } ExampleIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon . Built in are the Material Design icons . One can be selected by name via the material field. ExampleIcon also sets a tooltip, shown when the Lens user hovers over the icon with a mouse, by setting the tooltip field. A cluster page menu can also be used to define a foldout submenu in the cluster dashboard sidebar. This enables the grouping of cluster pages. The following example shows how to specify a submenu having two menu items: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } }, { id : \"bonjour\" , components : { Page : () => < ExemplePage extension = { this } /> , } } ]; clusterPageMenus = [ { id : \"example\" , title : \"Greetings\" , components : { Icon : ExampleIcon , } }, { parentId : \"example\" , target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , } }, { parentId : \"example\" , target : { pageId : \"bonjour\" }, title : \"Bonjour le monde\" , components : { Icon : ExempleIcon , } } ]; } The above defines two cluster pages and three cluster page menu objects. The cluster page definitons are straightforward. The first cluster page menu object defines the parent of a foldout submenu. Setting the id field in a cluster page menu definition implies that it is defining a foldout submenu. Also note that the target field is not specified (it is ignored if the id field is specified). This cluster page menu object specifies the title and components fields, which are used in displaying the menu item in the cluster dashboard sidebar. Initially the submenu is hidden. Activating this menu item toggles on and off the appearance of the submenu below it. The remaining two cluster page menu objects define the contents of the submenu. A cluster page menu object is defined to be a submenu item by setting the parentId field to the id of the parent of a foldout submenu, \"example\" in this case","title":"clusterPageMenus"},{"location":"extensions/guides/renderer-extension/#globalpages","text":"Global pages appear independently of the cluster dashboard and they fill the Lens UI space. A global page is typically triggered from the cluster menu using a global page menu . They can also be triggered by a custom app menu selection from a Main Extension or a custom status bar item . Global pages can appear even when there is no active cluster, unlike cluster pages. It is conventional to use a global page to show information and provide functionality relevant across clusters, along with custom data and functionality that your extension may have. The following example defines a LensRendererExtension subclass with a single global page definition: import { LensRendererExtension } from '@k8slens/extensions' ; import { HelpPage } from './page' ; import React from 'react' ; export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; } Global pages are objects matching the PageRegistration interface. The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. The 'id' field can also convey route path details, such as variable parameters provided to a page ( See example below ). The components field matches the PageComponents interface for which there is one field, Page . Page is of type React.ComponentType , which gives you great flexibility in defining the appearance and behaviour of your page. For the example above HelpPage can be defined in page.tsx : import { LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" export class HelpPage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Help yourself < /p> < /div> ) } } Note that the HelpPage class defines a property named extension . This allows the HelpExtension object to be passed in React-style in the global page definition, so that HelpPage can access any HelpExtension subclass data. This example code shows how to create a global page but not how to make it available to the Lens user. Global pages are typically made available through a number of ways. Menu items can be added to the Lens app menu system and set to open a global page when activated (See appMenus in the Main Extension guide ). Interactive elements can be placed on the status bar (the blue strip along the bottom of the Lens UI) and can be configured to link to a global page when activated (See statusBarItems ). As well, global pages can be made accessible from the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Global page menu icons that are defined using globalPageMenus appear below the Add Cluster icon.","title":"globalPages"},{"location":"extensions/guides/renderer-extension/#globalpagemenus","text":"Global page menus connect a global page to the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Expanding on the example from globalPages a global page menu is added to the HelpExtension definition: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { HelpIcon , HelpPage } from \"./page\" import React from \"react\" export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; globalPageMenus = [ { target : { pageId : \"help\" }, title : \"Help\" , components : { Icon : HelpIcon , } }, ]; } Global page menus are objects matching the PageMenuRegistration interface. They define the appearance of the global page menu item in the cluster menu and the behaviour when the global page menu item is activated (typically by a mouse click). The example above uses the target field to set the behaviour as a link to the global page with id of \"help\" . This is done by setting target 's pageId field to \"help\" . The global page menu item's appearance is defined by setting the title field to the text that is to be displayed as a tooltip in the cluster menu. The components field is used to set an icon that appears in the cluster menu. Thus when the \"Help\" icon is activated the contents of ExamplePage will be shown. This example requires the definition of another React-based component, HelpIcon , which has been added to page.tsx : import { LensRendererExtension , Component } from \"@k8slens/extensions\" ; import React from \"react\" export function HelpIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"help\" /> } export class HelpPage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Help < /p> < /div> ) } } HelpIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon . Built in are the Material Design icons . One can be selected by name via the material field.","title":"globalPageMenus"},{"location":"extensions/guides/renderer-extension/#clusterfeatures","text":"Cluster features are Kubernetes resources that can be applied to and managed within the active cluster. They can be installed/uninstalled by the Lens user from the cluster settings page . The following example shows how to add a cluster feature as part of a LensRendererExtension : import { LensRendererExtension } from \"@k8slens/extensions\" import { ExampleFeature } from \"./src/example-feature\" import React from \"react\" export default class ExampleFeatureExtension extends LensRendererExtension { clusterFeatures = [ { title : \"Example Feature\" , components : { Description : () => { return ( < span > Enable an example feature . < /span> ) } }, feature : new ExampleFeature () } ]; } The title and components.Description fields provide content that appears on the cluster settings page, in the Features section. The feature field must specify an instance which extends the abstract class ClusterFeature.Feature , and specifically implement the following methods: abstract install ( cluster : Cluster ) : Promise < void > ; abstract upgrade ( cluster : Cluster ) : Promise < void > ; abstract uninstall ( cluster : Cluster ) : Promise < void > ; abstract updateStatus ( cluster : Cluster ) : Promise < ClusterFeatureStatus > ; The install() method is typically called by Lens when a user has indicated that this feature is to be installed (i.e. clicked Install for the feature on the cluster settings page). The implementation of this method should install kubernetes resources using the applyResources() method, or by directly accessing the kubernetes api ( K8sApi ). The upgrade() method is typically called by Lens when a user has indicated that this feature is to be upgraded (i.e. clicked Upgrade for the feature on the cluster settings page). The implementation of this method should upgrade the kubernetes resources already installed, if relevant to the feature. The uninstall() method is typically called by Lens when a user has indicated that this feature is to be uninstalled (i.e. clicked Uninstall for the feature on the cluster settings page). The implementation of this method should uninstall kubernetes resources using the kubernetes api ( K8sApi ) The updateStatus() 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 in the status field of the ClusterFeature.Feature parent class. The status.currentVersion and status.latestVersion fields may be displayed by Lens in describing the feature. The status.installed field should be set to true if the feature is currently installed, otherwise false. Also, Lens relies on the status.canUpgrade field to determine if the feature can be upgraded (i.e a new version could be available) so the implementation should set the status.canUpgrade field according to specific rules for the feature, if relevant. The following shows a very simple implementation of a ClusterFeature : import { ClusterFeature , Store , K8sApi } from \"@k8slens/extensions\" ; import * as path from \"path\" ; export class ExampleFeature extends ClusterFeature . Feature { async install ( cluster : Store.Cluster ) : Promise < void > { super . applyResources ( cluster , path . join ( __dirname , \"../resources/\" )); } async upgrade ( cluster : Store.Cluster ) : Promise < void > { return this . install ( cluster ); } async updateStatus ( cluster : Store.Cluster ) : Promise < ClusterFeature . FeatureStatus > { try { const pod = K8sApi . forCluster ( cluster , K8sApi . Pod ); const examplePod = await pod . get ({ name : \"example-pod\" , namespace : \"default\" }); if ( examplePod ? . kind ) { this . status . installed = true ; this . status . currentVersion = examplePod . spec . containers [ 0 ]. image . split ( \":\" )[ 1 ]; this . status . canUpgrade = true ; // a real implementation would perform a check here that is relevant to the specific feature } else { this . status . installed = false ; this . status . canUpgrade = false ; } } catch ( e ) { if ( e ? . error ? . code === 404 ) { this . status . installed = false ; this . status . canUpgrade = false ; } } return this . status ; } async uninstall ( cluster : Store.Cluster ) : Promise < void > { const podApi = K8sApi . forCluster ( cluster , K8sApi . Pod ); await podApi . delete ({ name : \"example-pod\" , namespace : \"default\" }); } } This example implements the install() method by simply invoking the helper applyResources() method. applyResources() tries to apply all resources read from all files found in the folder path provided. In this case this folder path is the ../resources subfolder relative to current source code's folder. The file ../resources/example-pod.yml could contain: apiVersion : v1 kind : Pod metadata : name : example-pod spec : containers : - name : example-pod image : nginx The upgrade() method in the example above is implemented by simply invoking the install() method. Depending on the feature to be supported by an extension, upgrading may require additional and/or different steps. The uninstall() method is implemented in the example above by utilizing the K8sApi provided by Lens to simply delete the example-pod pod applied by the install() method. The updateStatus() method is implemented above by using the K8sApi as well, this time to get information from the example-pod pod, in particular to determine if it is installed, what version is associated with it, and if it can be upgraded. How the status is updated for a specific cluster feature is up to the implementation.","title":"clusterFeatures"},{"location":"extensions/guides/renderer-extension/#apppreferences","text":"The Preferences page is a built-in global page. Extensions can add custom preferences to the Preferences page, thus providing a single location for users to configure global options, for Lens and extensions alike. The following example demonstrates adding a custom preference: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { observable } from \"mobx\" ; import React from \"react\" ; export default class ExampleRendererExtension extends LensRendererExtension { @observable preference = { enabled : false }; appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { this . preference } /> , Hint : () => < ExamplePreferenceHint /> } } ]; } App preferences are objects matching the AppPreferenceRegistration interface. The title field specifies the text to show as the heading on the Preferences page. The components field specifies two React.Component objects defining the interface for the preference. Input should specify an interactive input element for your preference and Hint should provide descriptive information for the preference, which is shown below the Input element. ExamplePreferenceInput expects its React props set to an ExamplePreferenceProps instance, which is how ExampleRendererExtension handles the state of the preference input. ExampleRendererExtension has the field preference , which is provided to ExamplePreferenceInput when it is created. In this example ExamplePreferenceInput , ExamplePreferenceHint , and ExamplePreferenceProps are defined in ./src/example-preference.tsx : import { Component } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; export class ExamplePreferenceProps { preference : { enabled : boolean ; } } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { render() { const { preference } = this . props ; return ( < Component . Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = { v => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render() { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } ExamplePreferenceInput implements a simple checkbox (using Lens's Component.Checkbox ). It provides label as the text to display next to the checkbox and an onChange function, which reacts to the checkbox state change. The checkbox's value is initially set to preference.enabled . ExamplePreferenceInput is defined with React props of ExamplePreferenceProps type, which is an object with a single field, enabled . This is used to indicate the state of the preference, and is bound to the checkbox state in onChange . ExamplePreferenceHint is a simple text span. Note that the input and the hint could comprise of more sophisticated elements, according to the needs of the extension. Note that the above example introduces decorators observable and observer from the mobx and mobx-react packages. mobx simplifies state management and without it this example would not visually update the checkbox properly when the user activates it. Lens uses mobx extensively for state management of its own UI elements and it is recommended that extensions rely on it too. Alternatively, React's state management can be used, though mobx is typically simpler to use. Also note that an extension's state data can be managed using an ExtensionStore object, which conveniently handles persistence and synchronization. The example above defined a preference field in the ExampleRendererExtension class definition to hold the extension's state primarily to simplify the code for this guide, but it is recommended to manage your extension's state data using ExtensionStore","title":"appPreferences"},{"location":"extensions/guides/renderer-extension/#statusbaritems","text":"The Status bar is the blue strip along the bottom of the Lens UI. Status bar items are React.ReactNode types, which can be used to convey status information, or act as a link to a global page, or even an external page. The following example adds a status bar item definition, as well as a global page definition, to a LensRendererExtension subclass, and configures the status bar item to navigate to the global page upon activation (normally a mouse click): import { LensRendererExtension } from '@k8slens/extensions' ; import { HelpIcon , HelpPage } from \"./page\" import React from 'react' ; export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; statusBarItems = [ { item : ( < div className = \"flex align-center gaps\" onClick = {() => this . navigate ( \"help\" )} > < HelpIcon /> My Status Bar Item < /div> ), }, ]; } The item field of a status bar item specifies the React.Component to be shown on the status bar. By default items are added starting from the right side of the status bar. Typically, item would specify an icon and/or a short string of text, considering the limited space on the status bar. In the example above the HelpIcon from the globalPageMenus guide is reused. Also, the item provides a link to the global page by setting the onClick property to a function that calls the LensRendererExtension navigate() method. navigate() takes as a parameter the id of the global page, which is shown when navigate() is called.","title":"statusBarItems"},{"location":"extensions/guides/renderer-extension/#kubeobjectmenuitems","text":"An extension can add custom menu items (including actions) for specific Kubernetes resource kinds/apiVersions. These menu items appear under the ... for each listed resource in the cluster dashboard, and on the title bar of the details page for a specific resource: The following example shows how to add a menu for Namespace resources, and associate an action with it: import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { NamespaceMenuItem } from \"./src/namespace-menu-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectMenuItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : Component.KubeObjectMenuProps < K8sApi . Namespace > ) => < NamespaceMenuItem {... props } /> } } ]; } Kube object menu items are objects matching the KubeObjectMenuRegistration interface. The kind field specifies the kubernetes resource type to apply this menu item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. This example adds a menu item for namespaces in the cluster dashboard. The components field defines the menu item's appearance and behaviour. The MenuItem field provides a function that returns a React.Component given a set of menu item properties. In this example a NamespaceMenuItem object is returned. NamespaceMenuItem is defined in ./src/namespace-menu-item.tsx : import React from \"react\" ; import { Component , K8sApi , Navigation } from \"@k8slens/extensions\" ; export function NamespaceMenuItem ( props : Component.KubeObjectMenuProps < K8sApi . Namespace > ) { const { object : namespace , toolbar } = props ; if ( ! namespace ) return null ; const namespaceName = namespace . getName (); const sendToTerminal = ( command : string ) => { Component . terminalStore . sendCommand ( command , { enter : true , newTab : true , }); Navigation . hideDetails (); }; const getPods = () => { sendToTerminal ( `kubectl get pods -n ${ namespaceName } ` ); }; return ( < Component . MenuItem onClick = { getPods } > < Component . Icon material = \"speaker_group\" interactive = { toolbar } title = \"Get pods in terminal\" /> < span className = \"title\" > Get Pods < /span> < /Component.MenuItem> ); } NamespaceMenuItem returns a Component.MenuItem defining the menu item's appearance (icon and text) and behaviour when activated via the onClick property. getPods() shows how to open a terminal tab and run a command, specifically it runs kubectl to get a list of pods running in the current namespace. See Component.terminalStore.sendCommand for more details on running terminal commands. The name of the namespace is retrieved from props passed into NamespaceMenuItem() . namespace is the props.object , which is of type K8sApi.Namespace . This is the api for accessing namespaces, and the current namespace in this example is simply given by namespace.getName() . Thus kube object menu items are afforded convenient access to the specific resource selected by the user.","title":"kubeObjectMenuItems"},{"location":"extensions/guides/renderer-extension/#kubeobjectdetailitems","text":"An extension can add custom details (content) for specified Kubernetes resource kinds/apiVersions. These custom details appear on the details page for a specific resource, such as a Namespace: The following example shows how to add a tabulated list of pods to the Namespace resource details page: import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { NamespaceDetailsItem } from \"./src/namespace-details-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectDetailItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], priority : 10 , components : { Details : ( props : Component.KubeObjectDetailsProps < K8sApi . Namespace > ) => < NamespaceDetailsItem {... props } /> } } ]; } Kube object detail items are objects matching the KubeObjectDetailRegistration interface. The kind field specifies the kubernetes resource type to apply this detail item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. This example adds a detail item for namespaces in the cluster dashboard. The components field defines the detail item's appearance and behaviour. The Details field provides a function that returns a React.Component given a set of detail item properties. In this example a NamespaceDetailsItem object is returned. NamespaceDetailsItem is defined in ./src/namespace-details-item.tsx : import { Component , K8sApi } from \"@k8slens/extensions\" ; import { PodsDetailsList } from \"./pods-details-list\" ; import React from \"react\" ; import { observable } from \"mobx\" ; import { observer } from \"mobx-react\" ; @observer export class NamespaceDetailsItem extends React . Component < Component . KubeObjectDetailsProps < K8sApi . Namespace >> { @observable private pods : K8sApi.Pod []; async componentDidMount() { this . pods = await K8sApi . podsApi . list ({ namespace : this.props.object.getName ()}); } render() { return ( < div > < Component . DrawerTitle title = \"Pods\" /> < PodsDetailsList pods = { this . pods } /> < /div> ) } } Since NamespaceDetailsItem extends React.Component> it can access the current namespace object (type K8sApi.Namespace ) through this.props.object . This object can be queried for many details about the current namespace. In this example the namespace's name is obtained in componentDidMount() using the K8sApi.Namespace getName() method. The namespace's name is needed to limit the list of pods to only those in this namespace. To get the list of pods this example uses the kubernetes pods api, specifically the K8sApi.podsApi.list() method. The K8sApi.podsApi is automatically configured for the currently active cluster. Note that K8sApi.podsApi.list() is an asynchronous method, and ideally getting the pods list should be done before rendering the NamespaceDetailsItem . It is a common technique in React development to await async calls in componentDidMount() . However, componentDidMount() is called right after the first call to render() . In order to effect a subsequent render() call React must be made aware of a state change. Like in the appPreferences guide , mobx and mobx-react are used to ensure NamespaceDetailsItem renders when the pods list is updated. This is done simply by marking the pods field as an observable and the NamespaceDetailsItem class itself as an observer . Finally, the NamespaceDetailsItem is rendered using the render() method. Details are placed in drawers, and using Component.DrawerTitle provides a separator from details above this one. Multiple details in a drawer can be placed in elements for further separation, if desired. The rest of this example's details are defined in PodsDetailsList , found in ./pods-details-list.tsx : import React from \"react\" ; import { Component , K8sApi } from \"@k8slens/extensions\" ; interface Props { pods : K8sApi.Pod []; } export class PodsDetailsList extends React . Component < Props > { getTableRow ( index : number ) { const { pods } = this . props ; return ( < Component . TableRow key = { index } nowrap > < Component . TableCell className = \"podName\" > { pods [ index ]. getName ()} < /Component.TableCell> < Component . TableCell className = \"podAge\" > { pods [ index ]. getAge ()} < /Component.TableCell> < Component . TableCell className = \"podStatus\" > { pods [ index ]. getStatus ()} < /Component.TableCell> < /Component.TableRow> ) } render() { const { pods } = this . props if ( ! pods ? . length ) { return null ; } return ( < div > < Component . Table > < Component . TableHead > < Component . TableCell className = \"podName\" > Name < /Component.TableCell> < Component . TableCell className = \"podAge\" > Age < /Component.TableCell> < Component . TableCell className = \"podStatus\" > Status < /Component.TableCell> < /Component.TableHead> { pods . map (( pod , index ) => this . getTableRow ( index )) } < /Component.Table> < /div> ) } } PodsDetailsList produces a simple table showing a list of the pods found in this namespace: For each pod the name, age, and status are obtained using the K8sApi.Pod methods. The table is constructed using the Component.Table and related elements. See Component documentation for further details.","title":"kubeObjectDetailItems"},{"location":"extensions/guides/stores/","text":"WIP # Stores # ClusterStore # WorkspaceStore # ExtensionStore #","title":"Stores"},{"location":"extensions/guides/stores/#wip","text":"","title":"WIP"},{"location":"extensions/guides/stores/#stores","text":"","title":"Stores"},{"location":"extensions/guides/stores/#clusterstore","text":"","title":"ClusterStore"},{"location":"extensions/guides/stores/#workspacestore","text":"","title":"WorkspaceStore"},{"location":"extensions/guides/stores/#extensionstore","text":"","title":"ExtensionStore"},{"location":"extensions/guides/working-with-mobx/","text":"Working with mobx # Introduction # Lens uses mobx as its state manager on top of React's state management system. This helps with having a more declarative style of managing state, as opposed to React 's native setState mechanism. You should already have a basic understanding of how React handles state ( read here for more information). However, if you do not, here is a quick overview. A React.Component is generic over both Props and State (with default empty object types). Props should be considered read-only from the point of view of the component and is the mechanism for passing in \"arguments\" to a component. State is a component's internal state and can be read by accessing the parent field state . State must be updated using the setState parent method which merges the new data with the old state. React does do some optimizations around re-rendering components after quick successions of setState calls. How mobx works: # mobx is a package that provides an abstraction over React 's state management. The three main concepts are: - observable : data stored in the component's state - action : a function that modifies any observable data - computed : data that is derived from observable data but is not actually stored. Think of this as computing isEmpty vs an observable field called count . Further reading is available from mobx 's website .","title":"Working with mobx"},{"location":"extensions/guides/working-with-mobx/#working-with-mobx","text":"","title":"Working with mobx"},{"location":"extensions/guides/working-with-mobx/#introduction","text":"Lens uses mobx as its state manager on top of React's state management system. This helps with having a more declarative style of managing state, as opposed to React 's native setState mechanism. You should already have a basic understanding of how React handles state ( read here for more information). However, if you do not, here is a quick overview. A React.Component is generic over both Props and State (with default empty object types). Props should be considered read-only from the point of view of the component and is the mechanism for passing in \"arguments\" to a component. State is a component's internal state and can be read by accessing the parent field state . State must be updated using the setState parent method which merges the new data with the old state. React does do some optimizations around re-rendering components after quick successions of setState calls.","title":"Introduction"},{"location":"extensions/guides/working-with-mobx/#how-mobx-works","text":"mobx is a package that provides an abstraction over React 's state management. The three main concepts are: - observable : data stored in the component's state - action : a function that modifies any observable data - computed : data that is derived from observable data but is not actually stored. Think of this as computing isEmpty vs an observable field called count . Further reading is available from mobx 's website .","title":"How mobx works:"},{"location":"extensions/testing-and-publishing/bundling/","text":"","title":"Bundling"},{"location":"extensions/testing-and-publishing/publishing/","text":"Publishing Extensions # To be able to easily share extensions with users they need to be published somewhere. Lens currently only supports installing extensions from NPM tarballs. All hosted extensions must, therefore, be retrievable in a NPM tarball. Places To Host Your Extension # We recommend to host your extension somewhere on the web so that it is easy for people to search for and download it. We recommend either hosting it as an NPM package on https://www.npmjs.com or through GitHub releases. We recommend against using GitHub packages (https://github.com/features/packages) as it requires a GitHub token to access the package. Publishing via NPM # This is the easiest method of publishing as NPM comes built in with mechanism to get a link to download the package as a tarball. Once you have set up an account with NPM (https://www.npmjs.com/signup) and logged in with their CLI ( npm login ) you will be ready to publish. Run npm version to bump the version of your extension by the appropriate amount. Run npm publish to publish your extension to NPM Run git push && git push --tags to push the commit that NPM creates to your git remote. It is probably a good idea to put into your README.md the following instructions for your users to get the tarball download link. npm view dist.tarball This will output the link that they will need to give to Lens to install your extension. Publish via GitHub Releases # Another method of publishing your extensions is to do so with the releases mechanism built into GitHub. We recommend reading GitHub's Releases Documentation for how to actually do the steps of a release. The following will be a quick walk through on how to make the tarball which will be the released file. Making a NPM Tarball of Your Extension # While this is necessary for hosting on GitHub releases, this is also the means for creating a tarball if you plan on hosting on a different file hosting platform. Say you have your project folder at ~/my-extension/ and you want to create an NPM package we need to do the following within your git repo: npm pack This will create a NPM tarball that can be hosted on Github Releases or any other publicly available file hosting service.","title":"Publishing Extensions"},{"location":"extensions/testing-and-publishing/publishing/#publishing-extensions","text":"To be able to easily share extensions with users they need to be published somewhere. Lens currently only supports installing extensions from NPM tarballs. All hosted extensions must, therefore, be retrievable in a NPM tarball.","title":"Publishing Extensions"},{"location":"extensions/testing-and-publishing/publishing/#places-to-host-your-extension","text":"We recommend to host your extension somewhere on the web so that it is easy for people to search for and download it. We recommend either hosting it as an NPM package on https://www.npmjs.com or through GitHub releases. We recommend against using GitHub packages (https://github.com/features/packages) as it requires a GitHub token to access the package.","title":"Places To Host Your Extension"},{"location":"extensions/testing-and-publishing/publishing/#publishing-via-npm","text":"This is the easiest method of publishing as NPM comes built in with mechanism to get a link to download the package as a tarball. Once you have set up an account with NPM (https://www.npmjs.com/signup) and logged in with their CLI ( npm login ) you will be ready to publish. Run npm version to bump the version of your extension by the appropriate amount. Run npm publish to publish your extension to NPM Run git push && git push --tags to push the commit that NPM creates to your git remote. It is probably a good idea to put into your README.md the following instructions for your users to get the tarball download link. npm view dist.tarball This will output the link that they will need to give to Lens to install your extension.","title":"Publishing via NPM"},{"location":"extensions/testing-and-publishing/publishing/#publish-via-github-releases","text":"Another method of publishing your extensions is to do so with the releases mechanism built into GitHub. We recommend reading GitHub's Releases Documentation for how to actually do the steps of a release. The following will be a quick walk through on how to make the tarball which will be the released file.","title":"Publish via GitHub Releases"},{"location":"extensions/testing-and-publishing/publishing/#making-a-npm-tarball-of-your-extension","text":"While this is necessary for hosting on GitHub releases, this is also the means for creating a tarball if you plan on hosting on a different file hosting platform. Say you have your project folder at ~/my-extension/ and you want to create an NPM package we need to do the following within your git repo: npm pack This will create a NPM tarball that can be hosted on Github Releases or any other publicly available file hosting service.","title":"Making a NPM Tarball of Your Extension"},{"location":"extensions/testing-and-publishing/testing/","text":"Testing Extensions # Renderer Process Unit Testing # UI components in extension renderer process are based on React/ReactDOM. These components can be tested by popular React testing tools like React Testing Library . If you are using the Yeoman Lens Extension Generator to scaffold extension project. The testing environment for render process are already setup for you. Just use npm start or yarn test to run the tests. For example, I have a component GlobalPageMenuIcon and want to test if props.navigate is called when user clicks the icon. My component GlobalPageMenuIcon import React from \"react\" import { Component: { Icon } } from \"@k8slens/extensions\"; const GlobalPageMenuIcon = ({ navigate }: { navigate?: () => void }): JSX.Element => ( navigate()} data-testid=\"global-page-menu-icon\" /> ) The test import React from \"react\" import { render , screen , fireEvent } from \"@testing-library/react\" ; import GlobalPageMenuIcon from \"./GlobalPageMenuIcon\" ; test ( \"click called navigate()\" , () => { const navigate = jest . fn (); render ( < GlobalPageMenuIcon navigate = { navigate } /> ); fireEvent . click ( screen . getByTestId ( \"global-page-menu-icon\" )); expect ( navigate ). toHaveBeenCalled (); }); In the example we used React Testing Library but any React testing framework can be used to test renderer process UI components. There are more example tests in the generator's template . Extend your tests based on the examples. Main Process Unit Testing # Code in the extension main process are just normal JavaScript files that has access to extension api, you can write unit tests using any testing framework. If you are using the Yeoman Lens Extension Generator to scaffold your extension project. The testing environment Jest are setup for you. Just use npm start or yarn test to run the tests. Tips # Console.log # Extension developers might find console.log() useful for printing out information and errors from extensions. To use console.log() , note that Lens is based on Electron, and that Electron has two types of processes: Main and Renderer . Renderer Process Logs # In the Renderer process, console.log() is printed in the Console in Developer Tools ( View > Toggle Developer Tools ). Main Process Logs # Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools. macOS On macOS, view the Main process logs by running Lens from the terminal: /Applications/Lens.app/Contents/MacOS/Lens You can also use Console.app to view the Main process logs. Linux On Linux, you can access the Main process logs using the Lens PID. First get the PID: ps aux | grep Lens | grep -v grep Then get the Main process logs using the PID: tail -f /proc/ [ pid ] /fd/1 # stdout (console.log) tail -f /proc/ [ pid ] /fd/2 # stdout (console.error)","title":"Testing Extensions"},{"location":"extensions/testing-and-publishing/testing/#testing-extensions","text":"","title":"Testing Extensions"},{"location":"extensions/testing-and-publishing/testing/#renderer-process-unit-testing","text":"UI components in extension renderer process are based on React/ReactDOM. These components can be tested by popular React testing tools like React Testing Library . If you are using the Yeoman Lens Extension Generator to scaffold extension project. The testing environment for render process are already setup for you. Just use npm start or yarn test to run the tests. For example, I have a component GlobalPageMenuIcon and want to test if props.navigate is called when user clicks the icon. My component GlobalPageMenuIcon import React from \"react\" import { Component: { Icon } } from \"@k8slens/extensions\"; const GlobalPageMenuIcon = ({ navigate }: { navigate?: () => void }): JSX.Element => ( navigate()} data-testid=\"global-page-menu-icon\" /> ) The test import React from \"react\" import { render , screen , fireEvent } from \"@testing-library/react\" ; import GlobalPageMenuIcon from \"./GlobalPageMenuIcon\" ; test ( \"click called navigate()\" , () => { const navigate = jest . fn (); render ( < GlobalPageMenuIcon navigate = { navigate } /> ); fireEvent . click ( screen . getByTestId ( \"global-page-menu-icon\" )); expect ( navigate ). toHaveBeenCalled (); }); In the example we used React Testing Library but any React testing framework can be used to test renderer process UI components. There are more example tests in the generator's template . Extend your tests based on the examples.","title":"Renderer Process Unit Testing"},{"location":"extensions/testing-and-publishing/testing/#main-process-unit-testing","text":"Code in the extension main process are just normal JavaScript files that has access to extension api, you can write unit tests using any testing framework. If you are using the Yeoman Lens Extension Generator to scaffold your extension project. The testing environment Jest are setup for you. Just use npm start or yarn test to run the tests.","title":"Main Process Unit Testing"},{"location":"extensions/testing-and-publishing/testing/#tips","text":"","title":"Tips"},{"location":"extensions/testing-and-publishing/testing/#consolelog","text":"Extension developers might find console.log() useful for printing out information and errors from extensions. To use console.log() , note that Lens is based on Electron, and that Electron has two types of processes: Main and Renderer .","title":"Console.log"},{"location":"extensions/testing-and-publishing/testing/#renderer-process-logs","text":"In the Renderer process, console.log() is printed in the Console in Developer Tools ( View > Toggle Developer Tools ).","title":"Renderer Process Logs"},{"location":"extensions/testing-and-publishing/testing/#main-process-logs","text":"Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools.","title":"Main Process Logs"},{"location":"extensions/usage/","text":"Using Extensions # The features that Lens includes out-of-the-box are just the start. Lens extensions let you add new features to your installation to support your workflow. Rich extensibility model lets extension authors plug directly into the Lens UI and contribute functionality through the same APIs used by Lens itself. The start using Lens Extensions go to File (or Lens on macOS) > Extensions in the application menu. This is the Extensions management page where all the management of the extensions you want to use is done. Installing an Extension # There are three ways to install extensions. If you have the extension as a .tgz file then dragging and dropping it in the extension management page will install it for you. If it is hosted on the web, you can paste the URL and click Install and Lens will download and install it. The third way is to move the extension into your ~/.k8slens/extensions (or C:\\Users\\\\.k8slens\\extensions ) folder and Lens will automatically detect it and install the extension. Enabling or Disabling an Extension # Go to the extension management page and click either the Enable or Disable buttons. Extensions will be enabled by default when you first install them. A disabled extension is not loaded by Lens and is not run. Uninstalling an Extension # If, for whatever reason, you wish to remove the installation of an extension simple click the Uninstall button. This will remove all the files that Lens would need to run the extension.","title":"Using Extensions"},{"location":"extensions/usage/#using-extensions","text":"The features that Lens includes out-of-the-box are just the start. Lens extensions let you add new features to your installation to support your workflow. Rich extensibility model lets extension authors plug directly into the Lens UI and contribute functionality through the same APIs used by Lens itself. The start using Lens Extensions go to File (or Lens on macOS) > Extensions in the application menu. This is the Extensions management page where all the management of the extensions you want to use is done.","title":"Using Extensions"},{"location":"extensions/usage/#installing-an-extension","text":"There are three ways to install extensions. If you have the extension as a .tgz file then dragging and dropping it in the extension management page will install it for you. If it is hosted on the web, you can paste the URL and click Install and Lens will download and install it. The third way is to move the extension into your ~/.k8slens/extensions (or C:\\Users\\\\.k8slens\\extensions ) folder and Lens will automatically detect it and install the extension.","title":"Installing an Extension"},{"location":"extensions/usage/#enabling-or-disabling-an-extension","text":"Go to the extension management page and click either the Enable or Disable buttons. Extensions will be enabled by default when you first install them. A disabled extension is not loaded by Lens and is not run.","title":"Enabling or Disabling an Extension"},{"location":"extensions/usage/#uninstalling-an-extension","text":"If, for whatever reason, you wish to remove the installation of an extension simple click the Uninstall button. This will remove all the files that Lens would need to run the extension.","title":"Uninstalling an Extension"},{"location":"faq/","text":"FAQ # What operating systems does Lens support? # Lens supports MacOS, Windows and Linux operating systems. For Linux there are Snap and AppImage versions. For MacOS there are DMG and Homebrew options. Lens application is not opening, what might be wrong? # When Lens is started, it will start HTTP proxy server on the background and requires that operating system allows to start listening to some free port. You can see the port allocated for Lens from application logs. Lens expects also that localhost DNS points to 127.0.0.1 address. Why can't I add any clusters? # When adding new clusters, a valid Kubeconfig file is required. Please check that all contexts present in Kubeconfig file are valid. Why Cluster dashboard is not opening? # To see Cluster dashboard properly, Kubernetes cluster must be reachable either directly from your computer or via HTTP proxy. You can configure HTTP proxy in Cluster Settigns. Also, provided credentials in Kubeconfig must be valid. If Kubeconfig uses exec command, the binary must be available in global PATH or absolute path must be used. Lens application can't see PATH modifications made by any shell init scripts. There might be also some issues on the Snap version if the exec binary is installed also from Snap and requires additional symlinking, please see #699 . Why I don't see anything on Cluster dashboard? # Users will see on Cluster dashboard only those resources that they are allowed to see (RBAC). Lens requires that user has access at least to one namespace. Lens tries first fetch namespaces from Kubernetes API. If user is not allowed to list namespaces, allowed namespaces can be configured in Cluster settings or in Kubeconfig. Why I don't see any metrics or some of the metrics are not working? # In order to display cluster metrics, Lens requires that Prometheus is running in the cluster. You can install Prometheus in Cluster settings if needed. Lens tries to detect Prometheus installation automatically. If it fails to detect the installation properly, you can configure Prometheus service address in Cluster settings. If some of the metrics are not displayed correctly, you can see queries that Lens is using here and adapt your prometheus configuration to support those queries. Please refer Prometheus documentation or your Prometheus installer documentation how to do this. Kubectl is not working in Lens terminal, what should I do? # Lens tries to download correct Kubectl version for the cluster and use that in Lens terminal. Some operating systems (namely Windows) might have restrictions set that prevent downloading and executing binaries from the default location that Lens is using. You can change the directory where Lens downloads the binaries in App Preferences. It's also possible to change the Download mirror to use Azure if default Google is not reachable from your network. If downloading Kubectl is not option for you, you can define path to pre-installed Kubectl on your machine and Lens will use that binary instead. How can I configure Helm repositories? # Lens comes with bundled Helm 3 binary and Lens will add by default bitnami repository if no other repositories are configured. You can add more repositories from Artifact HUB in App preferences. At this moment it is not possible to add private repositories. Those and other public repositories can be added manually via command line. Where can I find application logs? # Lens will store application logs to following locations depending on your operating system: - MacOS: ~/Library/Logs/Lens/ - Windows: %USERPROFILE%\\AppData\\Roaming\\Lens\\logs\\ - Linux: ~/.config/Lens/logs/ How can I see more verbose logs? # You can start Lens application on debug mode from the command line to see more verbose logs. To start application on debug mode, please provide DEBUG=true environment variable and before starting the application, for example: DEBUG=TRUE /Applications/Lens.app/Contents/MacOS/Lens","title":"FAQ"},{"location":"faq/#faq","text":"","title":"FAQ"},{"location":"faq/#what-operating-systems-does-lens-support","text":"Lens supports MacOS, Windows and Linux operating systems. For Linux there are Snap and AppImage versions. For MacOS there are DMG and Homebrew options.","title":"What operating systems does Lens support?"},{"location":"faq/#lens-application-is-not-opening-what-might-be-wrong","text":"When Lens is started, it will start HTTP proxy server on the background and requires that operating system allows to start listening to some free port. You can see the port allocated for Lens from application logs. Lens expects also that localhost DNS points to 127.0.0.1 address.","title":"Lens application is not opening, what might be wrong?"},{"location":"faq/#why-cant-i-add-any-clusters","text":"When adding new clusters, a valid Kubeconfig file is required. Please check that all contexts present in Kubeconfig file are valid.","title":"Why can't I add any clusters?"},{"location":"faq/#why-cluster-dashboard-is-not-opening","text":"To see Cluster dashboard properly, Kubernetes cluster must be reachable either directly from your computer or via HTTP proxy. You can configure HTTP proxy in Cluster Settigns. Also, provided credentials in Kubeconfig must be valid. If Kubeconfig uses exec command, the binary must be available in global PATH or absolute path must be used. Lens application can't see PATH modifications made by any shell init scripts. There might be also some issues on the Snap version if the exec binary is installed also from Snap and requires additional symlinking, please see #699 .","title":"Why Cluster dashboard is not opening?"},{"location":"faq/#why-i-dont-see-anything-on-cluster-dashboard","text":"Users will see on Cluster dashboard only those resources that they are allowed to see (RBAC). Lens requires that user has access at least to one namespace. Lens tries first fetch namespaces from Kubernetes API. If user is not allowed to list namespaces, allowed namespaces can be configured in Cluster settings or in Kubeconfig.","title":"Why I don't see anything on Cluster dashboard?"},{"location":"faq/#why-i-dont-see-any-metrics-or-some-of-the-metrics-are-not-working","text":"In order to display cluster metrics, Lens requires that Prometheus is running in the cluster. You can install Prometheus in Cluster settings if needed. Lens tries to detect Prometheus installation automatically. If it fails to detect the installation properly, you can configure Prometheus service address in Cluster settings. If some of the metrics are not displayed correctly, you can see queries that Lens is using here and adapt your prometheus configuration to support those queries. Please refer Prometheus documentation or your Prometheus installer documentation how to do this.","title":"Why I don't see any metrics or some of the metrics are not working?"},{"location":"faq/#kubectl-is-not-working-in-lens-terminal-what-should-i-do","text":"Lens tries to download correct Kubectl version for the cluster and use that in Lens terminal. Some operating systems (namely Windows) might have restrictions set that prevent downloading and executing binaries from the default location that Lens is using. You can change the directory where Lens downloads the binaries in App Preferences. It's also possible to change the Download mirror to use Azure if default Google is not reachable from your network. If downloading Kubectl is not option for you, you can define path to pre-installed Kubectl on your machine and Lens will use that binary instead.","title":"Kubectl is not working in Lens terminal, what should I do?"},{"location":"faq/#how-can-i-configure-helm-repositories","text":"Lens comes with bundled Helm 3 binary and Lens will add by default bitnami repository if no other repositories are configured. You can add more repositories from Artifact HUB in App preferences. At this moment it is not possible to add private repositories. Those and other public repositories can be added manually via command line.","title":"How can I configure Helm repositories?"},{"location":"faq/#where-can-i-find-application-logs","text":"Lens will store application logs to following locations depending on your operating system: - MacOS: ~/Library/Logs/Lens/ - Windows: %USERPROFILE%\\AppData\\Roaming\\Lens\\logs\\ - Linux: ~/.config/Lens/logs/","title":"Where can I find application logs?"},{"location":"faq/#how-can-i-see-more-verbose-logs","text":"You can start Lens application on debug mode from the command line to see more verbose logs. To start application on debug mode, please provide DEBUG=true environment variable and before starting the application, for example: DEBUG=TRUE /Applications/Lens.app/Contents/MacOS/Lens","title":"How can I see more verbose logs?"},{"location":"getting-started/","text":"Getting Started # Lens is lightweight and simple to install. You'll be up and running in just a few minutes. System Requirements # Review the System Requirements to check if your computer configuration is supported. macOS # Download Lens for macOS. Open the browser's download list and locate the downloaded archive. Select the 'magnifying glass' icon to open the archive in Finder. Double-click Lens-{version}.dmg and drag Lens.app to the Applications folder, making it available in the macOS Launchpad. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing Options , Keep in Dock . Windows # Download the Lens installer for Windows. Once it is downloaded, run the installer Lens-Setup-{version}.exe . This will only take a minute. By default, Lens is installed under C:\\users\\{username}\\AppData\\Local\\Programs\\Lens . Linux # See the Download Lens page for a complete list of available installation options. Snap # Lens is officially distributed as a Snap package in the Snap Store : You can install it by running: sudo snap install kontena-lens --classic Update Cadence # Lens releases a new version each month with new features and important bug fixes. Lens supports auto updating and you will be prompted to install the new release when it becomes available! To stay current with the Lens features, you can review the release notes . Next Steps # Add clusters Watch introductory videos","title":"Getting Started"},{"location":"getting-started/#getting-started","text":"Lens is lightweight and simple to install. You'll be up and running in just a few minutes.","title":"Getting Started"},{"location":"getting-started/#system-requirements","text":"Review the System Requirements to check if your computer configuration is supported.","title":"System Requirements"},{"location":"getting-started/#macos","text":"Download Lens for macOS. Open the browser's download list and locate the downloaded archive. Select the 'magnifying glass' icon to open the archive in Finder. Double-click Lens-{version}.dmg and drag Lens.app to the Applications folder, making it available in the macOS Launchpad. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing Options , Keep in Dock .","title":"macOS"},{"location":"getting-started/#windows","text":"Download the Lens installer for Windows. Once it is downloaded, run the installer Lens-Setup-{version}.exe . This will only take a minute. By default, Lens is installed under C:\\users\\{username}\\AppData\\Local\\Programs\\Lens .","title":"Windows"},{"location":"getting-started/#linux","text":"See the Download Lens page for a complete list of available installation options.","title":"Linux"},{"location":"getting-started/#snap","text":"Lens is officially distributed as a Snap package in the Snap Store : You can install it by running: sudo snap install kontena-lens --classic","title":"Snap"},{"location":"getting-started/#update-cadence","text":"Lens releases a new version each month with new features and important bug fixes. Lens supports auto updating and you will be prompted to install the new release when it becomes available! To stay current with the Lens features, you can review the release notes .","title":"Update Cadence"},{"location":"getting-started/#next-steps","text":"Add clusters Watch introductory videos","title":"Next Steps"},{"location":"getting-started/introductory-videos/","text":"Introductory Videos # Continue your Lens journey with this set of introductory videos! These videos are meant to quickly familiarize you with Lens' various powerful features. Getting started Get Lens Kubernetes IDE Running in 5 Minutes Duration 35 minutes Introducing Lens Lens Kubernetes IDE overview Duration 2 minutes Demo of Mirantis Lens The Best IDE For Kubernetes Duration 10 minutes","title":"Introductory Videos"},{"location":"getting-started/introductory-videos/#introductory-videos","text":"Continue your Lens journey with this set of introductory videos! These videos are meant to quickly familiarize you with Lens' various powerful features.","title":"Introductory Videos"},{"location":"getting-started/preferences/","text":"Preferences # Color Themes # The Color Themes option in Lens preferences lets you set the colors in the Lens user interface to suit your liking. Go to File > Preferences ( Lens > Preferences on Mac). Select your preferred theme from the Color Theme dropdown. Telemetry & Usage Tracking # Lens collects telemetry data, which is used to help us understand how to improve the product. For example, this usage data helps us to debug issues and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. Please see our privacy statement to learn more. Disable Telemetry Reporting # If you don't wish to send usage data to Mirantis, you can disable the \"Telemetry & Usage Tracking\" in the Lens preferences. Go to File > Preferences ( Lens > Preferences on Mac). Scroll down to Telemetry & Usage Tracking Uncheck Allow Telemetry & Usage Tracking . This will silence all telemetry events from Lens going forward. Telemetry information may have been collected and sent up until the point when you disable this setting.","title":"Preferences"},{"location":"getting-started/preferences/#preferences","text":"","title":"Preferences"},{"location":"getting-started/preferences/#color-themes","text":"The Color Themes option in Lens preferences lets you set the colors in the Lens user interface to suit your liking. Go to File > Preferences ( Lens > Preferences on Mac). Select your preferred theme from the Color Theme dropdown.","title":"Color Themes"},{"location":"getting-started/preferences/#telemetry-usage-tracking","text":"Lens collects telemetry data, which is used to help us understand how to improve the product. For example, this usage data helps us to debug issues and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. Please see our privacy statement to learn more.","title":"Telemetry & Usage Tracking"},{"location":"getting-started/preferences/#disable-telemetry-reporting","text":"If you don't wish to send usage data to Mirantis, you can disable the \"Telemetry & Usage Tracking\" in the Lens preferences. Go to File > Preferences ( Lens > Preferences on Mac). Scroll down to Telemetry & Usage Tracking Uncheck Allow Telemetry & Usage Tracking . This will silence all telemetry events from Lens going forward. Telemetry information may have been collected and sent up until the point when you disable this setting.","title":"Disable Telemetry Reporting"},{"location":"helm/","text":"Using Helm Charts # Lens has integration to Helm making it easy to install and manage Helm charts and releases in Apps section. Managing Helm Reporistories # Used Helm repositories are possible to configure in the Preferences . Lens app will fetch available Helm repositories from the Artifact HUB and automatically add bitnami repository by default if no other repositories are already configured. If any other repositories are needed to add, those can be added manually via command line. Note! Configured Helm repositories are added globally to user's computer, so other processes can see those as well. Installing a Helm Chart # Lens will list all charts from configured Helm repositries on Apps section. To install a chart, you need to select a chart and click \"Install\" button. Lens will open the chart in the editor where you can select a chart version, target namespace and give optionally a name for the release and configure values for the release. Finally, by clicking \"Install\" button Lens will deploy the chart into the cluster. Updating a Helm Release # To update a Helm release, you can open the release details and modify the release values and click \"Save\" button. To upgrade or downgrade the release, click \"Upgrade\" button in the release details. In the release editor you can select a new chart version and edit the release values if needed and then click \"Upgrade\" or \"Upgrade and Close\" button. Deleting a Helm Release # To delete existing Helm release open the release details and click trash can icon on the top of the panel. Deletion removes all Kubernetes resources created by the Helm release. Note! If the release included any persistent volumes, those are required to remove manually!","title":"Using Helm Charts"},{"location":"helm/#using-helm-charts","text":"Lens has integration to Helm making it easy to install and manage Helm charts and releases in Apps section.","title":"Using Helm Charts"},{"location":"helm/#managing-helm-reporistories","text":"Used Helm repositories are possible to configure in the Preferences . Lens app will fetch available Helm repositories from the Artifact HUB and automatically add bitnami repository by default if no other repositories are already configured. If any other repositories are needed to add, those can be added manually via command line. Note! Configured Helm repositories are added globally to user's computer, so other processes can see those as well.","title":"Managing Helm Reporistories"},{"location":"helm/#installing-a-helm-chart","text":"Lens will list all charts from configured Helm repositries on Apps section. To install a chart, you need to select a chart and click \"Install\" button. Lens will open the chart in the editor where you can select a chart version, target namespace and give optionally a name for the release and configure values for the release. Finally, by clicking \"Install\" button Lens will deploy the chart into the cluster.","title":"Installing a Helm Chart"},{"location":"helm/#updating-a-helm-release","text":"To update a Helm release, you can open the release details and modify the release values and click \"Save\" button. To upgrade or downgrade the release, click \"Upgrade\" button in the release details. In the release editor you can select a new chart version and edit the release values if needed and then click \"Upgrade\" or \"Upgrade and Close\" button.","title":"Updating a Helm Release"},{"location":"helm/#deleting-a-helm-release","text":"To delete existing Helm release open the release details and click trash can icon on the top of the panel. Deletion removes all Kubernetes resources created by the Helm release. Note! If the release included any persistent volumes, those are required to remove manually!","title":"Deleting a Helm Release"},{"location":"support/","text":"Support # Here you will find different ways of getting support for Lens IDE. Community Support # Community Slack - Request for support and help from the Lens community via Slack. Github Issues - Submit your issues and feature requests to Lens IDE via Github. Commercial Support & Services # If you are interested in paid support options, professional services or training, please see the offerings from the following vendors: Mirantis offers commercial support for officially released versions of Lens IDE on MacOS, Windows and Linux operating systems. In addition, Mirantis offers professional services to create proprietary / custom Lens IDE extensions and custom msi packaging to meet enterprise IT policies for software distribution and configuration. Training is also available. If you'd like to get your business listed in here, please contact us via email info@k8slens.dev","title":"Support"},{"location":"support/#support","text":"Here you will find different ways of getting support for Lens IDE.","title":"Support"},{"location":"support/#community-support","text":"Community Slack - Request for support and help from the Lens community via Slack. Github Issues - Submit your issues and feature requests to Lens IDE via Github.","title":"Community Support"},{"location":"support/#commercial-support-services","text":"If you are interested in paid support options, professional services or training, please see the offerings from the following vendors: Mirantis offers commercial support for officially released versions of Lens IDE on MacOS, Windows and Linux operating systems. In addition, Mirantis offers professional services to create proprietary / custom Lens IDE extensions and custom msi packaging to meet enterprise IT policies for software distribution and configuration. Training is also available. If you'd like to get your business listed in here, please contact us via email info@k8slens.dev","title":"Commercial Support & Services"},{"location":"supporting/requirements/","text":"Requirements for Lens # Hardware # Lens is a small download (< 300 MB) and has a disk footprint of 600 MB. Lens is lightweight and should easily run on today's hardware. We recommend: 2 GHz or faster processor 1 GB of RAM Platforms # Lens has been tested on the following platforms: macOS Windows Linux Additional Windows requirements # ... Additional Linux Requirements # ...","title":"Requirements for Lens"},{"location":"supporting/requirements/#requirements-for-lens","text":"","title":"Requirements for Lens"},{"location":"supporting/requirements/#hardware","text":"Lens is a small download (< 300 MB) and has a disk footprint of 600 MB. Lens is lightweight and should easily run on today's hardware. We recommend: 2 GHz or faster processor 1 GB of RAM","title":"Hardware"},{"location":"supporting/requirements/#platforms","text":"Lens has been tested on the following platforms: macOS Windows Linux","title":"Platforms"},{"location":"supporting/requirements/#additional-windows-requirements","text":"...","title":"Additional Windows requirements"},{"location":"supporting/requirements/#additional-linux-requirements","text":"...","title":"Additional Linux Requirements"}]} \ No newline at end of file +{"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). 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). 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 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/#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
    ); }) Defined in src/renderer/components/layout/tab-layout.tsx:27 Const notificationsStore # \u2022 notificationsStore : NotificationsStore \u2039\u203a = new NotificationsStore() Defined in src/renderer/components/notifications/notifications.store.ts:77 Const terminalStore # \u2022 terminalStore : TerminalStore\u2039\u203a = new TerminalStore() Defined in src/renderer/components/dock/terminal.store.ts:124 Functions # DrawerItemLabels # \u25b8 DrawerItemLabels ( props : DrawerItemLabelsProps ): Element\u2039\u203a Defined in src/renderer/components/drawer/drawer-item-labels.tsx:9 Parameters: Name Type props DrawerItemLabelsProps Returns: Element\u2039\u203a SubMenu # \u25b8 SubMenu ( props : Partial\u2039 MenuProps \u203a): Element\u2039\u203a Defined in src/renderer/components/menu/menu.tsx:275 Parameters: Name Type props Partial\u2039 MenuProps \u203a Returns: Element\u2039\u203a createPodLogsTab # \u25b8 createPodLogsTab ( data : IPodLogsData, tabParams : Partial\u2039IDockTab\u203a): IDockTab Defined in src/renderer/components/dock/pod-logs.store.ts:190 Parameters: Name Type Default data IPodLogsData - tabParams Partial\u2039IDockTab\u203a {} Returns: IDockTab createTerminalTab # \u25b8 createTerminalTab ( tabParams : Partial\u2039ITerminalTab\u203a): IDockTab Defined in src/renderer/components/dock/terminal.store.ts:18 Parameters: Name Type Default tabParams Partial\u2039ITerminalTab\u203a {} Returns: IDockTab withTooltip # \u25b8 withTooltip \u2039 T \u203a( Target : T): T Defined in src/renderer/components/tooltip/withTooltip.tsx:18 Type parameters: \u25aa T : React.ComponentType\u2039any\u203a Parameters: Name Type Target T Returns: T","title":"Module: \"renderer-api/components\""},{"location":"extensions/api/modules/_renderer_api_components_/#module-renderer-apicomponents","text":"","title":"Module: \"renderer-api/components\""},{"location":"extensions/api/modules/_renderer_api_components_/#index","text":"","title":"Index"},{"location":"extensions/api/modules/_renderer_api_components_/#enumerations","text":"NotificationStatus TooltipPosition","title":"Enumerations"},{"location":"extensions/api/modules/_renderer_api_components_/#classes","text":"Badge Button Checkbox ConfirmDialog CubeSpinner Dialog Drawer DrawerItem DrawerParamToggler DrawerTitle Icon Input KubeEventDetails KubeObjectDetails KubeObjectListLayout KubeObjectMenu KubeObjectMeta LineProgress Menu MenuActions MenuItem Notifications NotificationsStore PageLayout Radio RadioGroup Select Slider Spinner StatusBrick Stepper Tab Table TableCell TableHead TableRow Tabs Tooltip WizardLayout","title":"Classes"},{"location":"extensions/api/modules/_renderer_api_components_/#interfaces","text":"BadgeProps ButtonProps CheckboxProps ConfirmDialogParams ConfirmDialogProps CubeSpinnerProps DialogProps DrawerItemLabelsProps DrawerItemProps DrawerParamTogglerProps DrawerProps DrawerTitleProps GroupSelectOption IconProps InputValidator KubeEventDetailsProps KubeObjectDetailsProps KubeObjectListLayoutProps KubeObjectMenuProps KubeObjectMetaProps LineProgressProps MenuActionsProps MenuItemProps MenuPosition MenuProps Notification PageLayoutProps RadioGroupProps SelectOption SelectProps SliderProps SpinnerProps StatusBrickProps StepperProps TabLayoutProps TabLayoutRoute TabProps TableCellProps TableHeadProps TableProps TableRowProps TabsProps TooltipContentFormatters TooltipDecoratorProps TooltipProps WizardLayoutProps","title":"Interfaces"},{"location":"extensions/api/modules/_renderer_api_components_/#type-aliases","text":"InputProps MenuContextValue NotificationId NotificationMessage RadioProps TableCellElem TableHeadElem TableOrderBy TableRowElem TableSortBy TableSortCallback TableSortParams","title":"Type aliases"},{"location":"extensions/api/modules/_renderer_api_components_/#variables","text":"InputValidators MenuContext TabLayout notificationsStore terminalStore","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_components_/#functions","text":"DrawerItemLabels SubMenu createPodLogsTab createTerminalTab withTooltip","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_components_/#type-aliases_1","text":"","title":"Type aliases"},{"location":"extensions/api/modules/_renderer_api_components_/#inputprops","text":"\u01ac InputProps : Omit\u2039InputElementProps, \"onChange\" | \"onSubmit\"\u203a & object Defined in src/renderer/components/input/input.tsx:21","title":"InputProps"},{"location":"extensions/api/modules/_renderer_api_components_/#menucontextvalue","text":"\u01ac MenuContextValue : Menu Defined in src/renderer/components/menu/menu.tsx:11","title":"MenuContextValue"},{"location":"extensions/api/modules/_renderer_api_components_/#notificationid","text":"\u01ac NotificationId : string | number Defined in src/renderer/components/notifications/notifications.store.ts:7","title":"NotificationId"},{"location":"extensions/api/modules/_renderer_api_components_/#notificationmessage","text":"\u01ac NotificationMessage : React.ReactNode | React.ReactNode[] | JsonApiErrorParsed Defined in src/renderer/components/notifications/notifications.store.ts:8","title":"NotificationMessage"},{"location":"extensions/api/modules/_renderer_api_components_/#radioprops","text":"\u01ac RadioProps : HTMLProps\u2039any\u203a & object Defined in src/renderer/components/radio/radio.tsx:40","title":"RadioProps"},{"location":"extensions/api/modules/_renderer_api_components_/#tablecellelem","text":"\u01ac TableCellElem : ReactElement\u2039 TableCellProps \u203a Defined in src/renderer/components/table/table-cell.tsx:9","title":"TableCellElem"},{"location":"extensions/api/modules/_renderer_api_components_/#tableheadelem","text":"\u01ac TableHeadElem : ReactElement\u2039 TableHeadProps \u203a Defined in src/renderer/components/table/table-head.tsx:6","title":"TableHeadElem"},{"location":"extensions/api/modules/_renderer_api_components_/#tableorderby","text":"\u01ac TableOrderBy : \"asc\" | \"desc\" | string Defined in src/renderer/components/table/table.tsx:18","title":"TableOrderBy"},{"location":"extensions/api/modules/_renderer_api_components_/#tablerowelem","text":"\u01ac TableRowElem : ReactElement\u2039 TableRowProps \u203a Defined in src/renderer/components/table/table-row.tsx:7","title":"TableRowElem"},{"location":"extensions/api/modules/_renderer_api_components_/#tablesortby","text":"\u01ac TableSortBy : string Defined in src/renderer/components/table/table.tsx:17","title":"TableSortBy"},{"location":"extensions/api/modules/_renderer_api_components_/#tablesortcallback","text":"\u01ac TableSortCallback : function Defined in src/renderer/components/table/table.tsx:20","title":"TableSortCallback"},{"location":"extensions/api/modules/_renderer_api_components_/#tablesortparams","text":"\u01ac TableSortParams : object Defined in src/renderer/components/table/table.tsx:19","title":"TableSortParams"},{"location":"extensions/api/modules/_renderer_api_components_/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_components_/#inputvalidators","text":"\u2022 InputValidators : InputValidators Defined in src/renderer/components/input/input.tsx:14","title":"InputValidators"},{"location":"extensions/api/modules/_renderer_api_components_/#const-menucontext","text":"\u2022 MenuContext : Context\u2039 Menu \u2039\u203a\u203a = React.createContext (null) Defined in src/renderer/components/menu/menu.tsx:10","title":"Const MenuContext"},{"location":"extensions/api/modules/_renderer_api_components_/#const-tablayout","text":"\u2022 TabLayout : (Anonymous function) = observer(({ className, contentClass, tabs = [], children }: TabLayoutProps) => { const currentLocation = navigation.location.pathname; const hasTabs = tabs.length > 0; const startTabUrl = hasTabs ? (tabs.find(tab => tab.default) || tabs[0])?.url : null; return ( {hasTabs && ( navigate(url)}> {tabs.map(({ title, routePath, url = routePath, exact }) => { const isActive = !!matchPath(currentLocation, { path: routePath, exact }); return ; })} )}
    {hasTabs && ( {tabs.map(({ routePath, exact, component }) => { return ; })} )} {children}
    ); }) Defined in src/renderer/components/layout/tab-layout.tsx:27","title":"Const TabLayout"},{"location":"extensions/api/modules/_renderer_api_components_/#const-notificationsstore","text":"\u2022 notificationsStore : NotificationsStore \u2039\u203a = new NotificationsStore() Defined in src/renderer/components/notifications/notifications.store.ts:77","title":"Const notificationsStore"},{"location":"extensions/api/modules/_renderer_api_components_/#const-terminalstore","text":"\u2022 terminalStore : TerminalStore\u2039\u203a = new TerminalStore() Defined in src/renderer/components/dock/terminal.store.ts:124","title":"Const terminalStore"},{"location":"extensions/api/modules/_renderer_api_components_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_components_/#draweritemlabels","text":"\u25b8 DrawerItemLabels ( props : DrawerItemLabelsProps ): Element\u2039\u203a Defined in src/renderer/components/drawer/drawer-item-labels.tsx:9 Parameters: Name Type props DrawerItemLabelsProps Returns: Element\u2039\u203a","title":"DrawerItemLabels"},{"location":"extensions/api/modules/_renderer_api_components_/#submenu","text":"\u25b8 SubMenu ( props : Partial\u2039 MenuProps \u203a): Element\u2039\u203a Defined in src/renderer/components/menu/menu.tsx:275 Parameters: Name Type props Partial\u2039 MenuProps \u203a Returns: Element\u2039\u203a","title":"SubMenu"},{"location":"extensions/api/modules/_renderer_api_components_/#createpodlogstab","text":"\u25b8 createPodLogsTab ( data : IPodLogsData, tabParams : Partial\u2039IDockTab\u203a): IDockTab Defined in src/renderer/components/dock/pod-logs.store.ts:190 Parameters: Name Type Default data IPodLogsData - tabParams Partial\u2039IDockTab\u203a {} Returns: IDockTab","title":"createPodLogsTab"},{"location":"extensions/api/modules/_renderer_api_components_/#createterminaltab","text":"\u25b8 createTerminalTab ( tabParams : Partial\u2039ITerminalTab\u203a): IDockTab Defined in src/renderer/components/dock/terminal.store.ts:18 Parameters: Name Type Default tabParams Partial\u2039ITerminalTab\u203a {} Returns: IDockTab","title":"createTerminalTab"},{"location":"extensions/api/modules/_renderer_api_components_/#withtooltip","text":"\u25b8 withTooltip \u2039 T \u203a( Target : T): T Defined in src/renderer/components/tooltip/withTooltip.tsx:18 Type parameters: \u25aa T : React.ComponentType\u2039any\u203a Parameters: Name Type Target T Returns: T","title":"withTooltip"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/","text":"Module: \"renderer-api/k8s-api\" # Index # Enumerations # KubeObjectStatusLevel Classes # CRDResourceStore CRDStore ClusterRole ClusterRoleBinding ConfigMap ConfigMapsStore CronJob CronJobStore CustomResourceDefinition DaemonSet DaemonSetStore Deployment DeploymentApi DeploymentStore Endpoint EndpointStore EventStore HPAStore HorizontalPodAutoscaler Ingress IngressApi IngressStore Job JobStore KubeApi KubeEvent KubeObject KubeObjectStore Namespace NamespaceStore NetworkPolicy NetworkPolicyStore Node NodesApi NodesStore PersistentVolume PersistentVolumeClaim PersistentVolumeClaimsApi PersistentVolumesStore Pod PodDisruptionBudget PodDisruptionBudgetsStore PodsApi PodsStore ReplicaSet ReplicaSetStore ResourceQuota ResourceQuotasStore Role RoleBinding RoleBindingsStore RolesStore Secret SecretsStore Service ServiceAccount ServiceAccountsStore ServiceStore StatefulSet StatefulSetStore StorageClass StorageClassStore VolumeClaimStore Interfaces # IKubeApiCluster IPodContainer IPodContainerStatus ISecretRef Type aliases # KubeObjectStatus Variables # apiManager clusterRoleApi clusterRoleBindingApi configMapApi crdApi cronJobApi daemonSetApi deploymentApi endpointApi eventApi hpaApi ingressApi jobApi namespacesApi networkPolicyApi nodesApi pdbApi persistentVolumeApi podsApi pvcApi replicaSetApi resourceQuotaApi roleApi roleBindingApi secretsApi serviceAccountsApi serviceApi statefulSetApi storageClassApi Functions # forCluster isAllowedResource Type aliases # KubeObjectStatus # \u01ac KubeObjectStatus : object Defined in src/extensions/renderer-api/kube-object-status.ts:1 Type declaration: level : KubeObjectStatusLevel text : string timestamp ? : string Variables # Const apiManager # \u2022 apiManager : ApiManager\u2039\u203a = new ApiManager() Defined in src/renderer/api/api-manager.ts:54 Const clusterRoleApi # \u2022 clusterRoleApi : KubeApi \u2039 ClusterRole \u2039\u203a\u203a = new KubeApi({ objectConstructor: ClusterRole, }) Defined in src/renderer/api/endpoints/cluster-role.api.ts:12 Const clusterRoleBindingApi # \u2022 clusterRoleBindingApi : KubeApi \u2039 ClusterRoleBinding \u2039\u203a\u203a = new KubeApi({ objectConstructor: ClusterRoleBinding, }) Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:10 Const configMapApi # \u2022 configMapApi : KubeApi \u2039 ConfigMap \u2039\u203a\u203a = new KubeApi({ objectConstructor: ConfigMap, }) Defined in src/renderer/api/endpoints/configmap.api.ts:26 Const crdApi # \u2022 crdApi : KubeApi \u2039 CustomResourceDefinition \u2039\u203a\u203a = new KubeApi ({ objectConstructor: CustomResourceDefinition, checkPreferredVersion: true, }) Defined in src/renderer/api/endpoints/crd.api.ts:154 Const cronJobApi # \u2022 cronJobApi : KubeApi \u2039 CronJob \u2039\u203a\u203a = new KubeApi({ objectConstructor: CronJob, }) Defined in src/renderer/api/endpoints/cron-job.api.ts:95 Const daemonSetApi # \u2022 daemonSetApi : KubeApi \u2039 DaemonSet \u2039\u203a\u203a = new KubeApi({ objectConstructor: DaemonSet, }) Defined in src/renderer/api/endpoints/daemon-set.api.ts:74 Const deploymentApi # \u2022 deploymentApi : DeploymentApi \u2039\u203a = new DeploymentApi({ objectConstructor: Deployment, }) Defined in src/renderer/api/endpoints/deployment.api.ts:193 Const endpointApi # \u2022 endpointApi : KubeApi \u2039 Endpoint \u2039\u203a\u203a = new KubeApi({ objectConstructor: Endpoint, }) Defined in src/renderer/api/endpoints/endpoint.api.ts:127 Const eventApi # \u2022 eventApi : KubeApi \u2039 KubeEvent \u2039\u203a\u203a = new KubeApi({ objectConstructor: KubeEvent, }) Defined in src/renderer/api/endpoints/events.api.ts:59 Const hpaApi # \u2022 hpaApi : KubeApi \u2039 HorizontalPodAutoscaler \u2039\u203a\u203a = new KubeApi({ objectConstructor: HorizontalPodAutoscaler, }) Defined in src/renderer/api/endpoints/hpa.api.ts:143 Const ingressApi # \u2022 ingressApi : IngressApi \u2039\u203a = new IngressApi({ objectConstructor: Ingress, // Add fallback for Kubernetes <1.19 checkPreferredVersion: true, fallbackApiBases: [\"/apis/extensions/v1beta1/ingresses\"], logStuff: true } as any) Defined in src/renderer/api/endpoints/ingress.api.ts:177 Const jobApi # \u2022 jobApi : KubeApi \u2039 Job \u2039\u203a\u203a = new KubeApi({ objectConstructor: Job, }) Defined in src/renderer/api/endpoints/job.api.ts:110 Const namespacesApi # \u2022 namespacesApi : KubeApi \u2039 Namespace \u2039\u203a\u203a = new KubeApi({ objectConstructor: Namespace, }) Defined in src/renderer/api/endpoints/namespaces.api.ts:25 Const networkPolicyApi # \u2022 networkPolicyApi : KubeApi \u2039 NetworkPolicy \u2039\u203a\u203a = new KubeApi({ objectConstructor: NetworkPolicy, }) Defined in src/renderer/api/endpoints/network-policy.api.ts:71 Const nodesApi # \u2022 nodesApi : NodesApi \u2039\u203a = new NodesApi({ objectConstructor: Node, }) Defined in src/renderer/api/endpoints/nodes.api.ts:169 Const pdbApi # \u2022 pdbApi : KubeApi \u2039 PodDisruptionBudget \u2039\u203a\u203a = new KubeApi({ objectConstructor: PodDisruptionBudget, }) Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:47 Const persistentVolumeApi # \u2022 persistentVolumeApi : KubeApi \u2039 PersistentVolume \u2039\u203a\u203a = new KubeApi({ objectConstructor: PersistentVolume, }) Defined in src/renderer/api/endpoints/persistent-volume.api.ts:73 Const podsApi # \u2022 podsApi : PodsApi \u2039\u203a = new PodsApi({ objectConstructor: Pod, }) Defined in src/renderer/api/endpoints/pods.api.ts:459 Const pvcApi # \u2022 pvcApi : PersistentVolumeClaimsApi \u2039\u203a = new PersistentVolumeClaimsApi({ objectConstructor: PersistentVolumeClaim, }) Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:90 Const replicaSetApi # \u2022 replicaSetApi : KubeApi \u2039 ReplicaSet \u2039\u203a\u203a = new KubeApi({ objectConstructor: ReplicaSet, }) Defined in src/renderer/api/endpoints/replica-set.api.ts:56 Const resourceQuotaApi # \u2022 resourceQuotaApi : KubeApi \u2039 ResourceQuota \u2039\u203a\u203a = new KubeApi({ objectConstructor: ResourceQuota, }) Defined in src/renderer/api/endpoints/resource-quota.api.ts:66 Const roleApi # \u2022 roleApi : KubeApi \u2039 Role \u2039\u203a\u203a = new KubeApi({ objectConstructor: Role, }) Defined in src/renderer/api/endpoints/role.api.ts:21 Const roleBindingApi # \u2022 roleBindingApi : KubeApi \u2039 RoleBinding \u2039\u203a\u203a = new KubeApi({ objectConstructor: RoleBinding, }) Defined in src/renderer/api/endpoints/role-binding.api.ts:34 Const secretsApi # \u2022 secretsApi : KubeApi \u2039 Secret \u2039\u203a\u203a = new KubeApi({ objectConstructor: Secret, }) Defined in src/renderer/api/endpoints/secret.api.ts:48 Const serviceAccountsApi # \u2022 serviceAccountsApi : KubeApi \u2039 ServiceAccount \u2039\u203a\u203a = new KubeApi ({ objectConstructor: ServiceAccount, }) Defined in src/renderer/api/endpoints/service-accounts.api.ts:27 Const serviceApi # \u2022 serviceApi : KubeApi \u2039 Service \u2039\u203a\u203a = new KubeApi({ objectConstructor: Service, }) Defined in src/renderer/api/endpoints/service.api.ts:101 Const statefulSetApi # \u2022 statefulSetApi : StatefulSetApi\u2039\u203a = new StatefulSetApi({ objectConstructor: StatefulSet, }) Defined in src/renderer/api/endpoints/stateful-set.api.ts:110 Const storageClassApi # \u2022 storageClassApi : KubeApi \u2039 StorageClass \u2039\u203a\u203a = new KubeApi({ objectConstructor: StorageClass, }) Defined in src/renderer/api/endpoints/storage-class.api.ts:37 Functions # forCluster # \u25b8 forCluster \u2039 T \u203a( cluster : IKubeApiCluster , kubeClass : IKubeObjectConstructor\u2039T\u203a): KubeApi \u2039T\u203a Defined in src/renderer/api/kube-api.ts:66 Type parameters: \u25aa T : KubeObject Parameters: Name Type cluster IKubeApiCluster kubeClass IKubeObjectConstructor\u2039T\u203a Returns: KubeApi \u2039T\u203a isAllowedResource # \u25b8 isAllowedResource ( resources : KubeResource | KubeResource[]): boolean Defined in src/common/rbac.ts:40 Parameters: Name Type resources KubeResource | KubeResource[] Returns: boolean","title":"Module: \"renderer-api/k8s-api\""},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#module-renderer-apik8s-api","text":"","title":"Module: \"renderer-api/k8s-api\""},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#index","text":"","title":"Index"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#enumerations","text":"KubeObjectStatusLevel","title":"Enumerations"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#classes","text":"CRDResourceStore CRDStore ClusterRole ClusterRoleBinding ConfigMap ConfigMapsStore CronJob CronJobStore CustomResourceDefinition DaemonSet DaemonSetStore Deployment DeploymentApi DeploymentStore Endpoint EndpointStore EventStore HPAStore HorizontalPodAutoscaler Ingress IngressApi IngressStore Job JobStore KubeApi KubeEvent KubeObject KubeObjectStore Namespace NamespaceStore NetworkPolicy NetworkPolicyStore Node NodesApi NodesStore PersistentVolume PersistentVolumeClaim PersistentVolumeClaimsApi PersistentVolumesStore Pod PodDisruptionBudget PodDisruptionBudgetsStore PodsApi PodsStore ReplicaSet ReplicaSetStore ResourceQuota ResourceQuotasStore Role RoleBinding RoleBindingsStore RolesStore Secret SecretsStore Service ServiceAccount ServiceAccountsStore ServiceStore StatefulSet StatefulSetStore StorageClass StorageClassStore VolumeClaimStore","title":"Classes"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#interfaces","text":"IKubeApiCluster IPodContainer IPodContainerStatus ISecretRef","title":"Interfaces"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#type-aliases","text":"KubeObjectStatus","title":"Type aliases"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#variables","text":"apiManager clusterRoleApi clusterRoleBindingApi configMapApi crdApi cronJobApi daemonSetApi deploymentApi endpointApi eventApi hpaApi ingressApi jobApi namespacesApi networkPolicyApi nodesApi pdbApi persistentVolumeApi podsApi pvcApi replicaSetApi resourceQuotaApi roleApi roleBindingApi secretsApi serviceAccountsApi serviceApi statefulSetApi storageClassApi","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#functions","text":"forCluster isAllowedResource","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#type-aliases_1","text":"","title":"Type aliases"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#kubeobjectstatus","text":"\u01ac KubeObjectStatus : object Defined in src/extensions/renderer-api/kube-object-status.ts:1","title":"KubeObjectStatus"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#variables_1","text":"","title":"Variables"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-apimanager","text":"\u2022 apiManager : ApiManager\u2039\u203a = new ApiManager() Defined in src/renderer/api/api-manager.ts:54","title":"Const apiManager"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-clusterroleapi","text":"\u2022 clusterRoleApi : KubeApi \u2039 ClusterRole \u2039\u203a\u203a = new KubeApi({ objectConstructor: ClusterRole, }) Defined in src/renderer/api/endpoints/cluster-role.api.ts:12","title":"Const clusterRoleApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-clusterrolebindingapi","text":"\u2022 clusterRoleBindingApi : KubeApi \u2039 ClusterRoleBinding \u2039\u203a\u203a = new KubeApi({ objectConstructor: ClusterRoleBinding, }) Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:10","title":"Const clusterRoleBindingApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-configmapapi","text":"\u2022 configMapApi : KubeApi \u2039 ConfigMap \u2039\u203a\u203a = new KubeApi({ objectConstructor: ConfigMap, }) Defined in src/renderer/api/endpoints/configmap.api.ts:26","title":"Const configMapApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-crdapi","text":"\u2022 crdApi : KubeApi \u2039 CustomResourceDefinition \u2039\u203a\u203a = new KubeApi ({ objectConstructor: CustomResourceDefinition, checkPreferredVersion: true, }) Defined in src/renderer/api/endpoints/crd.api.ts:154","title":"Const crdApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-cronjobapi","text":"\u2022 cronJobApi : KubeApi \u2039 CronJob \u2039\u203a\u203a = new KubeApi({ objectConstructor: CronJob, }) Defined in src/renderer/api/endpoints/cron-job.api.ts:95","title":"Const cronJobApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-daemonsetapi","text":"\u2022 daemonSetApi : KubeApi \u2039 DaemonSet \u2039\u203a\u203a = new KubeApi({ objectConstructor: DaemonSet, }) Defined in src/renderer/api/endpoints/daemon-set.api.ts:74","title":"Const daemonSetApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-deploymentapi","text":"\u2022 deploymentApi : DeploymentApi \u2039\u203a = new DeploymentApi({ objectConstructor: Deployment, }) Defined in src/renderer/api/endpoints/deployment.api.ts:193","title":"Const deploymentApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-endpointapi","text":"\u2022 endpointApi : KubeApi \u2039 Endpoint \u2039\u203a\u203a = new KubeApi({ objectConstructor: Endpoint, }) Defined in src/renderer/api/endpoints/endpoint.api.ts:127","title":"Const endpointApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-eventapi","text":"\u2022 eventApi : KubeApi \u2039 KubeEvent \u2039\u203a\u203a = new KubeApi({ objectConstructor: KubeEvent, }) Defined in src/renderer/api/endpoints/events.api.ts:59","title":"Const eventApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-hpaapi","text":"\u2022 hpaApi : KubeApi \u2039 HorizontalPodAutoscaler \u2039\u203a\u203a = new KubeApi({ objectConstructor: HorizontalPodAutoscaler, }) Defined in src/renderer/api/endpoints/hpa.api.ts:143","title":"Const hpaApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-ingressapi","text":"\u2022 ingressApi : IngressApi \u2039\u203a = new IngressApi({ objectConstructor: Ingress, // Add fallback for Kubernetes <1.19 checkPreferredVersion: true, fallbackApiBases: [\"/apis/extensions/v1beta1/ingresses\"], logStuff: true } as any) Defined in src/renderer/api/endpoints/ingress.api.ts:177","title":"Const ingressApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-jobapi","text":"\u2022 jobApi : KubeApi \u2039 Job \u2039\u203a\u203a = new KubeApi({ objectConstructor: Job, }) Defined in src/renderer/api/endpoints/job.api.ts:110","title":"Const jobApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-namespacesapi","text":"\u2022 namespacesApi : KubeApi \u2039 Namespace \u2039\u203a\u203a = new KubeApi({ objectConstructor: Namespace, }) Defined in src/renderer/api/endpoints/namespaces.api.ts:25","title":"Const namespacesApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-networkpolicyapi","text":"\u2022 networkPolicyApi : KubeApi \u2039 NetworkPolicy \u2039\u203a\u203a = new KubeApi({ objectConstructor: NetworkPolicy, }) Defined in src/renderer/api/endpoints/network-policy.api.ts:71","title":"Const networkPolicyApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-nodesapi","text":"\u2022 nodesApi : NodesApi \u2039\u203a = new NodesApi({ objectConstructor: Node, }) Defined in src/renderer/api/endpoints/nodes.api.ts:169","title":"Const nodesApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-pdbapi","text":"\u2022 pdbApi : KubeApi \u2039 PodDisruptionBudget \u2039\u203a\u203a = new KubeApi({ objectConstructor: PodDisruptionBudget, }) Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:47","title":"Const pdbApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-persistentvolumeapi","text":"\u2022 persistentVolumeApi : KubeApi \u2039 PersistentVolume \u2039\u203a\u203a = new KubeApi({ objectConstructor: PersistentVolume, }) Defined in src/renderer/api/endpoints/persistent-volume.api.ts:73","title":"Const persistentVolumeApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-podsapi","text":"\u2022 podsApi : PodsApi \u2039\u203a = new PodsApi({ objectConstructor: Pod, }) Defined in src/renderer/api/endpoints/pods.api.ts:459","title":"Const podsApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-pvcapi","text":"\u2022 pvcApi : PersistentVolumeClaimsApi \u2039\u203a = new PersistentVolumeClaimsApi({ objectConstructor: PersistentVolumeClaim, }) Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:90","title":"Const pvcApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-replicasetapi","text":"\u2022 replicaSetApi : KubeApi \u2039 ReplicaSet \u2039\u203a\u203a = new KubeApi({ objectConstructor: ReplicaSet, }) Defined in src/renderer/api/endpoints/replica-set.api.ts:56","title":"Const replicaSetApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-resourcequotaapi","text":"\u2022 resourceQuotaApi : KubeApi \u2039 ResourceQuota \u2039\u203a\u203a = new KubeApi({ objectConstructor: ResourceQuota, }) Defined in src/renderer/api/endpoints/resource-quota.api.ts:66","title":"Const resourceQuotaApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-roleapi","text":"\u2022 roleApi : KubeApi \u2039 Role \u2039\u203a\u203a = new KubeApi({ objectConstructor: Role, }) Defined in src/renderer/api/endpoints/role.api.ts:21","title":"Const roleApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-rolebindingapi","text":"\u2022 roleBindingApi : KubeApi \u2039 RoleBinding \u2039\u203a\u203a = new KubeApi({ objectConstructor: RoleBinding, }) Defined in src/renderer/api/endpoints/role-binding.api.ts:34","title":"Const roleBindingApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-secretsapi","text":"\u2022 secretsApi : KubeApi \u2039 Secret \u2039\u203a\u203a = new KubeApi({ objectConstructor: Secret, }) Defined in src/renderer/api/endpoints/secret.api.ts:48","title":"Const secretsApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-serviceaccountsapi","text":"\u2022 serviceAccountsApi : KubeApi \u2039 ServiceAccount \u2039\u203a\u203a = new KubeApi ({ objectConstructor: ServiceAccount, }) Defined in src/renderer/api/endpoints/service-accounts.api.ts:27","title":"Const serviceAccountsApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-serviceapi","text":"\u2022 serviceApi : KubeApi \u2039 Service \u2039\u203a\u203a = new KubeApi({ objectConstructor: Service, }) Defined in src/renderer/api/endpoints/service.api.ts:101","title":"Const serviceApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-statefulsetapi","text":"\u2022 statefulSetApi : StatefulSetApi\u2039\u203a = new StatefulSetApi({ objectConstructor: StatefulSet, }) Defined in src/renderer/api/endpoints/stateful-set.api.ts:110","title":"Const statefulSetApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#const-storageclassapi","text":"\u2022 storageClassApi : KubeApi \u2039 StorageClass \u2039\u203a\u203a = new KubeApi({ objectConstructor: StorageClass, }) Defined in src/renderer/api/endpoints/storage-class.api.ts:37","title":"Const storageClassApi"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#forcluster","text":"\u25b8 forCluster \u2039 T \u203a( cluster : IKubeApiCluster , kubeClass : IKubeObjectConstructor\u2039T\u203a): KubeApi \u2039T\u203a Defined in src/renderer/api/kube-api.ts:66 Type parameters: \u25aa T : KubeObject Parameters: Name Type cluster IKubeApiCluster kubeClass IKubeObjectConstructor\u2039T\u203a Returns: KubeApi \u2039T\u203a","title":"forCluster"},{"location":"extensions/api/modules/_renderer_api_k8s_api_/#isallowedresource","text":"\u25b8 isAllowedResource ( resources : KubeResource | KubeResource[]): boolean Defined in src/common/rbac.ts:40 Parameters: Name Type resources KubeResource | KubeResource[] Returns: boolean","title":"isAllowedResource"},{"location":"extensions/api/modules/_renderer_api_navigation_/","text":"Module: \"renderer-api/navigation\" # Index # Interfaces # IURLParams Functions # getDetailsUrl hideDetails navigate showDetails Functions # getDetailsUrl # \u25b8 getDetailsUrl ( details : string): string Defined in src/renderer/navigation.ts:71 Parameters: Name Type details string Returns: string hideDetails # \u25b8 hideDetails (): void Defined in src/renderer/navigation.ts:93 Hide details. Works only in renderer. Returns: void navigate # \u25b8 navigate ( location : LocationDescriptor): void Defined in src/renderer/navigation.ts:17 Navigate to a location. Works only in renderer. Parameters: Name Type location LocationDescriptor Returns: void showDetails # \u25b8 showDetails ( path : string, resetSelected : boolean): void Defined in src/renderer/navigation.ts:83 Show details. Works only in renderer. Parameters: Name Type Default path string - resetSelected boolean true Returns: void","title":"Module: \"renderer-api/navigation\""},{"location":"extensions/api/modules/_renderer_api_navigation_/#module-renderer-apinavigation","text":"","title":"Module: \"renderer-api/navigation\""},{"location":"extensions/api/modules/_renderer_api_navigation_/#index","text":"","title":"Index"},{"location":"extensions/api/modules/_renderer_api_navigation_/#interfaces","text":"IURLParams","title":"Interfaces"},{"location":"extensions/api/modules/_renderer_api_navigation_/#functions","text":"getDetailsUrl hideDetails navigate showDetails","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_navigation_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_navigation_/#getdetailsurl","text":"\u25b8 getDetailsUrl ( details : string): string Defined in src/renderer/navigation.ts:71 Parameters: Name Type details string Returns: string","title":"getDetailsUrl"},{"location":"extensions/api/modules/_renderer_api_navigation_/#hidedetails","text":"\u25b8 hideDetails (): void Defined in src/renderer/navigation.ts:93 Hide details. Works only in renderer. Returns: void","title":"hideDetails"},{"location":"extensions/api/modules/_renderer_api_navigation_/#navigate","text":"\u25b8 navigate ( location : LocationDescriptor): void Defined in src/renderer/navigation.ts:17 Navigate to a location. Works only in renderer. Parameters: Name Type location LocationDescriptor Returns: void","title":"navigate"},{"location":"extensions/api/modules/_renderer_api_navigation_/#showdetails","text":"\u25b8 showDetails ( path : string, resetSelected : boolean): void Defined in src/renderer/navigation.ts:83 Show details. Works only in renderer. Parameters: Name Type Default path string - resetSelected boolean true Returns: void","title":"showDetails"},{"location":"extensions/api/modules/_renderer_api_theming_/","text":"Module: \"renderer-api/theming\" # Index # Functions # getActiveTheme Functions # getActiveTheme # \u25b8 getActiveTheme (): Theme Defined in src/extensions/renderer-api/theming.ts:3 Returns: Theme","title":"Module: \"renderer-api/theming\""},{"location":"extensions/api/modules/_renderer_api_theming_/#module-renderer-apitheming","text":"","title":"Module: \"renderer-api/theming\""},{"location":"extensions/api/modules/_renderer_api_theming_/#index","text":"","title":"Index"},{"location":"extensions/api/modules/_renderer_api_theming_/#functions","text":"getActiveTheme","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_theming_/#functions_1","text":"","title":"Functions"},{"location":"extensions/api/modules/_renderer_api_theming_/#getactivetheme","text":"\u25b8 getActiveTheme (): Theme Defined in src/extensions/renderer-api/theming.ts:3 Returns: Theme","title":"getActiveTheme"},{"location":"extensions/capabilities/","text":"","title":"Index"},{"location":"extensions/capabilities/color-reference/","text":"Theme Color Reference # You can use theme-based CSS Variables to style an extension according to the active theme. Base Colors # --blue : blue color. --magenta : magenta color. --golden : gold/yellow color. --halfGray : gray with some apacity applied. --primary : Lens brand (blue) color. --colorSuccess : successfull operations color. --colorOk : successfull operations (bright version) color. --colorInfo : informational, in-progress color. --colorError : critical error color. --colorSoftError : error color. --colorWarning : warning color. --colorVague : soft gray color for notices, hints etc. --colorTerminated : terminated, closed, stale color. --boxShadow : semi-transparent box-shadow color. Text Colors # --textColorPrimary : foreground text color. --textColorSecondary : foreground text color for different paragraps, parts of text. --textColorAccent : foreground text color to highlight its parts. Border Colors # --borderColor : border color. --borderFaintColor : fainted (lighter or darker, which depends on the theme) border color. Layout Colors # --mainBackground : main background color for the app. --contentColor : background color for panels contains some data. --layoutBackground : background color for layout parts. --layoutTabsBackground : background color for general tabs. --layoutTabsActiveColor : foreground color for general tabs. --layoutTabsLineColor : background color for lines under general tabs. Sidebar Colors # --sidebarLogoBackground : background color behind logo in sidebar. --sidebarActiveColor : foreground color for active menu items in sidebar. --sidebarSubmenuActiveColor : foreground color for active submenu items in sidebar. --sidebarBackground : background color for sidebar. Button Colors # --buttonPrimaryBackground : button background color for primary actions. --buttonDefaultBackground : default button background color. --buttonAccentBackground : accent button background color. --buttonDisabledBackground : disabled button background color. Table Colors # --tableBgcStripe : background color for odd rows in table. --tableBgcSelected : background color for selected row in table. --tableHeaderBackground : background color for table header. --tableHeaderBorderWidth : border width under table header. --tableHeaderBorderColor : border color for line under table header. --tableHeaderColor : foreground color for table header. --tableSelectedRowColor : foreground color for selected row in table. Dock Colors # --dockHeadBackground : background color for dock's header. --dockInfoBackground : background color for dock's info panel. --dockInfoBorderColor : border color for dock's info panel. Helm Chart Colors # --helmLogoBackground : background color for chart logo. --helmImgBackground : background color for chart image. --helmStableRepo : background color for stable repo. --helmIncubatorRepo : background color for incubator repo. --helmDescriptionHr : Helm chart description separator line color. --helmDescriptionBlockqouteColor : Helm chart description blockquote color. --helmDescriptionBlockqouteBorder : Helm chart description blockquote border color. --helmDescriptionBlockquoteBackground : Helm chart description blockquote background color. --helmDescriptionHeaders : Helm chart description headers color. --helmDescriptionH6 : Helm chart description header foreground color. --helmDescriptionTdBorder : Helm chart description table cell border color. --helmDescriptionTrBackground : Helm chart description table row background color. --helmDescriptionCodeBackground : Helm chart description code background color. --helmDescriptionPreBackground : Helm chart description pre background color. --helmDescriptionPreColor : Helm chart description pre foreground color. Terminal Colors # --terminalBackground : Terminal background color. --terminalForeground : Terminal foreground color. --terminalCursor : Terminal cursor color. --terminalCursorAccent : Terminal cursor accent color. --terminalSelection : Terminal selection background color. --terminalBlack : Terminal black color. --terminalRed : Terminal red color. --terminalGreen : Terminal green color. --terminalYellow : Terminal yellow color. --terminalBlue : Terminal blue color. --terminalMagenta : Terminal magenta color. --terminalCyan : Terminal cyan color. --terminalWhite : Terminal white color. --terminalBrightBlack : Terminal bright black color. --terminalBrightRed : Terminal bright red color. --terminalBrightGreen : Terminal bright green color. --terminalBrightYellow : Terminal bright yellow color. --terminalBrightBlue : Terminal bright blue color. --terminalBrightMagenta : Terminal bright magenta color. --terminalBrightCyan : Terminal bright cyan color. --terminalBrightWhite : Terminal bright white color. Dialog Colors # --dialogHeaderBackground : background color for dialog header. --dialogFooterBackground : background color for dialog footer. Detail Panel (Drawer) Colors # --drawerTitleText : drawer title foreground color. --drawerSubtitleBackground : drawer subtitle foreground color. --drawerItemNameColor : foreground color for item name in drawer. --drawerItemValueColor : foreground color for item value in drawer. Misc Colors # --logsBackground : background color for pod logs. --clusterMenuBackground : background color for cluster menu. --clusterMenuBorderColor : border color for cluster menu. --clusterSettingsBackground : background color for cluster settings. --addClusterIconColor : add cluster button background color. --iconActiveColor : active cluster icon foreground color. --iconActiveBackground : active cluster icon background color. --filterAreaBackground : page filter area (where selected namespaces are lister) background color. --chartStripesColor : bar chart zebra stripes background color. --chartCapacityColor : background color for capacity values in bar charts. --pieChartDefaultColor : default background color for pie chart values. --selectOptionHoveredColor : foregrond color for selected element in dropdown list. --lineProgressBackground : background color for progress line. --radioActiveBackground : background color for active radio buttons. --menuActiveBackground : background color for active menu items. In most cases you would only need base, text and some of the layout colors.","title":"Color Reference"},{"location":"extensions/capabilities/color-reference/#theme-color-reference","text":"You can use theme-based CSS Variables to style an extension according to the active theme.","title":"Theme Color Reference"},{"location":"extensions/capabilities/color-reference/#base-colors","text":"--blue : blue color. --magenta : magenta color. --golden : gold/yellow color. --halfGray : gray with some apacity applied. --primary : Lens brand (blue) color. --colorSuccess : successfull operations color. --colorOk : successfull operations (bright version) color. --colorInfo : informational, in-progress color. --colorError : critical error color. --colorSoftError : error color. --colorWarning : warning color. --colorVague : soft gray color for notices, hints etc. --colorTerminated : terminated, closed, stale color. --boxShadow : semi-transparent box-shadow color.","title":"Base Colors"},{"location":"extensions/capabilities/color-reference/#text-colors","text":"--textColorPrimary : foreground text color. --textColorSecondary : foreground text color for different paragraps, parts of text. --textColorAccent : foreground text color to highlight its parts.","title":"Text Colors"},{"location":"extensions/capabilities/color-reference/#border-colors","text":"--borderColor : border color. --borderFaintColor : fainted (lighter or darker, which depends on the theme) border color.","title":"Border Colors"},{"location":"extensions/capabilities/color-reference/#layout-colors","text":"--mainBackground : main background color for the app. --contentColor : background color for panels contains some data. --layoutBackground : background color for layout parts. --layoutTabsBackground : background color for general tabs. --layoutTabsActiveColor : foreground color for general tabs. --layoutTabsLineColor : background color for lines under general tabs.","title":"Layout Colors"},{"location":"extensions/capabilities/color-reference/#sidebar-colors","text":"--sidebarLogoBackground : background color behind logo in sidebar. --sidebarActiveColor : foreground color for active menu items in sidebar. --sidebarSubmenuActiveColor : foreground color for active submenu items in sidebar. --sidebarBackground : background color for sidebar.","title":"Sidebar Colors"},{"location":"extensions/capabilities/color-reference/#button-colors","text":"--buttonPrimaryBackground : button background color for primary actions. --buttonDefaultBackground : default button background color. --buttonAccentBackground : accent button background color. --buttonDisabledBackground : disabled button background color.","title":"Button Colors"},{"location":"extensions/capabilities/color-reference/#table-colors","text":"--tableBgcStripe : background color for odd rows in table. --tableBgcSelected : background color for selected row in table. --tableHeaderBackground : background color for table header. --tableHeaderBorderWidth : border width under table header. --tableHeaderBorderColor : border color for line under table header. --tableHeaderColor : foreground color for table header. --tableSelectedRowColor : foreground color for selected row in table.","title":"Table Colors"},{"location":"extensions/capabilities/color-reference/#dock-colors","text":"--dockHeadBackground : background color for dock's header. --dockInfoBackground : background color for dock's info panel. --dockInfoBorderColor : border color for dock's info panel.","title":"Dock Colors"},{"location":"extensions/capabilities/color-reference/#helm-chart-colors","text":"--helmLogoBackground : background color for chart logo. --helmImgBackground : background color for chart image. --helmStableRepo : background color for stable repo. --helmIncubatorRepo : background color for incubator repo. --helmDescriptionHr : Helm chart description separator line color. --helmDescriptionBlockqouteColor : Helm chart description blockquote color. --helmDescriptionBlockqouteBorder : Helm chart description blockquote border color. --helmDescriptionBlockquoteBackground : Helm chart description blockquote background color. --helmDescriptionHeaders : Helm chart description headers color. --helmDescriptionH6 : Helm chart description header foreground color. --helmDescriptionTdBorder : Helm chart description table cell border color. --helmDescriptionTrBackground : Helm chart description table row background color. --helmDescriptionCodeBackground : Helm chart description code background color. --helmDescriptionPreBackground : Helm chart description pre background color. --helmDescriptionPreColor : Helm chart description pre foreground color.","title":"Helm Chart Colors"},{"location":"extensions/capabilities/color-reference/#terminal-colors","text":"--terminalBackground : Terminal background color. --terminalForeground : Terminal foreground color. --terminalCursor : Terminal cursor color. --terminalCursorAccent : Terminal cursor accent color. --terminalSelection : Terminal selection background color. --terminalBlack : Terminal black color. --terminalRed : Terminal red color. --terminalGreen : Terminal green color. --terminalYellow : Terminal yellow color. --terminalBlue : Terminal blue color. --terminalMagenta : Terminal magenta color. --terminalCyan : Terminal cyan color. --terminalWhite : Terminal white color. --terminalBrightBlack : Terminal bright black color. --terminalBrightRed : Terminal bright red color. --terminalBrightGreen : Terminal bright green color. --terminalBrightYellow : Terminal bright yellow color. --terminalBrightBlue : Terminal bright blue color. --terminalBrightMagenta : Terminal bright magenta color. --terminalBrightCyan : Terminal bright cyan color. --terminalBrightWhite : Terminal bright white color.","title":"Terminal Colors"},{"location":"extensions/capabilities/color-reference/#dialog-colors","text":"--dialogHeaderBackground : background color for dialog header. --dialogFooterBackground : background color for dialog footer.","title":"Dialog Colors"},{"location":"extensions/capabilities/color-reference/#detail-panel-drawer-colors","text":"--drawerTitleText : drawer title foreground color. --drawerSubtitleBackground : drawer subtitle foreground color. --drawerItemNameColor : foreground color for item name in drawer. --drawerItemValueColor : foreground color for item value in drawer.","title":"Detail Panel (Drawer) Colors"},{"location":"extensions/capabilities/color-reference/#misc-colors","text":"--logsBackground : background color for pod logs. --clusterMenuBackground : background color for cluster menu. --clusterMenuBorderColor : border color for cluster menu. --clusterSettingsBackground : background color for cluster settings. --addClusterIconColor : add cluster button background color. --iconActiveColor : active cluster icon foreground color. --iconActiveBackground : active cluster icon background color. --filterAreaBackground : page filter area (where selected namespaces are lister) background color. --chartStripesColor : bar chart zebra stripes background color. --chartCapacityColor : background color for capacity values in bar charts. --pieChartDefaultColor : default background color for pie chart values. --selectOptionHoveredColor : foregrond color for selected element in dropdown list. --lineProgressBackground : background color for progress line. --radioActiveBackground : background color for active radio buttons. --menuActiveBackground : background color for active menu items. In most cases you would only need base, text and some of the layout colors.","title":"Misc Colors"},{"location":"extensions/capabilities/common-capabilities/","text":"Common Capabilities # Here we will discuss common and important building blocks for your extensions, and explain how you can use them. Almost all extensions use some of these functionalities. Main Extension # The main extension runs in the background. It adds app menu items to the Lens UI. In order to see logs from this extension, you need to start Lens from the command line. Activate # This extension can register a custom callback that is executed when an extension is activated (started). import { LensMainExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { async onActivate () { console . log ( \"hello world\" ) } } Deactivate # This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { LensMainExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { async onDeactivate () { console . log ( \"bye bye\" ) } } App Menus # This extension can register custom app menus that will be displayed on OS native menus. Example: import { LensMainExtension , windowManager } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { appMenus = [ { parentId : \"help\" , label : \"Example item\" , click() { windowManager . navigate ( \"https://k8slens.dev\" ); } } ] } Renderer Extension # The renderer extension runs in a browser context, and is visible in Lens's main window. In order to see logs from this extension you need to check them via View > Toggle Developer Tools > Console . Activate # This extension can register a custom callback that is executed when an extension is activated (started). import { LensRendererExtension } from \"@k8slens/extensions\" export default class ExampleExtension extends LensRendererExtension { async onActivate () { console . log ( \"hello world\" ) } } Deactivate # This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { LensRendererExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensRendererExtension { async onDeactivate () { console . log ( \"bye bye\" ) } } Global Pages # This extension can register custom global pages (views) to Lens's main window. The global page is a full-screen page that hides all other content from a window. import React from \"react\" import { Component , LensRendererExtension } from \"@k8slens/extensions\" import { ExamplePage } from \"./src/example-page\" export default class ExampleRendererExtension extends LensRendererExtension { globalPages = [ { id : \"example\" , components : { Page : ExamplePage , } } ] globalPageMenus = [ { title : \"Example page\" , // used in icon's tooltip target : { pageId : \"example\" } components : { Icon : () => < Component . Icon material = \"arrow\" /> , } } ] } App Preferences # This extension can register custom app preferences. It is responsible for storing a state for custom preferences. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" import { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\" import { MyCustomPreferenceHint , MyCustomPreferenceInput } from \"./src/my-custom-preference\" export default class ExampleRendererExtension extends LensRendererExtension { appPreferences = [ { title : \"My Custom Preference\" , components : { Hint : () => < MyCustomPreferenceHint /> , Input : () => < MyCustomPreferenceInput store = { myCustomPreferencesStore } /> } } ] } Cluster Pages # This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./src/page\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"extension-example\" , // optional exact : true , // optional components : { Page : () => < ExamplePage extension = { this } /> , } } ] clusterPageMenus = [ { url : \"/extension-example\" , // optional title : \"Example Extension\" , components : { Icon : ExampleIcon , } } ] } Cluster Features # This extension can register installable features for a cluster. These features are visible in the \"Cluster Settings\" page. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" import { MyCustomFeature } from \"./src/my-custom-feature\" export default class ExampleExtension extends LensRendererExtension { clusterFeatures = [ { title : \"My Custom Feature\" , components : { Description : () => { return ( < span > Just an example . < /span> ) } }, feature : new MyCustomFeature () } ] } Status Bar Items # This extension can register custom icons and text to a status bar area. import React from \"react\" ; import { Component , LensRendererExtension , Navigation } from \"@k8slens/extensions\" ; export default class ExampleExtension extends LensRendererExtension { statusBarItems = [ { item : ( < div className = \"flex align-center gaps hover-highlight\" onClick = {() => this . navigate ( \"/example-page\" )} > < Component . Icon material = \"favorite\" /> < /div> ) } ] } Kubernetes Object Menu Items # This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { CustomMenuItem , CustomMenuItemProps } from \"./src/custom-menu-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectMenuItems = [ { kind : \"Node\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : CustomMenuItemProps ) => < CustomMenuItem {... props } /> } } ] } Kubernetes Object Details # This extension can register custom details (content) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { CustomKindDetails , CustomKindDetailsProps } from \"./src/custom-kind-details\" export default class ExampleExtension extends LensRendererExtension { kubeObjectDetailItems = [ { kind : \"CustomKind\" , apiVersions : [ \"custom.acme.org/v1\" ], components : { Details : ( props : CustomKindDetailsProps ) => < CustomKindDetails {... props } /> } } ] }","title":"Common Capabilities"},{"location":"extensions/capabilities/common-capabilities/#common-capabilities","text":"Here we will discuss common and important building blocks for your extensions, and explain how you can use them. Almost all extensions use some of these functionalities.","title":"Common Capabilities"},{"location":"extensions/capabilities/common-capabilities/#main-extension","text":"The main extension runs in the background. It adds app menu items to the Lens UI. In order to see logs from this extension, you need to start Lens from the command line.","title":"Main Extension"},{"location":"extensions/capabilities/common-capabilities/#activate","text":"This extension can register a custom callback that is executed when an extension is activated (started). import { LensMainExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { async onActivate () { console . log ( \"hello world\" ) } }","title":"Activate"},{"location":"extensions/capabilities/common-capabilities/#deactivate","text":"This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { LensMainExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { async onDeactivate () { console . log ( \"bye bye\" ) } }","title":"Deactivate"},{"location":"extensions/capabilities/common-capabilities/#app-menus","text":"This extension can register custom app menus that will be displayed on OS native menus. Example: import { LensMainExtension , windowManager } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensMainExtension { appMenus = [ { parentId : \"help\" , label : \"Example item\" , click() { windowManager . navigate ( \"https://k8slens.dev\" ); } } ] }","title":"App Menus"},{"location":"extensions/capabilities/common-capabilities/#renderer-extension","text":"The renderer extension runs in a browser context, and is visible in Lens's main window. In order to see logs from this extension you need to check them via View > Toggle Developer Tools > Console .","title":"Renderer Extension"},{"location":"extensions/capabilities/common-capabilities/#activate_1","text":"This extension can register a custom callback that is executed when an extension is activated (started). import { LensRendererExtension } from \"@k8slens/extensions\" export default class ExampleExtension extends LensRendererExtension { async onActivate () { console . log ( \"hello world\" ) } }","title":"Activate"},{"location":"extensions/capabilities/common-capabilities/#deactivate_1","text":"This extension can register a custom callback that is executed when an extension is deactivated (stopped). import { LensRendererExtension } from \"@k8slens/extensions\" export default class ExampleMainExtension extends LensRendererExtension { async onDeactivate () { console . log ( \"bye bye\" ) } }","title":"Deactivate"},{"location":"extensions/capabilities/common-capabilities/#global-pages","text":"This extension can register custom global pages (views) to Lens's main window. The global page is a full-screen page that hides all other content from a window. import React from \"react\" import { Component , LensRendererExtension } from \"@k8slens/extensions\" import { ExamplePage } from \"./src/example-page\" export default class ExampleRendererExtension extends LensRendererExtension { globalPages = [ { id : \"example\" , components : { Page : ExamplePage , } } ] globalPageMenus = [ { title : \"Example page\" , // used in icon's tooltip target : { pageId : \"example\" } components : { Icon : () => < Component . Icon material = \"arrow\" /> , } } ] }","title":"Global Pages"},{"location":"extensions/capabilities/common-capabilities/#app-preferences","text":"This extension can register custom app preferences. It is responsible for storing a state for custom preferences. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" import { myCustomPreferencesStore } from \"./src/my-custom-preferences-store\" import { MyCustomPreferenceHint , MyCustomPreferenceInput } from \"./src/my-custom-preference\" export default class ExampleRendererExtension extends LensRendererExtension { appPreferences = [ { title : \"My Custom Preference\" , components : { Hint : () => < MyCustomPreferenceHint /> , Input : () => < MyCustomPreferenceInput store = { myCustomPreferencesStore } /> } } ] }","title":"App Preferences"},{"location":"extensions/capabilities/common-capabilities/#cluster-pages","text":"This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./src/page\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"extension-example\" , // optional exact : true , // optional components : { Page : () => < ExamplePage extension = { this } /> , } } ] clusterPageMenus = [ { url : \"/extension-example\" , // optional title : \"Example Extension\" , components : { Icon : ExampleIcon , } } ] }","title":"Cluster Pages"},{"location":"extensions/capabilities/common-capabilities/#cluster-features","text":"This extension can register installable features for a cluster. These features are visible in the \"Cluster Settings\" page. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" import { MyCustomFeature } from \"./src/my-custom-feature\" export default class ExampleExtension extends LensRendererExtension { clusterFeatures = [ { title : \"My Custom Feature\" , components : { Description : () => { return ( < span > Just an example . < /span> ) } }, feature : new MyCustomFeature () } ] }","title":"Cluster Features"},{"location":"extensions/capabilities/common-capabilities/#status-bar-items","text":"This extension can register custom icons and text to a status bar area. import React from \"react\" ; import { Component , LensRendererExtension , Navigation } from \"@k8slens/extensions\" ; export default class ExampleExtension extends LensRendererExtension { statusBarItems = [ { item : ( < div className = \"flex align-center gaps hover-highlight\" onClick = {() => this . navigate ( \"/example-page\" )} > < Component . Icon material = \"favorite\" /> < /div> ) } ] }","title":"Status Bar Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-menu-items","text":"This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { CustomMenuItem , CustomMenuItemProps } from \"./src/custom-menu-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectMenuItems = [ { kind : \"Node\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : CustomMenuItemProps ) => < CustomMenuItem {... props } /> } } ] }","title":"Kubernetes Object Menu Items"},{"location":"extensions/capabilities/common-capabilities/#kubernetes-object-details","text":"This extension can register custom details (content) for specified Kubernetes kinds/apiVersions. import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { CustomKindDetails , CustomKindDetailsProps } from \"./src/custom-kind-details\" export default class ExampleExtension extends LensRendererExtension { kubeObjectDetailItems = [ { kind : \"CustomKind\" , apiVersions : [ \"custom.acme.org/v1\" ], components : { Details : ( props : CustomKindDetailsProps ) => < CustomKindDetails {... props } /> } } ] }","title":"Kubernetes Object Details"},{"location":"extensions/capabilities/styling/","text":"Styling an Extension # Lens provides a set of global styles and UI components that can be used by any extension to preserve the look and feel of the application. Layout # For layout tasks, Lens uses the flex.box library which provides helpful class names to specify some of the flexbox properties. For example, consider the following HTML and its associated CSS properties: < div className = \"flex column align-center\" > div { display : flex ; flex-direction : column ; align-items : center ; } However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS. Layout Variables # There is a set of CSS variables available for for basic layout needs. They are located inside :root and are defined in app.scss : --unit : 8px ; --padding : var ( --unit ); --margin : var ( --unit ); --border-radius : 3px ; These variables are intended to set consistent margins and paddings across components. For example: . status { padding-left : calc ( var ( -- padding ) * 2 ); border-radius : var ( -- border - radius ); } Themes # Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark. Theme Variables # When Lens is loaded, it transforms the selected theme's json file into a list of CSS Custom Properties (CSS Variables) . This list then gets injected into the :root element so that any of the down-level components can use them. When the user changes the theme, the above process is repeated, and new CSS variables appear, replacing the previous ones. If you want to preserve Lens's native look and feel, with respect to the lightness or darkness of your extension, you can use the provided variables and built-in Lens components such as Button , Select , Table , and so on. There is a set of CSS variables available for extensions to use for theming. They are all located inside :root and are defined in app.scss : --font-main : 'Roboto' , 'Helvetica' , 'Arial' , sans-serif ; --font-monospace : Lucida Console , Monaco , Consolas , monospace ; --font-size-small : calc ( 1 . 5 * var ( --unit )); --font-size : calc ( 1 . 75 * var ( --unit )); --font-size-big : calc ( 2 * var ( --unit )); --font-weight-thin : 300 ; --font-weight-normal : 400 ; --font-weight-bold : 500 ; as well as in the theme modules : --blue: #3d90ce; --magenta: #c93dce; --golden: #ffc63d; --halfGray: #87909c80; --primary: #3d90ce; --textColorPrimary: #555555; --textColorSecondary: #51575d; --textColorAccent: #333333; --borderColor: #c9cfd3; --borderFaintColor: #dfdfdf; --mainBackground: #f1f1f1; --contentColor: #ffffff; --layoutBackground: #e8e8e8; --layoutTabsBackground: #f8f8f8; --layoutTabsActiveColor: #333333; --layoutTabsLineColor: #87909c80; ... These variables can be used in the following form: var(--magenta) . For example: . status { font-size : var ( -- font - size - small ); background-color : var ( -- colorSuccess ); } A complete list of themable colors can be found in the Color Reference . Theme Switching # When the light theme is active, the element gets a \"theme-light\" class, or: . If the class isn't there, the theme defaults to dark. The active theme can be changed in the Preferences page: There is a way of detect active theme and its changes in JS. MobX observer function/decorator can be used for this purpose. import React from \"react\" import { observer } from \"mobx-react\" import { App , Component , Theme } from \"@k8slens/extensions\" ; @ observer export class SupportPage extends React . Component { render () { return ( < div className = \"SupportPage\" > < h1 > Active theme is { Theme . getActiveTheme (). name } < /h1> < /div> ); } } Theme entity from @k8slens/extensions provides active theme object and @observer decorator makes component reactive - so it will rerender each time any of the observables (active theme in our case) will be changed. Working example provided in Styling with Emotion sample extension. Injected Styles # Every extension is affected by the list of default global styles defined in app.scss . These are basic browser resets and element styles, including: setting the box-sizing property for every element default text and background colors default font sizes basic heading (h1, h2, etc) formatting custom scrollbar styling Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy. CSS-in-JS # If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows: const Container = styled . div (() => ({ backgroundColor : 'var(--mainBackground)' })); Examples # You can explore samples for each styling technique that you can use for extensions: Styling with Sass Styling with Emotion Styling with CSS Modules","title":"Styling"},{"location":"extensions/capabilities/styling/#styling-an-extension","text":"Lens provides a set of global styles and UI components that can be used by any extension to preserve the look and feel of the application.","title":"Styling an Extension"},{"location":"extensions/capabilities/styling/#layout","text":"For layout tasks, Lens uses the flex.box library which provides helpful class names to specify some of the flexbox properties. For example, consider the following HTML and its associated CSS properties: < div className = \"flex column align-center\" > div { display : flex ; flex-direction : column ; align-items : center ; } However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS.","title":"Layout"},{"location":"extensions/capabilities/styling/#layout-variables","text":"There is a set of CSS variables available for for basic layout needs. They are located inside :root and are defined in app.scss : --unit : 8px ; --padding : var ( --unit ); --margin : var ( --unit ); --border-radius : 3px ; These variables are intended to set consistent margins and paddings across components. For example: . status { padding-left : calc ( var ( -- padding ) * 2 ); border-radius : var ( -- border - radius ); }","title":"Layout Variables"},{"location":"extensions/capabilities/styling/#themes","text":"Lens uses two built-in themes defined in the themes directory \u2013 one light and one dark.","title":"Themes"},{"location":"extensions/capabilities/styling/#theme-variables","text":"When Lens is loaded, it transforms the selected theme's json file into a list of CSS Custom Properties (CSS Variables) . This list then gets injected into the :root element so that any of the down-level components can use them. When the user changes the theme, the above process is repeated, and new CSS variables appear, replacing the previous ones. If you want to preserve Lens's native look and feel, with respect to the lightness or darkness of your extension, you can use the provided variables and built-in Lens components such as Button , Select , Table , and so on. There is a set of CSS variables available for extensions to use for theming. They are all located inside :root and are defined in app.scss : --font-main : 'Roboto' , 'Helvetica' , 'Arial' , sans-serif ; --font-monospace : Lucida Console , Monaco , Consolas , monospace ; --font-size-small : calc ( 1 . 5 * var ( --unit )); --font-size : calc ( 1 . 75 * var ( --unit )); --font-size-big : calc ( 2 * var ( --unit )); --font-weight-thin : 300 ; --font-weight-normal : 400 ; --font-weight-bold : 500 ; as well as in the theme modules : --blue: #3d90ce; --magenta: #c93dce; --golden: #ffc63d; --halfGray: #87909c80; --primary: #3d90ce; --textColorPrimary: #555555; --textColorSecondary: #51575d; --textColorAccent: #333333; --borderColor: #c9cfd3; --borderFaintColor: #dfdfdf; --mainBackground: #f1f1f1; --contentColor: #ffffff; --layoutBackground: #e8e8e8; --layoutTabsBackground: #f8f8f8; --layoutTabsActiveColor: #333333; --layoutTabsLineColor: #87909c80; ... These variables can be used in the following form: var(--magenta) . For example: . status { font-size : var ( -- font - size - small ); background-color : var ( -- colorSuccess ); } A complete list of themable colors can be found in the Color Reference .","title":"Theme Variables"},{"location":"extensions/capabilities/styling/#theme-switching","text":"When the light theme is active, the element gets a \"theme-light\" class, or: . If the class isn't there, the theme defaults to dark. The active theme can be changed in the Preferences page: There is a way of detect active theme and its changes in JS. MobX observer function/decorator can be used for this purpose. import React from \"react\" import { observer } from \"mobx-react\" import { App , Component , Theme } from \"@k8slens/extensions\" ; @ observer export class SupportPage extends React . Component { render () { return ( < div className = \"SupportPage\" > < h1 > Active theme is { Theme . getActiveTheme (). name } < /h1> < /div> ); } } Theme entity from @k8slens/extensions provides active theme object and @observer decorator makes component reactive - so it will rerender each time any of the observables (active theme in our case) will be changed. Working example provided in Styling with Emotion sample extension.","title":"Theme Switching"},{"location":"extensions/capabilities/styling/#injected-styles","text":"Every extension is affected by the list of default global styles defined in app.scss . These are basic browser resets and element styles, including: setting the box-sizing property for every element default text and background colors default font sizes basic heading (h1, h2, etc) formatting custom scrollbar styling Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy.","title":"Injected Styles"},{"location":"extensions/capabilities/styling/#css-in-js","text":"If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows: const Container = styled . div (() => ({ backgroundColor : 'var(--mainBackground)' }));","title":"CSS-in-JS"},{"location":"extensions/capabilities/styling/#examples","text":"You can explore samples for each styling technique that you can use for extensions: Styling with Sass Styling with Emotion Styling with CSS Modules","title":"Examples"},{"location":"extensions/get-started/anatomy/","text":"Extension Anatomy # In the previous section you learned how to create your first extension. In this section you will learn how this extension works under the hood. The Hello World sample extension does three things: Implements onActivate() and outputs a message to the console. Implements onDectivate() and outputs a message to the console. Registers ClusterPage so that the page is visible in the left-side menu of the cluster dashboard. Let's take a closer look at our Hello World sample's source code and see how these three things are achieved. Extension File Structure # . \u251c\u2500\u2500 .gitignore // Ignore build output and node_modules \u251c\u2500\u2500 Makefile // Config for build tasks that compiles the extension \u251c\u2500\u2500 README.md // Readable description of your extension's functionality \u251c\u2500\u2500 src \u2502 \u2514\u2500\u2500 page.tsx // Extension's additional source code \u251c\u2500\u2500 main.ts // Source code for extension's main entrypoint \u251c\u2500\u2500 package.json // Extension manifest and dependencies \u251c\u2500\u2500 renderer.tsx // Source code for extension's renderer entrypoint \u251c\u2500\u2500 tsconfig.json // TypeScript configuration \u251c\u2500\u2500 webpack.config.js // Webpack configuration The extension directory contains the extension's entry files and a few configuration files. Three files: package.json , main.ts and renderer.tsx are essential to understanding the Hello World sample extension. We'll look at those first. Extension Manifest # Each Lens extension must have a package.json file. It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as publisher and contributes . Some of the most-important fields include: name and publisher : Lens uses @/ as a unique ID for the extension. For example, the Hello World sample has the ID @lensapp-samples/helloworld-sample . Lens uses this ID to uniquely identify your extension. main : the extension's entry point run in main process. renderer : the extension's entry point run in renderer process. engines.lens : the minimum version of Lens API that the extension depends upon. { \"name\" : \"helloworld-sample\" , \"publisher\" : \"lens-samples\" , \"version\" : \"0.0.1\" , \"description\" : \"Lens helloworld-sample\" , \"license\" : \"MIT\" , \"homepage\" : \"https://github.com/lensapp/lens-extension-samples\" , \"engines\" : { \"lens\" : \"^4.0.0\" }, \"main\" : \"dist/main.js\" , \"renderer\" : \"dist/renderer.js\" , \"scripts\" : { \"build\" : \"webpack --config webpack.config.js\" , \"dev\" : \"npm run build --watch\" }, \"dependencies\" : { \"react-open-doodles\" : \"^1.0.5\" }, \"devDependencies\" : { \"@k8slens/extensions\" : \"^4.0.0-alpha.2\" , \"ts-loader\" : \"^8.0.4\" , \"typescript\" : \"^4.0.3\" , \"@types/react\" : \"^16.9.35\" , \"@types/node\" : \"^12.0.0\" , \"webpack\" : \"^4.44.2\" , \"webpack-cli\" : \"^3.3.11\" } } Extension Entry Files # Lens extensions can have two separate entry files. One file is used in the main process of the Lens application and the other is used in the renderer process. The main entry file exports the class that extends LensMainExtension , and the renderer entry file exports the class that extends LensRendererExtension . Both extension classes have onActivate and onDeactivate methods. The onActivate method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The onDeactivate method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur. The Hello World sample extension does not do anything on the main process, so we'll focus on the renderer process, instead. On the renderer entry point, the Hello World sample extension defines the Cluster Page object. The Cluster Page object registers the /extension-example path, and this path renders the ExamplePage React component. It also registers the MenuItem component that displays the ExampleIcon React component and the \"Hello World\" text in the left-side menu of the cluster dashboard. These React components are defined in the additional ./src/page.tsx file. import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"extension-example\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ] } The Hello World sample extension uses the Cluster Page capability, which is just one of the Lens extension API's capabilities. The Common Capabilities page will help you home in on the right capabilities to use with your own extensions.","title":"Extension Anatomy"},{"location":"extensions/get-started/anatomy/#extension-anatomy","text":"In the previous section you learned how to create your first extension. In this section you will learn how this extension works under the hood. The Hello World sample extension does three things: Implements onActivate() and outputs a message to the console. Implements onDectivate() and outputs a message to the console. Registers ClusterPage so that the page is visible in the left-side menu of the cluster dashboard. Let's take a closer look at our Hello World sample's source code and see how these three things are achieved.","title":"Extension Anatomy"},{"location":"extensions/get-started/anatomy/#extension-file-structure","text":". \u251c\u2500\u2500 .gitignore // Ignore build output and node_modules \u251c\u2500\u2500 Makefile // Config for build tasks that compiles the extension \u251c\u2500\u2500 README.md // Readable description of your extension's functionality \u251c\u2500\u2500 src \u2502 \u2514\u2500\u2500 page.tsx // Extension's additional source code \u251c\u2500\u2500 main.ts // Source code for extension's main entrypoint \u251c\u2500\u2500 package.json // Extension manifest and dependencies \u251c\u2500\u2500 renderer.tsx // Source code for extension's renderer entrypoint \u251c\u2500\u2500 tsconfig.json // TypeScript configuration \u251c\u2500\u2500 webpack.config.js // Webpack configuration The extension directory contains the extension's entry files and a few configuration files. Three files: package.json , main.ts and renderer.tsx are essential to understanding the Hello World sample extension. We'll look at those first.","title":"Extension File Structure"},{"location":"extensions/get-started/anatomy/#extension-manifest","text":"Each Lens extension must have a package.json file. It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as publisher and contributes . Some of the most-important fields include: name and publisher : Lens uses @/ as a unique ID for the extension. For example, the Hello World sample has the ID @lensapp-samples/helloworld-sample . Lens uses this ID to uniquely identify your extension. main : the extension's entry point run in main process. renderer : the extension's entry point run in renderer process. engines.lens : the minimum version of Lens API that the extension depends upon. { \"name\" : \"helloworld-sample\" , \"publisher\" : \"lens-samples\" , \"version\" : \"0.0.1\" , \"description\" : \"Lens helloworld-sample\" , \"license\" : \"MIT\" , \"homepage\" : \"https://github.com/lensapp/lens-extension-samples\" , \"engines\" : { \"lens\" : \"^4.0.0\" }, \"main\" : \"dist/main.js\" , \"renderer\" : \"dist/renderer.js\" , \"scripts\" : { \"build\" : \"webpack --config webpack.config.js\" , \"dev\" : \"npm run build --watch\" }, \"dependencies\" : { \"react-open-doodles\" : \"^1.0.5\" }, \"devDependencies\" : { \"@k8slens/extensions\" : \"^4.0.0-alpha.2\" , \"ts-loader\" : \"^8.0.4\" , \"typescript\" : \"^4.0.3\" , \"@types/react\" : \"^16.9.35\" , \"@types/node\" : \"^12.0.0\" , \"webpack\" : \"^4.44.2\" , \"webpack-cli\" : \"^3.3.11\" } }","title":"Extension Manifest"},{"location":"extensions/get-started/anatomy/#extension-entry-files","text":"Lens extensions can have two separate entry files. One file is used in the main process of the Lens application and the other is used in the renderer process. The main entry file exports the class that extends LensMainExtension , and the renderer entry file exports the class that extends LensRendererExtension . Both extension classes have onActivate and onDeactivate methods. The onActivate method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The onDeactivate method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur. The Hello World sample extension does not do anything on the main process, so we'll focus on the renderer process, instead. On the renderer entry point, the Hello World sample extension defines the Cluster Page object. The Cluster Page object registers the /extension-example path, and this path renders the ExamplePage React component. It also registers the MenuItem component that displays the ExampleIcon React component and the \"Hello World\" text in the left-side menu of the cluster dashboard. These React components are defined in the additional ./src/page.tsx file. import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"extension-example\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ] } The Hello World sample extension uses the Cluster Page capability, which is just one of the Lens extension API's capabilities. The Common Capabilities page will help you home in on the right capabilities to use with your own extensions.","title":"Extension Entry Files"},{"location":"extensions/get-started/overview/","text":"Extension Development Overview # This is a general overview to how the development of an extension will procede. For building extensions there will be a few things that you should have installed, and some other things that might be of help. Required: # Node.js Git Some sort of text editor \u2013 we recommend VSCode We use Webpack for compilation. All extension need to be at least compatable with a webpack system. Recommended: # All Lens extensions are javascript packages. We recommend that you program in Typescript because it catches many common errors. Lens is a standard Electron application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work. Lens uses React as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is resonsible for the lifetime of any resources it spins up. If an extension's main part starts new processes they all must be stopped and cleaned up when the extension is deactivated or unloaded. See Your First Extension to get started.","title":"Overview"},{"location":"extensions/get-started/overview/#extension-development-overview","text":"This is a general overview to how the development of an extension will procede. For building extensions there will be a few things that you should have installed, and some other things that might be of help.","title":"Extension Development Overview"},{"location":"extensions/get-started/overview/#required","text":"Node.js Git Some sort of text editor \u2013 we recommend VSCode We use Webpack for compilation. All extension need to be at least compatable with a webpack system.","title":"Required:"},{"location":"extensions/get-started/overview/#recommended","text":"All Lens extensions are javascript packages. We recommend that you program in Typescript because it catches many common errors. Lens is a standard Electron application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work. Lens uses React as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is resonsible for the lifetime of any resources it spins up. If an extension's main part starts new processes they all must be stopped and cleaned up when the extension is deactivated or unloaded. See Your First Extension to get started.","title":"Recommended:"},{"location":"extensions/get-started/wrapping-up/","text":"Wrapping Up # In Your First Extension , you learned how to create and run an extension. In Extension Anatomy , you learned in detail how a basic extension works. This is just a glimpse into what can be created with Lens extensions. Below are some suggested routes for learning more. Extension Capabilities # In this section, you'll find information on common extension capabilities, styling information, and a color reference guide. Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the Common Capabilities page. Guides and Samples # Here you'll find a collection of sample extensions that you can use as a base to work from. Some of these samples include a detailed guide that explains the source code. You can find all samples and guides in the lens-extension-samples repository. Testing and Publishing # In this section, you can learn: How to add integration tests to your extension How to publish your extension","title":"Wrapping Up"},{"location":"extensions/get-started/wrapping-up/#wrapping-up","text":"In Your First Extension , you learned how to create and run an extension. In Extension Anatomy , you learned in detail how a basic extension works. This is just a glimpse into what can be created with Lens extensions. Below are some suggested routes for learning more.","title":"Wrapping Up"},{"location":"extensions/get-started/wrapping-up/#extension-capabilities","text":"In this section, you'll find information on common extension capabilities, styling information, and a color reference guide. Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the Common Capabilities page.","title":"Extension Capabilities"},{"location":"extensions/get-started/wrapping-up/#guides-and-samples","text":"Here you'll find a collection of sample extensions that you can use as a base to work from. Some of these samples include a detailed guide that explains the source code. You can find all samples and guides in the lens-extension-samples repository.","title":"Guides and Samples"},{"location":"extensions/get-started/wrapping-up/#testing-and-publishing","text":"In this section, you can learn: How to add integration tests to your extension How to publish your extension","title":"Testing and Publishing"},{"location":"extensions/get-started/your-first-extension/","text":"Your First Extension # We recommend to always use Yeoman generator for Lens Extension to start new extension project. Read the generator guide here . If you want to setup the project manually, please continue reading. First Extension # In this topic, you'll learn the basics of building extensions by creating an extension that adds a \"Hello World\" page to a cluster menu. Install the Extension # To install the extension, clone the Lens Extension samples repository to your local machine: git clone https://github.com/lensapp/lens-extension-samples.git Next you need to create a symlink. A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension. In this case the sample extension is helloworld-sample . Linux & macOS # mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s lens-extension-samples/helloworld-sample helloworld-sample Windows # Create the directory that Lens will monitor for user-installed extensions: mkdir C: \\U sers \\< user> \\. k8slens \\e xtensions -force cd C: \\U sers \\< user> \\. k8slens \\e xtensions If you have administrator rights, you can create symlink to the sample extension \u2013 in this case helloworld-sample : cmd /c mklink /D helloworld-sample lens-extension-samples \\h elloworld-sample Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\\\.k8slens\\extensions : Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\\\.k8slens\\extensions\\helloworld-sample' Build the Extension # To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build To run the npm commands, enter: cd /helloworld-sample npm install npm run build Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter: cd /helloworld-sample npm run dev You must restart Lens for the extension to load. After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds. With Lens running, either connect to an existing cluster or create a new one . You will see the \"Hello World\" page in the left-side cluster menu. Develop the Extension # Finally, you'll make a change to the message that our Hello World sample extension displays: Navigate to /helloworld-sample . In page.tsx , change the message from HelloWorld! to Hello Lens Extensions . Rebuild the extension. If you used npm run dev , the extension will rebuild automatically. Reload the Lens window. Click on the Hello World page. The updated message will appear. Next Steps # In the next topic , we'll take a closer look at the source code of our Hello World sample. You can find the source code for this tutorial at: lensapp/lens-extension-samples . Extension Guides contains additional samples.","title":"Your First Extension"},{"location":"extensions/get-started/your-first-extension/#your-first-extension","text":"We recommend to always use Yeoman generator for Lens Extension to start new extension project. Read the generator guide here . If you want to setup the project manually, please continue reading.","title":"Your First Extension"},{"location":"extensions/get-started/your-first-extension/#first-extension","text":"In this topic, you'll learn the basics of building extensions by creating an extension that adds a \"Hello World\" page to a cluster menu.","title":"First Extension"},{"location":"extensions/get-started/your-first-extension/#install-the-extension","text":"To install the extension, clone the Lens Extension samples repository to your local machine: git clone https://github.com/lensapp/lens-extension-samples.git Next you need to create a symlink. A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension. In this case the sample extension is helloworld-sample .","title":"Install the Extension"},{"location":"extensions/get-started/your-first-extension/#linux-macos","text":"mkdir -p ~/.k8slens/extensions cd ~/.k8slens/extensions ln -s lens-extension-samples/helloworld-sample helloworld-sample","title":"Linux & macOS"},{"location":"extensions/get-started/your-first-extension/#windows","text":"Create the directory that Lens will monitor for user-installed extensions: mkdir C: \\U sers \\< user> \\. k8slens \\e xtensions -force cd C: \\U sers \\< user> \\. k8slens \\e xtensions If you have administrator rights, you can create symlink to the sample extension \u2013 in this case helloworld-sample : cmd /c mklink /D helloworld-sample lens-extension-samples \\h elloworld-sample Without administrator rights, you need to copy the extensions sample directory into C:\\Users\\\\.k8slens\\extensions : Copy-Item 'lens-extension-samples\\helloworld-sample' 'C:\\Users\\\\.k8slens\\extensions\\helloworld-sample'","title":"Windows"},{"location":"extensions/get-started/your-first-extension/#build-the-extension","text":"To build the extension you can use make or run the npm commands manually: cd /helloworld-sample make build To run the npm commands, enter: cd /helloworld-sample npm install npm run build Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter: cd /helloworld-sample npm run dev You must restart Lens for the extension to load. After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds. With Lens running, either connect to an existing cluster or create a new one . You will see the \"Hello World\" page in the left-side cluster menu.","title":"Build the Extension"},{"location":"extensions/get-started/your-first-extension/#develop-the-extension","text":"Finally, you'll make a change to the message that our Hello World sample extension displays: Navigate to /helloworld-sample . In page.tsx , change the message from HelloWorld! to Hello Lens Extensions . Rebuild the extension. If you used npm run dev , the extension will rebuild automatically. Reload the Lens window. Click on the Hello World page. The updated message will appear.","title":"Develop the Extension"},{"location":"extensions/get-started/your-first-extension/#next-steps","text":"In the next topic , we'll take a closer look at the source code of our Hello World sample. You can find the source code for this tutorial at: lensapp/lens-extension-samples . Extension Guides contains additional samples.","title":"Next Steps"},{"location":"extensions/guides/","text":"Extension Guides # The basics of the Lens Extension API are covered in Your First Extension . In this section detailed code guides and samples are used to explain how to use specific Lens Extension APIs. Each guide or sample will include: Clearly commented source code. Instructions for running the sample extension. Image of the sample extension's appearance and usage. Listing of Extension API being used. Explanation of Extension API concepts. Guides # Guide APIs Generate new extension project Main process extension LensMainExtension Renderer process extension LensRendererExtension Stores Components KubeObjectListLayout Working with mobx Samples # Sample APIs helloworld LensMainExtension LensRendererExtension Component.Icon Component.IconProps minikube LensMainExtension Store.clusterStore Store.workspaceStore styling-css-modules-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps styling-emotion-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps styling-sass-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps custom-resource-page LensRendererExtension K8sApi.KubeApi K8sApi.KubeObjectStore Component.KubeObjectListLayout Component.KubeObjectDetailsProps Component.IconProps","title":"Overview"},{"location":"extensions/guides/#extension-guides","text":"The basics of the Lens Extension API are covered in Your First Extension . In this section detailed code guides and samples are used to explain how to use specific Lens Extension APIs. Each guide or sample will include: Clearly commented source code. Instructions for running the sample extension. Image of the sample extension's appearance and usage. Listing of Extension API being used. Explanation of Extension API concepts.","title":"Extension Guides"},{"location":"extensions/guides/#guides","text":"Guide APIs Generate new extension project Main process extension LensMainExtension Renderer process extension LensRendererExtension Stores Components KubeObjectListLayout Working with mobx","title":"Guides"},{"location":"extensions/guides/#samples","text":"Sample APIs helloworld LensMainExtension LensRendererExtension Component.Icon Component.IconProps minikube LensMainExtension Store.clusterStore Store.workspaceStore styling-css-modules-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps styling-emotion-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps styling-sass-sample LensMainExtension LensRendererExtension Component.Icon Component.IconProps custom-resource-page LensRendererExtension K8sApi.KubeApi K8sApi.KubeObjectStore Component.KubeObjectListLayout Component.KubeObjectDetailsProps Component.IconProps","title":"Samples"},{"location":"extensions/guides/anatomy/","text":"WIP #","title":"Anatomy"},{"location":"extensions/guides/anatomy/#wip","text":"","title":"WIP"},{"location":"extensions/guides/components/","text":"WIP #","title":"Components"},{"location":"extensions/guides/components/#wip","text":"","title":"WIP"},{"location":"extensions/guides/generator/","text":"New Extension Project with Generator # The Lens Extension Generator scaffolds a project ready for development. Install Yeoman and Lens Extension Generator with: npm install -g yo generator-lens-ext Run the generator and fill out a few fields for a TypeScript project: yo lens-ext # ? What type of extension do you want to create? New Extension (TypeScript) # ? What's the name of your extension? my-first-lens-ext # ? What's the description of your extension? My hello world extension # ? What's your extension's publisher name? @my-org/my-first-lens-ext # ? Initialize a git repository? Yes # ? Install dependencies after initialization? Yes # ? Which package manager to use? yarn # ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :User s \\< user> \\. k8slens \\e xtensions ( windows ) ? Yes Start webpack, which watches the my-first-lens-ext folder. cd my-first-lens-ext npm start # start the webpack server in watch mode Then, open Lens, you should see a Hello World item in the menu: Developing the Extension # Try to change my-first-lens-ext/renderer.tsx to \"Hello Lens!\": clusterPageMenus = [ { target: { pageId: \"hello\" }, title: \"Hello Lens\", components: { Icon: ExampleIcon, } } ] Then, Reload Lens by CMD+R (Mac) / Ctrl+R (Linux/Windows), you should see the menu item text changes: Debugging the Extension # Testing Next steps # You can take a closer look at Common Capabilities of extension, how to style the extension. Or the Extension Anatomy . You are welcome to raise an issue for Lens Extension Generator, if you find problems, or have feature requests. The source code of the generator is hosted at Github","title":"Generator"},{"location":"extensions/guides/generator/#new-extension-project-with-generator","text":"The Lens Extension Generator scaffolds a project ready for development. Install Yeoman and Lens Extension Generator with: npm install -g yo generator-lens-ext Run the generator and fill out a few fields for a TypeScript project: yo lens-ext # ? What type of extension do you want to create? New Extension (TypeScript) # ? What's the name of your extension? my-first-lens-ext # ? What's the description of your extension? My hello world extension # ? What's your extension's publisher name? @my-org/my-first-lens-ext # ? Initialize a git repository? Yes # ? Install dependencies after initialization? Yes # ? Which package manager to use? yarn # ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :User s \\< user> \\. k8slens \\e xtensions ( windows ) ? Yes Start webpack, which watches the my-first-lens-ext folder. cd my-first-lens-ext npm start # start the webpack server in watch mode Then, open Lens, you should see a Hello World item in the menu:","title":"New Extension Project with Generator"},{"location":"extensions/guides/generator/#developing-the-extension","text":"Try to change my-first-lens-ext/renderer.tsx to \"Hello Lens!\": clusterPageMenus = [ { target: { pageId: \"hello\" }, title: \"Hello Lens\", components: { Icon: ExampleIcon, } } ] Then, Reload Lens by CMD+R (Mac) / Ctrl+R (Linux/Windows), you should see the menu item text changes:","title":"Developing the Extension"},{"location":"extensions/guides/generator/#debugging-the-extension","text":"Testing","title":"Debugging the Extension"},{"location":"extensions/guides/generator/#next-steps","text":"You can take a closer look at Common Capabilities of extension, how to style the extension. Or the Extension Anatomy . You are welcome to raise an issue for Lens Extension Generator, if you find problems, or have feature requests. The source code of the generator is hosted at Github","title":"Next steps"},{"location":"extensions/guides/kube-object-list-layout/","text":"KubeObjectListLayout Sample # In this guide we will learn how to list Kubernetes CRD objects on the cluster dashboard. You can see the complete source code for this guide here . Next, we will go the implementation through in steps. To achieve our goal, we need to: Register ClustePage and ClusterPageMenu objects List Certificate Objects on the Cluster Page Customize Details Panel Register clusterPage and clusterPageMenu Objects # First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class: export default class CrdSampleExtension extends LensRendererExtension { } To register menu item in the cluster menu we need to register PageMenuRegistration object. This object will register a menu item with \"Certificates\" text. It will also use CertificateIcon component to render an icon and navigate to cluster page that is having certificates page id. export function CertificateIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"security\" tooltip = \"Certificates\" /> } export default class CrdSampleExtension extends LensRendererExtension { clusterPageMenus = [ { target : { pageId : \"certificates\" }, title : \"Certificates\" , components : { Icon : CertificateIcon , } }, ] } Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates. export default class CrdSampleExtension extends LensRendererExtension { ... clusterPages = [{ id : \"certificates\" , components : { Page : () => < CertificatePage extension = { this } /> , MenuIcon : CertificateIcon , } }] } List Certificate Objects on the Cluster Page # In the previous step we defined CertificatePage component to render certificates. In this step we will actually implement that. CertificatePage is a React component that will render Component.KubeObjectListLayout component to list Certificate CRD objects. Get CRD objects # In order to list CRD objects, we need first fetch those from Kubernetes API. Lens Extensions API provides easy mechanism to do this. We just need to define Certificate class derived from K8sApi.KubeObject , CertificatesApi derived from K8sApi.KubeApi and CertificatesStore derived from K8sApi.KubeObjectStore . Certificate class defines properties found in the CRD object: export class Certificate extends K8sApi . KubeObject { static kind = \"Certificate\" static namespaced = true static apiBase = \"/apis/cert-manager.io/v1alpha2/certificates\" kind : string apiVersion : string metadata : { name : string ; namespace : string ; selfLink : string ; uid : string ; resourceVersion : string ; creationTimestamp : string ; labels : { [ key : string ] : string ; }; annotations : { [ key : string ] : string ; }; } spec : { dnsNames : string []; issuerRef : { group : string ; kind : string ; name : string ; } secretName : string } status : { conditions : { lastTransitionTime : string ; message : string ; reason : string ; status : string ; type? : string ; }[]; } } With CertificatesApi class we are able to manage Certificate objects in Kubernetes API: export class CertificatesApi extends K8sApi . KubeApi < Certificate > { } export const certificatesApi = new CertificatesApi ({ objectConstructor : Certificate }); CertificateStore defines storage for Certificate objects export class CertificatesStore extends K8sApi . KubeObjectStore < Certificate > { api = certificatesApi } export const certificatesStore = new CertificatesStore (); And, finally, we register this store to Lens's API manager. K8sApi . apiManager . registerStore ( certificatesStore ); Create CertificatePage component # Now we have created mechanism to manage Certificate objects in Kubernetes API. Then we need to fetch those and render them in the UI. First we define CertificatePage class that extends React.Component . import { Component , LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" ; import { certificatesStore } from \"../certificate-store\" ; import { Certificate } from \"../certificate\" export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { } Next we will implement render method that will display certificates in a list. To do that, we just need to add Component.KubeObjectListLayout component inside Component.TabLayout component in render method. To define which objects the list is showing, we need to pass certificateStore object to Component.KubeObjectListLayout in store property. Component.KubeObjectListLayout will fetch automacially items from the given store when component is mounted. Also, we can define needed sorting callbacks and search filters for the list: enum sortBy { name = \"name\" , namespace = \"namespace\" , issuer = \"issuer\" } export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { // ... render() { return ( < Component . TabLayout > < Component . KubeObjectListLayout className = \"Certicates\" store = { certificatesStore } sortingCallbacks = {{ [ sortBy . name ] : ( certificate : Certificate ) => certificate . getName (), [ sortBy . namespace ] : ( certificate : Certificate ) => certificate . metadata . namespace , [ sortBy . issuer ] : ( certificate : Certificate ) => certificate . spec . issuerRef . name }} searchFilters = {[ ( certificate : Certificate ) => certificate . getSearchFields () ]} renderHeaderTitle = \"Certificates\" renderTableHeader = {[ { title : \"Name\" , className : \"name\" , sortBy : sortBy.name }, { title : \"Namespace\" , className : \"namespace\" , sortBy : sortBy.namespace }, { title : \"Issuer\" , className : \"issuer\" , sortBy : sortBy.namespace }, ]} renderTableContents = {( certificate : Certificate ) => [ certificate . getName (), certificate . metadata . namespace , certificate . spec . issuerRef . name ]} /> < /Component.TabLayout> ) } } Customize Details panel # We have learned now, how to list CRD objects in a list view. Next, we will learn how to customize details panel that will be opened when the object is clicked in the list. First, we need to register our custom component to render details for the specific Kubernetes custom resource, in our case Certificate . We will do this again in CrdSampleExtension class: export default class CrdSampleExtension extends LensRendererExtension { //... kubeObjectDetailItems = [{ kind : Certificate.kind , apiVersions : [ \"cert-manager.io/v1alpha2\" ], components : { Details : ( props : CertificateDetailsProps ) => < CertificateDetails {... props } /> } }] } Here we defined that CertificateDetails component will render the resource details. So, next we need to implement that component. Lens will inject Certificate object into our component so we just need to render some information out of it. We can use Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere: import { Component , K8sApi } from \"@k8slens/extensions\" ; import React from \"react\" ; import { Certificate } from \"../certificate\" ; export interface CertificateDetailsProps extends Component . KubeObjectDetailsProps < Certificate > { } export class CertificateDetails extends React . Component < CertificateDetailsProps > { render() { const { object : certificate } = this . props ; if ( ! certificate ) return null ; return ( < div className = \"Certificate\" > < Component . DrawerItem name = \"Created\" > { certificate . getAge ( true , false )} ago ({ certificate . metadata . creationTimestamp }) < /Component.DrawerItem> < Component . DrawerItem name = \"DNS Names\" > { certificate . spec . dnsNames . join ( \",\" )} < /Component.DrawerItem> < Component . DrawerItem name = \"Secret\" > { certificate . spec . secretName } < /Component.DrawerItem> < Component . DrawerItem name = \"Status\" className = \"status\" labelsOnly > { certificate . status . conditions . map (( condition , index ) => { const { type , reason , message , status } = condition ; const kind = type || reason ; if ( ! kind ) return null ; return ( < Component . Badge key = { kind + index } label = { kind } className = { \"success \" + kind . toLowerCase ()} tooltip = { message } /> ); })} < /Component.DrawerItem> < /div> ) } } Summary # Like we can see above, it's very easy to add custom pages and fetch Kubernetes resources by using Extensions API. Please see the complete source code to test it out.","title":"KubeObjectListLayout Sample"},{"location":"extensions/guides/kube-object-list-layout/#kubeobjectlistlayout-sample","text":"In this guide we will learn how to list Kubernetes CRD objects on the cluster dashboard. You can see the complete source code for this guide here . Next, we will go the implementation through in steps. To achieve our goal, we need to: Register ClustePage and ClusterPageMenu objects List Certificate Objects on the Cluster Page Customize Details Panel","title":"KubeObjectListLayout Sample"},{"location":"extensions/guides/kube-object-list-layout/#register-clusterpage-and-clusterpagemenu-objects","text":"First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class: export default class CrdSampleExtension extends LensRendererExtension { } To register menu item in the cluster menu we need to register PageMenuRegistration object. This object will register a menu item with \"Certificates\" text. It will also use CertificateIcon component to render an icon and navigate to cluster page that is having certificates page id. export function CertificateIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"security\" tooltip = \"Certificates\" /> } export default class CrdSampleExtension extends LensRendererExtension { clusterPageMenus = [ { target : { pageId : \"certificates\" }, title : \"Certificates\" , components : { Icon : CertificateIcon , } }, ] } Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates. export default class CrdSampleExtension extends LensRendererExtension { ... clusterPages = [{ id : \"certificates\" , components : { Page : () => < CertificatePage extension = { this } /> , MenuIcon : CertificateIcon , } }] }","title":"Register clusterPage and clusterPageMenu Objects"},{"location":"extensions/guides/kube-object-list-layout/#list-certificate-objects-on-the-cluster-page","text":"In the previous step we defined CertificatePage component to render certificates. In this step we will actually implement that. CertificatePage is a React component that will render Component.KubeObjectListLayout component to list Certificate CRD objects.","title":"List Certificate Objects on the Cluster Page"},{"location":"extensions/guides/kube-object-list-layout/#get-crd-objects","text":"In order to list CRD objects, we need first fetch those from Kubernetes API. Lens Extensions API provides easy mechanism to do this. We just need to define Certificate class derived from K8sApi.KubeObject , CertificatesApi derived from K8sApi.KubeApi and CertificatesStore derived from K8sApi.KubeObjectStore . Certificate class defines properties found in the CRD object: export class Certificate extends K8sApi . KubeObject { static kind = \"Certificate\" static namespaced = true static apiBase = \"/apis/cert-manager.io/v1alpha2/certificates\" kind : string apiVersion : string metadata : { name : string ; namespace : string ; selfLink : string ; uid : string ; resourceVersion : string ; creationTimestamp : string ; labels : { [ key : string ] : string ; }; annotations : { [ key : string ] : string ; }; } spec : { dnsNames : string []; issuerRef : { group : string ; kind : string ; name : string ; } secretName : string } status : { conditions : { lastTransitionTime : string ; message : string ; reason : string ; status : string ; type? : string ; }[]; } } With CertificatesApi class we are able to manage Certificate objects in Kubernetes API: export class CertificatesApi extends K8sApi . KubeApi < Certificate > { } export const certificatesApi = new CertificatesApi ({ objectConstructor : Certificate }); CertificateStore defines storage for Certificate objects export class CertificatesStore extends K8sApi . KubeObjectStore < Certificate > { api = certificatesApi } export const certificatesStore = new CertificatesStore (); And, finally, we register this store to Lens's API manager. K8sApi . apiManager . registerStore ( certificatesStore );","title":"Get CRD objects"},{"location":"extensions/guides/kube-object-list-layout/#create-certificatepage-component","text":"Now we have created mechanism to manage Certificate objects in Kubernetes API. Then we need to fetch those and render them in the UI. First we define CertificatePage class that extends React.Component . import { Component , LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" ; import { certificatesStore } from \"../certificate-store\" ; import { Certificate } from \"../certificate\" export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { } Next we will implement render method that will display certificates in a list. To do that, we just need to add Component.KubeObjectListLayout component inside Component.TabLayout component in render method. To define which objects the list is showing, we need to pass certificateStore object to Component.KubeObjectListLayout in store property. Component.KubeObjectListLayout will fetch automacially items from the given store when component is mounted. Also, we can define needed sorting callbacks and search filters for the list: enum sortBy { name = \"name\" , namespace = \"namespace\" , issuer = \"issuer\" } export class CertificatePage extends React . Component < { extension : LensRendererExtension } > { // ... render() { return ( < Component . TabLayout > < Component . KubeObjectListLayout className = \"Certicates\" store = { certificatesStore } sortingCallbacks = {{ [ sortBy . name ] : ( certificate : Certificate ) => certificate . getName (), [ sortBy . namespace ] : ( certificate : Certificate ) => certificate . metadata . namespace , [ sortBy . issuer ] : ( certificate : Certificate ) => certificate . spec . issuerRef . name }} searchFilters = {[ ( certificate : Certificate ) => certificate . getSearchFields () ]} renderHeaderTitle = \"Certificates\" renderTableHeader = {[ { title : \"Name\" , className : \"name\" , sortBy : sortBy.name }, { title : \"Namespace\" , className : \"namespace\" , sortBy : sortBy.namespace }, { title : \"Issuer\" , className : \"issuer\" , sortBy : sortBy.namespace }, ]} renderTableContents = {( certificate : Certificate ) => [ certificate . getName (), certificate . metadata . namespace , certificate . spec . issuerRef . name ]} /> < /Component.TabLayout> ) } }","title":"Create CertificatePage component"},{"location":"extensions/guides/kube-object-list-layout/#customize-details-panel","text":"We have learned now, how to list CRD objects in a list view. Next, we will learn how to customize details panel that will be opened when the object is clicked in the list. First, we need to register our custom component to render details for the specific Kubernetes custom resource, in our case Certificate . We will do this again in CrdSampleExtension class: export default class CrdSampleExtension extends LensRendererExtension { //... kubeObjectDetailItems = [{ kind : Certificate.kind , apiVersions : [ \"cert-manager.io/v1alpha2\" ], components : { Details : ( props : CertificateDetailsProps ) => < CertificateDetails {... props } /> } }] } Here we defined that CertificateDetails component will render the resource details. So, next we need to implement that component. Lens will inject Certificate object into our component so we just need to render some information out of it. We can use Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere: import { Component , K8sApi } from \"@k8slens/extensions\" ; import React from \"react\" ; import { Certificate } from \"../certificate\" ; export interface CertificateDetailsProps extends Component . KubeObjectDetailsProps < Certificate > { } export class CertificateDetails extends React . Component < CertificateDetailsProps > { render() { const { object : certificate } = this . props ; if ( ! certificate ) return null ; return ( < div className = \"Certificate\" > < Component . DrawerItem name = \"Created\" > { certificate . getAge ( true , false )} ago ({ certificate . metadata . creationTimestamp }) < /Component.DrawerItem> < Component . DrawerItem name = \"DNS Names\" > { certificate . spec . dnsNames . join ( \",\" )} < /Component.DrawerItem> < Component . DrawerItem name = \"Secret\" > { certificate . spec . secretName } < /Component.DrawerItem> < Component . DrawerItem name = \"Status\" className = \"status\" labelsOnly > { certificate . status . conditions . map (( condition , index ) => { const { type , reason , message , status } = condition ; const kind = type || reason ; if ( ! kind ) return null ; return ( < Component . Badge key = { kind + index } label = { kind } className = { \"success \" + kind . toLowerCase ()} tooltip = { message } /> ); })} < /Component.DrawerItem> < /div> ) } }","title":"Customize Details panel"},{"location":"extensions/guides/kube-object-list-layout/#summary","text":"Like we can see above, it's very easy to add custom pages and fetch Kubernetes resources by using Extensions API. Please see the complete source code to test it out.","title":"Summary"},{"location":"extensions/guides/main-extension/","text":"Main Extension # The main extension api is the interface to Lens' main process (Lens runs in main and renderer processes). It allows you to access, configure, and customize Lens data, add custom application menu items, and generally run custom code in Lens' main process. LensMainExtension Class # To create a main extension simply extend the LensMainExtension class: import { LensMainExtension } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends LensMainExtension { onActivate() { console . log ( 'custom main process extension code started' ); } onDeactivate() { console . log ( 'custom main process extension de-activated' ); } } There are two methods that you can implement to facilitate running your custom code. onActivate() is called when your extension has been successfully enabled. By implementing onActivate() you can initiate your custom code. onDeactivate() is called when the extension is disabled (typically from the Lens Extensions Page ) and when implemented gives you a chance to clean up after your extension, if necessary. The example above simply logs messages when the extension is enabled and disabled. Note that to see standard output from the main process there must be a console connected to it. This is typically achieved by starting Lens from the command prompt. The following example is a little more interesting in that it accesses some Lens state data and periodically logs the name of the currently active cluster in Lens. import { LensMainExtension , Store } from \"@k8slens/extensions\" ; const clusterStore = Store . clusterStore export default class ActiveClusterExtensionMain extends LensMainExtension { timer : NodeJS.Timeout onActivate() { console . log ( \"Cluster logger activated\" ); this . timer = setInterval (() => { if ( ! clusterStore . active ) { console . log ( \"No active cluster\" ); return ; } console . log ( \"active cluster is\" , clusterStore . active . contextName ) }, 5000 ) } onDeactivate() { clearInterval ( this . timer ) console . log ( \"Cluster logger deactivated\" ); } } See the Stores guide for more details on accessing Lens state data. appMenus # The only UI feature customizable in the main extension api is the application menu. Custom menu items can be inserted and linked to custom functionality, such as navigating to a specific page. The following example demonstrates adding a menu item to the Help menu. import { LensMainExtension } from \"@k8slens/extensions\" ; export default class SamplePageMainExtension extends LensMainExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click() { console . log ( \"Sample clicked\" ); } } ] } appMenus is an array of objects satisfying the MenuRegistration interface. MenuRegistration extends React's MenuItemConstructorOptions interface. parentId is the id of the menu to put this menu item under (todo: is this case sensitive and how do we know what the available ids are?), label is the text to show on the menu item, and click() is called when the menu item is selected. In this example we simply log a message, but typically you would navigate to a specific page or perform some operation. Pages are associated with the LensRendererExtension class and can be defined when you extend it.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#main-extension","text":"The main extension api is the interface to Lens' main process (Lens runs in main and renderer processes). It allows you to access, configure, and customize Lens data, add custom application menu items, and generally run custom code in Lens' main process.","title":"Main Extension"},{"location":"extensions/guides/main-extension/#lensmainextension-class","text":"To create a main extension simply extend the LensMainExtension class: import { LensMainExtension } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends LensMainExtension { onActivate() { console . log ( 'custom main process extension code started' ); } onDeactivate() { console . log ( 'custom main process extension de-activated' ); } } There are two methods that you can implement to facilitate running your custom code. onActivate() is called when your extension has been successfully enabled. By implementing onActivate() you can initiate your custom code. onDeactivate() is called when the extension is disabled (typically from the Lens Extensions Page ) and when implemented gives you a chance to clean up after your extension, if necessary. The example above simply logs messages when the extension is enabled and disabled. Note that to see standard output from the main process there must be a console connected to it. This is typically achieved by starting Lens from the command prompt. The following example is a little more interesting in that it accesses some Lens state data and periodically logs the name of the currently active cluster in Lens. import { LensMainExtension , Store } from \"@k8slens/extensions\" ; const clusterStore = Store . clusterStore export default class ActiveClusterExtensionMain extends LensMainExtension { timer : NodeJS.Timeout onActivate() { console . log ( \"Cluster logger activated\" ); this . timer = setInterval (() => { if ( ! clusterStore . active ) { console . log ( \"No active cluster\" ); return ; } console . log ( \"active cluster is\" , clusterStore . active . contextName ) }, 5000 ) } onDeactivate() { clearInterval ( this . timer ) console . log ( \"Cluster logger deactivated\" ); } } See the Stores guide for more details on accessing Lens state data.","title":"LensMainExtension Class"},{"location":"extensions/guides/main-extension/#appmenus","text":"The only UI feature customizable in the main extension api is the application menu. Custom menu items can be inserted and linked to custom functionality, such as navigating to a specific page. The following example demonstrates adding a menu item to the Help menu. import { LensMainExtension } from \"@k8slens/extensions\" ; export default class SamplePageMainExtension extends LensMainExtension { appMenus = [ { parentId : \"help\" , label : \"Sample\" , click() { console . log ( \"Sample clicked\" ); } } ] } appMenus is an array of objects satisfying the MenuRegistration interface. MenuRegistration extends React's MenuItemConstructorOptions interface. parentId is the id of the menu to put this menu item under (todo: is this case sensitive and how do we know what the available ids are?), label is the text to show on the menu item, and click() is called when the menu item is selected. In this example we simply log a message, but typically you would navigate to a specific page or perform some operation. Pages are associated with the LensRendererExtension class and can be defined when you extend it.","title":"appMenus"},{"location":"extensions/guides/renderer-extension/","text":"Renderer Extension # The renderer extension api is the interface to Lens's renderer process (Lens runs in main and renderer processes). It allows you to access, configure, and customize Lens data, add custom Lens UI elements, and generally run custom code in Lens's renderer process. The custom Lens UI elements that can be added include global pages, cluster pages, cluster page menus, cluster features, app preferences, status bar items, KubeObject menu items, and KubeObject details items. These UI elements are based on React components. LensRendererExtension Class # To create a renderer extension simply extend the LensRendererExtension class: import { LensRendererExtension } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends LensRendererExtension { onActivate() { console . log ( 'custom renderer process extension code started' ); } onDeactivate() { console . log ( 'custom renderer process extension de-activated' ); } } There are two methods that you can implement to facilitate running your custom code. onActivate() is called when your extension has been successfully enabled. By implementing onActivate() you can initiate your custom code. onDeactivate() is called when the extension is disabled (typically from the Lens Extensions Page ) and when implemented gives you a chance to clean up after your extension, if necessary. The example above simply logs messages when the extension is enabled and disabled. clusterPages # Cluster pages appear as part of the cluster dashboard. They are accessible from the side bar, and are shown in the menu list after Custom Resources . It is conventional to use a cluster page to show information or provide functionality pertaining to the active cluster, along with custom data and functionality your extension may have. However, it is not limited to the active cluster. Also, your extension can gain access to the Kubernetes resources in the active cluster in a straightforward manner using the clusterStore . The following example adds a cluster page definition to a LensRendererExtension subclass: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; } Cluster pages are objects matching the PageRegistration interface. The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. The 'id' field can also convey route path details, such as variable parameters provided to a page ( See example below ). The components field matches the PageComponents interface for wich there is one field, Page . Page is of type React.ComponentType , which gives you great flexibility in defining the appearance and behaviour of your page. For the example above ExamplePage can be defined in page.tsx : import { LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Hello world !< /p> < /div> ) } } Note that the ExamplePage class defines a property named extension . This allows the ExampleExtension object to be passed in React-style in the cluster page definition, so that ExamplePage can access any ExampleExtension subclass data. clusterPageMenus # The above example code shows how to create a cluster page but not how to make it available to the Lens user. Cluster pages are typically made available through a menu item in the cluster dashboard sidebar. Expanding on the above example a cluster page menu is added to the ExampleExtension definition: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; clusterPageMenus = [ { target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , } }, ]; } Cluster page menus are objects matching the ClusterPageMenuRegistration interface. They define the appearance of the cluster page menu item in the cluster dashboard sidebar and the behaviour when the cluster page menu item is activated (typically by a mouse click). The example above uses the target field to set the behaviour as a link to the cluster page with id of \"hello\" . This is done by setting target 's pageId field to \"hello\" . The cluster page menu item's appearance is defined by setting the title field to the text that is to be displayed in the cluster dashboard sidebar. The components field is used to set an icon that appears to the left of the title text in the sidebar. Thus when the \"Hello World\" menu item is activated the cluster dashboard will show the contents of ExamplePage . This example requires the definition of another React-based component, ExampleIcon , which has been added to page.tsx : import { LensRendererExtension , Component } from \"@k8slens/extensions\" ; import React from \"react\" export function ExampleIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"pages\" tooltip = { \"Hi!\" } /> } export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Hello world !< /p> < /div> ) } } ExampleIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon . Built in are the Material Design icons . One can be selected by name via the material field. ExampleIcon also sets a tooltip, shown when the Lens user hovers over the icon with a mouse, by setting the tooltip field. A cluster page menu can also be used to define a foldout submenu in the cluster dashboard sidebar. This enables the grouping of cluster pages. The following example shows how to specify a submenu having two menu items: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } }, { id : \"bonjour\" , components : { Page : () => < ExemplePage extension = { this } /> , } } ]; clusterPageMenus = [ { id : \"example\" , title : \"Greetings\" , components : { Icon : ExampleIcon , } }, { parentId : \"example\" , target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , } }, { parentId : \"example\" , target : { pageId : \"bonjour\" }, title : \"Bonjour le monde\" , components : { Icon : ExempleIcon , } } ]; } The above defines two cluster pages and three cluster page menu objects. The cluster page definitons are straightforward. The first cluster page menu object defines the parent of a foldout submenu. Setting the id field in a cluster page menu definition implies that it is defining a foldout submenu. Also note that the target field is not specified (it is ignored if the id field is specified). This cluster page menu object specifies the title and components fields, which are used in displaying the menu item in the cluster dashboard sidebar. Initially the submenu is hidden. Activating this menu item toggles on and off the appearance of the submenu below it. The remaining two cluster page menu objects define the contents of the submenu. A cluster page menu object is defined to be a submenu item by setting the parentId field to the id of the parent of a foldout submenu, \"example\" in this case globalPages # Global pages appear independently of the cluster dashboard and they fill the Lens UI space. A global page is typically triggered from the cluster menu using a global page menu . They can also be triggered by a custom app menu selection from a Main Extension or a custom status bar item . Global pages can appear even when there is no active cluster, unlike cluster pages. It is conventional to use a global page to show information and provide functionality relevant across clusters, along with custom data and functionality that your extension may have. The following example defines a LensRendererExtension subclass with a single global page definition: import { LensRendererExtension } from '@k8slens/extensions' ; import { HelpPage } from './page' ; import React from 'react' ; export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; } Global pages are objects matching the PageRegistration interface. The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. The 'id' field can also convey route path details, such as variable parameters provided to a page ( See example below ). The components field matches the PageComponents interface for which there is one field, Page . Page is of type React.ComponentType , which gives you great flexibility in defining the appearance and behaviour of your page. For the example above HelpPage can be defined in page.tsx : import { LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" export class HelpPage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Help yourself < /p> < /div> ) } } Note that the HelpPage class defines a property named extension . This allows the HelpExtension object to be passed in React-style in the global page definition, so that HelpPage can access any HelpExtension subclass data. This example code shows how to create a global page but not how to make it available to the Lens user. Global pages are typically made available through a number of ways. Menu items can be added to the Lens app menu system and set to open a global page when activated (See appMenus in the Main Extension guide ). Interactive elements can be placed on the status bar (the blue strip along the bottom of the Lens UI) and can be configured to link to a global page when activated (See statusBarItems ). As well, global pages can be made accessible from the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Global page menu icons that are defined using globalPageMenus appear below the Add Cluster icon. globalPageMenus # Global page menus connect a global page to the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Expanding on the example from globalPages a global page menu is added to the HelpExtension definition: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { HelpIcon , HelpPage } from \"./page\" import React from \"react\" export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; globalPageMenus = [ { target : { pageId : \"help\" }, title : \"Help\" , components : { Icon : HelpIcon , } }, ]; } Global page menus are objects matching the PageMenuRegistration interface. They define the appearance of the global page menu item in the cluster menu and the behaviour when the global page menu item is activated (typically by a mouse click). The example above uses the target field to set the behaviour as a link to the global page with id of \"help\" . This is done by setting target 's pageId field to \"help\" . The global page menu item's appearance is defined by setting the title field to the text that is to be displayed as a tooltip in the cluster menu. The components field is used to set an icon that appears in the cluster menu. Thus when the \"Help\" icon is activated the contents of ExamplePage will be shown. This example requires the definition of another React-based component, HelpIcon , which has been added to page.tsx : import { LensRendererExtension , Component } from \"@k8slens/extensions\" ; import React from \"react\" export function HelpIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"help\" /> } export class HelpPage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Help < /p> < /div> ) } } HelpIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon . Built in are the Material Design icons . One can be selected by name via the material field. clusterFeatures # Cluster features are Kubernetes resources that can be applied to and managed within the active cluster. They can be installed/uninstalled by the Lens user from the cluster settings page . The following example shows how to add a cluster feature as part of a LensRendererExtension : import { LensRendererExtension } from \"@k8slens/extensions\" import { ExampleFeature } from \"./src/example-feature\" import React from \"react\" export default class ExampleFeatureExtension extends LensRendererExtension { clusterFeatures = [ { title : \"Example Feature\" , components : { Description : () => { return ( < span > Enable an example feature . < /span> ) } }, feature : new ExampleFeature () } ]; } The title and components.Description fields provide content that appears on the cluster settings page, in the Features section. The feature field must specify an instance which extends the abstract class ClusterFeature.Feature , and specifically implement the following methods: abstract install ( cluster : Cluster ) : Promise < void > ; abstract upgrade ( cluster : Cluster ) : Promise < void > ; abstract uninstall ( cluster : Cluster ) : Promise < void > ; abstract updateStatus ( cluster : Cluster ) : Promise < ClusterFeatureStatus > ; The install() method is typically called by Lens when a user has indicated that this feature is to be installed (i.e. clicked Install for the feature on the cluster settings page). The implementation of this method should install kubernetes resources using the applyResources() method, or by directly accessing the kubernetes api ( K8sApi ). The upgrade() method is typically called by Lens when a user has indicated that this feature is to be upgraded (i.e. clicked Upgrade for the feature on the cluster settings page). The implementation of this method should upgrade the kubernetes resources already installed, if relevant to the feature. The uninstall() method is typically called by Lens when a user has indicated that this feature is to be uninstalled (i.e. clicked Uninstall for the feature on the cluster settings page). The implementation of this method should uninstall kubernetes resources using the kubernetes api ( K8sApi ) The updateStatus() 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 in the status field of the ClusterFeature.Feature parent class. The status.currentVersion and status.latestVersion fields may be displayed by Lens in describing the feature. The status.installed field should be set to true if the feature is currently installed, otherwise false. Also, Lens relies on the status.canUpgrade field to determine if the feature can be upgraded (i.e a new version could be available) so the implementation should set the status.canUpgrade field according to specific rules for the feature, if relevant. The following shows a very simple implementation of a ClusterFeature : import { ClusterFeature , Store , K8sApi } from \"@k8slens/extensions\" ; import * as path from \"path\" ; export class ExampleFeature extends ClusterFeature . Feature { async install ( cluster : Store.Cluster ) : Promise < void > { super . applyResources ( cluster , path . join ( __dirname , \"../resources/\" )); } async upgrade ( cluster : Store.Cluster ) : Promise < void > { return this . install ( cluster ); } async updateStatus ( cluster : Store.Cluster ) : Promise < ClusterFeature . FeatureStatus > { try { const pod = K8sApi . forCluster ( cluster , K8sApi . Pod ); const examplePod = await pod . get ({ name : \"example-pod\" , namespace : \"default\" }); if ( examplePod ? . kind ) { this . status . installed = true ; this . status . currentVersion = examplePod . spec . containers [ 0 ]. image . split ( \":\" )[ 1 ]; this . status . canUpgrade = true ; // a real implementation would perform a check here that is relevant to the specific feature } else { this . status . installed = false ; this . status . canUpgrade = false ; } } catch ( e ) { if ( e ? . error ? . code === 404 ) { this . status . installed = false ; this . status . canUpgrade = false ; } } return this . status ; } async uninstall ( cluster : Store.Cluster ) : Promise < void > { const podApi = K8sApi . forCluster ( cluster , K8sApi . Pod ); await podApi . delete ({ name : \"example-pod\" , namespace : \"default\" }); } } This example implements the install() method by simply invoking the helper applyResources() method. applyResources() tries to apply all resources read from all files found in the folder path provided. In this case this folder path is the ../resources subfolder relative to current source code's folder. The file ../resources/example-pod.yml could contain: apiVersion : v1 kind : Pod metadata : name : example-pod spec : containers : - name : example-pod image : nginx The upgrade() method in the example above is implemented by simply invoking the install() method. Depending on the feature to be supported by an extension, upgrading may require additional and/or different steps. The uninstall() method is implemented in the example above by utilizing the K8sApi provided by Lens to simply delete the example-pod pod applied by the install() method. The updateStatus() method is implemented above by using the K8sApi as well, this time to get information from the example-pod pod, in particular to determine if it is installed, what version is associated with it, and if it can be upgraded. How the status is updated for a specific cluster feature is up to the implementation. appPreferences # The Preferences page is a built-in global page. Extensions can add custom preferences to the Preferences page, thus providing a single location for users to configure global options, for Lens and extensions alike. The following example demonstrates adding a custom preference: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { observable } from \"mobx\" ; import React from \"react\" ; export default class ExampleRendererExtension extends LensRendererExtension { @observable preference = { enabled : false }; appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { this . preference } /> , Hint : () => < ExamplePreferenceHint /> } } ]; } App preferences are objects matching the AppPreferenceRegistration interface. The title field specifies the text to show as the heading on the Preferences page. The components field specifies two React.Component objects defining the interface for the preference. Input should specify an interactive input element for your preference and Hint should provide descriptive information for the preference, which is shown below the Input element. ExamplePreferenceInput expects its React props set to an ExamplePreferenceProps instance, which is how ExampleRendererExtension handles the state of the preference input. ExampleRendererExtension has the field preference , which is provided to ExamplePreferenceInput when it is created. In this example ExamplePreferenceInput , ExamplePreferenceHint , and ExamplePreferenceProps are defined in ./src/example-preference.tsx : import { Component } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; export class ExamplePreferenceProps { preference : { enabled : boolean ; } } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { render() { const { preference } = this . props ; return ( < Component . Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = { v => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render() { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } ExamplePreferenceInput implements a simple checkbox (using Lens's Component.Checkbox ). It provides label as the text to display next to the checkbox and an onChange function, which reacts to the checkbox state change. The checkbox's value is initially set to preference.enabled . ExamplePreferenceInput is defined with React props of ExamplePreferenceProps type, which is an object with a single field, enabled . This is used to indicate the state of the preference, and is bound to the checkbox state in onChange . ExamplePreferenceHint is a simple text span. Note that the input and the hint could comprise of more sophisticated elements, according to the needs of the extension. Note that the above example introduces decorators observable and observer from the mobx and mobx-react packages. mobx simplifies state management and without it this example would not visually update the checkbox properly when the user activates it. Lens uses mobx extensively for state management of its own UI elements and it is recommended that extensions rely on it too. Alternatively, React's state management can be used, though mobx is typically simpler to use. Also note that an extension's state data can be managed using an ExtensionStore object, which conveniently handles persistence and synchronization. The example above defined a preference field in the ExampleRendererExtension class definition to hold the extension's state primarily to simplify the code for this guide, but it is recommended to manage your extension's state data using ExtensionStore statusBarItems # The Status bar is the blue strip along the bottom of the Lens UI. Status bar items are React.ReactNode types, which can be used to convey status information, or act as a link to a global page, or even an external page. The following example adds a status bar item definition, as well as a global page definition, to a LensRendererExtension subclass, and configures the status bar item to navigate to the global page upon activation (normally a mouse click): import { LensRendererExtension } from '@k8slens/extensions' ; import { HelpIcon , HelpPage } from \"./page\" import React from 'react' ; export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; statusBarItems = [ { item : ( < div className = \"flex align-center gaps\" onClick = {() => this . navigate ( \"help\" )} > < HelpIcon /> My Status Bar Item < /div> ), }, ]; } The item field of a status bar item specifies the React.Component to be shown on the status bar. By default items are added starting from the right side of the status bar. Typically, item would specify an icon and/or a short string of text, considering the limited space on the status bar. In the example above the HelpIcon from the globalPageMenus guide is reused. Also, the item provides a link to the global page by setting the onClick property to a function that calls the LensRendererExtension navigate() method. navigate() takes as a parameter the id of the global page, which is shown when navigate() is called. kubeObjectMenuItems # An extension can add custom menu items (including actions) for specific Kubernetes resource kinds/apiVersions. These menu items appear under the ... for each listed resource in the cluster dashboard, and on the title bar of the details page for a specific resource: The following example shows how to add a menu for Namespace resources, and associate an action with it: import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { NamespaceMenuItem } from \"./src/namespace-menu-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectMenuItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : Component.KubeObjectMenuProps < K8sApi . Namespace > ) => < NamespaceMenuItem {... props } /> } } ]; } Kube object menu items are objects matching the KubeObjectMenuRegistration interface. The kind field specifies the kubernetes resource type to apply this menu item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. This example adds a menu item for namespaces in the cluster dashboard. The components field defines the menu item's appearance and behaviour. The MenuItem field provides a function that returns a React.Component given a set of menu item properties. In this example a NamespaceMenuItem object is returned. NamespaceMenuItem is defined in ./src/namespace-menu-item.tsx : import React from \"react\" ; import { Component , K8sApi , Navigation } from \"@k8slens/extensions\" ; export function NamespaceMenuItem ( props : Component.KubeObjectMenuProps < K8sApi . Namespace > ) { const { object : namespace , toolbar } = props ; if ( ! namespace ) return null ; const namespaceName = namespace . getName (); const sendToTerminal = ( command : string ) => { Component . terminalStore . sendCommand ( command , { enter : true , newTab : true , }); Navigation . hideDetails (); }; const getPods = () => { sendToTerminal ( `kubectl get pods -n ${ namespaceName } ` ); }; return ( < Component . MenuItem onClick = { getPods } > < Component . Icon material = \"speaker_group\" interactive = { toolbar } title = \"Get pods in terminal\" /> < span className = \"title\" > Get Pods < /span> < /Component.MenuItem> ); } NamespaceMenuItem returns a Component.MenuItem defining the menu item's appearance (icon and text) and behaviour when activated via the onClick property. getPods() shows how to open a terminal tab and run a command, specifically it runs kubectl to get a list of pods running in the current namespace. See Component.terminalStore.sendCommand for more details on running terminal commands. The name of the namespace is retrieved from props passed into NamespaceMenuItem() . namespace is the props.object , which is of type K8sApi.Namespace . This is the api for accessing namespaces, and the current namespace in this example is simply given by namespace.getName() . Thus kube object menu items are afforded convenient access to the specific resource selected by the user. kubeObjectDetailItems # An extension can add custom details (content) for specified Kubernetes resource kinds/apiVersions. These custom details appear on the details page for a specific resource, such as a Namespace: The following example shows how to add a tabulated list of pods to the Namespace resource details page: import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { NamespaceDetailsItem } from \"./src/namespace-details-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectDetailItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], priority : 10 , components : { Details : ( props : Component.KubeObjectDetailsProps < K8sApi . Namespace > ) => < NamespaceDetailsItem {... props } /> } } ]; } Kube object detail items are objects matching the KubeObjectDetailRegistration interface. The kind field specifies the kubernetes resource type to apply this detail item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. This example adds a detail item for namespaces in the cluster dashboard. The components field defines the detail item's appearance and behaviour. The Details field provides a function that returns a React.Component given a set of detail item properties. In this example a NamespaceDetailsItem object is returned. NamespaceDetailsItem is defined in ./src/namespace-details-item.tsx : import { Component , K8sApi } from \"@k8slens/extensions\" ; import { PodsDetailsList } from \"./pods-details-list\" ; import React from \"react\" ; import { observable } from \"mobx\" ; import { observer } from \"mobx-react\" ; @observer export class NamespaceDetailsItem extends React . Component < Component . KubeObjectDetailsProps < K8sApi . Namespace >> { @observable private pods : K8sApi.Pod []; async componentDidMount() { this . pods = await K8sApi . podsApi . list ({ namespace : this.props.object.getName ()}); } render() { return ( < div > < Component . DrawerTitle title = \"Pods\" /> < PodsDetailsList pods = { this . pods } /> < /div> ) } } Since NamespaceDetailsItem extends React.Component> it can access the current namespace object (type K8sApi.Namespace ) through this.props.object . This object can be queried for many details about the current namespace. In this example the namespace's name is obtained in componentDidMount() using the K8sApi.Namespace getName() method. The namespace's name is needed to limit the list of pods to only those in this namespace. To get the list of pods this example uses the kubernetes pods api, specifically the K8sApi.podsApi.list() method. The K8sApi.podsApi is automatically configured for the currently active cluster. Note that K8sApi.podsApi.list() is an asynchronous method, and ideally getting the pods list should be done before rendering the NamespaceDetailsItem . It is a common technique in React development to await async calls in componentDidMount() . However, componentDidMount() is called right after the first call to render() . In order to effect a subsequent render() call React must be made aware of a state change. Like in the appPreferences guide , mobx and mobx-react are used to ensure NamespaceDetailsItem renders when the pods list is updated. This is done simply by marking the pods field as an observable and the NamespaceDetailsItem class itself as an observer . Finally, the NamespaceDetailsItem is rendered using the render() method. Details are placed in drawers, and using Component.DrawerTitle provides a separator from details above this one. Multiple details in a drawer can be placed in elements for further separation, if desired. The rest of this example's details are defined in PodsDetailsList , found in ./pods-details-list.tsx : import React from \"react\" ; import { Component , K8sApi } from \"@k8slens/extensions\" ; interface Props { pods : K8sApi.Pod []; } export class PodsDetailsList extends React . Component < Props > { getTableRow ( index : number ) { const { pods } = this . props ; return ( < Component . TableRow key = { index } nowrap > < Component . TableCell className = \"podName\" > { pods [ index ]. getName ()} < /Component.TableCell> < Component . TableCell className = \"podAge\" > { pods [ index ]. getAge ()} < /Component.TableCell> < Component . TableCell className = \"podStatus\" > { pods [ index ]. getStatus ()} < /Component.TableCell> < /Component.TableRow> ) } render() { const { pods } = this . props if ( ! pods ? . length ) { return null ; } return ( < div > < Component . Table > < Component . TableHead > < Component . TableCell className = \"podName\" > Name < /Component.TableCell> < Component . TableCell className = \"podAge\" > Age < /Component.TableCell> < Component . TableCell className = \"podStatus\" > Status < /Component.TableCell> < /Component.TableHead> { pods . map (( pod , index ) => this . getTableRow ( index )) } < /Component.Table> < /div> ) } } PodsDetailsList produces a simple table showing a list of the pods found in this namespace: For each pod the name, age, and status are obtained using the K8sApi.Pod methods. The table is constructed using the Component.Table and related elements. See Component documentation for further details.","title":"Renderer Extension"},{"location":"extensions/guides/renderer-extension/#renderer-extension","text":"The renderer extension api is the interface to Lens's renderer process (Lens runs in main and renderer processes). It allows you to access, configure, and customize Lens data, add custom Lens UI elements, and generally run custom code in Lens's renderer process. The custom Lens UI elements that can be added include global pages, cluster pages, cluster page menus, cluster features, app preferences, status bar items, KubeObject menu items, and KubeObject details items. These UI elements are based on React components.","title":"Renderer Extension"},{"location":"extensions/guides/renderer-extension/#lensrendererextension-class","text":"To create a renderer extension simply extend the LensRendererExtension class: import { LensRendererExtension } from \"@k8slens/extensions\" ; export default class ExampleExtensionMain extends LensRendererExtension { onActivate() { console . log ( 'custom renderer process extension code started' ); } onDeactivate() { console . log ( 'custom renderer process extension de-activated' ); } } There are two methods that you can implement to facilitate running your custom code. onActivate() is called when your extension has been successfully enabled. By implementing onActivate() you can initiate your custom code. onDeactivate() is called when the extension is disabled (typically from the Lens Extensions Page ) and when implemented gives you a chance to clean up after your extension, if necessary. The example above simply logs messages when the extension is enabled and disabled.","title":"LensRendererExtension Class"},{"location":"extensions/guides/renderer-extension/#clusterpages","text":"Cluster pages appear as part of the cluster dashboard. They are accessible from the side bar, and are shown in the menu list after Custom Resources . It is conventional to use a cluster page to show information or provide functionality pertaining to the active cluster, along with custom data and functionality your extension may have. However, it is not limited to the active cluster. Also, your extension can gain access to the Kubernetes resources in the active cluster in a straightforward manner using the clusterStore . The following example adds a cluster page definition to a LensRendererExtension subclass: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; } Cluster pages are objects matching the PageRegistration interface. The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. The 'id' field can also convey route path details, such as variable parameters provided to a page ( See example below ). The components field matches the PageComponents interface for wich there is one field, Page . Page is of type React.ComponentType , which gives you great flexibility in defining the appearance and behaviour of your page. For the example above ExamplePage can be defined in page.tsx : import { LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Hello world !< /p> < /div> ) } } Note that the ExamplePage class defines a property named extension . This allows the ExampleExtension object to be passed in React-style in the cluster page definition, so that ExamplePage can access any ExampleExtension subclass data.","title":"clusterPages"},{"location":"extensions/guides/renderer-extension/#clusterpagemenus","text":"The above example code shows how to create a cluster page but not how to make it available to the Lens user. Cluster pages are typically made available through a menu item in the cluster dashboard sidebar. Expanding on the above example a cluster page menu is added to the ExampleExtension definition: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } } ]; clusterPageMenus = [ { target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , } }, ]; } Cluster page menus are objects matching the ClusterPageMenuRegistration interface. They define the appearance of the cluster page menu item in the cluster dashboard sidebar and the behaviour when the cluster page menu item is activated (typically by a mouse click). The example above uses the target field to set the behaviour as a link to the cluster page with id of \"hello\" . This is done by setting target 's pageId field to \"hello\" . The cluster page menu item's appearance is defined by setting the title field to the text that is to be displayed in the cluster dashboard sidebar. The components field is used to set an icon that appears to the left of the title text in the sidebar. Thus when the \"Hello World\" menu item is activated the cluster dashboard will show the contents of ExamplePage . This example requires the definition of another React-based component, ExampleIcon , which has been added to page.tsx : import { LensRendererExtension , Component } from \"@k8slens/extensions\" ; import React from \"react\" export function ExampleIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"pages\" tooltip = { \"Hi!\" } /> } export class ExamplePage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Hello world !< /p> < /div> ) } } ExampleIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon . Built in are the Material Design icons . One can be selected by name via the material field. ExampleIcon also sets a tooltip, shown when the Lens user hovers over the icon with a mouse, by setting the tooltip field. A cluster page menu can also be used to define a foldout submenu in the cluster dashboard sidebar. This enables the grouping of cluster pages. The following example shows how to specify a submenu having two menu items: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExampleIcon , ExamplePage } from \"./page\" import React from \"react\" export default class ExampleExtension extends LensRendererExtension { clusterPages = [ { id : \"hello\" , components : { Page : () => < ExamplePage extension = { this } /> , } }, { id : \"bonjour\" , components : { Page : () => < ExemplePage extension = { this } /> , } } ]; clusterPageMenus = [ { id : \"example\" , title : \"Greetings\" , components : { Icon : ExampleIcon , } }, { parentId : \"example\" , target : { pageId : \"hello\" }, title : \"Hello World\" , components : { Icon : ExampleIcon , } }, { parentId : \"example\" , target : { pageId : \"bonjour\" }, title : \"Bonjour le monde\" , components : { Icon : ExempleIcon , } } ]; } The above defines two cluster pages and three cluster page menu objects. The cluster page definitons are straightforward. The first cluster page menu object defines the parent of a foldout submenu. Setting the id field in a cluster page menu definition implies that it is defining a foldout submenu. Also note that the target field is not specified (it is ignored if the id field is specified). This cluster page menu object specifies the title and components fields, which are used in displaying the menu item in the cluster dashboard sidebar. Initially the submenu is hidden. Activating this menu item toggles on and off the appearance of the submenu below it. The remaining two cluster page menu objects define the contents of the submenu. A cluster page menu object is defined to be a submenu item by setting the parentId field to the id of the parent of a foldout submenu, \"example\" in this case","title":"clusterPageMenus"},{"location":"extensions/guides/renderer-extension/#globalpages","text":"Global pages appear independently of the cluster dashboard and they fill the Lens UI space. A global page is typically triggered from the cluster menu using a global page menu . They can also be triggered by a custom app menu selection from a Main Extension or a custom status bar item . Global pages can appear even when there is no active cluster, unlike cluster pages. It is conventional to use a global page to show information and provide functionality relevant across clusters, along with custom data and functionality that your extension may have. The following example defines a LensRendererExtension subclass with a single global page definition: import { LensRendererExtension } from '@k8slens/extensions' ; import { HelpPage } from './page' ; import React from 'react' ; export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; } Global pages are objects matching the PageRegistration interface. The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. The 'id' field can also convey route path details, such as variable parameters provided to a page ( See example below ). The components field matches the PageComponents interface for which there is one field, Page . Page is of type React.ComponentType , which gives you great flexibility in defining the appearance and behaviour of your page. For the example above HelpPage can be defined in page.tsx : import { LensRendererExtension } from \"@k8slens/extensions\" ; import React from \"react\" export class HelpPage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Help yourself < /p> < /div> ) } } Note that the HelpPage class defines a property named extension . This allows the HelpExtension object to be passed in React-style in the global page definition, so that HelpPage can access any HelpExtension subclass data. This example code shows how to create a global page but not how to make it available to the Lens user. Global pages are typically made available through a number of ways. Menu items can be added to the Lens app menu system and set to open a global page when activated (See appMenus in the Main Extension guide ). Interactive elements can be placed on the status bar (the blue strip along the bottom of the Lens UI) and can be configured to link to a global page when activated (See statusBarItems ). As well, global pages can be made accessible from the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Global page menu icons that are defined using globalPageMenus appear below the Add Cluster icon.","title":"globalPages"},{"location":"extensions/guides/renderer-extension/#globalpagemenus","text":"Global page menus connect a global page to the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. Expanding on the example from globalPages a global page menu is added to the HelpExtension definition: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { HelpIcon , HelpPage } from \"./page\" import React from \"react\" export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; globalPageMenus = [ { target : { pageId : \"help\" }, title : \"Help\" , components : { Icon : HelpIcon , } }, ]; } Global page menus are objects matching the PageMenuRegistration interface. They define the appearance of the global page menu item in the cluster menu and the behaviour when the global page menu item is activated (typically by a mouse click). The example above uses the target field to set the behaviour as a link to the global page with id of \"help\" . This is done by setting target 's pageId field to \"help\" . The global page menu item's appearance is defined by setting the title field to the text that is to be displayed as a tooltip in the cluster menu. The components field is used to set an icon that appears in the cluster menu. Thus when the \"Help\" icon is activated the contents of ExamplePage will be shown. This example requires the definition of another React-based component, HelpIcon , which has been added to page.tsx : import { LensRendererExtension , Component } from \"@k8slens/extensions\" ; import React from \"react\" export function HelpIcon ( props : Component.IconProps ) { return < Component . Icon {... props } material = \"help\" /> } export class HelpPage extends React . Component < { extension : LensRendererExtension } > { render() { return ( < div > < p > Help < /p> < /div> ) } } HelpIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon . Built in are the Material Design icons . One can be selected by name via the material field.","title":"globalPageMenus"},{"location":"extensions/guides/renderer-extension/#clusterfeatures","text":"Cluster features are Kubernetes resources that can be applied to and managed within the active cluster. They can be installed/uninstalled by the Lens user from the cluster settings page . The following example shows how to add a cluster feature as part of a LensRendererExtension : import { LensRendererExtension } from \"@k8slens/extensions\" import { ExampleFeature } from \"./src/example-feature\" import React from \"react\" export default class ExampleFeatureExtension extends LensRendererExtension { clusterFeatures = [ { title : \"Example Feature\" , components : { Description : () => { return ( < span > Enable an example feature . < /span> ) } }, feature : new ExampleFeature () } ]; } The title and components.Description fields provide content that appears on the cluster settings page, in the Features section. The feature field must specify an instance which extends the abstract class ClusterFeature.Feature , and specifically implement the following methods: abstract install ( cluster : Cluster ) : Promise < void > ; abstract upgrade ( cluster : Cluster ) : Promise < void > ; abstract uninstall ( cluster : Cluster ) : Promise < void > ; abstract updateStatus ( cluster : Cluster ) : Promise < ClusterFeatureStatus > ; The install() method is typically called by Lens when a user has indicated that this feature is to be installed (i.e. clicked Install for the feature on the cluster settings page). The implementation of this method should install kubernetes resources using the applyResources() method, or by directly accessing the kubernetes api ( K8sApi ). The upgrade() method is typically called by Lens when a user has indicated that this feature is to be upgraded (i.e. clicked Upgrade for the feature on the cluster settings page). The implementation of this method should upgrade the kubernetes resources already installed, if relevant to the feature. The uninstall() method is typically called by Lens when a user has indicated that this feature is to be uninstalled (i.e. clicked Uninstall for the feature on the cluster settings page). The implementation of this method should uninstall kubernetes resources using the kubernetes api ( K8sApi ) The updateStatus() 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 in the status field of the ClusterFeature.Feature parent class. The status.currentVersion and status.latestVersion fields may be displayed by Lens in describing the feature. The status.installed field should be set to true if the feature is currently installed, otherwise false. Also, Lens relies on the status.canUpgrade field to determine if the feature can be upgraded (i.e a new version could be available) so the implementation should set the status.canUpgrade field according to specific rules for the feature, if relevant. The following shows a very simple implementation of a ClusterFeature : import { ClusterFeature , Store , K8sApi } from \"@k8slens/extensions\" ; import * as path from \"path\" ; export class ExampleFeature extends ClusterFeature . Feature { async install ( cluster : Store.Cluster ) : Promise < void > { super . applyResources ( cluster , path . join ( __dirname , \"../resources/\" )); } async upgrade ( cluster : Store.Cluster ) : Promise < void > { return this . install ( cluster ); } async updateStatus ( cluster : Store.Cluster ) : Promise < ClusterFeature . FeatureStatus > { try { const pod = K8sApi . forCluster ( cluster , K8sApi . Pod ); const examplePod = await pod . get ({ name : \"example-pod\" , namespace : \"default\" }); if ( examplePod ? . kind ) { this . status . installed = true ; this . status . currentVersion = examplePod . spec . containers [ 0 ]. image . split ( \":\" )[ 1 ]; this . status . canUpgrade = true ; // a real implementation would perform a check here that is relevant to the specific feature } else { this . status . installed = false ; this . status . canUpgrade = false ; } } catch ( e ) { if ( e ? . error ? . code === 404 ) { this . status . installed = false ; this . status . canUpgrade = false ; } } return this . status ; } async uninstall ( cluster : Store.Cluster ) : Promise < void > { const podApi = K8sApi . forCluster ( cluster , K8sApi . Pod ); await podApi . delete ({ name : \"example-pod\" , namespace : \"default\" }); } } This example implements the install() method by simply invoking the helper applyResources() method. applyResources() tries to apply all resources read from all files found in the folder path provided. In this case this folder path is the ../resources subfolder relative to current source code's folder. The file ../resources/example-pod.yml could contain: apiVersion : v1 kind : Pod metadata : name : example-pod spec : containers : - name : example-pod image : nginx The upgrade() method in the example above is implemented by simply invoking the install() method. Depending on the feature to be supported by an extension, upgrading may require additional and/or different steps. The uninstall() method is implemented in the example above by utilizing the K8sApi provided by Lens to simply delete the example-pod pod applied by the install() method. The updateStatus() method is implemented above by using the K8sApi as well, this time to get information from the example-pod pod, in particular to determine if it is installed, what version is associated with it, and if it can be upgraded. How the status is updated for a specific cluster feature is up to the implementation.","title":"clusterFeatures"},{"location":"extensions/guides/renderer-extension/#apppreferences","text":"The Preferences page is a built-in global page. Extensions can add custom preferences to the Preferences page, thus providing a single location for users to configure global options, for Lens and extensions alike. The following example demonstrates adding a custom preference: import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { observable } from \"mobx\" ; import React from \"react\" ; export default class ExampleRendererExtension extends LensRendererExtension { @observable preference = { enabled : false }; appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { this . preference } /> , Hint : () => < ExamplePreferenceHint /> } } ]; } App preferences are objects matching the AppPreferenceRegistration interface. The title field specifies the text to show as the heading on the Preferences page. The components field specifies two React.Component objects defining the interface for the preference. Input should specify an interactive input element for your preference and Hint should provide descriptive information for the preference, which is shown below the Input element. ExamplePreferenceInput expects its React props set to an ExamplePreferenceProps instance, which is how ExampleRendererExtension handles the state of the preference input. ExampleRendererExtension has the field preference , which is provided to ExamplePreferenceInput when it is created. In this example ExamplePreferenceInput , ExamplePreferenceHint , and ExamplePreferenceProps are defined in ./src/example-preference.tsx : import { Component } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; export class ExamplePreferenceProps { preference : { enabled : boolean ; } } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { render() { const { preference } = this . props ; return ( < Component . Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = { v => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render() { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } ExamplePreferenceInput implements a simple checkbox (using Lens's Component.Checkbox ). It provides label as the text to display next to the checkbox and an onChange function, which reacts to the checkbox state change. The checkbox's value is initially set to preference.enabled . ExamplePreferenceInput is defined with React props of ExamplePreferenceProps type, which is an object with a single field, enabled . This is used to indicate the state of the preference, and is bound to the checkbox state in onChange . ExamplePreferenceHint is a simple text span. Note that the input and the hint could comprise of more sophisticated elements, according to the needs of the extension. Note that the above example introduces decorators observable and observer from the mobx and mobx-react packages. mobx simplifies state management and without it this example would not visually update the checkbox properly when the user activates it. Lens uses mobx extensively for state management of its own UI elements and it is recommended that extensions rely on it too. Alternatively, React's state management can be used, though mobx is typically simpler to use. Also note that an extension's state data can be managed using an ExtensionStore object, which conveniently handles persistence and synchronization. The example above defined a preference field in the ExampleRendererExtension class definition to hold the extension's state primarily to simplify the code for this guide, but it is recommended to manage your extension's state data using ExtensionStore","title":"appPreferences"},{"location":"extensions/guides/renderer-extension/#statusbaritems","text":"The Status bar is the blue strip along the bottom of the Lens UI. Status bar items are React.ReactNode types, which can be used to convey status information, or act as a link to a global page, or even an external page. The following example adds a status bar item definition, as well as a global page definition, to a LensRendererExtension subclass, and configures the status bar item to navigate to the global page upon activation (normally a mouse click): import { LensRendererExtension } from '@k8slens/extensions' ; import { HelpIcon , HelpPage } from \"./page\" import React from 'react' ; export default class HelpExtension extends LensRendererExtension { globalPages = [ { id : \"help\" , components : { Page : () => < HelpPage extension = { this } /> , } } ]; statusBarItems = [ { item : ( < div className = \"flex align-center gaps\" onClick = {() => this . navigate ( \"help\" )} > < HelpIcon /> My Status Bar Item < /div> ), }, ]; } The item field of a status bar item specifies the React.Component to be shown on the status bar. By default items are added starting from the right side of the status bar. Typically, item would specify an icon and/or a short string of text, considering the limited space on the status bar. In the example above the HelpIcon from the globalPageMenus guide is reused. Also, the item provides a link to the global page by setting the onClick property to a function that calls the LensRendererExtension navigate() method. navigate() takes as a parameter the id of the global page, which is shown when navigate() is called.","title":"statusBarItems"},{"location":"extensions/guides/renderer-extension/#kubeobjectmenuitems","text":"An extension can add custom menu items (including actions) for specific Kubernetes resource kinds/apiVersions. These menu items appear under the ... for each listed resource in the cluster dashboard, and on the title bar of the details page for a specific resource: The following example shows how to add a menu for Namespace resources, and associate an action with it: import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { NamespaceMenuItem } from \"./src/namespace-menu-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectMenuItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], components : { MenuItem : ( props : Component.KubeObjectMenuProps < K8sApi . Namespace > ) => < NamespaceMenuItem {... props } /> } } ]; } Kube object menu items are objects matching the KubeObjectMenuRegistration interface. The kind field specifies the kubernetes resource type to apply this menu item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. This example adds a menu item for namespaces in the cluster dashboard. The components field defines the menu item's appearance and behaviour. The MenuItem field provides a function that returns a React.Component given a set of menu item properties. In this example a NamespaceMenuItem object is returned. NamespaceMenuItem is defined in ./src/namespace-menu-item.tsx : import React from \"react\" ; import { Component , K8sApi , Navigation } from \"@k8slens/extensions\" ; export function NamespaceMenuItem ( props : Component.KubeObjectMenuProps < K8sApi . Namespace > ) { const { object : namespace , toolbar } = props ; if ( ! namespace ) return null ; const namespaceName = namespace . getName (); const sendToTerminal = ( command : string ) => { Component . terminalStore . sendCommand ( command , { enter : true , newTab : true , }); Navigation . hideDetails (); }; const getPods = () => { sendToTerminal ( `kubectl get pods -n ${ namespaceName } ` ); }; return ( < Component . MenuItem onClick = { getPods } > < Component . Icon material = \"speaker_group\" interactive = { toolbar } title = \"Get pods in terminal\" /> < span className = \"title\" > Get Pods < /span> < /Component.MenuItem> ); } NamespaceMenuItem returns a Component.MenuItem defining the menu item's appearance (icon and text) and behaviour when activated via the onClick property. getPods() shows how to open a terminal tab and run a command, specifically it runs kubectl to get a list of pods running in the current namespace. See Component.terminalStore.sendCommand for more details on running terminal commands. The name of the namespace is retrieved from props passed into NamespaceMenuItem() . namespace is the props.object , which is of type K8sApi.Namespace . This is the api for accessing namespaces, and the current namespace in this example is simply given by namespace.getName() . Thus kube object menu items are afforded convenient access to the specific resource selected by the user.","title":"kubeObjectMenuItems"},{"location":"extensions/guides/renderer-extension/#kubeobjectdetailitems","text":"An extension can add custom details (content) for specified Kubernetes resource kinds/apiVersions. These custom details appear on the details page for a specific resource, such as a Namespace: The following example shows how to add a tabulated list of pods to the Namespace resource details page: import React from \"react\" import { LensRendererExtension } from \"@k8slens/extensions\" ; import { NamespaceDetailsItem } from \"./src/namespace-details-item\" export default class ExampleExtension extends LensRendererExtension { kubeObjectDetailItems = [ { kind : \"Namespace\" , apiVersions : [ \"v1\" ], priority : 10 , components : { Details : ( props : Component.KubeObjectDetailsProps < K8sApi . Namespace > ) => < NamespaceDetailsItem {... props } /> } } ]; } Kube object detail items are objects matching the KubeObjectDetailRegistration interface. The kind field specifies the kubernetes resource type to apply this detail item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. This example adds a detail item for namespaces in the cluster dashboard. The components field defines the detail item's appearance and behaviour. The Details field provides a function that returns a React.Component given a set of detail item properties. In this example a NamespaceDetailsItem object is returned. NamespaceDetailsItem is defined in ./src/namespace-details-item.tsx : import { Component , K8sApi } from \"@k8slens/extensions\" ; import { PodsDetailsList } from \"./pods-details-list\" ; import React from \"react\" ; import { observable } from \"mobx\" ; import { observer } from \"mobx-react\" ; @observer export class NamespaceDetailsItem extends React . Component < Component . KubeObjectDetailsProps < K8sApi . Namespace >> { @observable private pods : K8sApi.Pod []; async componentDidMount() { this . pods = await K8sApi . podsApi . list ({ namespace : this.props.object.getName ()}); } render() { return ( < div > < Component . DrawerTitle title = \"Pods\" /> < PodsDetailsList pods = { this . pods } /> < /div> ) } } Since NamespaceDetailsItem extends React.Component> it can access the current namespace object (type K8sApi.Namespace ) through this.props.object . This object can be queried for many details about the current namespace. In this example the namespace's name is obtained in componentDidMount() using the K8sApi.Namespace getName() method. The namespace's name is needed to limit the list of pods to only those in this namespace. To get the list of pods this example uses the kubernetes pods api, specifically the K8sApi.podsApi.list() method. The K8sApi.podsApi is automatically configured for the currently active cluster. Note that K8sApi.podsApi.list() is an asynchronous method, and ideally getting the pods list should be done before rendering the NamespaceDetailsItem . It is a common technique in React development to await async calls in componentDidMount() . However, componentDidMount() is called right after the first call to render() . In order to effect a subsequent render() call React must be made aware of a state change. Like in the appPreferences guide , mobx and mobx-react are used to ensure NamespaceDetailsItem renders when the pods list is updated. This is done simply by marking the pods field as an observable and the NamespaceDetailsItem class itself as an observer . Finally, the NamespaceDetailsItem is rendered using the render() method. Details are placed in drawers, and using Component.DrawerTitle provides a separator from details above this one. Multiple details in a drawer can be placed in elements for further separation, if desired. The rest of this example's details are defined in PodsDetailsList , found in ./pods-details-list.tsx : import React from \"react\" ; import { Component , K8sApi } from \"@k8slens/extensions\" ; interface Props { pods : K8sApi.Pod []; } export class PodsDetailsList extends React . Component < Props > { getTableRow ( index : number ) { const { pods } = this . props ; return ( < Component . TableRow key = { index } nowrap > < Component . TableCell className = \"podName\" > { pods [ index ]. getName ()} < /Component.TableCell> < Component . TableCell className = \"podAge\" > { pods [ index ]. getAge ()} < /Component.TableCell> < Component . TableCell className = \"podStatus\" > { pods [ index ]. getStatus ()} < /Component.TableCell> < /Component.TableRow> ) } render() { const { pods } = this . props if ( ! pods ? . length ) { return null ; } return ( < div > < Component . Table > < Component . TableHead > < Component . TableCell className = \"podName\" > Name < /Component.TableCell> < Component . TableCell className = \"podAge\" > Age < /Component.TableCell> < Component . TableCell className = \"podStatus\" > Status < /Component.TableCell> < /Component.TableHead> { pods . map (( pod , index ) => this . getTableRow ( index )) } < /Component.Table> < /div> ) } } PodsDetailsList produces a simple table showing a list of the pods found in this namespace: For each pod the name, age, and status are obtained using the K8sApi.Pod methods. The table is constructed using the Component.Table and related elements. See Component documentation for further details.","title":"kubeObjectDetailItems"},{"location":"extensions/guides/stores/","text":"Stores # Stores are components that persist and synchronize state data. Lens utilizes a number of stores for maintaining a variety of state information. A few of these are exposed by the extensions api for use by the extension developer. The ClusterStore manages cluster state data such as cluster details, and which cluster is active. The WorkspaceStore similarly manages workspace state data, such as workspace name, and which clusters belong to a given workspace. The ExtensionStore is a store for managing custom extension state data. ExtensionStore # Extension developers can create their own store for managing state data by extending the ExtensionStore class. This guide shows how to create a store for the appPreferences guide example , which demonstrates how to add a custom preference to the Preferences page. The preference is a simple boolean that indicates whether something is enabled or not. The problem with that example is that the enabled state is not stored anywhere, and reverts to the default the next time Lens is started. The following example code creates a store for the appPreferences guide example: import { Store } from \"@k8slens/extensions\" ; import { observable , toJS } from \"mobx\" ; export type ExamplePreferencesModel = { enabled : boolean ; }; export class ExamplePreferencesStore extends Store . ExtensionStore < ExamplePreferencesModel > { @observable enabled = false ; private constructor () { super ({ configName : \"example-preferences-store\" , defaults : { enabled : false } }); } protected fromStore ({ enabled } : ExamplePreferencesModel ) : void { this . enabled = enabled ; } toJSON () : ExamplePreferencesModel { return toJS ({ enabled : this.enabled }, { recurseEverything : true }); } } export const examplePreferencesStore = ExamplePreferencesStore . getInstance < ExamplePreferencesStore > (); First the extension's data model is defined using a simple type, ExamplePreferencesModel , which has a single field, enabled , representing the preference's state. ExamplePreferencesStore extends Store.ExtensionStore , based on the ExamplePreferencesModel . The field enabled is added to the ExamplePreferencesStore class to hold the \"live\" or current state of the preference. Note the use of the observer decorator on the enabled field. As for the appPreferences guide example , mobx is used for the UI state management, ensuring the checkbox updates when activated by the user. Then the constructor and two abstract methods are implemented. In the constructor, the name of the store ( \"example-preferences-store\" ), and the default (initial) value for the preference state ( enabled: false ) are specified. The fromStore() method is called by Lens internals when the store is loaded, and gives the extension the opportunity to retrieve the stored state data values based on the defined data model. Here, the enabled field of the ExamplePreferencesStore is set to the value from the store whenever fromStore() is invoked. The toJSON() method is complementary to fromStore() , and is called when the store is being saved. toJSON() must provide a JSON serializable object, facilitating its storage in JSON format. The toJS() function from mobx is convenient for this purpose, and is used here. Finally, examplePreferencesStore is created by calling ExamplePreferencesStore.getInstance() , and exported for use by other parts of the extension. Note that examplePreferencesStore is a singleton, calling this function again will not create a new store. The following example code, modified from the appPreferences guide example demonstrates how to use the extension store. examplePreferencesStore must be loaded in the main process, where loaded stores are automatically saved when exiting Lens. This can be done in ./main.ts : import { LensMainExtension } from \"@k8slens/extensions\" ; import { examplePreferencesStore } from \"./src/example-preference-store\" ; export default class ExampleMainExtension extends LensMainExtension { async onActivate() { await examplePreferencesStore . loadExtension ( this ); } } Here, examplePreferencesStore is loaded with examplePreferencesStore.loadExtension(this) , which is conveniently called from the onActivate() method of ExampleMainExtension . Similarly, examplePreferencesStore must be loaded in the renderer process where the appPreferences are handled. This can be done in ./renderer.ts : import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { examplePreferencesStore } from \"./src/example-preference-store\" ; import React from \"react\" ; export default class ExampleRendererExtension extends LensRendererExtension { async onActivate() { await examplePreferencesStore . loadExtension ( this ); } appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { examplePreferencesStore } /> , Hint : () => < ExamplePreferenceHint /> } } ]; } Again, examplePreferencesStore.loadExtension(this) is called to load examplePreferencesStore , this time from the onActivate() method of ExampleRendererExtension . Also, there is no longer the need for the preference field in the ExampleRendererExtension class, as the props for ExamplePreferenceInput is now examplePreferencesStore . ExamplePreferenceInput is defined in ./src/example-preference.tsx : import { Component } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; import { ExamplePreferencesStore } from \"./example-preference-store\" ; export class ExamplePreferenceProps { preference : ExamplePreferencesStore ; } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { render() { const { preference } = this . props ; return ( < Component . Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = { v => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render() { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } The only change here is that ExamplePreferenceProps defines its preference field as an ExamplePreferencesStore type. Everything else works as before except now the enabled state persists across Lens restarts because it is managed by the examplePreferencesStore .","title":"Stores"},{"location":"extensions/guides/stores/#stores","text":"Stores are components that persist and synchronize state data. Lens utilizes a number of stores for maintaining a variety of state information. A few of these are exposed by the extensions api for use by the extension developer. The ClusterStore manages cluster state data such as cluster details, and which cluster is active. The WorkspaceStore similarly manages workspace state data, such as workspace name, and which clusters belong to a given workspace. The ExtensionStore is a store for managing custom extension state data.","title":"Stores"},{"location":"extensions/guides/stores/#extensionstore","text":"Extension developers can create their own store for managing state data by extending the ExtensionStore class. This guide shows how to create a store for the appPreferences guide example , which demonstrates how to add a custom preference to the Preferences page. The preference is a simple boolean that indicates whether something is enabled or not. The problem with that example is that the enabled state is not stored anywhere, and reverts to the default the next time Lens is started. The following example code creates a store for the appPreferences guide example: import { Store } from \"@k8slens/extensions\" ; import { observable , toJS } from \"mobx\" ; export type ExamplePreferencesModel = { enabled : boolean ; }; export class ExamplePreferencesStore extends Store . ExtensionStore < ExamplePreferencesModel > { @observable enabled = false ; private constructor () { super ({ configName : \"example-preferences-store\" , defaults : { enabled : false } }); } protected fromStore ({ enabled } : ExamplePreferencesModel ) : void { this . enabled = enabled ; } toJSON () : ExamplePreferencesModel { return toJS ({ enabled : this.enabled }, { recurseEverything : true }); } } export const examplePreferencesStore = ExamplePreferencesStore . getInstance < ExamplePreferencesStore > (); First the extension's data model is defined using a simple type, ExamplePreferencesModel , which has a single field, enabled , representing the preference's state. ExamplePreferencesStore extends Store.ExtensionStore , based on the ExamplePreferencesModel . The field enabled is added to the ExamplePreferencesStore class to hold the \"live\" or current state of the preference. Note the use of the observer decorator on the enabled field. As for the appPreferences guide example , mobx is used for the UI state management, ensuring the checkbox updates when activated by the user. Then the constructor and two abstract methods are implemented. In the constructor, the name of the store ( \"example-preferences-store\" ), and the default (initial) value for the preference state ( enabled: false ) are specified. The fromStore() method is called by Lens internals when the store is loaded, and gives the extension the opportunity to retrieve the stored state data values based on the defined data model. Here, the enabled field of the ExamplePreferencesStore is set to the value from the store whenever fromStore() is invoked. The toJSON() method is complementary to fromStore() , and is called when the store is being saved. toJSON() must provide a JSON serializable object, facilitating its storage in JSON format. The toJS() function from mobx is convenient for this purpose, and is used here. Finally, examplePreferencesStore is created by calling ExamplePreferencesStore.getInstance() , and exported for use by other parts of the extension. Note that examplePreferencesStore is a singleton, calling this function again will not create a new store. The following example code, modified from the appPreferences guide example demonstrates how to use the extension store. examplePreferencesStore must be loaded in the main process, where loaded stores are automatically saved when exiting Lens. This can be done in ./main.ts : import { LensMainExtension } from \"@k8slens/extensions\" ; import { examplePreferencesStore } from \"./src/example-preference-store\" ; export default class ExampleMainExtension extends LensMainExtension { async onActivate() { await examplePreferencesStore . loadExtension ( this ); } } Here, examplePreferencesStore is loaded with examplePreferencesStore.loadExtension(this) , which is conveniently called from the onActivate() method of ExampleMainExtension . Similarly, examplePreferencesStore must be loaded in the renderer process where the appPreferences are handled. This can be done in ./renderer.ts : import { LensRendererExtension } from \"@k8slens/extensions\" ; import { ExamplePreferenceHint , ExamplePreferenceInput } from \"./src/example-preference\" ; import { examplePreferencesStore } from \"./src/example-preference-store\" ; import React from \"react\" ; export default class ExampleRendererExtension extends LensRendererExtension { async onActivate() { await examplePreferencesStore . loadExtension ( this ); } appPreferences = [ { title : \"Example Preferences\" , components : { Input : () => < ExamplePreferenceInput preference = { examplePreferencesStore } /> , Hint : () => < ExamplePreferenceHint /> } } ]; } Again, examplePreferencesStore.loadExtension(this) is called to load examplePreferencesStore , this time from the onActivate() method of ExampleRendererExtension . Also, there is no longer the need for the preference field in the ExampleRendererExtension class, as the props for ExamplePreferenceInput is now examplePreferencesStore . ExamplePreferenceInput is defined in ./src/example-preference.tsx : import { Component } from \"@k8slens/extensions\" ; import { observer } from \"mobx-react\" ; import React from \"react\" ; import { ExamplePreferencesStore } from \"./example-preference-store\" ; export class ExamplePreferenceProps { preference : ExamplePreferencesStore ; } @observer export class ExamplePreferenceInput extends React . Component < ExamplePreferenceProps > { render() { const { preference } = this . props ; return ( < Component . Checkbox label = \"I understand appPreferences\" value = { preference . enabled } onChange = { v => { preference . enabled = v ; }} /> ); } } export class ExamplePreferenceHint extends React . Component { render() { return ( < span > This is an example of an appPreference for extensions . < /span> ); } } The only change here is that ExamplePreferenceProps defines its preference field as an ExamplePreferencesStore type. Everything else works as before except now the enabled state persists across Lens restarts because it is managed by the examplePreferencesStore .","title":"ExtensionStore"},{"location":"extensions/guides/working-with-mobx/","text":"Working with mobx # Introduction # Lens uses mobx as its state manager on top of React's state management system. This helps with having a more declarative style of managing state, as opposed to React 's native setState mechanism. You should already have a basic understanding of how React handles state ( read here for more information). However, if you do not, here is a quick overview. A React.Component is generic over both Props and State (with default empty object types). Props should be considered read-only from the point of view of the component and is the mechanism for passing in \"arguments\" to a component. State is a component's internal state and can be read by accessing the parent field state . State must be updated using the setState parent method which merges the new data with the old state. React does do some optimizations around re-rendering components after quick successions of setState calls. How mobx works: # mobx is a package that provides an abstraction over React 's state management. The three main concepts are: - observable : data stored in the component's state - action : a function that modifies any observable data - computed : data that is derived from observable data but is not actually stored. Think of this as computing isEmpty vs an observable field called count . Further reading is available from mobx 's website .","title":"Working with mobx"},{"location":"extensions/guides/working-with-mobx/#working-with-mobx","text":"","title":"Working with mobx"},{"location":"extensions/guides/working-with-mobx/#introduction","text":"Lens uses mobx as its state manager on top of React's state management system. This helps with having a more declarative style of managing state, as opposed to React 's native setState mechanism. You should already have a basic understanding of how React handles state ( read here for more information). However, if you do not, here is a quick overview. A React.Component is generic over both Props and State (with default empty object types). Props should be considered read-only from the point of view of the component and is the mechanism for passing in \"arguments\" to a component. State is a component's internal state and can be read by accessing the parent field state . State must be updated using the setState parent method which merges the new data with the old state. React does do some optimizations around re-rendering components after quick successions of setState calls.","title":"Introduction"},{"location":"extensions/guides/working-with-mobx/#how-mobx-works","text":"mobx is a package that provides an abstraction over React 's state management. The three main concepts are: - observable : data stored in the component's state - action : a function that modifies any observable data - computed : data that is derived from observable data but is not actually stored. Think of this as computing isEmpty vs an observable field called count . Further reading is available from mobx 's website .","title":"How mobx works:"},{"location":"extensions/testing-and-publishing/bundling/","text":"","title":"Bundling"},{"location":"extensions/testing-and-publishing/publishing/","text":"Publishing Extensions # To be able to easily share extensions with users they need to be published somewhere. Lens currently only supports installing extensions from NPM tarballs. All hosted extensions must, therefore, be retrievable in a NPM tarball. Places To Host Your Extension # We recommend to host your extension somewhere on the web so that it is easy for people to search for and download it. We recommend either hosting it as an NPM package on https://www.npmjs.com or through GitHub releases. We recommend against using GitHub packages (https://github.com/features/packages) as it requires a GitHub token to access the package. Publishing via NPM # This is the easiest method of publishing as NPM comes built in with mechanism to get a link to download the package as a tarball. Once you have set up an account with NPM (https://www.npmjs.com/signup) and logged in with their CLI ( npm login ) you will be ready to publish. Run npm version to bump the version of your extension by the appropriate amount. Run npm publish to publish your extension to NPM Run git push && git push --tags to push the commit that NPM creates to your git remote. It is probably a good idea to put into your README.md the following instructions for your users to get the tarball download link. npm view dist.tarball This will output the link that they will need to give to Lens to install your extension. Publish via GitHub Releases # Another method of publishing your extensions is to do so with the releases mechanism built into GitHub. We recommend reading GitHub's Releases Documentation for how to actually do the steps of a release. The following will be a quick walk through on how to make the tarball which will be the released file. Making a NPM Tarball of Your Extension # While this is necessary for hosting on GitHub releases, this is also the means for creating a tarball if you plan on hosting on a different file hosting platform. Say you have your project folder at ~/my-extension/ and you want to create an NPM package we need to do the following within your git repo: npm pack This will create a NPM tarball that can be hosted on Github Releases or any other publicly available file hosting service.","title":"Publishing Extensions"},{"location":"extensions/testing-and-publishing/publishing/#publishing-extensions","text":"To be able to easily share extensions with users they need to be published somewhere. Lens currently only supports installing extensions from NPM tarballs. All hosted extensions must, therefore, be retrievable in a NPM tarball.","title":"Publishing Extensions"},{"location":"extensions/testing-and-publishing/publishing/#places-to-host-your-extension","text":"We recommend to host your extension somewhere on the web so that it is easy for people to search for and download it. We recommend either hosting it as an NPM package on https://www.npmjs.com or through GitHub releases. We recommend against using GitHub packages (https://github.com/features/packages) as it requires a GitHub token to access the package.","title":"Places To Host Your Extension"},{"location":"extensions/testing-and-publishing/publishing/#publishing-via-npm","text":"This is the easiest method of publishing as NPM comes built in with mechanism to get a link to download the package as a tarball. Once you have set up an account with NPM (https://www.npmjs.com/signup) and logged in with their CLI ( npm login ) you will be ready to publish. Run npm version to bump the version of your extension by the appropriate amount. Run npm publish to publish your extension to NPM Run git push && git push --tags to push the commit that NPM creates to your git remote. It is probably a good idea to put into your README.md the following instructions for your users to get the tarball download link. npm view dist.tarball This will output the link that they will need to give to Lens to install your extension.","title":"Publishing via NPM"},{"location":"extensions/testing-and-publishing/publishing/#publish-via-github-releases","text":"Another method of publishing your extensions is to do so with the releases mechanism built into GitHub. We recommend reading GitHub's Releases Documentation for how to actually do the steps of a release. The following will be a quick walk through on how to make the tarball which will be the released file.","title":"Publish via GitHub Releases"},{"location":"extensions/testing-and-publishing/publishing/#making-a-npm-tarball-of-your-extension","text":"While this is necessary for hosting on GitHub releases, this is also the means for creating a tarball if you plan on hosting on a different file hosting platform. Say you have your project folder at ~/my-extension/ and you want to create an NPM package we need to do the following within your git repo: npm pack This will create a NPM tarball that can be hosted on Github Releases or any other publicly available file hosting service.","title":"Making a NPM Tarball of Your Extension"},{"location":"extensions/testing-and-publishing/testing/","text":"Testing Extensions # Renderer Process Unit Testing # UI components in extension renderer process are based on React/ReactDOM. These components can be tested by popular React testing tools like React Testing Library . If you are using the Yeoman Lens Extension Generator to scaffold extension project. The testing environment for render process are already setup for you. Just use npm start or yarn test to run the tests. For example, I have a component GlobalPageMenuIcon and want to test if props.navigate is called when user clicks the icon. My component GlobalPageMenuIcon import React from \"react\" import { Component: { Icon } } from \"@k8slens/extensions\"; const GlobalPageMenuIcon = ({ navigate }: { navigate?: () => void }): JSX.Element => ( navigate()} data-testid=\"global-page-menu-icon\" /> ) The test import React from \"react\" import { render , screen , fireEvent } from \"@testing-library/react\" ; import GlobalPageMenuIcon from \"./GlobalPageMenuIcon\" ; test ( \"click called navigate()\" , () => { const navigate = jest . fn (); render ( < GlobalPageMenuIcon navigate = { navigate } /> ); fireEvent . click ( screen . getByTestId ( \"global-page-menu-icon\" )); expect ( navigate ). toHaveBeenCalled (); }); In the example we used React Testing Library but any React testing framework can be used to test renderer process UI components. There are more example tests in the generator's template . Extend your tests based on the examples. Main Process Unit Testing # Code in the extension main process are just normal JavaScript files that has access to extension api, you can write unit tests using any testing framework. If you are using the Yeoman Lens Extension Generator to scaffold your extension project. The testing environment Jest are setup for you. Just use npm start or yarn test to run the tests. Tips # Console.log # Extension developers might find console.log() useful for printing out information and errors from extensions. To use console.log() , note that Lens is based on Electron, and that Electron has two types of processes: Main and Renderer . Renderer Process Logs # In the Renderer process, console.log() is printed in the Console in Developer Tools ( View > Toggle Developer Tools ). Main Process Logs # Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools. macOS On macOS, view the Main process logs by running Lens from the terminal: /Applications/Lens.app/Contents/MacOS/Lens You can also use Console.app to view the Main process logs. Linux On Linux, you can access the Main process logs using the Lens PID. First get the PID: ps aux | grep Lens | grep -v grep Then get the Main process logs using the PID: tail -f /proc/ [ pid ] /fd/1 # stdout (console.log) tail -f /proc/ [ pid ] /fd/2 # stdout (console.error)","title":"Testing Extensions"},{"location":"extensions/testing-and-publishing/testing/#testing-extensions","text":"","title":"Testing Extensions"},{"location":"extensions/testing-and-publishing/testing/#renderer-process-unit-testing","text":"UI components in extension renderer process are based on React/ReactDOM. These components can be tested by popular React testing tools like React Testing Library . If you are using the Yeoman Lens Extension Generator to scaffold extension project. The testing environment for render process are already setup for you. Just use npm start or yarn test to run the tests. For example, I have a component GlobalPageMenuIcon and want to test if props.navigate is called when user clicks the icon. My component GlobalPageMenuIcon import React from \"react\" import { Component: { Icon } } from \"@k8slens/extensions\"; const GlobalPageMenuIcon = ({ navigate }: { navigate?: () => void }): JSX.Element => ( navigate()} data-testid=\"global-page-menu-icon\" /> ) The test import React from \"react\" import { render , screen , fireEvent } from \"@testing-library/react\" ; import GlobalPageMenuIcon from \"./GlobalPageMenuIcon\" ; test ( \"click called navigate()\" , () => { const navigate = jest . fn (); render ( < GlobalPageMenuIcon navigate = { navigate } /> ); fireEvent . click ( screen . getByTestId ( \"global-page-menu-icon\" )); expect ( navigate ). toHaveBeenCalled (); }); In the example we used React Testing Library but any React testing framework can be used to test renderer process UI components. There are more example tests in the generator's template . Extend your tests based on the examples.","title":"Renderer Process Unit Testing"},{"location":"extensions/testing-and-publishing/testing/#main-process-unit-testing","text":"Code in the extension main process are just normal JavaScript files that has access to extension api, you can write unit tests using any testing framework. If you are using the Yeoman Lens Extension Generator to scaffold your extension project. The testing environment Jest are setup for you. Just use npm start or yarn test to run the tests.","title":"Main Process Unit Testing"},{"location":"extensions/testing-and-publishing/testing/#tips","text":"","title":"Tips"},{"location":"extensions/testing-and-publishing/testing/#consolelog","text":"Extension developers might find console.log() useful for printing out information and errors from extensions. To use console.log() , note that Lens is based on Electron, and that Electron has two types of processes: Main and Renderer .","title":"Console.log"},{"location":"extensions/testing-and-publishing/testing/#renderer-process-logs","text":"In the Renderer process, console.log() is printed in the Console in Developer Tools ( View > Toggle Developer Tools ).","title":"Renderer Process Logs"},{"location":"extensions/testing-and-publishing/testing/#main-process-logs","text":"Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools.","title":"Main Process Logs"},{"location":"extensions/usage/","text":"Using Extensions # The features that Lens includes out-of-the-box are just the start. Lens extensions let you add new features to your installation to support your workflow. Rich extensibility model lets extension authors plug directly into the Lens UI and contribute functionality through the same APIs used by Lens itself. The start using Lens Extensions go to File (or Lens on macOS) > Extensions in the application menu. This is the Extensions management page where all the management of the extensions you want to use is done. Installing an Extension # There are three ways to install extensions. If you have the extension as a .tgz file then dragging and dropping it in the extension management page will install it for you. If it is hosted on the web, you can paste the URL and click Install and Lens will download and install it. The third way is to move the extension into your ~/.k8slens/extensions (or C:\\Users\\\\.k8slens\\extensions ) folder and Lens will automatically detect it and install the extension. Enabling or Disabling an Extension # Go to the extension management page and click either the Enable or Disable buttons. Extensions will be enabled by default when you first install them. A disabled extension is not loaded by Lens and is not run. Uninstalling an Extension # If, for whatever reason, you wish to remove the installation of an extension simple click the Uninstall button. This will remove all the files that Lens would need to run the extension.","title":"Using Extensions"},{"location":"extensions/usage/#using-extensions","text":"The features that Lens includes out-of-the-box are just the start. Lens extensions let you add new features to your installation to support your workflow. Rich extensibility model lets extension authors plug directly into the Lens UI and contribute functionality through the same APIs used by Lens itself. The start using Lens Extensions go to File (or Lens on macOS) > Extensions in the application menu. This is the Extensions management page where all the management of the extensions you want to use is done.","title":"Using Extensions"},{"location":"extensions/usage/#installing-an-extension","text":"There are three ways to install extensions. If you have the extension as a .tgz file then dragging and dropping it in the extension management page will install it for you. If it is hosted on the web, you can paste the URL and click Install and Lens will download and install it. The third way is to move the extension into your ~/.k8slens/extensions (or C:\\Users\\\\.k8slens\\extensions ) folder and Lens will automatically detect it and install the extension.","title":"Installing an Extension"},{"location":"extensions/usage/#enabling-or-disabling-an-extension","text":"Go to the extension management page and click either the Enable or Disable buttons. Extensions will be enabled by default when you first install them. A disabled extension is not loaded by Lens and is not run.","title":"Enabling or Disabling an Extension"},{"location":"extensions/usage/#uninstalling-an-extension","text":"If, for whatever reason, you wish to remove the installation of an extension simple click the Uninstall button. This will remove all the files that Lens would need to run the extension.","title":"Uninstalling an Extension"},{"location":"faq/","text":"FAQ # What operating systems does Lens support? # Lens supports MacOS, Windows and Linux operating systems. For Linux there are Snap and AppImage versions. For MacOS there are DMG and Homebrew options. Lens application is not opening, what might be wrong? # When Lens is started, it will start HTTP proxy server on the background and requires that operating system allows to start listening to some free port. You can see the port allocated for Lens from application logs. Lens expects also that localhost DNS points to 127.0.0.1 address. Why can't I add any clusters? # When adding new clusters, a valid Kubeconfig file is required. Please check that all contexts present in Kubeconfig file are valid. Why Cluster dashboard is not opening? # To see Cluster dashboard properly, Kubernetes cluster must be reachable either directly from your computer or via HTTP proxy. You can configure HTTP proxy in Cluster Settigns. Also, provided credentials in Kubeconfig must be valid. If Kubeconfig uses exec command, the binary must be available in global PATH or absolute path must be used. Lens application can't see PATH modifications made by any shell init scripts. There might be also some issues on the Snap version if the exec binary is installed also from Snap and requires additional symlinking, please see #699 . Why I don't see anything on Cluster dashboard? # Users will see on Cluster dashboard only those resources that they are allowed to see (RBAC). Lens requires that user has access at least to one namespace. Lens tries first fetch namespaces from Kubernetes API. If user is not allowed to list namespaces, allowed namespaces can be configured in Cluster settings or in Kubeconfig. Why I don't see any metrics or some of the metrics are not working? # In order to display cluster metrics, Lens requires that Prometheus is running in the cluster. You can install Prometheus in Cluster settings if needed. Lens tries to detect Prometheus installation automatically. If it fails to detect the installation properly, you can configure Prometheus service address in Cluster settings. If some of the metrics are not displayed correctly, you can see queries that Lens is using here and adapt your prometheus configuration to support those queries. Please refer Prometheus documentation or your Prometheus installer documentation how to do this. Kubectl is not working in Lens terminal, what should I do? # Lens tries to download correct Kubectl version for the cluster and use that in Lens terminal. Some operating systems (namely Windows) might have restrictions set that prevent downloading and executing binaries from the default location that Lens is using. You can change the directory where Lens downloads the binaries in App Preferences. It's also possible to change the Download mirror to use Azure if default Google is not reachable from your network. If downloading Kubectl is not option for you, you can define path to pre-installed Kubectl on your machine and Lens will use that binary instead. How can I configure Helm repositories? # Lens comes with bundled Helm 3 binary and Lens will add by default bitnami repository if no other repositories are configured. You can add more repositories from Artifact HUB in App preferences. At this moment it is not possible to add private repositories. Those and other public repositories can be added manually via command line. Where can I find application logs? # Lens will store application logs to following locations depending on your operating system: - MacOS: ~/Library/Logs/Lens/ - Windows: %USERPROFILE%\\AppData\\Roaming\\Lens\\logs\\ - Linux: ~/.config/Lens/logs/ How can I see more verbose logs? # You can start Lens application on debug mode from the command line to see more verbose logs. To start application on debug mode, please provide DEBUG=true environment variable and before starting the application, for example: DEBUG=TRUE /Applications/Lens.app/Contents/MacOS/Lens","title":"FAQ"},{"location":"faq/#faq","text":"","title":"FAQ"},{"location":"faq/#what-operating-systems-does-lens-support","text":"Lens supports MacOS, Windows and Linux operating systems. For Linux there are Snap and AppImage versions. For MacOS there are DMG and Homebrew options.","title":"What operating systems does Lens support?"},{"location":"faq/#lens-application-is-not-opening-what-might-be-wrong","text":"When Lens is started, it will start HTTP proxy server on the background and requires that operating system allows to start listening to some free port. You can see the port allocated for Lens from application logs. Lens expects also that localhost DNS points to 127.0.0.1 address.","title":"Lens application is not opening, what might be wrong?"},{"location":"faq/#why-cant-i-add-any-clusters","text":"When adding new clusters, a valid Kubeconfig file is required. Please check that all contexts present in Kubeconfig file are valid.","title":"Why can't I add any clusters?"},{"location":"faq/#why-cluster-dashboard-is-not-opening","text":"To see Cluster dashboard properly, Kubernetes cluster must be reachable either directly from your computer or via HTTP proxy. You can configure HTTP proxy in Cluster Settigns. Also, provided credentials in Kubeconfig must be valid. If Kubeconfig uses exec command, the binary must be available in global PATH or absolute path must be used. Lens application can't see PATH modifications made by any shell init scripts. There might be also some issues on the Snap version if the exec binary is installed also from Snap and requires additional symlinking, please see #699 .","title":"Why Cluster dashboard is not opening?"},{"location":"faq/#why-i-dont-see-anything-on-cluster-dashboard","text":"Users will see on Cluster dashboard only those resources that they are allowed to see (RBAC). Lens requires that user has access at least to one namespace. Lens tries first fetch namespaces from Kubernetes API. If user is not allowed to list namespaces, allowed namespaces can be configured in Cluster settings or in Kubeconfig.","title":"Why I don't see anything on Cluster dashboard?"},{"location":"faq/#why-i-dont-see-any-metrics-or-some-of-the-metrics-are-not-working","text":"In order to display cluster metrics, Lens requires that Prometheus is running in the cluster. You can install Prometheus in Cluster settings if needed. Lens tries to detect Prometheus installation automatically. If it fails to detect the installation properly, you can configure Prometheus service address in Cluster settings. If some of the metrics are not displayed correctly, you can see queries that Lens is using here and adapt your prometheus configuration to support those queries. Please refer Prometheus documentation or your Prometheus installer documentation how to do this.","title":"Why I don't see any metrics or some of the metrics are not working?"},{"location":"faq/#kubectl-is-not-working-in-lens-terminal-what-should-i-do","text":"Lens tries to download correct Kubectl version for the cluster and use that in Lens terminal. Some operating systems (namely Windows) might have restrictions set that prevent downloading and executing binaries from the default location that Lens is using. You can change the directory where Lens downloads the binaries in App Preferences. It's also possible to change the Download mirror to use Azure if default Google is not reachable from your network. If downloading Kubectl is not option for you, you can define path to pre-installed Kubectl on your machine and Lens will use that binary instead.","title":"Kubectl is not working in Lens terminal, what should I do?"},{"location":"faq/#how-can-i-configure-helm-repositories","text":"Lens comes with bundled Helm 3 binary and Lens will add by default bitnami repository if no other repositories are configured. You can add more repositories from Artifact HUB in App preferences. At this moment it is not possible to add private repositories. Those and other public repositories can be added manually via command line.","title":"How can I configure Helm repositories?"},{"location":"faq/#where-can-i-find-application-logs","text":"Lens will store application logs to following locations depending on your operating system: - MacOS: ~/Library/Logs/Lens/ - Windows: %USERPROFILE%\\AppData\\Roaming\\Lens\\logs\\ - Linux: ~/.config/Lens/logs/","title":"Where can I find application logs?"},{"location":"faq/#how-can-i-see-more-verbose-logs","text":"You can start Lens application on debug mode from the command line to see more verbose logs. To start application on debug mode, please provide DEBUG=true environment variable and before starting the application, for example: DEBUG=TRUE /Applications/Lens.app/Contents/MacOS/Lens","title":"How can I see more verbose logs?"},{"location":"getting-started/","text":"Getting Started # Lens is lightweight and simple to install. You'll be up and running in just a few minutes. System Requirements # Review the System Requirements to check if your computer configuration is supported. macOS # Download Lens for macOS. Open the browser's download list and locate the downloaded archive. Select the 'magnifying glass' icon to open the archive in Finder. Double-click Lens-{version}.dmg and drag Lens.app to the Applications folder, making it available in the macOS Launchpad. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing Options , Keep in Dock . Windows # Download the Lens installer for Windows. Once it is downloaded, run the installer Lens-Setup-{version}.exe . This will only take a minute. By default, Lens is installed under C:\\users\\{username}\\AppData\\Local\\Programs\\Lens . Linux # See the Download Lens page for a complete list of available installation options. Snap # Lens is officially distributed as a Snap package in the Snap Store : You can install it by running: sudo snap install kontena-lens --classic Update Cadence # Lens releases a new version each month with new features and important bug fixes. Lens supports auto updating and you will be prompted to install the new release when it becomes available! To stay current with the Lens features, you can review the release notes . Next Steps # Add clusters Watch introductory videos","title":"Getting Started"},{"location":"getting-started/#getting-started","text":"Lens is lightweight and simple to install. You'll be up and running in just a few minutes.","title":"Getting Started"},{"location":"getting-started/#system-requirements","text":"Review the System Requirements to check if your computer configuration is supported.","title":"System Requirements"},{"location":"getting-started/#macos","text":"Download Lens for macOS. Open the browser's download list and locate the downloaded archive. Select the 'magnifying glass' icon to open the archive in Finder. Double-click Lens-{version}.dmg and drag Lens.app to the Applications folder, making it available in the macOS Launchpad. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing Options , Keep in Dock .","title":"macOS"},{"location":"getting-started/#windows","text":"Download the Lens installer for Windows. Once it is downloaded, run the installer Lens-Setup-{version}.exe . This will only take a minute. By default, Lens is installed under C:\\users\\{username}\\AppData\\Local\\Programs\\Lens .","title":"Windows"},{"location":"getting-started/#linux","text":"See the Download Lens page for a complete list of available installation options.","title":"Linux"},{"location":"getting-started/#snap","text":"Lens is officially distributed as a Snap package in the Snap Store : You can install it by running: sudo snap install kontena-lens --classic","title":"Snap"},{"location":"getting-started/#update-cadence","text":"Lens releases a new version each month with new features and important bug fixes. Lens supports auto updating and you will be prompted to install the new release when it becomes available! To stay current with the Lens features, you can review the release notes .","title":"Update Cadence"},{"location":"getting-started/#next-steps","text":"Add clusters Watch introductory videos","title":"Next Steps"},{"location":"getting-started/introductory-videos/","text":"Introductory Videos # Continue your Lens journey with this set of introductory videos! These videos are meant to quickly familiarize you with Lens' various powerful features. Getting started Get Lens Kubernetes IDE Running in 5 Minutes Duration 35 minutes Introducing Lens Lens Kubernetes IDE overview Duration 2 minutes Demo of Mirantis Lens The Best IDE For Kubernetes Duration 10 minutes","title":"Introductory Videos"},{"location":"getting-started/introductory-videos/#introductory-videos","text":"Continue your Lens journey with this set of introductory videos! These videos are meant to quickly familiarize you with Lens' various powerful features.","title":"Introductory Videos"},{"location":"getting-started/preferences/","text":"Preferences # Color Themes # The Color Themes option in Lens preferences lets you set the colors in the Lens user interface to suit your liking. Go to File > Preferences ( Lens > Preferences on Mac). Select your preferred theme from the Color Theme dropdown. Telemetry & Usage Tracking # Lens collects telemetry data, which is used to help us understand how to improve the product. For example, this usage data helps us to debug issues and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. Please see our privacy statement to learn more. Disable Telemetry Reporting # If you don't wish to send usage data to Mirantis, you can disable the \"Telemetry & Usage Tracking\" in the Lens preferences. Go to File > Preferences ( Lens > Preferences on Mac). Scroll down to Telemetry & Usage Tracking Uncheck Allow Telemetry & Usage Tracking . This will silence all telemetry events from Lens going forward. Telemetry information may have been collected and sent up until the point when you disable this setting.","title":"Preferences"},{"location":"getting-started/preferences/#preferences","text":"","title":"Preferences"},{"location":"getting-started/preferences/#color-themes","text":"The Color Themes option in Lens preferences lets you set the colors in the Lens user interface to suit your liking. Go to File > Preferences ( Lens > Preferences on Mac). Select your preferred theme from the Color Theme dropdown.","title":"Color Themes"},{"location":"getting-started/preferences/#telemetry-usage-tracking","text":"Lens collects telemetry data, which is used to help us understand how to improve the product. For example, this usage data helps us to debug issues and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. Please see our privacy statement to learn more.","title":"Telemetry & Usage Tracking"},{"location":"getting-started/preferences/#disable-telemetry-reporting","text":"If you don't wish to send usage data to Mirantis, you can disable the \"Telemetry & Usage Tracking\" in the Lens preferences. Go to File > Preferences ( Lens > Preferences on Mac). Scroll down to Telemetry & Usage Tracking Uncheck Allow Telemetry & Usage Tracking . This will silence all telemetry events from Lens going forward. Telemetry information may have been collected and sent up until the point when you disable this setting.","title":"Disable Telemetry Reporting"},{"location":"helm/","text":"Using Helm Charts # Lens has integration to Helm making it easy to install and manage Helm charts and releases in Apps section. Managing Helm Reporistories # Used Helm repositories are possible to configure in the Preferences . Lens app will fetch available Helm repositories from the Artifact HUB and automatically add bitnami repository by default if no other repositories are already configured. If any other repositories are needed to add, those can be added manually via command line. Note! Configured Helm repositories are added globally to user's computer, so other processes can see those as well. Installing a Helm Chart # Lens will list all charts from configured Helm repositries on Apps section. To install a chart, you need to select a chart and click \"Install\" button. Lens will open the chart in the editor where you can select a chart version, target namespace and give optionally a name for the release and configure values for the release. Finally, by clicking \"Install\" button Lens will deploy the chart into the cluster. Updating a Helm Release # To update a Helm release, you can open the release details and modify the release values and click \"Save\" button. To upgrade or downgrade the release, click \"Upgrade\" button in the release details. In the release editor you can select a new chart version and edit the release values if needed and then click \"Upgrade\" or \"Upgrade and Close\" button. Deleting a Helm Release # To delete existing Helm release open the release details and click trash can icon on the top of the panel. Deletion removes all Kubernetes resources created by the Helm release. Note! If the release included any persistent volumes, those are required to remove manually!","title":"Using Helm Charts"},{"location":"helm/#using-helm-charts","text":"Lens has integration to Helm making it easy to install and manage Helm charts and releases in Apps section.","title":"Using Helm Charts"},{"location":"helm/#managing-helm-reporistories","text":"Used Helm repositories are possible to configure in the Preferences . Lens app will fetch available Helm repositories from the Artifact HUB and automatically add bitnami repository by default if no other repositories are already configured. If any other repositories are needed to add, those can be added manually via command line. Note! Configured Helm repositories are added globally to user's computer, so other processes can see those as well.","title":"Managing Helm Reporistories"},{"location":"helm/#installing-a-helm-chart","text":"Lens will list all charts from configured Helm repositries on Apps section. To install a chart, you need to select a chart and click \"Install\" button. Lens will open the chart in the editor where you can select a chart version, target namespace and give optionally a name for the release and configure values for the release. Finally, by clicking \"Install\" button Lens will deploy the chart into the cluster.","title":"Installing a Helm Chart"},{"location":"helm/#updating-a-helm-release","text":"To update a Helm release, you can open the release details and modify the release values and click \"Save\" button. To upgrade or downgrade the release, click \"Upgrade\" button in the release details. In the release editor you can select a new chart version and edit the release values if needed and then click \"Upgrade\" or \"Upgrade and Close\" button.","title":"Updating a Helm Release"},{"location":"helm/#deleting-a-helm-release","text":"To delete existing Helm release open the release details and click trash can icon on the top of the panel. Deletion removes all Kubernetes resources created by the Helm release. Note! If the release included any persistent volumes, those are required to remove manually!","title":"Deleting a Helm Release"},{"location":"support/","text":"Support # Here you will find different ways of getting support for Lens IDE. Community Support # Community Slack - Request for support and help from the Lens community via Slack. Github Issues - Submit your issues and feature requests to Lens IDE via Github. Commercial Support & Services # If you are interested in paid support options, professional services or training, please see the offerings from the following vendors: Mirantis offers commercial support for officially released versions of Lens IDE on MacOS, Windows and Linux operating systems. In addition, Mirantis offers professional services to create proprietary / custom Lens IDE extensions and custom msi packaging to meet enterprise IT policies for software distribution and configuration. Training is also available. If you'd like to get your business listed in here, please contact us via email info@k8slens.dev","title":"Support"},{"location":"support/#support","text":"Here you will find different ways of getting support for Lens IDE.","title":"Support"},{"location":"support/#community-support","text":"Community Slack - Request for support and help from the Lens community via Slack. Github Issues - Submit your issues and feature requests to Lens IDE via Github.","title":"Community Support"},{"location":"support/#commercial-support-services","text":"If you are interested in paid support options, professional services or training, please see the offerings from the following vendors: Mirantis offers commercial support for officially released versions of Lens IDE on MacOS, Windows and Linux operating systems. In addition, Mirantis offers professional services to create proprietary / custom Lens IDE extensions and custom msi packaging to meet enterprise IT policies for software distribution and configuration. Training is also available. If you'd like to get your business listed in here, please contact us via email info@k8slens.dev","title":"Commercial Support & Services"},{"location":"supporting/requirements/","text":"Requirements for Lens # Hardware # Lens is a small download (< 300 MB) and has a disk footprint of 600 MB. Lens is lightweight and should easily run on today's hardware. We recommend: 2 GHz or faster processor 1 GB of RAM Platforms # Lens has been tested on the following platforms: macOS Windows Linux Additional Windows requirements # ... Additional Linux Requirements # ...","title":"Requirements for Lens"},{"location":"supporting/requirements/#requirements-for-lens","text":"","title":"Requirements for Lens"},{"location":"supporting/requirements/#hardware","text":"Lens is a small download (< 300 MB) and has a disk footprint of 600 MB. Lens is lightweight and should easily run on today's hardware. We recommend: 2 GHz or faster processor 1 GB of RAM","title":"Hardware"},{"location":"supporting/requirements/#platforms","text":"Lens has been tested on the following platforms: macOS Windows Linux","title":"Platforms"},{"location":"supporting/requirements/#additional-windows-requirements","text":"...","title":"Additional Windows requirements"},{"location":"supporting/requirements/#additional-linux-requirements","text":"...","title":"Additional Linux Requirements"}]} \ No newline at end of file diff --git a/latest/sitemap.xml b/latest/sitemap.xml index e93d24e7c9..f213220f81 100644 --- a/latest/sitemap.xml +++ b/latest/sitemap.xml @@ -1,127 +1,131 @@ https://docs.k8slens.dev/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/getting-started/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/clusters/adding-clusters/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/clusters/removing-clusters/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/clusters/settings/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/helm/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/extensions/usage/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/getting-started/preferences/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/extensions/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/extensions/get-started/overview/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/extensions/get-started/your-first-extension/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/extensions/get-started/anatomy/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/extensions/get-started/wrapping-up/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/extensions/capabilities/common-capabilities/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/extensions/capabilities/styling/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/extensions/capabilities/color-reference/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/extensions/guides/ - 2020-12-07 - daily - - https://docs.k8slens.dev/extensions/guides/main-extension/ - 2020-12-07 - daily - - https://docs.k8slens.dev/extensions/guides/renderer-extension/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/extensions/guides/generator/ - 2020-12-07 + 2020-12-09 + daily + + https://docs.k8slens.dev/extensions/guides/main-extension/ + 2020-12-09 + daily + + https://docs.k8slens.dev/extensions/guides/renderer-extension/ + 2020-12-09 + daily + + https://docs.k8slens.dev/extensions/guides/stores/ + 2020-12-09 daily https://docs.k8slens.dev/extensions/guides/working-with-mobx/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/extensions/testing-and-publishing/testing/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/extensions/testing-and-publishing/publishing/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/extensions/api/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/contributing/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/contributing/development/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/contributing/documentation/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/contributing/maintainers/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/contributing/promotion/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/support/ - 2020-12-07 + 2020-12-09 daily https://docs.k8slens.dev/faq/ - 2020-12-07 + 2020-12-09 daily \ No newline at end of file diff --git a/latest/sitemap.xml.gz b/latest/sitemap.xml.gz index 9b5d5993e5..64c1de7cab 100644 Binary files a/latest/sitemap.xml.gz and b/latest/sitemap.xml.gz differ diff --git a/latest/support/index.html b/latest/support/index.html index 2cee77a65d..eca40186a7 100644 --- a/latest/support/index.html +++ b/latest/support/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/latest/supporting/requirements/index.html b/latest/supporting/requirements/index.html index a1ef18f7a2..eaa64b0c72 100644 --- a/latest/supporting/requirements/index.html +++ b/latest/supporting/requirements/index.html @@ -548,6 +548,18 @@ +
  • + + Generator + +
    • + + + + + + +
  • Main Extension @@ -573,8 +585,8 @@
  • - - Generator + + Stores
    • diff --git a/v4.0.1/404.html b/v4.0.1/404.html new file mode 100644 index 0000000000..46654eb321 --- /dev/null +++ b/v4.0.1/404.html @@ -0,0 +1,868 @@ + + + + + + + + + + + + + + + + + + + + Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + +

    404 - Not found

    + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/CNAME b/v4.0.1/CNAME new file mode 100644 index 0000000000..12bc650410 --- /dev/null +++ b/v4.0.1/CNAME @@ -0,0 +1 @@ +docs.k8slens.dev diff --git a/v4.0.1/assets/images/favicon.png b/v4.0.1/assets/images/favicon.png new file mode 100644 index 0000000000..1cf13b9f9d Binary files /dev/null and b/v4.0.1/assets/images/favicon.png differ diff --git a/v4.0.1/assets/javascripts/bundle.0421a6ad.min.js b/v4.0.1/assets/javascripts/bundle.0421a6ad.min.js new file mode 100644 index 0000000000..706648c574 --- /dev/null +++ b/v4.0.1/assets/javascripts/bundle.0421a6ad.min.js @@ -0,0 +1 @@ +!function(e,t){for(var n in t)e[n]=t[n]}(window,function(e){function t(t){for(var c,o,i=t[0],s=t[1],u=t[2],f=0,d=[];f"focus"===e),Object(l.a)(e===u()))}function m(e){return{x:e.scrollLeft,y:e.scrollTop}}function g(e){return Object(p.a)(Object(r.a)(e,"scroll"),Object(r.a)(window,"resize")).pipe(Object(O.a)(()=>m(e)),Object(l.a)(m(e)))}function v(e){if(!(e instanceof HTMLInputElement))throw new Error("Not implemented");e.select()}var y=n(82),$=n(29),w=n(83),S=n(41),x=n(55),T=n(13),C=n(85),k=n(96),_=n(36),M=n(30);const E=new $.a,A=Object(w.a)(()=>Object(S.a)(new y.a(e=>{for(const t of e)E.next(t)}))).pipe(Object(T.a)(e=>Object(p.a)(Object(S.a)(e),x.a).pipe(Object(C.a)(()=>e.disconnect()))),Object(k.a)({bufferSize:1,refCount:!0}));function R(e){return A.pipe(Object(_.a)(t=>t.observe(e)),Object(T.a)(t=>E.pipe(Object(M.a)(({target:t})=>t===e),Object(C.a)(()=>t.unobserve(e)),Object(O.a)(({contentRect:e})=>({width:e.width,height:e.height})))),Object(l.a)(function(e){return{width:e.offsetWidth,height:e.offsetHeight}}(e)))}var L=n(37);function H(e){switch(e.tagName){case"INPUT":case"SELECT":case"TEXTAREA":return!0;default:return e.isContentEditable}}function P(){return Object(r.a)(window,"keydown").pipe(Object(M.a)(e=>!(e.metaKey||e.ctrlKey)),Object(O.a)(e=>({type:e.key,claim(){e.preventDefault(),e.stopPropagation()}})),Object(L.a)())}var z=n(101);function N(e){location.href=e.href}function q(e,t=location){return e.host===t.host&&/^(?:\/[\w-]+)*(?:\/?|\.html)$/i.test(e.pathname)}function U(e,t=location){return e.pathname===t.pathname&&e.hash.length>0}function W(){return new z.a(new URL(location.href))}var I=n(102);function Q(e,{location$:t}){return t.pipe(Object(I.a)(1),Object(O.a)(({href:t})=>new URL(e,t).toString().replace(/\/$/,"")),Object(k.a)({bufferSize:1,refCount:!0}))}function D(){return location.hash.substring(1)}function F(e){const t=f("a");t.href=e,t.addEventListener("click",e=>e.stopPropagation()),t.click()}function J(){return Object(r.a)(window,"hashchange").pipe(Object(O.a)(D),Object(l.a)(D()),Object(M.a)(e=>e.length>0),Object(L.a)())}var K=n(6);function Y(e){const t=matchMedia(e);return new K.a(e=>{t.addListener(t=>e.next(t.matches))}).pipe(Object(l.a)(t.matches),Object(k.a)({bufferSize:1,refCount:!0}))}const B={drawer:s("[data-md-toggle=drawer]"),search:s("[data-md-toggle=search]")};function X(e){return B[e].checked}function V(e,t){B[e].checked!==t&&B[e].click()}function G(e){const t=B[e];return Object(r.a)(t,"change").pipe(Object(O.a)(()=>t.checked),Object(l.a)(t.checked))}var Z=n(60),ee=n(56);function te(){return{x:Math.max(0,pageXOffset),y:Math.max(0,pageYOffset)}}function ne({x:e,y:t}){window.scrollTo(e||0,t||0)}function ce(){return{width:innerWidth,height:innerHeight}}function re(){return Object(Z.a)([Object(p.a)(Object(r.a)(window,"scroll",{passive:!0}),Object(r.a)(window,"resize",{passive:!0})).pipe(Object(O.a)(te),Object(l.a)(te())),Object(r.a)(window,"resize",{passive:!0}).pipe(Object(O.a)(ce),Object(l.a)(ce()))]).pipe(Object(O.a)(([e,t])=>({offset:e,size:t})),Object(k.a)({bufferSize:1,refCount:!0}))}function ae(e,{header$:t,viewport$:n}){const c=n.pipe(Object(ee.a)("size")),r=Object(Z.a)([c,t]).pipe(Object(O.a)(()=>({x:e.offsetLeft,y:e.offsetTop})));return Object(Z.a)([t,n,r]).pipe(Object(O.a)(([{height:e},{offset:t,size:n},{x:c,y:r}])=>({offset:{x:t.x-c,y:t.y-r+e},size:n})))}var oe=n(103),ie=n(104);function se(e,{tx$:t}){const n=Object(r.a)(e,"message").pipe(Object(O.a)(({data:e})=>e));return t.pipe(Object(oe.a)(()=>n,{leading:!0,trailing:!0}),Object(_.a)(t=>e.postMessage(t)),Object(ie.a)(n),Object(L.a)())}},function(e,t,n){"use strict";function c(e){return"object"==typeof e&&"string"==typeof e.base&&"object"==typeof e.features&&"object"==typeof e.search}function r(e,t){if("string"==typeof t||"number"==typeof t)e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(const n of t)r(e,n)}function a(e,t,...n){const c=document.createElement(e);if(t)for(const e of Object.keys(t))"boolean"!=typeof t[e]?c.setAttribute(e,t[e]):t[e]&&c.setAttribute(e,"");for(const e of n)r(c,e);return c}n.d(t,"d",(function(){return c})),n.d(t,"b",(function(){return a})),n.d(t,"a",(function(){return s})),n.d(t,"f",(function(){return f})),n.d(t,"g",(function(){return d})),n.d(t,"e",(function(){return p})),n.d(t,"c",(function(){return O}));var o=n(83),i=n(41);function s(e,t){return Object(o.a)(()=>{const n=sessionStorage.getItem(e);if(n)return Object(i.a)(JSON.parse(n));{const n=t();return n.subscribe(t=>{try{sessionStorage.setItem(e,JSON.stringify(t))}catch(e){}}),n}})}var u=n(0);let b;function f(e,t){if(void 0===b){const e=Object(u.d)("#__lang");b=JSON.parse(e.textContent)}if(void 0===b[e])throw new ReferenceError("Invalid translation: "+e);return void 0!==t?b[e].replace("#",t.toString()):b[e]}function d(e,t){let n=t;if(e.length>n){for(;" "!==e[n]&&--n>0;);return e.substring(0,n)+"..."}return e}function p(e){if(e>999){return((e+1e-6)/1e3).toFixed(+((e-950)%1e3>99))+"k"}return e.toString()}function O(e){let t=0;for(let n=0,c=e.length;ne.reduce((e,n)=>{const c=Object(b.c)(`[data-md-component=${n}]`,t);return Object.assign(Object.assign({},e),void 0!==c?{[n]:c}:{})},{})),Object(o.a)((t,n)=>{for(const c of e)switch(c){case"announce":case"header-title":case"container":case"skip":c in t&&void 0!==t[c]&&(Object(b.j)(t[c],n[c]),t[c]=n[c]);break;default:void 0!==n[c]?t[c]=Object(b.c)(`[data-md-component=${c}]`):delete t[c]}return t}),Object(i.a)({bufferSize:1,refCount:!0}))}function p(e){return f.pipe(Object(s.a)(t=>void 0!==t[e]?Object(c.a)(t[e]):r.a),Object(u.a)())}},,,function(e,t,n){"use strict";function c(e,t){e.setAttribute("data-md-state",t?"blur":"")}function r(e){e.removeAttribute("data-md-state")}function a(e,t){e.classList.toggle("md-nav__link--active",t)}function o(e){e.classList.remove("md-nav__link--active")}n.d(t,"d",(function(){return c})),n.d(t,"b",(function(){return r})),n.d(t,"c",(function(){return a})),n.d(t,"a",(function(){return o}))},,,function(e,t,n){"use strict";var c=n(63);n.o(c,"applySidebar")&&n.d(t,"applySidebar",(function(){return c.applySidebar})),n.o(c,"mountTableOfContents")&&n.d(t,"mountTableOfContents",(function(){return c.mountTableOfContents})),n.o(c,"mountTabs")&&n.d(t,"mountTabs",(function(){return c.mountTabs})),n.o(c,"watchSidebar")&&n.d(t,"watchSidebar",(function(){return c.watchSidebar}))},function(e,t,n){"use strict";n.d(t,"a",(function(){return a})),n.d(t,"b",(function(){return i})),n.d(t,"c",(function(){return s})),n.d(t,"d",(function(){return u}));var c,r=n(1);function a(e){return Object(r.b)("button",{class:"md-clipboard md-icon",title:Object(r.f)("clipboard.copy"),"data-clipboard-target":`#${e} > code`})}function o(e,t){const n=t&c.PARENT,a=t&c.TEASER,o=Object.keys(e.terms).filter(t=>!e.terms[t]).map(e=>[Object(r.b)("del",null,e)," "]).flat().slice(0,-1),i=new URL(e.location);i.searchParams.append("h",Object.entries(e.terms).reduce((e,[t,n])=>`${e} ${n?t:""}`,"").replace(/%20/g,"+"));const s=""+i;return Object(r.b)("a",{href:s,class:"md-search-result__link",tabIndex:-1},Object(r.b)("article",{class:["md-search-result__article",...n?["md-search-result__article--document"]:[]].join(" "),"data-md-score":e.score.toFixed(2)},n>0&&Object(r.b)("div",{class:"md-search-result__icon md-icon"}),Object(r.b)("h1",{class:"md-search-result__title"},e.title),a>0&&e.text.length>0&&Object(r.b)("p",{class:"md-search-result__teaser"},Object(r.g)(e.text,320)),a>0&&o.length>0&&Object(r.b)("p",{class:"md-search-result__terms"},Object(r.f)("search.result.term.missing"),": ",o)))}function i(e,t=1/0){const n=[...e],a=n.findIndex(e=>!e.location.includes("#")),[i]=n.splice(a,1);let s=n.findIndex(e=>e.scoreo(e,c.TEASER)),...b.length?[Object(r.b)("details",{class:"md-search-result__more"},Object(r.b)("summary",{tabIndex:-1},b.length>0&&1===b.length?Object(r.f)("search.result.more.one"):Object(r.f)("search.result.more.other",b.length)),b.map(e=>o(e,c.TEASER)))]:[]];return Object(r.b)("li",{class:"md-search-result__item"},f)}function s(e){return Object(r.b)("ul",{class:"md-source__facts"},e.map(e=>Object(r.b)("li",{class:"md-source__fact"},e)))}function u(e){return Object(r.b)("div",{class:"md-typeset__scrollwrap"},Object(r.b)("div",{class:"md-typeset__table"},e))}!function(e){e[e.TEASER=1]="TEASER",e[e.PARENT=2]="PARENT"}(c||(c={}))},,,function(e,t,n){"use strict";function c(e,t){e.style.top=t+"px"}function r(e){e.style.top=""}function a(e,t){e.style.height=t+"px"}function o(e){e.style.height=""}n.d(t,"d",(function(){return c})),n.d(t,"b",(function(){return r})),n.d(t,"c",(function(){return a})),n.d(t,"a",(function(){return o}))},,,,,,,,,,,function(e,t,n){"use strict";n(66),n(42);var c=n(43);n.d(t,"setupSearchHighlighter",(function(){return c.a}));var r=n(67);n.o(r,"SearchMessageType")&&n.d(t,"SearchMessageType",(function(){return r.SearchMessageType})),n.o(r,"defaultTransform")&&n.d(t,"defaultTransform",(function(){return r.defaultTransform})),n.o(r,"isSearchQueryMessage")&&n.d(t,"isSearchQueryMessage",(function(){return r.isSearchQueryMessage})),n.o(r,"isSearchReadyMessage")&&n.d(t,"isSearchReadyMessage",(function(){return r.isSearchReadyMessage})),n.o(r,"isSearchResultMessage")&&n.d(t,"isSearchResultMessage",(function(){return r.isSearchResultMessage})),n.o(r,"setupSearchWorker")&&n.d(t,"setupSearchWorker",(function(){return r.setupSearchWorker}));var a=n(40);n.d(t,"defaultTransform",(function(){return a.a}));var o=n(80);n.d(t,"SearchMessageType",(function(){return o.a})),n.d(t,"isSearchQueryMessage",(function(){return o.b})),n.d(t,"isSearchReadyMessage",(function(){return o.c})),n.d(t,"isSearchResultMessage",(function(){return o.d})),n.d(t,"setupSearchWorker",(function(){return o.e}))},function(e,t,n){"use strict";var c=n(74);n.o(c,"applyAnchorList")&&n.d(t,"applyAnchorList",(function(){return c.applyAnchorList})),n.o(c,"watchAnchorList")&&n.d(t,"watchAnchorList",(function(){return c.watchAnchorList}));var r=n(75);n.d(t,"applyAnchorList",(function(){return r.a})),n.d(t,"watchAnchorList",(function(){return r.b}));n(20)},function(e,t,n){"use strict";function c(e){const t=new lunr.Query(["title","text"]);return new lunr.QueryParser(e,t).parse(),t.clauses}function r(e,t){const n=new Set(e),c={};for(let e=0;e1&t?e.replace(/^\b|^(?![^\x00-\x7F]|$)|\s+/g," +"):e).join("").replace(/"|(?:^|\s+)[*+\-:^~]+(?=\s+|$)/g,"").trim()}n.d(t,"c",(function(){return c})),n.d(t,"b",(function(){return r})),n.d(t,"a",(function(){return a}))},,function(e,t,n){"use strict";n.d(t,"a",(function(){return r}));var c=n(84);function r(e){const t=new Map,n=new Set;for(const r of e){const[e,a]=r.location.split("#"),o=r.location,i=r.title,s=c(r.text).replace(/\s+(?=[,.:;!?])/g,"").replace(/\s+/g," ");if(a){const c=t.get(e);n.has(c)?t.set(o,{location:o,title:i,text:s,parent:c}):(c.title=r.title,c.text=s,n.add(c))}else t.set(o,{location:o,title:i,text:s})}return t}},function(e,t,n){"use strict";function c(e){const t=new RegExp(e.separator,"img"),n=(e,t,n)=>`${t}${n}`;return c=>{c=c.replace(/[\s*+\-:~^]+/g," ").trim();const r=new RegExp(`(^|${e.separator})(${c.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(t,"|")})`,"img");return e=>e.replace(r,n).replace(/<\/mark>(\s+)]*>/gim,"$1")}}n.d(t,"a",(function(){return c}))},,,,,,,,,,,,,,,,,,,function(e,t,n){"use strict";n.d(t,"a",(function(){return s}));var c=n(34),r=n(41),a=n(13),o=n(10),i=n(23);function s({header$:e,main$:t,viewport$:n,screen$:s}){return Object(c.a)(Object(a.a)(c=>s.pipe(Object(a.a)(a=>a?Object(i.watchSidebar)(c,{main$:t,viewport$:n}).pipe(Object(i.applySidebar)(c,{header$:e}),Object(o.a)(e=>({sidebar:e}))):Object(r.a)({})))))}},function(e,t,n){"use strict";var c=n(64);n.o(c,"applySidebar")&&n.d(t,"applySidebar",(function(){return c.applySidebar})),n.o(c,"mountTableOfContents")&&n.d(t,"mountTableOfContents",(function(){return c.mountTableOfContents})),n.o(c,"mountTabs")&&n.d(t,"mountTabs",(function(){return c.mountTabs})),n.o(c,"watchSidebar")&&n.d(t,"watchSidebar",(function(){return c.watchSidebar}));var r=n(65);n.d(t,"applySidebar",(function(){return r.a})),n.d(t,"watchSidebar",(function(){return r.b}));n(27)},function(e,t){},function(e,t,n){"use strict";n.d(t,"b",(function(){return p})),n.d(t,"a",(function(){return O}));var c=n(60),r=n(34),a=n(58),o=n(10),i=n(35),s=n(57),u=n(52),b=n(36),f=n(85),d=n(27);function p(e,{main$:t,viewport$:n}){const r=e.parentElement.offsetTop-e.parentElement.parentElement.offsetTop;return Object(c.a)([t,n]).pipe(Object(o.a)(([{offset:e,height:t},{offset:{y:n}}])=>({height:t=t+Math.min(r,Math.max(0,n-e))-r,lock:n>=e+r})),Object(i.a)((e,t)=>e.height===t.height&&e.lock===t.lock))}function O(e,{header$:t}){return Object(r.a)(Object(s.a)(a.a),Object(u.a)(t),Object(b.a)(([{height:t,lock:n},{height:c}])=>{Object(d.c)(e,t),n?Object(d.d)(e,c):Object(d.b)(e)}),Object(o.a)(([e])=>e),Object(f.a)(()=>{Object(d.b)(e),Object(d.a)(e)}))}},function(e,t,n){"use strict";n(42),n(43),n(40)},function(e,t){},function(e,t,n){"use strict";n.d(t,"a",(function(){return d}));var c=n(53),r=n(55),a=n(6),o=n(37),i=n(36),s=n(95),u=n(0),b=n(24),f=n(1);function d({document$:e,dialog$:t}){if(!c.isSupported())return r.a;e.subscribe(()=>{Object(u.e)("pre > code").forEach((e,t)=>{const n=e.parentElement;n.id="__code_"+t,n.insertBefore(Object(b.a)(n.id),e)})});const n=new a.a(e=>{new c(".md-clipboard").on("success",t=>e.next(t))}).pipe(Object(o.a)());return n.pipe(Object(i.a)(e=>e.clearSelection()),Object(s.a)(Object(f.f)("clipboard.copied"))).subscribe(t),n}},function(e,t,n){"use strict";n.d(t,"a",(function(){return p}));var c=n(29),r=n(41),a=n(58),o=n(16),i=n(13),s=n(10),u=n(57),b=n(61),f=n(36),d=n(0);function p({duration:e}={}){const t=new c.a,n=Object(d.a)("div");return n.classList.add("md-dialog","md-typeset"),t.pipe(Object(i.a)(t=>Object(r.a)(document.body).pipe(Object(s.a)(e=>e.appendChild(n)),Object(u.a)(a.a),Object(b.a)(1),Object(f.a)(e=>{e.innerHTML=t,e.setAttribute("data-md-state","open")}),Object(b.a)(e||2e3),Object(f.a)(e=>e.removeAttribute("data-md-state")),Object(b.a)(400),Object(f.a)(e=>{e.innerHTML="",e.remove()})))).subscribe(o.a),t}},function(e,t,n){"use strict";n.d(t,"a",(function(){return y}));var c=n(54),r=n(41),a=n(55),o=n(59),i=n(9),s=n(30),u=n(13),b=n(10),f=n(37),d=n(35),p=n(56),O=n(97),l=n(98),j=n(87),h=n(52),m=n(99),g=n(88),v=n(0);function y(e,{document$:t,viewport$:n,location$:y}){"scrollRestoration"in history&&(history.scrollRestoration="manual"),Object(c.a)(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"});const $=Object(v.c)('link[rel="shortcut icon"]');void 0!==$&&($.href=$.href);const w=Object(c.a)(document.body,"click").pipe(Object(s.a)(e=>!(e.metaKey||e.ctrlKey)),Object(u.a)(t=>{if(t.target instanceof HTMLElement){const n=t.target.closest("a");if(n&&!n.target&&Object(v.h)(n)&&e.includes(n.href))return Object(v.g)(n)||t.preventDefault(),Object(r.a)(n)}return a.a}),Object(b.a)(e=>({url:new URL(e.href)})),Object(f.a)());w.subscribe(()=>{Object(v.o)("search",!1)});const S=w.pipe(Object(s.a)(({url:e})=>!Object(v.g)(e)),Object(f.a)()),x=Object(c.a)(window,"popstate").pipe(Object(s.a)(e=>null!==e.state),Object(b.a)(e=>({url:new URL(location.href),offset:e.state})),Object(f.a)());Object(o.a)(S,x).pipe(Object(d.a)((e,t)=>e.url.href===t.url.href),Object(b.a)(({url:e})=>e)).subscribe(y);const T=y.pipe(Object(p.a)("pathname"),Object(O.a)(1),Object(u.a)(e=>Object(i.a)(fetch(e.href,{credentials:"same-origin"}).then(e=>e.text())).pipe(Object(l.a)(()=>(Object(v.m)(e),a.a)))),Object(f.a)());S.pipe(Object(j.a)(T)).subscribe(({url:e})=>{history.pushState({},"",e.toString())});const C=new DOMParser;T.pipe(Object(b.a)(e=>C.parseFromString(e,"text/html"))).subscribe(t);const k=Object(o.a)(S,x).pipe(Object(j.a)(t));k.subscribe(({url:e,offset:t})=>{e.hash&&!t?Object(v.n)(e.hash):Object(v.p)(t||{y:0})}),k.pipe(Object(h.a)(t)).subscribe(([,{title:e,head:t}])=>{document.title=e;for(const e of['link[rel="canonical"]','meta[name="author"]','meta[name="description"]']){const n=Object(v.c)(e,t),c=Object(v.c)(e,document.head);void 0!==n&&void 0!==c&&Object(v.j)(c,n)}document.dispatchEvent(new CustomEvent("DOMContentSwitch"))}),n.pipe(Object(m.a)(250),Object(p.a)("offset")).subscribe(({offset:e})=>{history.replaceState(e,"")}),Object(o.a)(w,x).pipe(Object(g.a)(2,1),Object(s.a)(([e,t])=>e.url.pathname===t.url.pathname&&!Object(v.g)(t.url)),Object(b.a)(([,e])=>e)).subscribe(({offset:e})=>{Object(v.p)(e||{y:0})})}},function(e,t,n){"use strict";n.d(t,"a",(function(){return u}));var c=n(10),r=n(30),a=n(37),o=n(52),i=n(0),s=n(7);function u(){const e=Object(i.u)().pipe(Object(c.a)(e=>Object.assign({mode:Object(i.f)("search")?"search":"global"},e)),Object(r.a)(({mode:e})=>{if("global"===e){const e=Object(i.b)();if(void 0!==e)return!Object(i.i)(e)}return!0}),Object(a.a)());return e.pipe(Object(r.a)(({mode:e})=>"search"===e),Object(o.a)(Object(s.useComponent)("search-query"),Object(s.useComponent)("search-result"),Object(s.useComponent)("search-suggest"))).subscribe(([e,t,n,c])=>{const r=Object(i.b)();switch(e.type){case"Enter":if(r===t){const t=new Map;for(const e of Object(i.e)(":first-child [href]",n)){const n=e.firstElementChild;t.set(e,parseFloat(n.getAttribute("data-md-score")))}if(t.size){const[[e]]=[...t].sort(([,e],[,t])=>t-e);e.click()}e.claim()}break;case"Escape":case"Tab":Object(i.o)("search",!1),Object(i.k)(t,!1);break;case"ArrowUp":case"ArrowDown":if(void 0===r)Object(i.k)(t);else{const c=[t,...Object(i.e)(":not(details) > [href], summary, details[open] [href]",n)],a=Math.max(0,(Math.max(0,c.indexOf(r))+c.length+("ArrowUp"===e.type?-1:1))%c.length);Object(i.k)(c[a])}e.claim();break;case"ArrowRight":c.innerText.length&&t.selectionStart===t.value.length&&(t.value=c.innerText);break;default:t!==Object(i.b)()&&Object(i.k)(t)}}),e.pipe(Object(r.a)(({mode:e})=>"global"===e),Object(o.a)(Object(s.useComponent)("search-query"))).subscribe(([e,t])=>{switch(e.type){case"f":case"s":case"/":Object(i.k)(t),Object(i.l)(t),e.claim();break;case"p":case",":const n=Object(i.c)("[href][rel=prev]");void 0!==n&&n.click();break;case"n":case".":const c=Object(i.c)("[href][rel=next]");void 0!==c&&c.click()}}),e}},function(e,t,n){"use strict";var c=n(73);n.d(t,"mountTableOfContents",(function(){return c.a}));n(39)},function(e,t,n){"use strict";n.d(t,"a",(function(){return f}));var c=n(34),r=n(60),a=n(41),o=n(13),i=n(10),s=n(0),u=n(23),b=n(39);function f({header$:e,main$:t,viewport$:n,tablet$:f}){return Object(c.a)(Object(o.a)(c=>f.pipe(Object(o.a)(o=>{if(o){const a=Object(s.e)(".md-nav__link",c),o=Object(u.watchSidebar)(c,{main$:t,viewport$:n}).pipe(Object(u.applySidebar)(c,{header$:e})),f=Object(b.watchAnchorList)(a,{header$:e,viewport$:n}).pipe(Object(b.applyAnchorList)(a));return Object(r.a)([o,f]).pipe(Object(i.a)(([e,t])=>({sidebar:e,anchors:t})))}return Object(a.a)({})}))))}},function(e,t){},function(e,t,n){"use strict";n.d(t,"b",(function(){return m})),n.d(t,"a",(function(){return g}));var c=n(60),r=n(34),a=n(58),o=n(10),i=n(56),s=n(13),u=n(86),b=n(35),f=n(100),d=n(88),p=n(57),O=n(36),l=n(85),j=n(0),h=n(20);function m(e,{header$:t,viewport$:n}){const r=new Map;for(const t of e){const e=decodeURIComponent(t.hash.substring(1)),n=Object(j.c)(`[id="${e}"]`);void 0!==n&&r.set(t,n)}const a=t.pipe(Object(o.a)(e=>18+e.height));return Object(j.t)(document.body).pipe(Object(i.a)("height"),Object(o.a)(()=>{let e=[];return[...r].reduce((t,[n,c])=>{for(;e.length;){if(!(r.get(e[e.length-1]).tagName>=c.tagName))break;e.pop()}let a=c.offsetTop;for(;!a&&c.parentElement;)a=(c=c.parentElement).offsetTop;return t.set([...e=[...e,n]].reverse(),a)},new Map)}),Object(s.a)(e=>Object(c.a)([a,n]).pipe(Object(u.a)(([e,t],[n,{offset:{y:c}}])=>{for(;t.length;){const[,r]=t[0];if(!(r-n=c))break;t=[e.pop(),...t]}return[e,t]},[[],[...e]]),Object(b.a)((e,t)=>e[0]===t[0]&&e[1]===t[1])))).pipe(Object(o.a)(([e,t])=>({prev:e.map(([e])=>e),next:t.map(([e])=>e)})),Object(f.a)({prev:[],next:[]}),Object(d.a)(2,1),Object(o.a)(([e,t])=>e.prev.length{for(const[e]of t)Object(h.a)(e),Object(h.b)(e);e.forEach(([t],n)=>{Object(h.c)(t,n===e.length-1),Object(h.d)(t,!0)})}),Object(l.a)(()=>{for(const t of e)Object(h.a)(t),Object(h.b)(t)}))}},function(e,t,n){"use strict";n.d(t,"a",(function(){return p})),n.d(t,"b",(function(){return x})),n.d(t,"c",(function(){return k})),n.d(t,"d",(function(){return P}));var c=n(34),r=n(60),a=n(13),o=n(30),i=n(95),s=n(100),u=n(87),b=n(102),f=n(10),d=n(38);function p({rx$:e,tx$:t},{query$:n,reset$:p,result$:O}){return Object(c.a)(Object(a.a)(()=>{const c=e.pipe(Object(o.a)(d.isSearchReadyMessage),Object(i.a)("ready"),Object(s.a)("waiting"));return t.pipe(Object(o.a)(d.isSearchQueryMessage),Object(u.a)(c),Object(b.a)(1)).subscribe(t.next.bind(t)),Object(r.a)([c,n,O,p]).pipe(Object(f.a)(([e,t,n])=>({status:e,query:t,result:n})))}))}var O=n(56),l=n(0),j=n(11),h=n(59),m=n(54),g=n(61),v=n(35),y=n(36),$=n(85),w=n(1);function S(e){e.placeholder=Object(w.f)("search.placeholder")}function x({tx$:e},t={}){return Object(c.a)(Object(a.a)(n=>{const a=function(e,{transform:t}={}){const n=t||j.defaultTransform,c=Object(h.a)(Object(m.a)(e,"keyup"),Object(m.a)(e,"focus").pipe(Object(g.a)(1))).pipe(Object(f.a)(()=>n(e.value)),Object(s.a)(n(e.value)),Object(v.a)()),a=Object(l.r)(e);return Object(r.a)([c,a]).pipe(Object(f.a)(([e,t])=>({value:e,focus:t})))}(n,t);return a.pipe(Object(O.a)("value"),Object(f.a)(({value:e})=>({type:j.SearchMessageType.QUERY,data:e}))).subscribe(e.next.bind(e)),a.pipe(Object(O.a)("focus")).subscribe(({focus:e})=>{e&&Object(l.o)("search",e)}),a.pipe(function(e){return Object(c.a)(Object(y.a)(({focus:t})=>{t?function(e,t){e.placeholder=t}(e,""):S(e)}),Object($.a)(()=>{S(e)}))}(n))}))}var T=n(104),C=n(17);function k(){return Object(c.a)(Object(a.a)(e=>function(e){return Object(m.a)(e,"click").pipe(Object(i.a)(void 0))}(e).pipe(Object(T.a)(Object(C.b)("search-query")),Object(y.a)(l.k),Object(i.a)(void 0))),Object(s.a)(void 0))}var _=n(58),M=n(52),E=n(57),A=n(86),R=n(24);function L(e,t){e.appendChild(t)}function H(e,{query$:t,fetch$:n}){const r=Object(l.d)(".md-search-result__list",e),o=Object(l.d)(".md-search-result__meta",e);return Object(c.a)(Object(M.a)(t),Object(f.a)(([e,t])=>{const{items:n}=e;return t.value?function(e,t){switch(t){case 0:e.textContent=Object(w.f)("search.result.none");break;case 1:e.textContent=Object(w.f)("search.result.one");break;default:e.textContent=Object(w.f)("search.result.other",t)}}(o,n.length):function(e){e.textContent=Object(w.f)("search.result.placeholder")}(o),e}),Object(a.a)(t=>{const{items:c}=t,a=[...c.map(([e])=>e.score),0];return n.pipe(Object(E.a)(_.a),Object(A.a)(t=>{const n=e.parentElement;for(;t16)););return t},0),Object(i.a)(t),Object($.a)(()=>{!function(e){e.innerHTML=""}(r)}))}))}function P({rx$:e},{query$:t}){return Object(c.a)(Object(a.a)(n=>{const c=n.parentElement,r=Object(l.s)(c).pipe(Object(f.a)(({y:e})=>e>=c.scrollHeight-c.offsetHeight-16),Object(v.a)(),Object(o.a)(Boolean));return e.pipe(Object(o.a)(j.isSearchResultMessage),Object(f.a)(({data:e})=>e),H(n,{query$:t,fetch$:r}))}))}},function(e,t,n){"use strict";n.d(t,"a",(function(){return g}));var c=n(34),r=n(60),a=n(13),o=n(10),i=n(30),s=n(107),u=n(35),b=n(100),f=n(0),d=n(17),p=n(41),O=n(58),l=n(96),j=n(57),h=n(36),m=n(85);function g({document$:e,viewport$:t}){return Object(c.a)(Object(a.a)(n=>{const g=function(e,{document$:t}){return t.pipe(Object(o.a)(()=>{const t=getComputedStyle(e);return["sticky","-webkit-sticky"].includes(t.position)}),Object(u.a)(),Object(a.a)(t=>t?Object(f.t)(e).pipe(Object(o.a)(({height:e})=>({sticky:!0,height:e}))):Object(p.a)({sticky:!1,height:0})),Object(l.a)({bufferSize:1,refCount:!0}))}(n,{document$:e}),v=Object(d.b)("main").pipe(Object(o.a)(e=>Object(f.c)("h1, h2, h3, h4, h5, h6",e)),Object(i.a)(e=>void 0!==e),Object(s.a)(Object(d.b)("header-title")),Object(a.a)(([e,n])=>Object(f.B)(e,{header$:g,viewport$:t}).pipe(Object(o.a)(({offset:{y:t}})=>t>=e.offsetHeight?"page":"site"),Object(u.a)(),function(e){return Object(c.a)(Object(j.a)(O.a),Object(h.a)(t=>{!function(e,t){e.setAttribute("data-md-state",t?"active":"")}(e,"page"===t)}),Object(m.a)(()=>{!function(e){e.removeAttribute("data-md-state")}(e)}))}(n))),Object(b.a)("site"));return Object(r.a)([g,v]).pipe(Object(o.a)(([e,t])=>Object.assign({type:t},e)))}))}},function(e,t,n){"use strict";n.d(t,"a",(function(){return h}));var c=n(29),r=n(16),a=n(34),o=n(13),i=n(56),s=n(36),u=n(85),b=n(17),f=n(60),d=n(58),p=n(10),O=n(35),l=n(57),j=n(0);function h({header$:e,viewport$:t}){const n=new c.a;return Object(b.b)("header").pipe(Object(o.a)(e=>{return n.pipe(Object(i.a)("active"),(t=e,Object(a.a)(Object(l.a)(d.a),Object(s.a)(({active:e})=>{!function(e,t){e.setAttribute("data-md-state",t?"shadow":"")}(t,e)}),Object(u.a)(()=>{!function(e){e.removeAttribute("data-md-state")}(t)}))));var t})).subscribe(r.a),Object(a.a)(Object(o.a)(n=>function(e,{header$:t,viewport$:n}){const c=t.pipe(Object(p.a)(({height:e})=>e),Object(O.a)()),r=c.pipe(Object(o.a)(()=>Object(j.t)(e).pipe(Object(p.a)(({height:t})=>({top:e.offsetTop,bottom:e.offsetTop+t})),Object(i.a)("bottom"))));return Object(f.a)([c,r,n]).pipe(Object(p.a)(([e,{top:t,bottom:n},{offset:{y:c},size:{height:r}}])=>({offset:t-e,height:r=Math.max(0,r-Math.max(0,t-c,e)-Math.max(0,r+c-n)),active:t-e<=c})),Object(O.a)((e,t)=>e.offset===t.offset&&e.height===t.height&&e.active===t.active))}(n,{header$:e,viewport$:t})),Object(s.a)(e=>n.next(e)),Object(u.a)(()=>n.complete()))}},function(e,t,n){"use strict";n.d(t,"a",(function(){return p}));var c=n(34),r=n(41),a=n(13),o=n(10),i=n(56),s=n(0),u=n(58),b=n(57),f=n(36),d=n(85);function p({header$:e,viewport$:t,screen$:n}){return Object(c.a)(Object(a.a)(p=>n.pipe(Object(a.a)(n=>n?Object(s.B)(p,{header$:e,viewport$:t}).pipe(Object(o.a)(({offset:{y:e}})=>({hidden:e>=10})),Object(i.a)("hidden"),function(e){return Object(c.a)(Object(b.a)(u.a),Object(f.a)(({hidden:t})=>{!function(e,t){e.setAttribute("data-md-state",t?"hidden":"")}(e,t)}),Object(d.a)(()=>{!function(e){e.removeAttribute("data-md-state")}(e)}))}(p)):Object(r.a)({hidden:!0})))))}},function(e,t,n){"use strict";n.d(t,"e",(function(){return j})),n.d(t,"a",(function(){return c})),n.d(t,"c",(function(){return d})),n.d(t,"b",(function(){return p})),n.d(t,"d",(function(){return O}));var c,r=n(29),a=n(49),o=n(52),i=n(10),s=n(37),u=n(57),b=n(0),f=n(1);function d(e){return e.type===c.READY}function p(e){return e.type===c.QUERY}function O(e){return e.type===c.RESULT}function l({config:e,docs:t,index:n,options:c}){1===e.lang.length&&"en"===e.lang[0]&&(e.lang=[Object(f.f)("search.config.lang")]),"[\\s\\-]+"===e.separator&&(e.separator=Object(f.f)("search.config.separator"));const r=Object(f.f)("search.config.pipeline").split(/\s*,\s*/).filter(Boolean);return{config:e,docs:t,index:n,options:Object.assign(Object.assign({},c),{pipeline:r,suggestions:!0})}}function j(e,{index$:t,base$:n}){const f=new Worker(e),d=new r.a,p=Object(b.C)(f,{tx$:d}).pipe(Object(o.a)(n),Object(i.a)(([e,t])=>{if(O(e))for(const n of e.data.items)for(const e of n)e.location=`${t}/${e.location}`;return e}),Object(s.a)());return t.pipe(Object(i.a)(e=>({type:c.SETUP,data:l(e)})),Object(u.a)(a.a)).subscribe(d.next.bind(d)),{tx$:d,rx$:p}}!function(e){e[e.SETUP=0]="SETUP",e[e.READY=1]="READY",e[e.QUERY=2]="QUERY",e[e.RESULT=3]="RESULT"}(c||(c={}))},,,,,,,,,,,,,,function(e,t,n){"use strict";n.r(t),n.d(t,"setScrollLock",(function(){return W})),n.d(t,"resetScrollLock",(function(){return I})),n.d(t,"initialize",(function(){return Q}));n(89);var c=n(83),r=n(9),a=n(60),o=n(41),i=n(54),s=n(49),u=n(55),b=n(58),f=n(59),d=n(96),p=n(13),O=n(52),l=n(57),j=n(10),h=n(35),m=n(98),g=n(36),v=n(61),y=n(30),$=n(102),w=n(88),S=n(56),x=n(95),T=n(107),C=n(0),k=n(7),_=n(11);var M=n(104);var E=n(6),A=n(26),R=n(16),L=n(97),H=n(105);var P=n(106);function z(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}var N=n(24),q=n(1);function U(e){const[t]=e.match(/(git(?:hub|lab))/i)||[];switch(t.toLowerCase()){case"github":const[,t,n]=e.match(/^.+github\.com\/([^\/]+)\/?([^\/]+)?/i);return function(e,t){const n=void 0!==t?`https://api.github.com/repos/${e}/${t}`:"https://api.github.com/users/"+e;return Object(r.a)(fetch(n).then(e=>e.json())).pipe(Object(j.a)(e=>{if(void 0!==t){const{stargazers_count:t,forks_count:n}=e;return[Object(q.e)(t||0)+" Stars",Object(q.e)(n||0)+" Forks"]}{const{public_repos:t}=e;return[Object(q.e)(t||0)+" Repositories"]}}))}(t,n);case"gitlab":const[,c,a]=e.match(/^.+?([^\/]*gitlab[^\/]+)\/(.+?)\/?$/i);return function(e,t){const n=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return Object(r.a)(fetch(n).then(e=>e.json())).pipe(Object(j.a)(({star_count:e,forks_count:t})=>[Object(q.e)(e)+" Stars",Object(q.e)(t)+" Forks"]))}(c,a);default:return u.a}}function W(e,t){e.setAttribute("data-md-state","lock"),e.style.top=`-${t}px`}function I(e){const t=-1*parseInt(e.style.top,10);e.removeAttribute("data-md-state"),e.style.top="",t&&window.scrollTo(0,t)}function Q(e){if(!Object(q.d)(e))throw new SyntaxError("Invalid configuration: "+JSON.stringify(e));const t=Object(C.q)(),n=Object(C.v)(),Q=Object(C.w)(e.base,{location$:n}),D=Object(C.x)(),F=Object(C.A)(),J=Object(C.y)("(min-width: 960px)"),K=Object(C.y)("(min-width: 1220px)");Object(k.setupComponents)(["announce","container","header","header-title","main","navigation","search","search-query","search-reset","search-result","search-suggest","skip","tabs","toc"],{document$:t});const Y=Object(_.setupKeyboard)();matchMedia("(hover)").matches&&function({document$:e,viewport$:t}){const n=e.pipe(Object(j.a)(()=>Object(C.e)("pre > code"))),c=t.pipe(Object(S.a)("size"));Object(a.a)([n,c]).subscribe(([e])=>{for(const t of e)t.scrollWidth>t.clientWidth?t.setAttribute("tabindex","0"):t.removeAttribute("tabindex")})}({document$:t,viewport$:F}),function({document$:e,hash$:t}){const n=e.pipe(Object(j.a)(()=>Object(C.e)("details")));Object(f.a)(Object(C.y)("print").pipe(Object(y.a)(Boolean)),Object(i.a)(window,"beforeprint")).pipe(Object(M.a)(n)).subscribe(e=>{for(const t of e)t.setAttribute("open","")}),t.pipe(Object(j.a)(e=>Object(C.c)(`[id="${e}"]`)),Object(y.a)(e=>void 0!==e),Object(g.a)(e=>{const t=e.closest("details");t&&!t.open&&t.setAttribute("open","")})).subscribe(e=>e.scrollIntoView())}({document$:t,hash$:D}),function({document$:e}){e.pipe(Object(L.a)(1),Object(O.a)(Object(k.useComponent)("container")),Object(j.a)(([,e])=>Object(C.e)("script",e))).pipe(Object(p.a)(e=>Object(o.a)(...e)),Object(H.a)(e=>{const t=Object(C.a)("script");return e.src?(t.src=e.src,Object(C.j)(e,t),new E.a(e=>{t.onload=()=>e.complete()})):(t.textContent=e.textContent,Object(C.j)(e,t),A.a)})).subscribe(R.a)}({document$:t}),function({document$:e}){e.pipe(Object(j.a)(()=>Object(C.d)(".md-source[href]")),Object(p.a)(({href:e})=>Object(q.a)(""+Object(q.c)(e),()=>U(e))),Object(m.a)(()=>u.a)).subscribe(e=>{for(const t of Object(C.e)(".md-source__repository"))t.hasAttribute("data-md-state")||(t.setAttribute("data-md-state","done"),t.appendChild(Object(N.c)(e)))})}({document$:t}),function({document$:e}){const t=Object(C.a)("table");e.pipe(Object(j.a)(()=>Object(C.e)("table:not([class])"))).subscribe(e=>{for(const n of e)Object(C.j)(n,t),Object(C.j)(t,Object(N.d)(n))})}({document$:t}),function({document$:e}){const t=e.pipe(Object(j.a)(()=>Object(C.e)("[data-md-scrollfix]")),Object(d.a)({bufferSize:1,refCount:!0}));t.subscribe(e=>{for(const t of e)t.removeAttribute("data-md-scrollfix")}),Object(P.a)(z,t,u.a).pipe(Object(p.a)(e=>Object(f.a)(...e.map(e=>Object(i.a)(e,"touchstart").pipe(Object(x.a)(e)))))).subscribe(e=>{const t=e.scrollTop;0===t?e.scrollTop=1:t+e.offsetHeight===e.scrollHeight&&(e.scrollTop=t-1)})}({document$:t});const B=Object(_.setupDialog)(),X=Object(_.setupClipboard)({document$:t,dialog$:B}),V=Object(k.useComponent)("header").pipe(Object(k.mountHeader)({document$:t,viewport$:F}),Object(d.a)({bufferSize:1,refCount:!0})),G=Object(k.useComponent)("main").pipe(Object(k.mountMain)({header$:V,viewport$:F}),Object(d.a)({bufferSize:1,refCount:!0})),Z=Object(k.useComponent)("navigation").pipe(Object(k.mountNavigation)({header$:V,main$:G,viewport$:F,screen$:K}),Object(d.a)({bufferSize:1,refCount:!0})),ee=Object(k.useComponent)("toc").pipe(Object(k.mountTableOfContents)({header$:V,main$:G,viewport$:F,tablet$:J}),Object(d.a)({bufferSize:1,refCount:!0})),te=Object(k.useComponent)("tabs").pipe(Object(k.mountTabs)({header$:V,viewport$:F,screen$:K}),Object(d.a)({bufferSize:1,refCount:!0})),ne=Object(k.useComponent)("search").pipe(Object(p.a)(()=>Object(c.a)(()=>{const t=e.search&&e.search.index?e.search.index:void 0,c=void 0!==t?Object(r.a)(t):Q.pipe(Object(p.a)(e=>fetch(e+"/search/search_index.json",{credentials:"same-origin"}).then(e=>e.json())));return e.features.includes("search.highlight")&&Object(a.a)([n,c]).subscribe(([e,t])=>{if(!e.searchParams.has("h"))return;const n=Object(_.setupSearchHighlighter)(t.config)(e.searchParams.get("h"));let c=e.hash?Object(C.c)(`[id="${e.hash.slice(1)}"]`):Object(C.c)("article");if(void 0!==c)for(;c;){const e=document.createNodeIterator(c,NodeFilter.SHOW_TEXT),t=[];for(;;){const n=e.nextNode();if(!n)break;t.push(n)}for(const e of t)e.textContent.trim()&&e.replaceWith(Object(q.b)("span",null,n(e.textContent)));if("article"===c.tagName)break;{const e=c.nextSibling;if(e instanceof HTMLElement&&e.tagName.match(/^H[1-6]/))break;c=e}}}),Object(o.a)(Object(_.setupSearchWorker)(e.search.worker,{base$:Q,index$:c}))}))).pipe(Object(p.a)(t=>{const n=Object(k.useComponent)("search-query").pipe(Object(k.mountSearchQuery)(t,{transform:e.search.transform}),Object(d.a)({bufferSize:1,refCount:!0})),c=Object(k.useComponent)("search-reset").pipe(Object(k.mountSearchReset)(),Object(d.a)({bufferSize:1,refCount:!0})),r=Object(k.useComponent)("search-result").pipe(Object(k.mountSearchResult)(t,{query$:n}),Object(d.a)({bufferSize:1,refCount:!0}));return e.features.includes("search.suggest")&&(r.pipe(Object(O.a)(n)).subscribe(([{suggestions:e},t])=>{if(void 0!==e){const n=document.querySelector(".md-search__suggest"),c=t.value.split(/([\s-]+)/);if(e.length){const[r]=e.slice(-1);if(e.length>=t.value.split(/[\s-]+/).length&&r.startsWith(c[c.length-1])){const e=document.createElement("span");e.innerHTML=[...c.slice(0,-1),r].join(""),n.innerHTML="",n.appendChild(e)}else n.innerHTML=""}else n.innerHTML=""}}),Object(k.useComponent)("search-query").pipe(Object(p.a)(e=>Object(i.a)(e,"keydown").pipe(Object(l.a)(s.a),Object(j.a)(()=>e.value),Object(h.a)(),Object(j.a)(()=>{const t=document.querySelector(".md-search__suggest span");t&&(t.innerHTML.startsWith(e.value)&&!e.value.endsWith(" ")&&0!==e.value.length||(t.innerHTML=""))})))).subscribe()),Object(k.useComponent)("search").pipe(Object(k.mountSearch)(t,{query$:n,reset$:c,result$:r}))}),Object(m.a)(()=>(Object(k.useComponent)("search").subscribe(e=>e.hidden=!0),u.a)),Object(d.a)({bufferSize:1,refCount:!0}));if(D.pipe(Object(g.a)(()=>Object(C.o)("search",!1)),Object(v.a)(125)).subscribe(e=>Object(C.n)("#"+e)),Object(a.a)([Object(C.z)("search"),J]).pipe(Object(O.a)(F),Object(p.a)(([[e,n],{offset:{y:c}}])=>{const r=e&&!n;return t.pipe(Object(v.a)(r?400:100),Object(l.a)(b.a),Object(g.a)(({body:e})=>r?W(e,c):I(e)))})).subscribe(),Object(i.a)(document.body,"click").pipe(Object(y.a)(e=>!(e.metaKey||e.ctrlKey)),Object(y.a)(e=>{if(e.target instanceof HTMLElement){const t=e.target.closest("a");if(t&&Object(C.h)(t))return!0}return!1})).subscribe(()=>{Object(C.o)("drawer",!1)}),e.features.includes("navigation.instant")&&"file:"!==location.protocol){const e=new DOMParser;Q.pipe(Object(p.a)(t=>Object(r.a)(fetch(t+"/sitemap.xml").then(e=>e.text()).then(t=>e.parseFromString(t,"text/xml")))),Object(O.a)(Q),Object(j.a)(([e,t])=>{const n=Object(C.e)("loc",e).map(e=>e.textContent);if(n.length>1){const[e,c]=n.sort((e,t)=>e.length-t.length);let r=0;if(e===c)r=e.length;else for(;e.charAt(r)===c.charAt(r);)r++;for(let c=0;c{Object(_.setupInstantLoading)(e,{document$:t,location$:n,viewport$:F})})}Y.pipe(Object(y.a)(e=>"global"===e.mode&&"Tab"===e.type),Object($.a)(1)).subscribe(()=>{for(const e of Object(C.e)(".headerlink"))e.style.visibility="visible"}),t.subscribe(()=>{const e=Object(C.e)(".md-toggle--indeterminate");for(const t of e)t.indeterminate=!0,t.checked=!1});const ce=Object(C.e)("[data-md-option=palette]");for(let e=0;e{for(const e of["mdColorScheme","mdColorPrimary","mdColorAccent"])t.dataset[e]&&(document.body.dataset[e]=t.dataset[e]);ce[e].dataset.mdState="hidden";const n=ce[(e+1)%ce.length];n.dataset.mdState="",n.focus(),localStorage.setItem("__palette",JSON.stringify({index:e,color:{scheme:t.dataset.mdColorScheme,primary:t.dataset.mdColorPrimary,accent:t.dataset.mdColorAccent}}))})}if(ce.length){const{index:e}=JSON.parse(localStorage.getItem("__palette")||'{ "index": 0 }');ce[(+e+1)%ce.length].dataset.mdState=""}if(e.features.includes("header.autohide")&&F.pipe(Object(j.a)(({offset:e})=>e.y),Object(w.a)(2,1),Object(j.a)(([e,t])=>[eF.pipe(Object(j.a)(({offset:e})=>e.y),Object(y.a)(e=>e>400),Object(j.a)(e=>Math.abs(t-e)),Object(y.a)(e=>e>100),Object(x.a)(e),Object($.a)(1)))).subscribe(e=>{const t=Object(C.c)("[data-md-component=header]");null==t||t.setAttribute("data-md-state",e?"hidden":"shadow")}),void 0!==e.version&&"mike"===e.version.method){const e=Q.pipe(Object(p.a)(e=>fetch(e+"/../versions.json",{credentials:"same-origin"}).then(e=>e.json())),Object(m.a)(()=>(console.log("Couldn't load versions.json"),u.a)));Object(k.useComponent)("header-title").pipe(Object(j.a)(e=>e.querySelector(".md-header-nav__topic")),Object(T.a)(Q,e)).subscribe(([e,t,n])=>{e.appendChild(function(e,t){const[,n]=e.match(/([^\/]+)\/?$/),c=t.find(({version:e})=>e===n)||t[0];return Object(q.b)("div",{class:"md-version"},Object(q.b)("span",{class:"md-version__current"},c.version),Object(q.b)("ul",{class:"md-version__list"},t.map(t=>Object(q.b)("li",{class:"md-version__item"},Object(q.b)("a",{class:"md-version__link",href:`${e}/../${t.version}/`},t.title)))))}(t,n))})}const re={document$:t,location$:n,viewport$:F,header$:V,main$:G,navigation$:Z,search$:ne,tabs$:te,toc$:ee,clipboard$:X,keyboard$:Y,dialog$:B};return Object(f.a)(...Object.values(re)).subscribe(),re}document.documentElement.classList.remove("no-js"),document.documentElement.classList.add("js"),navigator.userAgent.match(/(iPad|iPhone|iPod)/g)&&document.documentElement.classList.add("ios")}])); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/min/lunr.ar.min.js b/v4.0.1/assets/javascripts/lunr/min/lunr.ar.min.js new file mode 100644 index 0000000000..248ddc5d14 --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/min/lunr.ar.min.js @@ -0,0 +1 @@ +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.ar=function(){this.pipeline.reset(),this.pipeline.add(e.ar.trimmer,e.ar.stopWordFilter,e.ar.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.ar.stemmer))},e.ar.wordCharacters="ء-ٛٱـ",e.ar.trimmer=e.trimmerSupport.generateTrimmer(e.ar.wordCharacters),e.Pipeline.registerFunction(e.ar.trimmer,"trimmer-ar"),e.ar.stemmer=function(){var e=this;return e.result=!1,e.preRemoved=!1,e.sufRemoved=!1,e.pre={pre1:"ف ك ب و س ل ن ا ي ت",pre2:"ال لل",pre3:"بال وال فال تال كال ولل",pre4:"فبال كبال وبال وكال"},e.suf={suf1:"ه ك ت ن ا ي",suf2:"نك نه ها وك يا اه ون ين تن تم نا وا ان كم كن ني نن ما هم هن تك ته ات يه",suf3:"تين كهم نيه نهم ونه وها يهم ونا ونك وني وهم تكم تنا تها تني تهم كما كها ناه نكم هنا تان يها",suf4:"كموه ناها ونني ونهم تكما تموه تكاه كماه ناكم ناهم نيها وننا"},e.patterns=JSON.parse('{"pt43":[{"pt":[{"c":"ا","l":1}]},{"pt":[{"c":"ا,ت,ن,ي","l":0}],"mPt":[{"c":"ف","l":0,"m":1},{"c":"ع","l":1,"m":2},{"c":"ل","l":2,"m":3}]},{"pt":[{"c":"و","l":2}],"mPt":[{"c":"ف","l":0,"m":0},{"c":"ع","l":1,"m":1},{"c":"ل","l":2,"m":3}]},{"pt":[{"c":"ا","l":2}]},{"pt":[{"c":"ي","l":2}],"mPt":[{"c":"ف","l":0,"m":0},{"c":"ع","l":1,"m":1},{"c":"ا","l":2},{"c":"ل","l":3,"m":3}]},{"pt":[{"c":"م","l":0}]}],"pt53":[{"pt":[{"c":"ت","l":0},{"c":"ا","l":2}]},{"pt":[{"c":"ا,ن,ت,ي","l":0},{"c":"ت","l":2}],"mPt":[{"c":"ا","l":0},{"c":"ف","l":1,"m":1},{"c":"ت","l":2},{"c":"ع","l":3,"m":3},{"c":"ا","l":4},{"c":"ل","l":5,"m":4}]},{"pt":[{"c":"ا","l":0},{"c":"ا","l":2}],"mPt":[{"c":"ا","l":0},{"c":"ف","l":1,"m":1},{"c":"ع","l":2,"m":3},{"c":"ل","l":3,"m":4},{"c":"ا","l":4},{"c":"ل","l":5,"m":4}]},{"pt":[{"c":"ا","l":0},{"c":"ا","l":3}],"mPt":[{"c":"ف","l":0,"m":1},{"c":"ع","l":1,"m":2},{"c":"ل","l":2,"m":4}]},{"pt":[{"c":"ا","l":3},{"c":"ن","l":4}]},{"pt":[{"c":"ت","l":0},{"c":"ي","l":3}]},{"pt":[{"c":"م","l":0},{"c":"و","l":3}]},{"pt":[{"c":"ا","l":1},{"c":"و","l":3}]},{"pt":[{"c":"و","l":1},{"c":"ا","l":2}]},{"pt":[{"c":"م","l":0},{"c":"ا","l":3}]},{"pt":[{"c":"م","l":0},{"c":"ي","l":3}]},{"pt":[{"c":"ا","l":2},{"c":"ن","l":3}]},{"pt":[{"c":"م","l":0},{"c":"ن","l":1}],"mPt":[{"c":"ا","l":0},{"c":"ن","l":1},{"c":"ف","l":2,"m":2},{"c":"ع","l":3,"m":3},{"c":"ا","l":4},{"c":"ل","l":5,"m":4}]},{"pt":[{"c":"م","l":0},{"c":"ت","l":2}],"mPt":[{"c":"ا","l":0},{"c":"ف","l":1,"m":1},{"c":"ت","l":2},{"c":"ع","l":3,"m":3},{"c":"ا","l":4},{"c":"ل","l":5,"m":4}]},{"pt":[{"c":"م","l":0},{"c":"ا","l":2}]},{"pt":[{"c":"م","l":1},{"c":"ا","l":3}]},{"pt":[{"c":"ي,ت,ا,ن","l":0},{"c":"ت","l":1}],"mPt":[{"c":"ف","l":0,"m":2},{"c":"ع","l":1,"m":3},{"c":"ا","l":2},{"c":"ل","l":3,"m":4}]},{"pt":[{"c":"ت,ي,ا,ن","l":0},{"c":"ت","l":2}],"mPt":[{"c":"ا","l":0},{"c":"ف","l":1,"m":1},{"c":"ت","l":2},{"c":"ع","l":3,"m":3},{"c":"ا","l":4},{"c":"ل","l":5,"m":4}]},{"pt":[{"c":"ا","l":2},{"c":"ي","l":3}]},{"pt":[{"c":"ا,ي,ت,ن","l":0},{"c":"ن","l":1}],"mPt":[{"c":"ا","l":0},{"c":"ن","l":1},{"c":"ف","l":2,"m":2},{"c":"ع","l":3,"m":3},{"c":"ا","l":4},{"c":"ل","l":5,"m":4}]},{"pt":[{"c":"ا","l":3},{"c":"ء","l":4}]}],"pt63":[{"pt":[{"c":"ا","l":0},{"c":"ت","l":2},{"c":"ا","l":4}]},{"pt":[{"c":"ا,ت,ن,ي","l":0},{"c":"س","l":1},{"c":"ت","l":2}],"mPt":[{"c":"ا","l":0},{"c":"س","l":1},{"c":"ت","l":2},{"c":"ف","l":3,"m":3},{"c":"ع","l":4,"m":4},{"c":"ا","l":5},{"c":"ل","l":6,"m":5}]},{"pt":[{"c":"ا,ن,ت,ي","l":0},{"c":"و","l":3}]},{"pt":[{"c":"م","l":0},{"c":"س","l":1},{"c":"ت","l":2}],"mPt":[{"c":"ا","l":0},{"c":"س","l":1},{"c":"ت","l":2},{"c":"ف","l":3,"m":3},{"c":"ع","l":4,"m":4},{"c":"ا","l":5},{"c":"ل","l":6,"m":5}]},{"pt":[{"c":"ي","l":1},{"c":"ي","l":3},{"c":"ا","l":4},{"c":"ء","l":5}]},{"pt":[{"c":"ا","l":0},{"c":"ن","l":1},{"c":"ا","l":4}]}],"pt54":[{"pt":[{"c":"ت","l":0}]},{"pt":[{"c":"ا,ي,ت,ن","l":0}],"mPt":[{"c":"ا","l":0},{"c":"ف","l":1,"m":1},{"c":"ع","l":2,"m":2},{"c":"ل","l":3,"m":3},{"c":"ر","l":4,"m":4},{"c":"ا","l":5},{"c":"ر","l":6,"m":4}]},{"pt":[{"c":"م","l":0}],"mPt":[{"c":"ا","l":0},{"c":"ف","l":1,"m":1},{"c":"ع","l":2,"m":2},{"c":"ل","l":3,"m":3},{"c":"ر","l":4,"m":4},{"c":"ا","l":5},{"c":"ر","l":6,"m":4}]},{"pt":[{"c":"ا","l":2}]},{"pt":[{"c":"ا","l":0},{"c":"ن","l":2}]}],"pt64":[{"pt":[{"c":"ا","l":0},{"c":"ا","l":4}]},{"pt":[{"c":"م","l":0},{"c":"ت","l":1}]}],"pt73":[{"pt":[{"c":"ا","l":0},{"c":"س","l":1},{"c":"ت","l":2},{"c":"ا","l":5}]}],"pt75":[{"pt":[{"c":"ا","l":0},{"c":"ا","l":5}]}]}'),e.execArray=["cleanWord","removeDiacritics","cleanAlef","removeStopWords","normalizeHamzaAndAlef","removeStartWaw","removePre432","removeEndTaa","wordCheck"],e.stem=function(){var r=0;for(e.result=!1,e.preRemoved=!1,e.sufRemoved=!1;r=0)return!0},e.normalizeHamzaAndAlef=function(){return e.word=e.word.replace("ؤ","ء"),e.word=e.word.replace("ئ","ء"),e.word=e.word.replace(/([\u0627])\1+/gi,"ا"),!1},e.removeEndTaa=function(){return!(e.word.length>2)||(e.word=e.word.replace(/[\u0627]$/,""),e.word=e.word.replace("ة",""),!1)},e.removeStartWaw=function(){return e.word.length>3&&"و"==e.word[0]&&"و"==e.word[1]&&(e.word=e.word.slice(1)),!1},e.removePre432=function(){var r=e.word;if(e.word.length>=7){var t=new RegExp("^("+e.pre.pre4.split(" ").join("|")+")");e.word=e.word.replace(t,"")}if(e.word==r&&e.word.length>=6){var c=new RegExp("^("+e.pre.pre3.split(" ").join("|")+")");e.word=e.word.replace(c,"")}if(e.word==r&&e.word.length>=5){var l=new RegExp("^("+e.pre.pre2.split(" ").join("|")+")");e.word=e.word.replace(l,"")}return r!=e.word&&(e.preRemoved=!0),!1},e.patternCheck=function(r){for(var t=0;t3){var t=new RegExp("^("+e.pre.pre1.split(" ").join("|")+")");e.word=e.word.replace(t,"")}return r!=e.word&&(e.preRemoved=!0),!1},e.removeSuf1=function(){var r=e.word;if(0==e.sufRemoved&&e.word.length>3){var t=new RegExp("("+e.suf.suf1.split(" ").join("|")+")$");e.word=e.word.replace(t,"")}return r!=e.word&&(e.sufRemoved=!0),!1},e.removeSuf432=function(){var r=e.word;if(e.word.length>=6){var t=new RegExp("("+e.suf.suf4.split(" ").join("|")+")$");e.word=e.word.replace(t,"")}if(e.word==r&&e.word.length>=5){var c=new RegExp("("+e.suf.suf3.split(" ").join("|")+")$");e.word=e.word.replace(c,"")}if(e.word==r&&e.word.length>=4){var l=new RegExp("("+e.suf.suf2.split(" ").join("|")+")$");e.word=e.word.replace(l,"")}return r!=e.word&&(e.sufRemoved=!0),!1},e.wordCheck=function(){for(var r=(e.word,[e.removeSuf432,e.removeSuf1,e.removePre1]),t=0,c=!1;e.word.length>=7&&!e.result&&t=f.limit)return;f.cursor++}for(;!f.out_grouping(w,97,248);){if(f.cursor>=f.limit)return;f.cursor++}d=f.cursor,d=d&&(r=f.limit_backward,f.limit_backward=d,f.ket=f.cursor,e=f.find_among_b(c,32),f.limit_backward=r,e))switch(f.bra=f.cursor,e){case 1:f.slice_del();break;case 2:f.in_grouping_b(p,97,229)&&f.slice_del()}}function t(){var e,r=f.limit-f.cursor;f.cursor>=d&&(e=f.limit_backward,f.limit_backward=d,f.ket=f.cursor,f.find_among_b(l,4)?(f.bra=f.cursor,f.limit_backward=e,f.cursor=f.limit-r,f.cursor>f.limit_backward&&(f.cursor--,f.bra=f.cursor,f.slice_del())):f.limit_backward=e)}function s(){var e,r,i,n=f.limit-f.cursor;if(f.ket=f.cursor,f.eq_s_b(2,"st")&&(f.bra=f.cursor,f.eq_s_b(2,"ig")&&f.slice_del()),f.cursor=f.limit-n,f.cursor>=d&&(r=f.limit_backward,f.limit_backward=d,f.ket=f.cursor,e=f.find_among_b(m,5),f.limit_backward=r,e))switch(f.bra=f.cursor,e){case 1:f.slice_del(),i=f.limit-f.cursor,t(),f.cursor=f.limit-i;break;case 2:f.slice_from("løs")}}function o(){var e;f.cursor>=d&&(e=f.limit_backward,f.limit_backward=d,f.ket=f.cursor,f.out_grouping_b(w,97,248)?(f.bra=f.cursor,u=f.slice_to(u),f.limit_backward=e,f.eq_v_b(u)&&f.slice_del()):f.limit_backward=e)}var a,d,u,c=[new r("hed",-1,1),new r("ethed",0,1),new r("ered",-1,1),new r("e",-1,1),new r("erede",3,1),new r("ende",3,1),new r("erende",5,1),new r("ene",3,1),new r("erne",3,1),new r("ere",3,1),new r("en",-1,1),new r("heden",10,1),new r("eren",10,1),new r("er",-1,1),new r("heder",13,1),new r("erer",13,1),new r("s",-1,2),new r("heds",16,1),new r("es",16,1),new r("endes",18,1),new r("erendes",19,1),new r("enes",18,1),new r("ernes",18,1),new r("eres",18,1),new r("ens",16,1),new r("hedens",24,1),new r("erens",24,1),new r("ers",16,1),new r("ets",16,1),new r("erets",28,1),new r("et",-1,1),new r("eret",30,1)],l=[new r("gd",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1)],m=[new r("ig",-1,1),new r("lig",0,1),new r("elig",1,1),new r("els",-1,1),new r("løst",-1,2)],w=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],p=[239,254,42,3,0,0,0,0,0,0,0,0,0,0,0,0,16],f=new i;this.setCurrent=function(e){f.setCurrent(e)},this.getCurrent=function(){return f.getCurrent()},this.stem=function(){var r=f.cursor;return e(),f.limit_backward=r,f.cursor=f.limit,n(),f.cursor=f.limit,t(),f.cursor=f.limit,s(),f.cursor=f.limit,o(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return n.setCurrent(e),n.stem(),n.getCurrent()}):(n.setCurrent(e),n.stem(),n.getCurrent())}}(),e.Pipeline.registerFunction(e.da.stemmer,"stemmer-da"),e.da.stopWordFilter=e.generateStopWordFilter("ad af alle alt anden at blev blive bliver da de dem den denne der deres det dette dig din disse dog du efter eller en end er et for fra ham han hans har havde have hende hendes her hos hun hvad hvis hvor i ikke ind jeg jer jo kunne man mange med meget men mig min mine mit mod ned noget nogle nu når og også om op os over på selv sig sin sine sit skal skulle som sådan thi til ud under var vi vil ville vor være været".split(" ")),e.Pipeline.registerFunction(e.da.stopWordFilter,"stopWordFilter-da")}}); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/min/lunr.de.min.js b/v4.0.1/assets/javascripts/lunr/min/lunr.de.min.js new file mode 100644 index 0000000000..f3b5c108c9 --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/min/lunr.de.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `German` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.de=function(){this.pipeline.reset(),this.pipeline.add(e.de.trimmer,e.de.stopWordFilter,e.de.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.de.stemmer))},e.de.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.de.trimmer=e.trimmerSupport.generateTrimmer(e.de.wordCharacters),e.Pipeline.registerFunction(e.de.trimmer,"trimmer-de"),e.de.stemmer=function(){var r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,i=new function(){function e(e,r,n){return!(!v.eq_s(1,e)||(v.ket=v.cursor,!v.in_grouping(p,97,252)))&&(v.slice_from(r),v.cursor=n,!0)}function i(){for(var r,n,i,s,t=v.cursor;;)if(r=v.cursor,v.bra=r,v.eq_s(1,"ß"))v.ket=v.cursor,v.slice_from("ss");else{if(r>=v.limit)break;v.cursor=r+1}for(v.cursor=t;;)for(n=v.cursor;;){if(i=v.cursor,v.in_grouping(p,97,252)){if(s=v.cursor,v.bra=s,e("u","U",i))break;if(v.cursor=s,e("y","Y",i))break}if(i>=v.limit)return void(v.cursor=n);v.cursor=i+1}}function s(){for(;!v.in_grouping(p,97,252);){if(v.cursor>=v.limit)return!0;v.cursor++}for(;!v.out_grouping(p,97,252);){if(v.cursor>=v.limit)return!0;v.cursor++}return!1}function t(){m=v.limit,l=m;var e=v.cursor+3;0<=e&&e<=v.limit&&(d=e,s()||(m=v.cursor,m=v.limit)return;v.cursor++}}}function c(){return m<=v.cursor}function u(){return l<=v.cursor}function a(){var e,r,n,i,s=v.limit-v.cursor;if(v.ket=v.cursor,(e=v.find_among_b(w,7))&&(v.bra=v.cursor,c()))switch(e){case 1:v.slice_del();break;case 2:v.slice_del(),v.ket=v.cursor,v.eq_s_b(1,"s")&&(v.bra=v.cursor,v.eq_s_b(3,"nis")&&v.slice_del());break;case 3:v.in_grouping_b(g,98,116)&&v.slice_del()}if(v.cursor=v.limit-s,v.ket=v.cursor,(e=v.find_among_b(f,4))&&(v.bra=v.cursor,c()))switch(e){case 1:v.slice_del();break;case 2:if(v.in_grouping_b(k,98,116)){var t=v.cursor-3;v.limit_backward<=t&&t<=v.limit&&(v.cursor=t,v.slice_del())}}if(v.cursor=v.limit-s,v.ket=v.cursor,(e=v.find_among_b(_,8))&&(v.bra=v.cursor,u()))switch(e){case 1:v.slice_del(),v.ket=v.cursor,v.eq_s_b(2,"ig")&&(v.bra=v.cursor,r=v.limit-v.cursor,v.eq_s_b(1,"e")||(v.cursor=v.limit-r,u()&&v.slice_del()));break;case 2:n=v.limit-v.cursor,v.eq_s_b(1,"e")||(v.cursor=v.limit-n,v.slice_del());break;case 3:if(v.slice_del(),v.ket=v.cursor,i=v.limit-v.cursor,!v.eq_s_b(2,"er")&&(v.cursor=v.limit-i,!v.eq_s_b(2,"en")))break;v.bra=v.cursor,c()&&v.slice_del();break;case 4:v.slice_del(),v.ket=v.cursor,e=v.find_among_b(b,2),e&&(v.bra=v.cursor,u()&&1==e&&v.slice_del())}}var d,l,m,h=[new r("",-1,6),new r("U",0,2),new r("Y",0,1),new r("ä",0,3),new r("ö",0,4),new r("ü",0,5)],w=[new r("e",-1,2),new r("em",-1,1),new r("en",-1,2),new r("ern",-1,1),new r("er",-1,1),new r("s",-1,3),new r("es",5,2)],f=[new r("en",-1,1),new r("er",-1,1),new r("st",-1,2),new r("est",2,1)],b=[new r("ig",-1,1),new r("lich",-1,1)],_=[new r("end",-1,1),new r("ig",-1,2),new r("ung",-1,1),new r("lich",-1,3),new r("isch",-1,2),new r("ik",-1,2),new r("heit",-1,3),new r("keit",-1,4)],p=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,8,0,32,8],g=[117,30,5],k=[117,30,4],v=new n;this.setCurrent=function(e){v.setCurrent(e)},this.getCurrent=function(){return v.getCurrent()},this.stem=function(){var e=v.cursor;return i(),v.cursor=e,t(),v.limit_backward=e,v.cursor=v.limit,a(),v.cursor=v.limit_backward,o(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}}(),e.Pipeline.registerFunction(e.de.stemmer,"stemmer-de"),e.de.stopWordFilter=e.generateStopWordFilter("aber alle allem allen aller alles als also am an ander andere anderem anderen anderer anderes anderm andern anderr anders auch auf aus bei bin bis bist da damit dann das dasselbe dazu daß dein deine deinem deinen deiner deines dem demselben den denn denselben der derer derselbe derselben des desselben dessen dich die dies diese dieselbe dieselben diesem diesen dieser dieses dir doch dort du durch ein eine einem einen einer eines einig einige einigem einigen einiger einiges einmal er es etwas euch euer eure eurem euren eurer eures für gegen gewesen hab habe haben hat hatte hatten hier hin hinter ich ihm ihn ihnen ihr ihre ihrem ihren ihrer ihres im in indem ins ist jede jedem jeden jeder jedes jene jenem jenen jener jenes jetzt kann kein keine keinem keinen keiner keines können könnte machen man manche manchem manchen mancher manches mein meine meinem meinen meiner meines mich mir mit muss musste nach nicht nichts noch nun nur ob oder ohne sehr sein seine seinem seinen seiner seines selbst sich sie sind so solche solchem solchen solcher solches soll sollte sondern sonst um und uns unse unsem unsen unser unses unter viel vom von vor war waren warst was weg weil weiter welche welchem welchen welcher welches wenn werde werden wie wieder will wir wird wirst wo wollen wollte während würde würden zu zum zur zwar zwischen über".split(" ")),e.Pipeline.registerFunction(e.de.stopWordFilter,"stopWordFilter-de")}}); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/min/lunr.du.min.js b/v4.0.1/assets/javascripts/lunr/min/lunr.du.min.js new file mode 100644 index 0000000000..49a0f3f0ac --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/min/lunr.du.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Dutch` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");console.warn('[Lunr Languages] Please use the "nl" instead of the "du". The "nl" code is the standard code for Dutch language, and "du" will be removed in the next major versions.'),e.du=function(){this.pipeline.reset(),this.pipeline.add(e.du.trimmer,e.du.stopWordFilter,e.du.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.du.stemmer))},e.du.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.du.trimmer=e.trimmerSupport.generateTrimmer(e.du.wordCharacters),e.Pipeline.registerFunction(e.du.trimmer,"trimmer-du"),e.du.stemmer=function(){var r=e.stemmerSupport.Among,i=e.stemmerSupport.SnowballProgram,n=new function(){function e(){for(var e,r,i,o=C.cursor;;){if(C.bra=C.cursor,e=C.find_among(b,11))switch(C.ket=C.cursor,e){case 1:C.slice_from("a");continue;case 2:C.slice_from("e");continue;case 3:C.slice_from("i");continue;case 4:C.slice_from("o");continue;case 5:C.slice_from("u");continue;case 6:if(C.cursor>=C.limit)break;C.cursor++;continue}break}for(C.cursor=o,C.bra=o,C.eq_s(1,"y")?(C.ket=C.cursor,C.slice_from("Y")):C.cursor=o;;)if(r=C.cursor,C.in_grouping(q,97,232)){if(i=C.cursor,C.bra=i,C.eq_s(1,"i"))C.ket=C.cursor,C.in_grouping(q,97,232)&&(C.slice_from("I"),C.cursor=r);else if(C.cursor=i,C.eq_s(1,"y"))C.ket=C.cursor,C.slice_from("Y"),C.cursor=r;else if(n(r))break}else if(n(r))break}function n(e){return C.cursor=e,e>=C.limit||(C.cursor++,!1)}function o(){_=C.limit,f=_,t()||(_=C.cursor,_<3&&(_=3),t()||(f=C.cursor))}function t(){for(;!C.in_grouping(q,97,232);){if(C.cursor>=C.limit)return!0;C.cursor++}for(;!C.out_grouping(q,97,232);){if(C.cursor>=C.limit)return!0;C.cursor++}return!1}function s(){for(var e;;)if(C.bra=C.cursor,e=C.find_among(p,3))switch(C.ket=C.cursor,e){case 1:C.slice_from("y");break;case 2:C.slice_from("i");break;case 3:if(C.cursor>=C.limit)return;C.cursor++}}function u(){return _<=C.cursor}function c(){return f<=C.cursor}function a(){var e=C.limit-C.cursor;C.find_among_b(g,3)&&(C.cursor=C.limit-e,C.ket=C.cursor,C.cursor>C.limit_backward&&(C.cursor--,C.bra=C.cursor,C.slice_del()))}function l(){var e;w=!1,C.ket=C.cursor,C.eq_s_b(1,"e")&&(C.bra=C.cursor,u()&&(e=C.limit-C.cursor,C.out_grouping_b(q,97,232)&&(C.cursor=C.limit-e,C.slice_del(),w=!0,a())))}function m(){var e;u()&&(e=C.limit-C.cursor,C.out_grouping_b(q,97,232)&&(C.cursor=C.limit-e,C.eq_s_b(3,"gem")||(C.cursor=C.limit-e,C.slice_del(),a())))}function d(){var e,r,i,n,o,t,s=C.limit-C.cursor;if(C.ket=C.cursor,e=C.find_among_b(h,5))switch(C.bra=C.cursor,e){case 1:u()&&C.slice_from("heid");break;case 2:m();break;case 3:u()&&C.out_grouping_b(z,97,232)&&C.slice_del()}if(C.cursor=C.limit-s,l(),C.cursor=C.limit-s,C.ket=C.cursor,C.eq_s_b(4,"heid")&&(C.bra=C.cursor,c()&&(r=C.limit-C.cursor,C.eq_s_b(1,"c")||(C.cursor=C.limit-r,C.slice_del(),C.ket=C.cursor,C.eq_s_b(2,"en")&&(C.bra=C.cursor,m())))),C.cursor=C.limit-s,C.ket=C.cursor,e=C.find_among_b(k,6))switch(C.bra=C.cursor,e){case 1:if(c()){if(C.slice_del(),i=C.limit-C.cursor,C.ket=C.cursor,C.eq_s_b(2,"ig")&&(C.bra=C.cursor,c()&&(n=C.limit-C.cursor,!C.eq_s_b(1,"e")))){C.cursor=C.limit-n,C.slice_del();break}C.cursor=C.limit-i,a()}break;case 2:c()&&(o=C.limit-C.cursor,C.eq_s_b(1,"e")||(C.cursor=C.limit-o,C.slice_del()));break;case 3:c()&&(C.slice_del(),l());break;case 4:c()&&C.slice_del();break;case 5:c()&&w&&C.slice_del()}C.cursor=C.limit-s,C.out_grouping_b(j,73,232)&&(t=C.limit-C.cursor,C.find_among_b(v,4)&&C.out_grouping_b(q,97,232)&&(C.cursor=C.limit-t,C.ket=C.cursor,C.cursor>C.limit_backward&&(C.cursor--,C.bra=C.cursor,C.slice_del())))}var f,_,w,b=[new r("",-1,6),new r("á",0,1),new r("ä",0,1),new r("é",0,2),new r("ë",0,2),new r("í",0,3),new r("ï",0,3),new r("ó",0,4),new r("ö",0,4),new r("ú",0,5),new r("ü",0,5)],p=[new r("",-1,3),new r("I",0,2),new r("Y",0,1)],g=[new r("dd",-1,-1),new r("kk",-1,-1),new r("tt",-1,-1)],h=[new r("ene",-1,2),new r("se",-1,3),new r("en",-1,2),new r("heden",2,1),new r("s",-1,3)],k=[new r("end",-1,1),new r("ig",-1,2),new r("ing",-1,1),new r("lijk",-1,3),new r("baar",-1,4),new r("bar",-1,5)],v=[new r("aa",-1,-1),new r("ee",-1,-1),new r("oo",-1,-1),new r("uu",-1,-1)],q=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,128],j=[1,0,0,17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,128],z=[17,67,16,1,0,0,0,0,0,0,0,0,0,0,0,0,128],C=new i;this.setCurrent=function(e){C.setCurrent(e)},this.getCurrent=function(){return C.getCurrent()},this.stem=function(){var r=C.cursor;return e(),C.cursor=r,o(),C.limit_backward=r,C.cursor=C.limit,d(),C.cursor=C.limit_backward,s(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return n.setCurrent(e),n.stem(),n.getCurrent()}):(n.setCurrent(e),n.stem(),n.getCurrent())}}(),e.Pipeline.registerFunction(e.du.stemmer,"stemmer-du"),e.du.stopWordFilter=e.generateStopWordFilter(" aan al alles als altijd andere ben bij daar dan dat de der deze die dit doch doen door dus een eens en er ge geen geweest haar had heb hebben heeft hem het hier hij hoe hun iemand iets ik in is ja je kan kon kunnen maar me meer men met mij mijn moet na naar niet niets nog nu of om omdat onder ons ook op over reeds te tegen toch toen tot u uit uw van veel voor want waren was wat werd wezen wie wil worden wordt zal ze zelf zich zij zijn zo zonder zou".split(" ")),e.Pipeline.registerFunction(e.du.stopWordFilter,"stopWordFilter-du")}}); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/min/lunr.es.min.js b/v4.0.1/assets/javascripts/lunr/min/lunr.es.min.js new file mode 100644 index 0000000000..2989d34265 --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/min/lunr.es.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Spanish` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,s){"function"==typeof define&&define.amd?define(s):"object"==typeof exports?module.exports=s():s()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.es=function(){this.pipeline.reset(),this.pipeline.add(e.es.trimmer,e.es.stopWordFilter,e.es.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.es.stemmer))},e.es.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.es.trimmer=e.trimmerSupport.generateTrimmer(e.es.wordCharacters),e.Pipeline.registerFunction(e.es.trimmer,"trimmer-es"),e.es.stemmer=function(){var s=e.stemmerSupport.Among,r=e.stemmerSupport.SnowballProgram,n=new function(){function e(){if(A.out_grouping(x,97,252)){for(;!A.in_grouping(x,97,252);){if(A.cursor>=A.limit)return!0;A.cursor++}return!1}return!0}function n(){if(A.in_grouping(x,97,252)){var s=A.cursor;if(e()){if(A.cursor=s,!A.in_grouping(x,97,252))return!0;for(;!A.out_grouping(x,97,252);){if(A.cursor>=A.limit)return!0;A.cursor++}}return!1}return!0}function i(){var s,r=A.cursor;if(n()){if(A.cursor=r,!A.out_grouping(x,97,252))return;if(s=A.cursor,e()){if(A.cursor=s,!A.in_grouping(x,97,252)||A.cursor>=A.limit)return;A.cursor++}}g=A.cursor}function a(){for(;!A.in_grouping(x,97,252);){if(A.cursor>=A.limit)return!1;A.cursor++}for(;!A.out_grouping(x,97,252);){if(A.cursor>=A.limit)return!1;A.cursor++}return!0}function t(){var e=A.cursor;g=A.limit,p=g,v=g,i(),A.cursor=e,a()&&(p=A.cursor,a()&&(v=A.cursor))}function o(){for(var e;;){if(A.bra=A.cursor,e=A.find_among(k,6))switch(A.ket=A.cursor,e){case 1:A.slice_from("a");continue;case 2:A.slice_from("e");continue;case 3:A.slice_from("i");continue;case 4:A.slice_from("o");continue;case 5:A.slice_from("u");continue;case 6:if(A.cursor>=A.limit)break;A.cursor++;continue}break}}function u(){return g<=A.cursor}function w(){return p<=A.cursor}function c(){return v<=A.cursor}function m(){var e;if(A.ket=A.cursor,A.find_among_b(y,13)&&(A.bra=A.cursor,(e=A.find_among_b(q,11))&&u()))switch(e){case 1:A.bra=A.cursor,A.slice_from("iendo");break;case 2:A.bra=A.cursor,A.slice_from("ando");break;case 3:A.bra=A.cursor,A.slice_from("ar");break;case 4:A.bra=A.cursor,A.slice_from("er");break;case 5:A.bra=A.cursor,A.slice_from("ir");break;case 6:A.slice_del();break;case 7:A.eq_s_b(1,"u")&&A.slice_del()}}function l(e,s){if(!c())return!0;A.slice_del(),A.ket=A.cursor;var r=A.find_among_b(e,s);return r&&(A.bra=A.cursor,1==r&&c()&&A.slice_del()),!1}function d(e){return!c()||(A.slice_del(),A.ket=A.cursor,A.eq_s_b(2,e)&&(A.bra=A.cursor,c()&&A.slice_del()),!1)}function b(){var e;if(A.ket=A.cursor,e=A.find_among_b(S,46)){switch(A.bra=A.cursor,e){case 1:if(!c())return!1;A.slice_del();break;case 2:if(d("ic"))return!1;break;case 3:if(!c())return!1;A.slice_from("log");break;case 4:if(!c())return!1;A.slice_from("u");break;case 5:if(!c())return!1;A.slice_from("ente");break;case 6:if(!w())return!1;A.slice_del(),A.ket=A.cursor,e=A.find_among_b(C,4),e&&(A.bra=A.cursor,c()&&(A.slice_del(),1==e&&(A.ket=A.cursor,A.eq_s_b(2,"at")&&(A.bra=A.cursor,c()&&A.slice_del()))));break;case 7:if(l(P,3))return!1;break;case 8:if(l(F,3))return!1;break;case 9:if(d("at"))return!1}return!0}return!1}function f(){var e,s;if(A.cursor>=g&&(s=A.limit_backward,A.limit_backward=g,A.ket=A.cursor,e=A.find_among_b(W,12),A.limit_backward=s,e)){if(A.bra=A.cursor,1==e){if(!A.eq_s_b(1,"u"))return!1;A.slice_del()}return!0}return!1}function _(){var e,s,r,n;if(A.cursor>=g&&(s=A.limit_backward,A.limit_backward=g,A.ket=A.cursor,e=A.find_among_b(L,96),A.limit_backward=s,e))switch(A.bra=A.cursor,e){case 1:r=A.limit-A.cursor,A.eq_s_b(1,"u")?(n=A.limit-A.cursor,A.eq_s_b(1,"g")?A.cursor=A.limit-n:A.cursor=A.limit-r):A.cursor=A.limit-r,A.bra=A.cursor;case 2:A.slice_del()}}function h(){var e,s;if(A.ket=A.cursor,e=A.find_among_b(z,8))switch(A.bra=A.cursor,e){case 1:u()&&A.slice_del();break;case 2:u()&&(A.slice_del(),A.ket=A.cursor,A.eq_s_b(1,"u")&&(A.bra=A.cursor,s=A.limit-A.cursor,A.eq_s_b(1,"g")&&(A.cursor=A.limit-s,u()&&A.slice_del())))}}var v,p,g,k=[new s("",-1,6),new s("á",0,1),new s("é",0,2),new s("í",0,3),new s("ó",0,4),new s("ú",0,5)],y=[new s("la",-1,-1),new s("sela",0,-1),new s("le",-1,-1),new s("me",-1,-1),new s("se",-1,-1),new s("lo",-1,-1),new s("selo",5,-1),new s("las",-1,-1),new s("selas",7,-1),new s("les",-1,-1),new s("los",-1,-1),new s("selos",10,-1),new s("nos",-1,-1)],q=[new s("ando",-1,6),new s("iendo",-1,6),new s("yendo",-1,7),new s("ándo",-1,2),new s("iéndo",-1,1),new s("ar",-1,6),new s("er",-1,6),new s("ir",-1,6),new s("ár",-1,3),new s("ér",-1,4),new s("ír",-1,5)],C=[new s("ic",-1,-1),new s("ad",-1,-1),new s("os",-1,-1),new s("iv",-1,1)],P=[new s("able",-1,1),new s("ible",-1,1),new s("ante",-1,1)],F=[new s("ic",-1,1),new s("abil",-1,1),new s("iv",-1,1)],S=[new s("ica",-1,1),new s("ancia",-1,2),new s("encia",-1,5),new s("adora",-1,2),new s("osa",-1,1),new s("ista",-1,1),new s("iva",-1,9),new s("anza",-1,1),new s("logía",-1,3),new s("idad",-1,8),new s("able",-1,1),new s("ible",-1,1),new s("ante",-1,2),new s("mente",-1,7),new s("amente",13,6),new s("ación",-1,2),new s("ución",-1,4),new s("ico",-1,1),new s("ismo",-1,1),new s("oso",-1,1),new s("amiento",-1,1),new s("imiento",-1,1),new s("ivo",-1,9),new s("ador",-1,2),new s("icas",-1,1),new s("ancias",-1,2),new s("encias",-1,5),new s("adoras",-1,2),new s("osas",-1,1),new s("istas",-1,1),new s("ivas",-1,9),new s("anzas",-1,1),new s("logías",-1,3),new s("idades",-1,8),new s("ables",-1,1),new s("ibles",-1,1),new s("aciones",-1,2),new s("uciones",-1,4),new s("adores",-1,2),new s("antes",-1,2),new s("icos",-1,1),new s("ismos",-1,1),new s("osos",-1,1),new s("amientos",-1,1),new s("imientos",-1,1),new s("ivos",-1,9)],W=[new s("ya",-1,1),new s("ye",-1,1),new s("yan",-1,1),new s("yen",-1,1),new s("yeron",-1,1),new s("yendo",-1,1),new s("yo",-1,1),new s("yas",-1,1),new s("yes",-1,1),new s("yais",-1,1),new s("yamos",-1,1),new s("yó",-1,1)],L=[new s("aba",-1,2),new s("ada",-1,2),new s("ida",-1,2),new s("ara",-1,2),new s("iera",-1,2),new s("ía",-1,2),new s("aría",5,2),new s("ería",5,2),new s("iría",5,2),new s("ad",-1,2),new s("ed",-1,2),new s("id",-1,2),new s("ase",-1,2),new s("iese",-1,2),new s("aste",-1,2),new s("iste",-1,2),new s("an",-1,2),new s("aban",16,2),new s("aran",16,2),new s("ieran",16,2),new s("ían",16,2),new s("arían",20,2),new s("erían",20,2),new s("irían",20,2),new s("en",-1,1),new s("asen",24,2),new s("iesen",24,2),new s("aron",-1,2),new s("ieron",-1,2),new s("arán",-1,2),new s("erán",-1,2),new s("irán",-1,2),new s("ado",-1,2),new s("ido",-1,2),new s("ando",-1,2),new s("iendo",-1,2),new s("ar",-1,2),new s("er",-1,2),new s("ir",-1,2),new s("as",-1,2),new s("abas",39,2),new s("adas",39,2),new s("idas",39,2),new s("aras",39,2),new s("ieras",39,2),new s("ías",39,2),new s("arías",45,2),new s("erías",45,2),new s("irías",45,2),new s("es",-1,1),new s("ases",49,2),new s("ieses",49,2),new s("abais",-1,2),new s("arais",-1,2),new s("ierais",-1,2),new s("íais",-1,2),new s("aríais",55,2),new s("eríais",55,2),new s("iríais",55,2),new s("aseis",-1,2),new s("ieseis",-1,2),new s("asteis",-1,2),new s("isteis",-1,2),new s("áis",-1,2),new s("éis",-1,1),new s("aréis",64,2),new s("eréis",64,2),new s("iréis",64,2),new s("ados",-1,2),new s("idos",-1,2),new s("amos",-1,2),new s("ábamos",70,2),new s("áramos",70,2),new s("iéramos",70,2),new s("íamos",70,2),new s("aríamos",74,2),new s("eríamos",74,2),new s("iríamos",74,2),new s("emos",-1,1),new s("aremos",78,2),new s("eremos",78,2),new s("iremos",78,2),new s("ásemos",78,2),new s("iésemos",78,2),new s("imos",-1,2),new s("arás",-1,2),new s("erás",-1,2),new s("irás",-1,2),new s("ís",-1,2),new s("ará",-1,2),new s("erá",-1,2),new s("irá",-1,2),new s("aré",-1,2),new s("eré",-1,2),new s("iré",-1,2),new s("ió",-1,2)],z=[new s("a",-1,1),new s("e",-1,2),new s("o",-1,1),new s("os",-1,1),new s("á",-1,1),new s("é",-1,2),new s("í",-1,1),new s("ó",-1,1)],x=[17,65,16,0,0,0,0,0,0,0,0,0,0,0,0,0,1,17,4,10],A=new r;this.setCurrent=function(e){A.setCurrent(e)},this.getCurrent=function(){return A.getCurrent()},this.stem=function(){var e=A.cursor;return t(),A.limit_backward=e,A.cursor=A.limit,m(),A.cursor=A.limit,b()||(A.cursor=A.limit,f()||(A.cursor=A.limit,_())),A.cursor=A.limit,h(),A.cursor=A.limit_backward,o(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return n.setCurrent(e),n.stem(),n.getCurrent()}):(n.setCurrent(e),n.stem(),n.getCurrent())}}(),e.Pipeline.registerFunction(e.es.stemmer,"stemmer-es"),e.es.stopWordFilter=e.generateStopWordFilter("a al algo algunas algunos ante antes como con contra cual cuando de del desde donde durante e el ella ellas ellos en entre era erais eran eras eres es esa esas ese eso esos esta estaba estabais estaban estabas estad estada estadas estado estados estamos estando estar estaremos estará estarán estarás estaré estaréis estaría estaríais estaríamos estarían estarías estas este estemos esto estos estoy estuve estuviera estuvierais estuvieran estuvieras estuvieron estuviese estuvieseis estuviesen estuvieses estuvimos estuviste estuvisteis estuviéramos estuviésemos estuvo está estábamos estáis están estás esté estéis estén estés fue fuera fuerais fueran fueras fueron fuese fueseis fuesen fueses fui fuimos fuiste fuisteis fuéramos fuésemos ha habida habidas habido habidos habiendo habremos habrá habrán habrás habré habréis habría habríais habríamos habrían habrías habéis había habíais habíamos habían habías han has hasta hay haya hayamos hayan hayas hayáis he hemos hube hubiera hubierais hubieran hubieras hubieron hubiese hubieseis hubiesen hubieses hubimos hubiste hubisteis hubiéramos hubiésemos hubo la las le les lo los me mi mis mucho muchos muy más mí mía mías mío míos nada ni no nos nosotras nosotros nuestra nuestras nuestro nuestros o os otra otras otro otros para pero poco por porque que quien quienes qué se sea seamos sean seas seremos será serán serás seré seréis sería seríais seríamos serían serías seáis sido siendo sin sobre sois somos son soy su sus suya suyas suyo suyos sí también tanto te tendremos tendrá tendrán tendrás tendré tendréis tendría tendríais tendríamos tendrían tendrías tened tenemos tenga tengamos tengan tengas tengo tengáis tenida tenidas tenido tenidos teniendo tenéis tenía teníais teníamos tenían tenías ti tiene tienen tienes todo todos tu tus tuve tuviera tuvierais tuvieran tuvieras tuvieron tuviese tuvieseis tuviesen tuvieses tuvimos tuviste tuvisteis tuviéramos tuviésemos tuvo tuya tuyas tuyo tuyos tú un una uno unos vosotras vosotros vuestra vuestras vuestro vuestros y ya yo él éramos".split(" ")),e.Pipeline.registerFunction(e.es.stopWordFilter,"stopWordFilter-es")}}); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/min/lunr.fi.min.js b/v4.0.1/assets/javascripts/lunr/min/lunr.fi.min.js new file mode 100644 index 0000000000..29f5dfcea8 --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/min/lunr.fi.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Finnish` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(i,e){"function"==typeof define&&define.amd?define(e):"object"==typeof exports?module.exports=e():e()(i.lunr)}(this,function(){return function(i){if(void 0===i)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===i.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");i.fi=function(){this.pipeline.reset(),this.pipeline.add(i.fi.trimmer,i.fi.stopWordFilter,i.fi.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(i.fi.stemmer))},i.fi.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",i.fi.trimmer=i.trimmerSupport.generateTrimmer(i.fi.wordCharacters),i.Pipeline.registerFunction(i.fi.trimmer,"trimmer-fi"),i.fi.stemmer=function(){var e=i.stemmerSupport.Among,r=i.stemmerSupport.SnowballProgram,n=new function(){function i(){f=A.limit,d=f,n()||(f=A.cursor,n()||(d=A.cursor))}function n(){for(var i;;){if(i=A.cursor,A.in_grouping(W,97,246))break;if(A.cursor=i,i>=A.limit)return!0;A.cursor++}for(A.cursor=i;!A.out_grouping(W,97,246);){if(A.cursor>=A.limit)return!0;A.cursor++}return!1}function t(){return d<=A.cursor}function s(){var i,e;if(A.cursor>=f)if(e=A.limit_backward,A.limit_backward=f,A.ket=A.cursor,i=A.find_among_b(h,10)){switch(A.bra=A.cursor,A.limit_backward=e,i){case 1:if(!A.in_grouping_b(x,97,246))return;break;case 2:if(!t())return}A.slice_del()}else A.limit_backward=e}function o(){var i,e,r;if(A.cursor>=f)if(e=A.limit_backward,A.limit_backward=f,A.ket=A.cursor,i=A.find_among_b(v,9))switch(A.bra=A.cursor,A.limit_backward=e,i){case 1:r=A.limit-A.cursor,A.eq_s_b(1,"k")||(A.cursor=A.limit-r,A.slice_del());break;case 2:A.slice_del(),A.ket=A.cursor,A.eq_s_b(3,"kse")&&(A.bra=A.cursor,A.slice_from("ksi"));break;case 3:A.slice_del();break;case 4:A.find_among_b(p,6)&&A.slice_del();break;case 5:A.find_among_b(g,6)&&A.slice_del();break;case 6:A.find_among_b(j,2)&&A.slice_del()}else A.limit_backward=e}function l(){return A.find_among_b(q,7)}function a(){return A.eq_s_b(1,"i")&&A.in_grouping_b(L,97,246)}function u(){var i,e,r;if(A.cursor>=f)if(e=A.limit_backward,A.limit_backward=f,A.ket=A.cursor,i=A.find_among_b(C,30)){switch(A.bra=A.cursor,A.limit_backward=e,i){case 1:if(!A.eq_s_b(1,"a"))return;break;case 2:case 9:if(!A.eq_s_b(1,"e"))return;break;case 3:if(!A.eq_s_b(1,"i"))return;break;case 4:if(!A.eq_s_b(1,"o"))return;break;case 5:if(!A.eq_s_b(1,"ä"))return;break;case 6:if(!A.eq_s_b(1,"ö"))return;break;case 7:if(r=A.limit-A.cursor,!l()&&(A.cursor=A.limit-r,!A.eq_s_b(2,"ie"))){A.cursor=A.limit-r;break}if(A.cursor=A.limit-r,A.cursor<=A.limit_backward){A.cursor=A.limit-r;break}A.cursor--,A.bra=A.cursor;break;case 8:if(!A.in_grouping_b(W,97,246)||!A.out_grouping_b(W,97,246))return}A.slice_del(),k=!0}else A.limit_backward=e}function c(){var i,e,r;if(A.cursor>=d)if(e=A.limit_backward,A.limit_backward=d,A.ket=A.cursor,i=A.find_among_b(P,14)){if(A.bra=A.cursor,A.limit_backward=e,1==i){if(r=A.limit-A.cursor,A.eq_s_b(2,"po"))return;A.cursor=A.limit-r}A.slice_del()}else A.limit_backward=e}function m(){var i;A.cursor>=f&&(i=A.limit_backward,A.limit_backward=f,A.ket=A.cursor,A.find_among_b(F,2)?(A.bra=A.cursor,A.limit_backward=i,A.slice_del()):A.limit_backward=i)}function w(){var i,e,r,n,t,s;if(A.cursor>=f){if(e=A.limit_backward,A.limit_backward=f,A.ket=A.cursor,A.eq_s_b(1,"t")&&(A.bra=A.cursor,r=A.limit-A.cursor,A.in_grouping_b(W,97,246)&&(A.cursor=A.limit-r,A.slice_del(),A.limit_backward=e,n=A.limit-A.cursor,A.cursor>=d&&(A.cursor=d,t=A.limit_backward,A.limit_backward=A.cursor,A.cursor=A.limit-n,A.ket=A.cursor,i=A.find_among_b(S,2))))){if(A.bra=A.cursor,A.limit_backward=t,1==i){if(s=A.limit-A.cursor,A.eq_s_b(2,"po"))return;A.cursor=A.limit-s}return void A.slice_del()}A.limit_backward=e}}function _(){var i,e,r,n;if(A.cursor>=f){for(i=A.limit_backward,A.limit_backward=f,e=A.limit-A.cursor,l()&&(A.cursor=A.limit-e,A.ket=A.cursor,A.cursor>A.limit_backward&&(A.cursor--,A.bra=A.cursor,A.slice_del())),A.cursor=A.limit-e,A.ket=A.cursor,A.in_grouping_b(y,97,228)&&(A.bra=A.cursor,A.out_grouping_b(W,97,246)&&A.slice_del()),A.cursor=A.limit-e,A.ket=A.cursor,A.eq_s_b(1,"j")&&(A.bra=A.cursor,r=A.limit-A.cursor,A.eq_s_b(1,"o")?A.slice_del():(A.cursor=A.limit-r,A.eq_s_b(1,"u")&&A.slice_del())),A.cursor=A.limit-e,A.ket=A.cursor,A.eq_s_b(1,"o")&&(A.bra=A.cursor,A.eq_s_b(1,"j")&&A.slice_del()),A.cursor=A.limit-e,A.limit_backward=i;;){if(n=A.limit-A.cursor,A.out_grouping_b(W,97,246)){A.cursor=A.limit-n;break}if(A.cursor=A.limit-n,A.cursor<=A.limit_backward)return;A.cursor--}A.ket=A.cursor,A.cursor>A.limit_backward&&(A.cursor--,A.bra=A.cursor,b=A.slice_to(),A.eq_v_b(b)&&A.slice_del())}}var k,b,d,f,h=[new e("pa",-1,1),new e("sti",-1,2),new e("kaan",-1,1),new e("han",-1,1),new e("kin",-1,1),new e("hän",-1,1),new e("kään",-1,1),new e("ko",-1,1),new e("pä",-1,1),new e("kö",-1,1)],p=[new e("lla",-1,-1),new e("na",-1,-1),new e("ssa",-1,-1),new e("ta",-1,-1),new e("lta",3,-1),new e("sta",3,-1)],g=[new e("llä",-1,-1),new e("nä",-1,-1),new e("ssä",-1,-1),new e("tä",-1,-1),new e("ltä",3,-1),new e("stä",3,-1)],j=[new e("lle",-1,-1),new e("ine",-1,-1)],v=[new e("nsa",-1,3),new e("mme",-1,3),new e("nne",-1,3),new e("ni",-1,2),new e("si",-1,1),new e("an",-1,4),new e("en",-1,6),new e("än",-1,5),new e("nsä",-1,3)],q=[new e("aa",-1,-1),new e("ee",-1,-1),new e("ii",-1,-1),new e("oo",-1,-1),new e("uu",-1,-1),new e("ää",-1,-1),new e("öö",-1,-1)],C=[new e("a",-1,8),new e("lla",0,-1),new e("na",0,-1),new e("ssa",0,-1),new e("ta",0,-1),new e("lta",4,-1),new e("sta",4,-1),new e("tta",4,9),new e("lle",-1,-1),new e("ine",-1,-1),new e("ksi",-1,-1),new e("n",-1,7),new e("han",11,1),new e("den",11,-1,a),new e("seen",11,-1,l),new e("hen",11,2),new e("tten",11,-1,a),new e("hin",11,3),new e("siin",11,-1,a),new e("hon",11,4),new e("hän",11,5),new e("hön",11,6),new e("ä",-1,8),new e("llä",22,-1),new e("nä",22,-1),new e("ssä",22,-1),new e("tä",22,-1),new e("ltä",26,-1),new e("stä",26,-1),new e("ttä",26,9)],P=[new e("eja",-1,-1),new e("mma",-1,1),new e("imma",1,-1),new e("mpa",-1,1),new e("impa",3,-1),new e("mmi",-1,1),new e("immi",5,-1),new e("mpi",-1,1),new e("impi",7,-1),new e("ejä",-1,-1),new e("mmä",-1,1),new e("immä",10,-1),new e("mpä",-1,1),new e("impä",12,-1)],F=[new e("i",-1,-1),new e("j",-1,-1)],S=[new e("mma",-1,1),new e("imma",0,-1)],y=[17,1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,8],W=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,8,0,32],L=[17,65,16,0,0,0,0,0,0,0,0,0,0,0,0,0,8,0,32],x=[17,97,24,1,0,0,0,0,0,0,0,0,0,0,0,0,8,0,32],A=new r;this.setCurrent=function(i){A.setCurrent(i)},this.getCurrent=function(){return A.getCurrent()},this.stem=function(){var e=A.cursor;return i(),k=!1,A.limit_backward=e,A.cursor=A.limit,s(),A.cursor=A.limit,o(),A.cursor=A.limit,u(),A.cursor=A.limit,c(),A.cursor=A.limit,k?(m(),A.cursor=A.limit):(A.cursor=A.limit,w(),A.cursor=A.limit),_(),!0}};return function(i){return"function"==typeof i.update?i.update(function(i){return n.setCurrent(i),n.stem(),n.getCurrent()}):(n.setCurrent(i),n.stem(),n.getCurrent())}}(),i.Pipeline.registerFunction(i.fi.stemmer,"stemmer-fi"),i.fi.stopWordFilter=i.generateStopWordFilter("ei eivät emme en et ette että he heidän heidät heihin heille heillä heiltä heissä heistä heitä hän häneen hänelle hänellä häneltä hänen hänessä hänestä hänet häntä itse ja johon joiden joihin joiksi joilla joille joilta joina joissa joista joita joka joksi jolla jolle jolta jona jonka jos jossa josta jota jotka kanssa keiden keihin keiksi keille keillä keiltä keinä keissä keistä keitä keneen keneksi kenelle kenellä keneltä kenen kenenä kenessä kenestä kenet ketkä ketkä ketä koska kuin kuka kun me meidän meidät meihin meille meillä meiltä meissä meistä meitä mihin miksi mikä mille millä miltä minkä minkä minua minulla minulle minulta minun minussa minusta minut minuun minä minä missä mistä mitkä mitä mukaan mutta ne niiden niihin niiksi niille niillä niiltä niin niin niinä niissä niistä niitä noiden noihin noiksi noilla noille noilta noin noina noissa noista noita nuo nyt näiden näihin näiksi näille näillä näiltä näinä näissä näistä näitä nämä ole olemme olen olet olette oli olimme olin olisi olisimme olisin olisit olisitte olisivat olit olitte olivat olla olleet ollut on ovat poikki se sekä sen siihen siinä siitä siksi sille sillä sillä siltä sinua sinulla sinulle sinulta sinun sinussa sinusta sinut sinuun sinä sinä sitä tai te teidän teidät teihin teille teillä teiltä teissä teistä teitä tuo tuohon tuoksi tuolla tuolle tuolta tuon tuona tuossa tuosta tuota tähän täksi tälle tällä tältä tämä tämän tänä tässä tästä tätä vaan vai vaikka yli".split(" ")),i.Pipeline.registerFunction(i.fi.stopWordFilter,"stopWordFilter-fi")}}); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/min/lunr.fr.min.js b/v4.0.1/assets/javascripts/lunr/min/lunr.fr.min.js new file mode 100644 index 0000000000..68cd0094ae --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/min/lunr.fr.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `French` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.fr=function(){this.pipeline.reset(),this.pipeline.add(e.fr.trimmer,e.fr.stopWordFilter,e.fr.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.fr.stemmer))},e.fr.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.fr.trimmer=e.trimmerSupport.generateTrimmer(e.fr.wordCharacters),e.Pipeline.registerFunction(e.fr.trimmer,"trimmer-fr"),e.fr.stemmer=function(){var r=e.stemmerSupport.Among,s=e.stemmerSupport.SnowballProgram,i=new function(){function e(e,r,s){return!(!W.eq_s(1,e)||(W.ket=W.cursor,!W.in_grouping(F,97,251)))&&(W.slice_from(r),W.cursor=s,!0)}function i(e,r,s){return!!W.eq_s(1,e)&&(W.ket=W.cursor,W.slice_from(r),W.cursor=s,!0)}function n(){for(var r,s;;){if(r=W.cursor,W.in_grouping(F,97,251)){if(W.bra=W.cursor,s=W.cursor,e("u","U",r))continue;if(W.cursor=s,e("i","I",r))continue;if(W.cursor=s,i("y","Y",r))continue}if(W.cursor=r,W.bra=r,!e("y","Y",r)){if(W.cursor=r,W.eq_s(1,"q")&&(W.bra=W.cursor,i("u","U",r)))continue;if(W.cursor=r,r>=W.limit)return;W.cursor++}}}function t(){for(;!W.in_grouping(F,97,251);){if(W.cursor>=W.limit)return!0;W.cursor++}for(;!W.out_grouping(F,97,251);){if(W.cursor>=W.limit)return!0;W.cursor++}return!1}function u(){var e=W.cursor;if(q=W.limit,g=q,p=q,W.in_grouping(F,97,251)&&W.in_grouping(F,97,251)&&W.cursor=W.limit){W.cursor=q;break}W.cursor++}while(!W.in_grouping(F,97,251))}q=W.cursor,W.cursor=e,t()||(g=W.cursor,t()||(p=W.cursor))}function o(){for(var e,r;;){if(r=W.cursor,W.bra=r,!(e=W.find_among(h,4)))break;switch(W.ket=W.cursor,e){case 1:W.slice_from("i");break;case 2:W.slice_from("u");break;case 3:W.slice_from("y");break;case 4:if(W.cursor>=W.limit)return;W.cursor++}}}function c(){return q<=W.cursor}function a(){return g<=W.cursor}function l(){return p<=W.cursor}function w(){var e,r;if(W.ket=W.cursor,e=W.find_among_b(C,43)){switch(W.bra=W.cursor,e){case 1:if(!l())return!1;W.slice_del();break;case 2:if(!l())return!1;W.slice_del(),W.ket=W.cursor,W.eq_s_b(2,"ic")&&(W.bra=W.cursor,l()?W.slice_del():W.slice_from("iqU"));break;case 3:if(!l())return!1;W.slice_from("log");break;case 4:if(!l())return!1;W.slice_from("u");break;case 5:if(!l())return!1;W.slice_from("ent");break;case 6:if(!c())return!1;if(W.slice_del(),W.ket=W.cursor,e=W.find_among_b(z,6))switch(W.bra=W.cursor,e){case 1:l()&&(W.slice_del(),W.ket=W.cursor,W.eq_s_b(2,"at")&&(W.bra=W.cursor,l()&&W.slice_del()));break;case 2:l()?W.slice_del():a()&&W.slice_from("eux");break;case 3:l()&&W.slice_del();break;case 4:c()&&W.slice_from("i")}break;case 7:if(!l())return!1;if(W.slice_del(),W.ket=W.cursor,e=W.find_among_b(y,3))switch(W.bra=W.cursor,e){case 1:l()?W.slice_del():W.slice_from("abl");break;case 2:l()?W.slice_del():W.slice_from("iqU");break;case 3:l()&&W.slice_del()}break;case 8:if(!l())return!1;if(W.slice_del(),W.ket=W.cursor,W.eq_s_b(2,"at")&&(W.bra=W.cursor,l()&&(W.slice_del(),W.ket=W.cursor,W.eq_s_b(2,"ic")))){W.bra=W.cursor,l()?W.slice_del():W.slice_from("iqU");break}break;case 9:W.slice_from("eau");break;case 10:if(!a())return!1;W.slice_from("al");break;case 11:if(l())W.slice_del();else{if(!a())return!1;W.slice_from("eux")}break;case 12:if(!a()||!W.out_grouping_b(F,97,251))return!1;W.slice_del();break;case 13:return c()&&W.slice_from("ant"),!1;case 14:return c()&&W.slice_from("ent"),!1;case 15:return r=W.limit-W.cursor,W.in_grouping_b(F,97,251)&&c()&&(W.cursor=W.limit-r,W.slice_del()),!1}return!0}return!1}function f(){var e,r;if(W.cursor=q){if(s=W.limit_backward,W.limit_backward=q,W.ket=W.cursor,e=W.find_among_b(P,7))switch(W.bra=W.cursor,e){case 1:if(l()){if(i=W.limit-W.cursor,!W.eq_s_b(1,"s")&&(W.cursor=W.limit-i,!W.eq_s_b(1,"t")))break;W.slice_del()}break;case 2:W.slice_from("i");break;case 3:W.slice_del();break;case 4:W.eq_s_b(2,"gu")&&W.slice_del()}W.limit_backward=s}}function b(){var e=W.limit-W.cursor;W.find_among_b(U,5)&&(W.cursor=W.limit-e,W.ket=W.cursor,W.cursor>W.limit_backward&&(W.cursor--,W.bra=W.cursor,W.slice_del()))}function d(){for(var e,r=1;W.out_grouping_b(F,97,251);)r--;if(r<=0){if(W.ket=W.cursor,e=W.limit-W.cursor,!W.eq_s_b(1,"é")&&(W.cursor=W.limit-e,!W.eq_s_b(1,"è")))return;W.bra=W.cursor,W.slice_from("e")}}function k(){if(!w()&&(W.cursor=W.limit,!f()&&(W.cursor=W.limit,!m())))return W.cursor=W.limit,void _();W.cursor=W.limit,W.ket=W.cursor,W.eq_s_b(1,"Y")?(W.bra=W.cursor,W.slice_from("i")):(W.cursor=W.limit,W.eq_s_b(1,"ç")&&(W.bra=W.cursor,W.slice_from("c")))}var p,g,q,v=[new r("col",-1,-1),new r("par",-1,-1),new r("tap",-1,-1)],h=[new r("",-1,4),new r("I",0,1),new r("U",0,2),new r("Y",0,3)],z=[new r("iqU",-1,3),new r("abl",-1,3),new r("Ièr",-1,4),new r("ièr",-1,4),new r("eus",-1,2),new r("iv",-1,1)],y=[new r("ic",-1,2),new r("abil",-1,1),new r("iv",-1,3)],C=[new r("iqUe",-1,1),new r("atrice",-1,2),new r("ance",-1,1),new r("ence",-1,5),new r("logie",-1,3),new r("able",-1,1),new r("isme",-1,1),new r("euse",-1,11),new r("iste",-1,1),new r("ive",-1,8),new r("if",-1,8),new r("usion",-1,4),new r("ation",-1,2),new r("ution",-1,4),new r("ateur",-1,2),new r("iqUes",-1,1),new r("atrices",-1,2),new r("ances",-1,1),new r("ences",-1,5),new r("logies",-1,3),new r("ables",-1,1),new r("ismes",-1,1),new r("euses",-1,11),new r("istes",-1,1),new r("ives",-1,8),new r("ifs",-1,8),new r("usions",-1,4),new r("ations",-1,2),new r("utions",-1,4),new r("ateurs",-1,2),new r("ments",-1,15),new r("ements",30,6),new r("issements",31,12),new r("ités",-1,7),new r("ment",-1,15),new r("ement",34,6),new r("issement",35,12),new r("amment",34,13),new r("emment",34,14),new r("aux",-1,10),new r("eaux",39,9),new r("eux",-1,1),new r("ité",-1,7)],x=[new r("ira",-1,1),new r("ie",-1,1),new r("isse",-1,1),new r("issante",-1,1),new r("i",-1,1),new r("irai",4,1),new r("ir",-1,1),new r("iras",-1,1),new r("ies",-1,1),new r("îmes",-1,1),new r("isses",-1,1),new r("issantes",-1,1),new r("îtes",-1,1),new r("is",-1,1),new r("irais",13,1),new r("issais",13,1),new r("irions",-1,1),new r("issions",-1,1),new r("irons",-1,1),new r("issons",-1,1),new r("issants",-1,1),new r("it",-1,1),new r("irait",21,1),new r("issait",21,1),new r("issant",-1,1),new r("iraIent",-1,1),new r("issaIent",-1,1),new r("irent",-1,1),new r("issent",-1,1),new r("iront",-1,1),new r("ît",-1,1),new r("iriez",-1,1),new r("issiez",-1,1),new r("irez",-1,1),new r("issez",-1,1)],I=[new r("a",-1,3),new r("era",0,2),new r("asse",-1,3),new r("ante",-1,3),new r("ée",-1,2),new r("ai",-1,3),new r("erai",5,2),new r("er",-1,2),new r("as",-1,3),new r("eras",8,2),new r("âmes",-1,3),new r("asses",-1,3),new r("antes",-1,3),new r("âtes",-1,3),new r("ées",-1,2),new r("ais",-1,3),new r("erais",15,2),new r("ions",-1,1),new r("erions",17,2),new r("assions",17,3),new r("erons",-1,2),new r("ants",-1,3),new r("és",-1,2),new r("ait",-1,3),new r("erait",23,2),new r("ant",-1,3),new r("aIent",-1,3),new r("eraIent",26,2),new r("èrent",-1,2),new r("assent",-1,3),new r("eront",-1,2),new r("ât",-1,3),new r("ez",-1,2),new r("iez",32,2),new r("eriez",33,2),new r("assiez",33,3),new r("erez",32,2),new r("é",-1,2)],P=[new r("e",-1,3),new r("Ière",0,2),new r("ière",0,2),new r("ion",-1,1),new r("Ier",-1,2),new r("ier",-1,2),new r("ë",-1,4)],U=[new r("ell",-1,-1),new r("eill",-1,-1),new r("enn",-1,-1),new r("onn",-1,-1),new r("ett",-1,-1)],F=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,128,130,103,8,5],S=[1,65,20,0,0,0,0,0,0,0,0,0,0,0,0,0,128],W=new s;this.setCurrent=function(e){W.setCurrent(e)},this.getCurrent=function(){return W.getCurrent()},this.stem=function(){var e=W.cursor;return n(),W.cursor=e,u(),W.limit_backward=e,W.cursor=W.limit,k(),W.cursor=W.limit,b(),W.cursor=W.limit,d(),W.cursor=W.limit_backward,o(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}}(),e.Pipeline.registerFunction(e.fr.stemmer,"stemmer-fr"),e.fr.stopWordFilter=e.generateStopWordFilter("ai aie aient aies ait as au aura aurai auraient aurais aurait auras aurez auriez aurions aurons auront aux avaient avais avait avec avez aviez avions avons ayant ayez ayons c ce ceci celà ces cet cette d dans de des du elle en es est et eu eue eues eurent eus eusse eussent eusses eussiez eussions eut eux eûmes eût eûtes furent fus fusse fussent fusses fussiez fussions fut fûmes fût fûtes ici il ils j je l la le les leur leurs lui m ma mais me mes moi mon même n ne nos notre nous on ont ou par pas pour qu que quel quelle quelles quels qui s sa sans se sera serai seraient serais serait seras serez seriez serions serons seront ses soi soient sois soit sommes son sont soyez soyons suis sur t ta te tes toi ton tu un une vos votre vous y à étaient étais était étant étiez étions été étée étées étés êtes".split(" ")),e.Pipeline.registerFunction(e.fr.stopWordFilter,"stopWordFilter-fr")}}); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/min/lunr.hu.min.js b/v4.0.1/assets/javascripts/lunr/min/lunr.hu.min.js new file mode 100644 index 0000000000..ed9d909f73 --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/min/lunr.hu.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Hungarian` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,n){"function"==typeof define&&define.amd?define(n):"object"==typeof exports?module.exports=n():n()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.hu=function(){this.pipeline.reset(),this.pipeline.add(e.hu.trimmer,e.hu.stopWordFilter,e.hu.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.hu.stemmer))},e.hu.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.hu.trimmer=e.trimmerSupport.generateTrimmer(e.hu.wordCharacters),e.Pipeline.registerFunction(e.hu.trimmer,"trimmer-hu"),e.hu.stemmer=function(){var n=e.stemmerSupport.Among,r=e.stemmerSupport.SnowballProgram,i=new function(){function e(){var e,n=L.cursor;if(d=L.limit,L.in_grouping(W,97,252))for(;;){if(e=L.cursor,L.out_grouping(W,97,252))return L.cursor=e,L.find_among(g,8)||(L.cursor=e,e=L.limit)return void(d=e);L.cursor++}if(L.cursor=n,L.out_grouping(W,97,252)){for(;!L.in_grouping(W,97,252);){if(L.cursor>=L.limit)return;L.cursor++}d=L.cursor}}function i(){return d<=L.cursor}function a(){var e;if(L.ket=L.cursor,(e=L.find_among_b(h,2))&&(L.bra=L.cursor,i()))switch(e){case 1:L.slice_from("a");break;case 2:L.slice_from("e")}}function t(){var e=L.limit-L.cursor;return!!L.find_among_b(p,23)&&(L.cursor=L.limit-e,!0)}function s(){if(L.cursor>L.limit_backward){L.cursor--,L.ket=L.cursor;var e=L.cursor-1;L.limit_backward<=e&&e<=L.limit&&(L.cursor=e,L.bra=e,L.slice_del())}}function c(){var e;if(L.ket=L.cursor,(e=L.find_among_b(_,2))&&(L.bra=L.cursor,i())){if((1==e||2==e)&&!t())return;L.slice_del(),s()}}function o(){L.ket=L.cursor,L.find_among_b(v,44)&&(L.bra=L.cursor,i()&&(L.slice_del(),a()))}function w(){var e;if(L.ket=L.cursor,(e=L.find_among_b(z,3))&&(L.bra=L.cursor,i()))switch(e){case 1:L.slice_from("e");break;case 2:case 3:L.slice_from("a")}}function l(){var e;if(L.ket=L.cursor,(e=L.find_among_b(y,6))&&(L.bra=L.cursor,i()))switch(e){case 1:case 2:L.slice_del();break;case 3:L.slice_from("a");break;case 4:L.slice_from("e")}}function u(){var e;if(L.ket=L.cursor,(e=L.find_among_b(j,2))&&(L.bra=L.cursor,i())){if((1==e||2==e)&&!t())return;L.slice_del(),s()}}function m(){var e;if(L.ket=L.cursor,(e=L.find_among_b(C,7))&&(L.bra=L.cursor,i()))switch(e){case 1:L.slice_from("a");break;case 2:L.slice_from("e");break;case 3:case 4:case 5:case 6:case 7:L.slice_del()}}function k(){var e;if(L.ket=L.cursor,(e=L.find_among_b(P,12))&&(L.bra=L.cursor,i()))switch(e){case 1:case 4:case 7:case 9:L.slice_del();break;case 2:case 5:case 8:L.slice_from("e");break;case 3:case 6:L.slice_from("a")}}function f(){var e;if(L.ket=L.cursor,(e=L.find_among_b(F,31))&&(L.bra=L.cursor,i()))switch(e){case 1:case 4:case 7:case 8:case 9:case 12:case 13:case 16:case 17:case 18:L.slice_del();break;case 2:case 5:case 10:case 14:case 19:L.slice_from("a");break;case 3:case 6:case 11:case 15:case 20:L.slice_from("e")}}function b(){var e;if(L.ket=L.cursor,(e=L.find_among_b(S,42))&&(L.bra=L.cursor,i()))switch(e){case 1:case 4:case 5:case 6:case 9:case 10:case 11:case 14:case 15:case 16:case 17:case 20:case 21:case 24:case 25:case 26:case 29:L.slice_del();break;case 2:case 7:case 12:case 18:case 22:case 27:L.slice_from("a");break;case 3:case 8:case 13:case 19:case 23:case 28:L.slice_from("e")}}var d,g=[new n("cs",-1,-1),new n("dzs",-1,-1),new n("gy",-1,-1),new n("ly",-1,-1),new n("ny",-1,-1),new n("sz",-1,-1),new n("ty",-1,-1),new n("zs",-1,-1)],h=[new n("á",-1,1),new n("é",-1,2)],p=[new n("bb",-1,-1),new n("cc",-1,-1),new n("dd",-1,-1),new n("ff",-1,-1),new n("gg",-1,-1),new n("jj",-1,-1),new n("kk",-1,-1),new n("ll",-1,-1),new n("mm",-1,-1),new n("nn",-1,-1),new n("pp",-1,-1),new n("rr",-1,-1),new n("ccs",-1,-1),new n("ss",-1,-1),new n("zzs",-1,-1),new n("tt",-1,-1),new n("vv",-1,-1),new n("ggy",-1,-1),new n("lly",-1,-1),new n("nny",-1,-1),new n("tty",-1,-1),new n("ssz",-1,-1),new n("zz",-1,-1)],_=[new n("al",-1,1),new n("el",-1,2)],v=[new n("ba",-1,-1),new n("ra",-1,-1),new n("be",-1,-1),new n("re",-1,-1),new n("ig",-1,-1),new n("nak",-1,-1),new n("nek",-1,-1),new n("val",-1,-1),new n("vel",-1,-1),new n("ul",-1,-1),new n("nál",-1,-1),new n("nél",-1,-1),new n("ból",-1,-1),new n("ról",-1,-1),new n("tól",-1,-1),new n("bõl",-1,-1),new n("rõl",-1,-1),new n("tõl",-1,-1),new n("ül",-1,-1),new n("n",-1,-1),new n("an",19,-1),new n("ban",20,-1),new n("en",19,-1),new n("ben",22,-1),new n("képpen",22,-1),new n("on",19,-1),new n("ön",19,-1),new n("képp",-1,-1),new n("kor",-1,-1),new n("t",-1,-1),new n("at",29,-1),new n("et",29,-1),new n("ként",29,-1),new n("anként",32,-1),new n("enként",32,-1),new n("onként",32,-1),new n("ot",29,-1),new n("ért",29,-1),new n("öt",29,-1),new n("hez",-1,-1),new n("hoz",-1,-1),new n("höz",-1,-1),new n("vá",-1,-1),new n("vé",-1,-1)],z=[new n("án",-1,2),new n("én",-1,1),new n("ánként",-1,3)],y=[new n("stul",-1,2),new n("astul",0,1),new n("ástul",0,3),new n("stül",-1,2),new n("estül",3,1),new n("éstül",3,4)],j=[new n("á",-1,1),new n("é",-1,2)],C=[new n("k",-1,7),new n("ak",0,4),new n("ek",0,6),new n("ok",0,5),new n("ák",0,1),new n("ék",0,2),new n("ök",0,3)],P=[new n("éi",-1,7),new n("áéi",0,6),new n("ééi",0,5),new n("é",-1,9),new n("ké",3,4),new n("aké",4,1),new n("eké",4,1),new n("oké",4,1),new n("áké",4,3),new n("éké",4,2),new n("öké",4,1),new n("éé",3,8)],F=[new n("a",-1,18),new n("ja",0,17),new n("d",-1,16),new n("ad",2,13),new n("ed",2,13),new n("od",2,13),new n("ád",2,14),new n("éd",2,15),new n("öd",2,13),new n("e",-1,18),new n("je",9,17),new n("nk",-1,4),new n("unk",11,1),new n("ánk",11,2),new n("énk",11,3),new n("ünk",11,1),new n("uk",-1,8),new n("juk",16,7),new n("ájuk",17,5),new n("ük",-1,8),new n("jük",19,7),new n("éjük",20,6),new n("m",-1,12),new n("am",22,9),new n("em",22,9),new n("om",22,9),new n("ám",22,10),new n("ém",22,11),new n("o",-1,18),new n("á",-1,19),new n("é",-1,20)],S=[new n("id",-1,10),new n("aid",0,9),new n("jaid",1,6),new n("eid",0,9),new n("jeid",3,6),new n("áid",0,7),new n("éid",0,8),new n("i",-1,15),new n("ai",7,14),new n("jai",8,11),new n("ei",7,14),new n("jei",10,11),new n("ái",7,12),new n("éi",7,13),new n("itek",-1,24),new n("eitek",14,21),new n("jeitek",15,20),new n("éitek",14,23),new n("ik",-1,29),new n("aik",18,26),new n("jaik",19,25),new n("eik",18,26),new n("jeik",21,25),new n("áik",18,27),new n("éik",18,28),new n("ink",-1,20),new n("aink",25,17),new n("jaink",26,16),new n("eink",25,17),new n("jeink",28,16),new n("áink",25,18),new n("éink",25,19),new n("aitok",-1,21),new n("jaitok",32,20),new n("áitok",-1,22),new n("im",-1,5),new n("aim",35,4),new n("jaim",36,1),new n("eim",35,4),new n("jeim",38,1),new n("áim",35,2),new n("éim",35,3)],W=[17,65,16,0,0,0,0,0,0,0,0,0,0,0,0,0,1,17,52,14],L=new r;this.setCurrent=function(e){L.setCurrent(e)},this.getCurrent=function(){return L.getCurrent()},this.stem=function(){var n=L.cursor;return e(),L.limit_backward=n,L.cursor=L.limit,c(),L.cursor=L.limit,o(),L.cursor=L.limit,w(),L.cursor=L.limit,l(),L.cursor=L.limit,u(),L.cursor=L.limit,k(),L.cursor=L.limit,f(),L.cursor=L.limit,b(),L.cursor=L.limit,m(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}}(),e.Pipeline.registerFunction(e.hu.stemmer,"stemmer-hu"),e.hu.stopWordFilter=e.generateStopWordFilter("a abban ahhoz ahogy ahol aki akik akkor alatt amely amelyek amelyekben amelyeket amelyet amelynek ami amikor amit amolyan amíg annak arra arról az azok azon azonban azt aztán azután azzal azért be belül benne bár cikk cikkek cikkeket csak de e ebben eddig egy egyes egyetlen egyik egyre egyéb egész ehhez ekkor el ellen elsõ elég elõ elõször elõtt emilyen ennek erre ez ezek ezen ezt ezzel ezért fel felé hanem hiszen hogy hogyan igen ill ill. illetve ilyen ilyenkor ismét ison itt jobban jó jól kell kellett keressünk keresztül ki kívül között közül legalább legyen lehet lehetett lenne lenni lesz lett maga magát majd majd meg mellett mely melyek mert mi mikor milyen minden mindenki mindent mindig mint mintha mit mivel miért most már más másik még míg nagy nagyobb nagyon ne nekem neki nem nincs néha néhány nélkül olyan ott pedig persze rá s saját sem semmi sok sokat sokkal szemben szerint szinte számára talán tehát teljes tovább továbbá több ugyanis utolsó után utána vagy vagyis vagyok valaki valami valamint való van vannak vele vissza viszont volna volt voltak voltam voltunk által általában át én éppen és így õ õk õket össze úgy új újabb újra".split(" ")),e.Pipeline.registerFunction(e.hu.stopWordFilter,"stopWordFilter-hu")}}); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/min/lunr.it.min.js b/v4.0.1/assets/javascripts/lunr/min/lunr.it.min.js new file mode 100644 index 0000000000..344b6a3c0c --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/min/lunr.it.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Italian` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.it=function(){this.pipeline.reset(),this.pipeline.add(e.it.trimmer,e.it.stopWordFilter,e.it.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.it.stemmer))},e.it.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.it.trimmer=e.trimmerSupport.generateTrimmer(e.it.wordCharacters),e.Pipeline.registerFunction(e.it.trimmer,"trimmer-it"),e.it.stemmer=function(){var r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,i=new function(){function e(e,r,n){return!(!x.eq_s(1,e)||(x.ket=x.cursor,!x.in_grouping(L,97,249)))&&(x.slice_from(r),x.cursor=n,!0)}function i(){for(var r,n,i,o,t=x.cursor;;){if(x.bra=x.cursor,r=x.find_among(h,7))switch(x.ket=x.cursor,r){case 1:x.slice_from("à");continue;case 2:x.slice_from("è");continue;case 3:x.slice_from("ì");continue;case 4:x.slice_from("ò");continue;case 5:x.slice_from("ù");continue;case 6:x.slice_from("qU");continue;case 7:if(x.cursor>=x.limit)break;x.cursor++;continue}break}for(x.cursor=t;;)for(n=x.cursor;;){if(i=x.cursor,x.in_grouping(L,97,249)){if(x.bra=x.cursor,o=x.cursor,e("u","U",i))break;if(x.cursor=o,e("i","I",i))break}if(x.cursor=i,x.cursor>=x.limit)return void(x.cursor=n);x.cursor++}}function o(e){if(x.cursor=e,!x.in_grouping(L,97,249))return!1;for(;!x.out_grouping(L,97,249);){if(x.cursor>=x.limit)return!1;x.cursor++}return!0}function t(){if(x.in_grouping(L,97,249)){var e=x.cursor;if(x.out_grouping(L,97,249)){for(;!x.in_grouping(L,97,249);){if(x.cursor>=x.limit)return o(e);x.cursor++}return!0}return o(e)}return!1}function s(){var e,r=x.cursor;if(!t()){if(x.cursor=r,!x.out_grouping(L,97,249))return;if(e=x.cursor,x.out_grouping(L,97,249)){for(;!x.in_grouping(L,97,249);){if(x.cursor>=x.limit)return x.cursor=e,void(x.in_grouping(L,97,249)&&x.cursor=x.limit)return;x.cursor++}k=x.cursor}function a(){for(;!x.in_grouping(L,97,249);){if(x.cursor>=x.limit)return!1;x.cursor++}for(;!x.out_grouping(L,97,249);){if(x.cursor>=x.limit)return!1;x.cursor++}return!0}function u(){var e=x.cursor;k=x.limit,p=k,g=k,s(),x.cursor=e,a()&&(p=x.cursor,a()&&(g=x.cursor))}function c(){for(var e;;){if(x.bra=x.cursor,!(e=x.find_among(q,3)))break;switch(x.ket=x.cursor,e){case 1:x.slice_from("i");break;case 2:x.slice_from("u");break;case 3:if(x.cursor>=x.limit)return;x.cursor++}}}function w(){return k<=x.cursor}function l(){return p<=x.cursor}function m(){return g<=x.cursor}function f(){var e;if(x.ket=x.cursor,x.find_among_b(C,37)&&(x.bra=x.cursor,(e=x.find_among_b(z,5))&&w()))switch(e){case 1:x.slice_del();break;case 2:x.slice_from("e")}}function v(){var e;if(x.ket=x.cursor,!(e=x.find_among_b(S,51)))return!1;switch(x.bra=x.cursor,e){case 1:if(!m())return!1;x.slice_del();break;case 2:if(!m())return!1;x.slice_del(),x.ket=x.cursor,x.eq_s_b(2,"ic")&&(x.bra=x.cursor,m()&&x.slice_del());break;case 3:if(!m())return!1;x.slice_from("log");break;case 4:if(!m())return!1;x.slice_from("u");break;case 5:if(!m())return!1;x.slice_from("ente");break;case 6:if(!w())return!1;x.slice_del();break;case 7:if(!l())return!1;x.slice_del(),x.ket=x.cursor,e=x.find_among_b(P,4),e&&(x.bra=x.cursor,m()&&(x.slice_del(),1==e&&(x.ket=x.cursor,x.eq_s_b(2,"at")&&(x.bra=x.cursor,m()&&x.slice_del()))));break;case 8:if(!m())return!1;x.slice_del(),x.ket=x.cursor,e=x.find_among_b(F,3),e&&(x.bra=x.cursor,1==e&&m()&&x.slice_del());break;case 9:if(!m())return!1;x.slice_del(),x.ket=x.cursor,x.eq_s_b(2,"at")&&(x.bra=x.cursor,m()&&(x.slice_del(),x.ket=x.cursor,x.eq_s_b(2,"ic")&&(x.bra=x.cursor,m()&&x.slice_del())))}return!0}function b(){var e,r;x.cursor>=k&&(r=x.limit_backward,x.limit_backward=k,x.ket=x.cursor,e=x.find_among_b(W,87),e&&(x.bra=x.cursor,1==e&&x.slice_del()),x.limit_backward=r)}function d(){var e=x.limit-x.cursor;if(x.ket=x.cursor,x.in_grouping_b(y,97,242)&&(x.bra=x.cursor,w()&&(x.slice_del(),x.ket=x.cursor,x.eq_s_b(1,"i")&&(x.bra=x.cursor,w()))))return void x.slice_del();x.cursor=x.limit-e}function _(){d(),x.ket=x.cursor,x.eq_s_b(1,"h")&&(x.bra=x.cursor,x.in_grouping_b(U,99,103)&&w()&&x.slice_del())}var g,p,k,h=[new r("",-1,7),new r("qu",0,6),new r("á",0,1),new r("é",0,2),new r("í",0,3),new r("ó",0,4),new r("ú",0,5)],q=[new r("",-1,3),new r("I",0,1),new r("U",0,2)],C=[new r("la",-1,-1),new r("cela",0,-1),new r("gliela",0,-1),new r("mela",0,-1),new r("tela",0,-1),new r("vela",0,-1),new r("le",-1,-1),new r("cele",6,-1),new r("gliele",6,-1),new r("mele",6,-1),new r("tele",6,-1),new r("vele",6,-1),new r("ne",-1,-1),new r("cene",12,-1),new r("gliene",12,-1),new r("mene",12,-1),new r("sene",12,-1),new r("tene",12,-1),new r("vene",12,-1),new r("ci",-1,-1),new r("li",-1,-1),new r("celi",20,-1),new r("glieli",20,-1),new r("meli",20,-1),new r("teli",20,-1),new r("veli",20,-1),new r("gli",20,-1),new r("mi",-1,-1),new r("si",-1,-1),new r("ti",-1,-1),new r("vi",-1,-1),new r("lo",-1,-1),new r("celo",31,-1),new r("glielo",31,-1),new r("melo",31,-1),new r("telo",31,-1),new r("velo",31,-1)],z=[new r("ando",-1,1),new r("endo",-1,1),new r("ar",-1,2),new r("er",-1,2),new r("ir",-1,2)],P=[new r("ic",-1,-1),new r("abil",-1,-1),new r("os",-1,-1),new r("iv",-1,1)],F=[new r("ic",-1,1),new r("abil",-1,1),new r("iv",-1,1)],S=[new r("ica",-1,1),new r("logia",-1,3),new r("osa",-1,1),new r("ista",-1,1),new r("iva",-1,9),new r("anza",-1,1),new r("enza",-1,5),new r("ice",-1,1),new r("atrice",7,1),new r("iche",-1,1),new r("logie",-1,3),new r("abile",-1,1),new r("ibile",-1,1),new r("usione",-1,4),new r("azione",-1,2),new r("uzione",-1,4),new r("atore",-1,2),new r("ose",-1,1),new r("ante",-1,1),new r("mente",-1,1),new r("amente",19,7),new r("iste",-1,1),new r("ive",-1,9),new r("anze",-1,1),new r("enze",-1,5),new r("ici",-1,1),new r("atrici",25,1),new r("ichi",-1,1),new r("abili",-1,1),new r("ibili",-1,1),new r("ismi",-1,1),new r("usioni",-1,4),new r("azioni",-1,2),new r("uzioni",-1,4),new r("atori",-1,2),new r("osi",-1,1),new r("anti",-1,1),new r("amenti",-1,6),new r("imenti",-1,6),new r("isti",-1,1),new r("ivi",-1,9),new r("ico",-1,1),new r("ismo",-1,1),new r("oso",-1,1),new r("amento",-1,6),new r("imento",-1,6),new r("ivo",-1,9),new r("ità",-1,8),new r("istà",-1,1),new r("istè",-1,1),new r("istì",-1,1)],W=[new r("isca",-1,1),new r("enda",-1,1),new r("ata",-1,1),new r("ita",-1,1),new r("uta",-1,1),new r("ava",-1,1),new r("eva",-1,1),new r("iva",-1,1),new r("erebbe",-1,1),new r("irebbe",-1,1),new r("isce",-1,1),new r("ende",-1,1),new r("are",-1,1),new r("ere",-1,1),new r("ire",-1,1),new r("asse",-1,1),new r("ate",-1,1),new r("avate",16,1),new r("evate",16,1),new r("ivate",16,1),new r("ete",-1,1),new r("erete",20,1),new r("irete",20,1),new r("ite",-1,1),new r("ereste",-1,1),new r("ireste",-1,1),new r("ute",-1,1),new r("erai",-1,1),new r("irai",-1,1),new r("isci",-1,1),new r("endi",-1,1),new r("erei",-1,1),new r("irei",-1,1),new r("assi",-1,1),new r("ati",-1,1),new r("iti",-1,1),new r("eresti",-1,1),new r("iresti",-1,1),new r("uti",-1,1),new r("avi",-1,1),new r("evi",-1,1),new r("ivi",-1,1),new r("isco",-1,1),new r("ando",-1,1),new r("endo",-1,1),new r("Yamo",-1,1),new r("iamo",-1,1),new r("avamo",-1,1),new r("evamo",-1,1),new r("ivamo",-1,1),new r("eremo",-1,1),new r("iremo",-1,1),new r("assimo",-1,1),new r("ammo",-1,1),new r("emmo",-1,1),new r("eremmo",54,1),new r("iremmo",54,1),new r("immo",-1,1),new r("ano",-1,1),new r("iscano",58,1),new r("avano",58,1),new r("evano",58,1),new r("ivano",58,1),new r("eranno",-1,1),new r("iranno",-1,1),new r("ono",-1,1),new r("iscono",65,1),new r("arono",65,1),new r("erono",65,1),new r("irono",65,1),new r("erebbero",-1,1),new r("irebbero",-1,1),new r("assero",-1,1),new r("essero",-1,1),new r("issero",-1,1),new r("ato",-1,1),new r("ito",-1,1),new r("uto",-1,1),new r("avo",-1,1),new r("evo",-1,1),new r("ivo",-1,1),new r("ar",-1,1),new r("ir",-1,1),new r("erà",-1,1),new r("irà",-1,1),new r("erò",-1,1),new r("irò",-1,1)],L=[17,65,16,0,0,0,0,0,0,0,0,0,0,0,0,128,128,8,2,1],y=[17,65,0,0,0,0,0,0,0,0,0,0,0,0,0,128,128,8,2],U=[17],x=new n;this.setCurrent=function(e){x.setCurrent(e)},this.getCurrent=function(){return x.getCurrent()},this.stem=function(){var e=x.cursor;return i(),x.cursor=e,u(),x.limit_backward=e,x.cursor=x.limit,f(),x.cursor=x.limit,v()||(x.cursor=x.limit,b()),x.cursor=x.limit,_(),x.cursor=x.limit_backward,c(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}}(),e.Pipeline.registerFunction(e.it.stemmer,"stemmer-it"),e.it.stopWordFilter=e.generateStopWordFilter("a abbia abbiamo abbiano abbiate ad agl agli ai al all alla alle allo anche avemmo avendo avesse avessero avessi avessimo aveste avesti avete aveva avevamo avevano avevate avevi avevo avrai avranno avrebbe avrebbero avrei avremmo avremo avreste avresti avrete avrà avrò avuta avute avuti avuto c che chi ci coi col come con contro cui da dagl dagli dai dal dall dalla dalle dallo degl degli dei del dell della delle dello di dov dove e ebbe ebbero ebbi ed era erano eravamo eravate eri ero essendo faccia facciamo facciano facciate faccio facemmo facendo facesse facessero facessi facessimo faceste facesti faceva facevamo facevano facevate facevi facevo fai fanno farai faranno farebbe farebbero farei faremmo faremo fareste faresti farete farà farò fece fecero feci fosse fossero fossi fossimo foste fosti fu fui fummo furono gli ha hai hanno ho i il in io l la le lei li lo loro lui ma mi mia mie miei mio ne negl negli nei nel nell nella nelle nello noi non nostra nostre nostri nostro o per perché più quale quanta quante quanti quanto quella quelle quelli quello questa queste questi questo sarai saranno sarebbe sarebbero sarei saremmo saremo sareste saresti sarete sarà sarò se sei si sia siamo siano siate siete sono sta stai stando stanno starai staranno starebbe starebbero starei staremmo staremo stareste staresti starete starà starò stava stavamo stavano stavate stavi stavo stemmo stesse stessero stessi stessimo steste stesti stette stettero stetti stia stiamo stiano stiate sto su sua sue sugl sugli sui sul sull sulla sulle sullo suo suoi ti tra tu tua tue tuo tuoi tutti tutto un una uno vi voi vostra vostre vostri vostro è".split(" ")),e.Pipeline.registerFunction(e.it.stopWordFilter,"stopWordFilter-it")}}); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/min/lunr.ja.min.js b/v4.0.1/assets/javascripts/lunr/min/lunr.ja.min.js new file mode 100644 index 0000000000..5f254ebe91 --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/min/lunr.ja.min.js @@ -0,0 +1 @@ +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");var r="2"==e.version[0];e.ja=function(){this.pipeline.reset(),this.pipeline.add(e.ja.trimmer,e.ja.stopWordFilter,e.ja.stemmer),r?this.tokenizer=e.ja.tokenizer:(e.tokenizer&&(e.tokenizer=e.ja.tokenizer),this.tokenizerFn&&(this.tokenizerFn=e.ja.tokenizer))};var t=new e.TinySegmenter;e.ja.tokenizer=function(i){var n,o,s,p,a,u,m,l,c,f;if(!arguments.length||null==i||void 0==i)return[];if(Array.isArray(i))return i.map(function(t){return r?new e.Token(t.toLowerCase()):t.toLowerCase()});for(o=i.toString().toLowerCase().replace(/^\s+/,""),n=o.length-1;n>=0;n--)if(/\S/.test(o.charAt(n))){o=o.substring(0,n+1);break}for(a=[],s=o.length,c=0,l=0;c<=s;c++)if(u=o.charAt(c),m=c-l,u.match(/\s/)||c==s){if(m>0)for(p=t.segment(o.slice(l,c)).filter(function(e){return!!e}),f=l,n=0;n=C.limit)break;C.cursor++;continue}break}for(C.cursor=o,C.bra=o,C.eq_s(1,"y")?(C.ket=C.cursor,C.slice_from("Y")):C.cursor=o;;)if(e=C.cursor,C.in_grouping(q,97,232)){if(i=C.cursor,C.bra=i,C.eq_s(1,"i"))C.ket=C.cursor,C.in_grouping(q,97,232)&&(C.slice_from("I"),C.cursor=e);else if(C.cursor=i,C.eq_s(1,"y"))C.ket=C.cursor,C.slice_from("Y"),C.cursor=e;else if(n(e))break}else if(n(e))break}function n(r){return C.cursor=r,r>=C.limit||(C.cursor++,!1)}function o(){_=C.limit,d=_,t()||(_=C.cursor,_<3&&(_=3),t()||(d=C.cursor))}function t(){for(;!C.in_grouping(q,97,232);){if(C.cursor>=C.limit)return!0;C.cursor++}for(;!C.out_grouping(q,97,232);){if(C.cursor>=C.limit)return!0;C.cursor++}return!1}function s(){for(var r;;)if(C.bra=C.cursor,r=C.find_among(p,3))switch(C.ket=C.cursor,r){case 1:C.slice_from("y");break;case 2:C.slice_from("i");break;case 3:if(C.cursor>=C.limit)return;C.cursor++}}function u(){return _<=C.cursor}function c(){return d<=C.cursor}function a(){var r=C.limit-C.cursor;C.find_among_b(g,3)&&(C.cursor=C.limit-r,C.ket=C.cursor,C.cursor>C.limit_backward&&(C.cursor--,C.bra=C.cursor,C.slice_del()))}function l(){var r;w=!1,C.ket=C.cursor,C.eq_s_b(1,"e")&&(C.bra=C.cursor,u()&&(r=C.limit-C.cursor,C.out_grouping_b(q,97,232)&&(C.cursor=C.limit-r,C.slice_del(),w=!0,a())))}function m(){var r;u()&&(r=C.limit-C.cursor,C.out_grouping_b(q,97,232)&&(C.cursor=C.limit-r,C.eq_s_b(3,"gem")||(C.cursor=C.limit-r,C.slice_del(),a())))}function f(){var r,e,i,n,o,t,s=C.limit-C.cursor;if(C.ket=C.cursor,r=C.find_among_b(h,5))switch(C.bra=C.cursor,r){case 1:u()&&C.slice_from("heid");break;case 2:m();break;case 3:u()&&C.out_grouping_b(j,97,232)&&C.slice_del()}if(C.cursor=C.limit-s,l(),C.cursor=C.limit-s,C.ket=C.cursor,C.eq_s_b(4,"heid")&&(C.bra=C.cursor,c()&&(e=C.limit-C.cursor,C.eq_s_b(1,"c")||(C.cursor=C.limit-e,C.slice_del(),C.ket=C.cursor,C.eq_s_b(2,"en")&&(C.bra=C.cursor,m())))),C.cursor=C.limit-s,C.ket=C.cursor,r=C.find_among_b(k,6))switch(C.bra=C.cursor,r){case 1:if(c()){if(C.slice_del(),i=C.limit-C.cursor,C.ket=C.cursor,C.eq_s_b(2,"ig")&&(C.bra=C.cursor,c()&&(n=C.limit-C.cursor,!C.eq_s_b(1,"e")))){C.cursor=C.limit-n,C.slice_del();break}C.cursor=C.limit-i,a()}break;case 2:c()&&(o=C.limit-C.cursor,C.eq_s_b(1,"e")||(C.cursor=C.limit-o,C.slice_del()));break;case 3:c()&&(C.slice_del(),l());break;case 4:c()&&C.slice_del();break;case 5:c()&&w&&C.slice_del()}C.cursor=C.limit-s,C.out_grouping_b(z,73,232)&&(t=C.limit-C.cursor,C.find_among_b(v,4)&&C.out_grouping_b(q,97,232)&&(C.cursor=C.limit-t,C.ket=C.cursor,C.cursor>C.limit_backward&&(C.cursor--,C.bra=C.cursor,C.slice_del())))}var d,_,w,b=[new e("",-1,6),new e("á",0,1),new e("ä",0,1),new e("é",0,2),new e("ë",0,2),new e("í",0,3),new e("ï",0,3),new e("ó",0,4),new e("ö",0,4),new e("ú",0,5),new e("ü",0,5)],p=[new e("",-1,3),new e("I",0,2),new e("Y",0,1)],g=[new e("dd",-1,-1),new e("kk",-1,-1),new e("tt",-1,-1)],h=[new e("ene",-1,2),new e("se",-1,3),new e("en",-1,2),new e("heden",2,1),new e("s",-1,3)],k=[new e("end",-1,1),new e("ig",-1,2),new e("ing",-1,1),new e("lijk",-1,3),new e("baar",-1,4),new e("bar",-1,5)],v=[new e("aa",-1,-1),new e("ee",-1,-1),new e("oo",-1,-1),new e("uu",-1,-1)],q=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,128],z=[1,0,0,17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,128],j=[17,67,16,1,0,0,0,0,0,0,0,0,0,0,0,0,128],C=new i;this.setCurrent=function(r){C.setCurrent(r)},this.getCurrent=function(){return C.getCurrent()},this.stem=function(){var e=C.cursor;return r(),C.cursor=e,o(),C.limit_backward=e,C.cursor=C.limit,f(),C.cursor=C.limit_backward,s(),!0}};return function(r){return"function"==typeof r.update?r.update(function(r){return n.setCurrent(r),n.stem(),n.getCurrent()}):(n.setCurrent(r),n.stem(),n.getCurrent())}}(),r.Pipeline.registerFunction(r.nl.stemmer,"stemmer-nl"),r.nl.stopWordFilter=r.generateStopWordFilter(" aan al alles als altijd andere ben bij daar dan dat de der deze die dit doch doen door dus een eens en er ge geen geweest haar had heb hebben heeft hem het hier hij hoe hun iemand iets ik in is ja je kan kon kunnen maar me meer men met mij mijn moet na naar niet niets nog nu of om omdat onder ons ook op over reeds te tegen toch toen tot u uit uw van veel voor want waren was wat werd wezen wie wil worden wordt zal ze zelf zich zij zijn zo zonder zou".split(" ")),r.Pipeline.registerFunction(r.nl.stopWordFilter,"stopWordFilter-nl")}}); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/min/lunr.no.min.js b/v4.0.1/assets/javascripts/lunr/min/lunr.no.min.js new file mode 100644 index 0000000000..92bc7e4e89 --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/min/lunr.no.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Norwegian` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.no=function(){this.pipeline.reset(),this.pipeline.add(e.no.trimmer,e.no.stopWordFilter,e.no.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.no.stemmer))},e.no.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.no.trimmer=e.trimmerSupport.generateTrimmer(e.no.wordCharacters),e.Pipeline.registerFunction(e.no.trimmer,"trimmer-no"),e.no.stemmer=function(){var r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,i=new function(){function e(){var e,r=w.cursor+3;if(a=w.limit,0<=r||r<=w.limit){for(s=r;;){if(e=w.cursor,w.in_grouping(d,97,248)){w.cursor=e;break}if(e>=w.limit)return;w.cursor=e+1}for(;!w.out_grouping(d,97,248);){if(w.cursor>=w.limit)return;w.cursor++}a=w.cursor,a=a&&(r=w.limit_backward,w.limit_backward=a,w.ket=w.cursor,e=w.find_among_b(m,29),w.limit_backward=r,e))switch(w.bra=w.cursor,e){case 1:w.slice_del();break;case 2:n=w.limit-w.cursor,w.in_grouping_b(c,98,122)?w.slice_del():(w.cursor=w.limit-n,w.eq_s_b(1,"k")&&w.out_grouping_b(d,97,248)&&w.slice_del());break;case 3:w.slice_from("er")}}function t(){var e,r=w.limit-w.cursor;w.cursor>=a&&(e=w.limit_backward,w.limit_backward=a,w.ket=w.cursor,w.find_among_b(u,2)?(w.bra=w.cursor,w.limit_backward=e,w.cursor=w.limit-r,w.cursor>w.limit_backward&&(w.cursor--,w.bra=w.cursor,w.slice_del())):w.limit_backward=e)}function o(){var e,r;w.cursor>=a&&(r=w.limit_backward,w.limit_backward=a,w.ket=w.cursor,e=w.find_among_b(l,11),e?(w.bra=w.cursor,w.limit_backward=r,1==e&&w.slice_del()):w.limit_backward=r)}var s,a,m=[new r("a",-1,1),new r("e",-1,1),new r("ede",1,1),new r("ande",1,1),new r("ende",1,1),new r("ane",1,1),new r("ene",1,1),new r("hetene",6,1),new r("erte",1,3),new r("en",-1,1),new r("heten",9,1),new r("ar",-1,1),new r("er",-1,1),new r("heter",12,1),new r("s",-1,2),new r("as",14,1),new r("es",14,1),new r("edes",16,1),new r("endes",16,1),new r("enes",16,1),new r("hetenes",19,1),new r("ens",14,1),new r("hetens",21,1),new r("ers",14,1),new r("ets",14,1),new r("et",-1,1),new r("het",25,1),new r("ert",-1,3),new r("ast",-1,1)],u=[new r("dt",-1,-1),new r("vt",-1,-1)],l=[new r("leg",-1,1),new r("eleg",0,1),new r("ig",-1,1),new r("eig",2,1),new r("lig",2,1),new r("elig",4,1),new r("els",-1,1),new r("lov",-1,1),new r("elov",7,1),new r("slov",7,1),new r("hetslov",9,1)],d=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,48,0,128],c=[119,125,149,1],w=new n;this.setCurrent=function(e){w.setCurrent(e)},this.getCurrent=function(){return w.getCurrent()},this.stem=function(){var r=w.cursor;return e(),w.limit_backward=r,w.cursor=w.limit,i(),w.cursor=w.limit,t(),w.cursor=w.limit,o(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return i.setCurrent(e),i.stem(),i.getCurrent()}):(i.setCurrent(e),i.stem(),i.getCurrent())}}(),e.Pipeline.registerFunction(e.no.stemmer,"stemmer-no"),e.no.stopWordFilter=e.generateStopWordFilter("alle at av bare begge ble blei bli blir blitt både båe da de deg dei deim deira deires dem den denne der dere deres det dette di din disse ditt du dykk dykkar då eg ein eit eitt eller elles en enn er et ett etter for fordi fra før ha hadde han hans har hennar henne hennes her hjå ho hoe honom hoss hossen hun hva hvem hver hvilke hvilken hvis hvor hvordan hvorfor i ikke ikkje ikkje ingen ingi inkje inn inni ja jeg kan kom korleis korso kun kunne kva kvar kvarhelst kven kvi kvifor man mange me med medan meg meget mellom men mi min mine mitt mot mykje ned no noe noen noka noko nokon nokor nokre nå når og også om opp oss over på samme seg selv si si sia sidan siden sin sine sitt sjøl skal skulle slik so som som somme somt så sånn til um upp ut uten var vart varte ved vere verte vi vil ville vore vors vort vår være være vært å".split(" ")),e.Pipeline.registerFunction(e.no.stopWordFilter,"stopWordFilter-no")}}); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/min/lunr.pt.min.js b/v4.0.1/assets/javascripts/lunr/min/lunr.pt.min.js new file mode 100644 index 0000000000..6c16996d65 --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/min/lunr.pt.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Portuguese` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.pt=function(){this.pipeline.reset(),this.pipeline.add(e.pt.trimmer,e.pt.stopWordFilter,e.pt.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.pt.stemmer))},e.pt.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.pt.trimmer=e.trimmerSupport.generateTrimmer(e.pt.wordCharacters),e.Pipeline.registerFunction(e.pt.trimmer,"trimmer-pt"),e.pt.stemmer=function(){var r=e.stemmerSupport.Among,s=e.stemmerSupport.SnowballProgram,n=new function(){function e(){for(var e;;){if(z.bra=z.cursor,e=z.find_among(k,3))switch(z.ket=z.cursor,e){case 1:z.slice_from("a~");continue;case 2:z.slice_from("o~");continue;case 3:if(z.cursor>=z.limit)break;z.cursor++;continue}break}}function n(){if(z.out_grouping(y,97,250)){for(;!z.in_grouping(y,97,250);){if(z.cursor>=z.limit)return!0;z.cursor++}return!1}return!0}function i(){if(z.in_grouping(y,97,250))for(;!z.out_grouping(y,97,250);){if(z.cursor>=z.limit)return!1;z.cursor++}return g=z.cursor,!0}function o(){var e,r,s=z.cursor;if(z.in_grouping(y,97,250))if(e=z.cursor,n()){if(z.cursor=e,i())return}else g=z.cursor;if(z.cursor=s,z.out_grouping(y,97,250)){if(r=z.cursor,n()){if(z.cursor=r,!z.in_grouping(y,97,250)||z.cursor>=z.limit)return;z.cursor++}g=z.cursor}}function t(){for(;!z.in_grouping(y,97,250);){if(z.cursor>=z.limit)return!1;z.cursor++}for(;!z.out_grouping(y,97,250);){if(z.cursor>=z.limit)return!1;z.cursor++}return!0}function a(){var e=z.cursor;g=z.limit,b=g,h=g,o(),z.cursor=e,t()&&(b=z.cursor,t()&&(h=z.cursor))}function u(){for(var e;;){if(z.bra=z.cursor,e=z.find_among(q,3))switch(z.ket=z.cursor,e){case 1:z.slice_from("ã");continue;case 2:z.slice_from("õ");continue;case 3:if(z.cursor>=z.limit)break;z.cursor++;continue}break}}function w(){return g<=z.cursor}function m(){return b<=z.cursor}function c(){return h<=z.cursor}function l(){var e;if(z.ket=z.cursor,!(e=z.find_among_b(F,45)))return!1;switch(z.bra=z.cursor,e){case 1:if(!c())return!1;z.slice_del();break;case 2:if(!c())return!1;z.slice_from("log");break;case 3:if(!c())return!1;z.slice_from("u");break;case 4:if(!c())return!1;z.slice_from("ente");break;case 5:if(!m())return!1;z.slice_del(),z.ket=z.cursor,e=z.find_among_b(j,4),e&&(z.bra=z.cursor,c()&&(z.slice_del(),1==e&&(z.ket=z.cursor,z.eq_s_b(2,"at")&&(z.bra=z.cursor,c()&&z.slice_del()))));break;case 6:if(!c())return!1;z.slice_del(),z.ket=z.cursor,e=z.find_among_b(C,3),e&&(z.bra=z.cursor,1==e&&c()&&z.slice_del());break;case 7:if(!c())return!1;z.slice_del(),z.ket=z.cursor,e=z.find_among_b(P,3),e&&(z.bra=z.cursor,1==e&&c()&&z.slice_del());break;case 8:if(!c())return!1;z.slice_del(),z.ket=z.cursor,z.eq_s_b(2,"at")&&(z.bra=z.cursor,c()&&z.slice_del());break;case 9:if(!w()||!z.eq_s_b(1,"e"))return!1;z.slice_from("ir")}return!0}function f(){var e,r;if(z.cursor>=g){if(r=z.limit_backward,z.limit_backward=g,z.ket=z.cursor,e=z.find_among_b(S,120))return z.bra=z.cursor,1==e&&z.slice_del(),z.limit_backward=r,!0;z.limit_backward=r}return!1}function d(){var e;z.ket=z.cursor,(e=z.find_among_b(W,7))&&(z.bra=z.cursor,1==e&&w()&&z.slice_del())}function v(e,r){if(z.eq_s_b(1,e)){z.bra=z.cursor;var s=z.limit-z.cursor;if(z.eq_s_b(1,r))return z.cursor=z.limit-s,w()&&z.slice_del(),!1}return!0}function p(){var e;if(z.ket=z.cursor,e=z.find_among_b(L,4))switch(z.bra=z.cursor,e){case 1:w()&&(z.slice_del(),z.ket=z.cursor,z.limit-z.cursor,v("u","g")&&v("i","c"));break;case 2:z.slice_from("c")}}function _(){if(!l()&&(z.cursor=z.limit,!f()))return z.cursor=z.limit,void d();z.cursor=z.limit,z.ket=z.cursor,z.eq_s_b(1,"i")&&(z.bra=z.cursor,z.eq_s_b(1,"c")&&(z.cursor=z.limit,w()&&z.slice_del()))}var h,b,g,k=[new r("",-1,3),new r("ã",0,1),new r("õ",0,2)],q=[new r("",-1,3),new r("a~",0,1),new r("o~",0,2)],j=[new r("ic",-1,-1),new r("ad",-1,-1),new r("os",-1,-1),new r("iv",-1,1)],C=[new r("ante",-1,1),new r("avel",-1,1),new r("ível",-1,1)],P=[new r("ic",-1,1),new r("abil",-1,1),new r("iv",-1,1)],F=[new r("ica",-1,1),new r("ância",-1,1),new r("ência",-1,4),new r("ira",-1,9),new r("adora",-1,1),new r("osa",-1,1),new r("ista",-1,1),new r("iva",-1,8),new r("eza",-1,1),new r("logía",-1,2),new r("idade",-1,7),new r("ante",-1,1),new r("mente",-1,6),new r("amente",12,5),new r("ável",-1,1),new r("ível",-1,1),new r("ución",-1,3),new r("ico",-1,1),new r("ismo",-1,1),new r("oso",-1,1),new r("amento",-1,1),new r("imento",-1,1),new r("ivo",-1,8),new r("aça~o",-1,1),new r("ador",-1,1),new r("icas",-1,1),new r("ências",-1,4),new r("iras",-1,9),new r("adoras",-1,1),new r("osas",-1,1),new r("istas",-1,1),new r("ivas",-1,8),new r("ezas",-1,1),new r("logías",-1,2),new r("idades",-1,7),new r("uciones",-1,3),new r("adores",-1,1),new r("antes",-1,1),new r("aço~es",-1,1),new r("icos",-1,1),new r("ismos",-1,1),new r("osos",-1,1),new r("amentos",-1,1),new r("imentos",-1,1),new r("ivos",-1,8)],S=[new r("ada",-1,1),new r("ida",-1,1),new r("ia",-1,1),new r("aria",2,1),new r("eria",2,1),new r("iria",2,1),new r("ara",-1,1),new r("era",-1,1),new r("ira",-1,1),new r("ava",-1,1),new r("asse",-1,1),new r("esse",-1,1),new r("isse",-1,1),new r("aste",-1,1),new r("este",-1,1),new r("iste",-1,1),new r("ei",-1,1),new r("arei",16,1),new r("erei",16,1),new r("irei",16,1),new r("am",-1,1),new r("iam",20,1),new r("ariam",21,1),new r("eriam",21,1),new r("iriam",21,1),new r("aram",20,1),new r("eram",20,1),new r("iram",20,1),new r("avam",20,1),new r("em",-1,1),new r("arem",29,1),new r("erem",29,1),new r("irem",29,1),new r("assem",29,1),new r("essem",29,1),new r("issem",29,1),new r("ado",-1,1),new r("ido",-1,1),new r("ando",-1,1),new r("endo",-1,1),new r("indo",-1,1),new r("ara~o",-1,1),new r("era~o",-1,1),new r("ira~o",-1,1),new r("ar",-1,1),new r("er",-1,1),new r("ir",-1,1),new r("as",-1,1),new r("adas",47,1),new r("idas",47,1),new r("ias",47,1),new r("arias",50,1),new r("erias",50,1),new r("irias",50,1),new r("aras",47,1),new r("eras",47,1),new r("iras",47,1),new r("avas",47,1),new r("es",-1,1),new r("ardes",58,1),new r("erdes",58,1),new r("irdes",58,1),new r("ares",58,1),new r("eres",58,1),new r("ires",58,1),new r("asses",58,1),new r("esses",58,1),new r("isses",58,1),new r("astes",58,1),new r("estes",58,1),new r("istes",58,1),new r("is",-1,1),new r("ais",71,1),new r("eis",71,1),new r("areis",73,1),new r("ereis",73,1),new r("ireis",73,1),new r("áreis",73,1),new r("éreis",73,1),new r("íreis",73,1),new r("ásseis",73,1),new r("ésseis",73,1),new r("ísseis",73,1),new r("áveis",73,1),new r("íeis",73,1),new r("aríeis",84,1),new r("eríeis",84,1),new r("iríeis",84,1),new r("ados",-1,1),new r("idos",-1,1),new r("amos",-1,1),new r("áramos",90,1),new r("éramos",90,1),new r("íramos",90,1),new r("ávamos",90,1),new r("íamos",90,1),new r("aríamos",95,1),new r("eríamos",95,1),new r("iríamos",95,1),new r("emos",-1,1),new r("aremos",99,1),new r("eremos",99,1),new r("iremos",99,1),new r("ássemos",99,1),new r("êssemos",99,1),new r("íssemos",99,1),new r("imos",-1,1),new r("armos",-1,1),new r("ermos",-1,1),new r("irmos",-1,1),new r("ámos",-1,1),new r("arás",-1,1),new r("erás",-1,1),new r("irás",-1,1),new r("eu",-1,1),new r("iu",-1,1),new r("ou",-1,1),new r("ará",-1,1),new r("erá",-1,1),new r("irá",-1,1)],W=[new r("a",-1,1),new r("i",-1,1),new r("o",-1,1),new r("os",-1,1),new r("á",-1,1),new r("í",-1,1),new r("ó",-1,1)],L=[new r("e",-1,1),new r("ç",-1,2),new r("é",-1,1),new r("ê",-1,1)],y=[17,65,16,0,0,0,0,0,0,0,0,0,0,0,0,0,3,19,12,2],z=new s;this.setCurrent=function(e){z.setCurrent(e)},this.getCurrent=function(){return z.getCurrent()},this.stem=function(){var r=z.cursor;return e(),z.cursor=r,a(),z.limit_backward=r,z.cursor=z.limit,_(),z.cursor=z.limit,p(),z.cursor=z.limit_backward,u(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return n.setCurrent(e),n.stem(),n.getCurrent()}):(n.setCurrent(e),n.stem(),n.getCurrent())}}(),e.Pipeline.registerFunction(e.pt.stemmer,"stemmer-pt"),e.pt.stopWordFilter=e.generateStopWordFilter("a ao aos aquela aquelas aquele aqueles aquilo as até com como da das de dela delas dele deles depois do dos e ela elas ele eles em entre era eram essa essas esse esses esta estamos estas estava estavam este esteja estejam estejamos estes esteve estive estivemos estiver estivera estiveram estiverem estivermos estivesse estivessem estivéramos estivéssemos estou está estávamos estão eu foi fomos for fora foram forem formos fosse fossem fui fôramos fôssemos haja hajam hajamos havemos hei houve houvemos houver houvera houveram houverei houverem houveremos houveria houveriam houvermos houverá houverão houveríamos houvesse houvessem houvéramos houvéssemos há hão isso isto já lhe lhes mais mas me mesmo meu meus minha minhas muito na nas nem no nos nossa nossas nosso nossos num numa não nós o os ou para pela pelas pelo pelos por qual quando que quem se seja sejam sejamos sem serei seremos seria seriam será serão seríamos seu seus somos sou sua suas são só também te tem temos tenha tenham tenhamos tenho terei teremos teria teriam terá terão teríamos teu teus teve tinha tinham tive tivemos tiver tivera tiveram tiverem tivermos tivesse tivessem tivéramos tivéssemos tu tua tuas tém tínhamos um uma você vocês vos à às éramos".split(" ")),e.Pipeline.registerFunction(e.pt.stopWordFilter,"stopWordFilter-pt")}}); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/min/lunr.ro.min.js b/v4.0.1/assets/javascripts/lunr/min/lunr.ro.min.js new file mode 100644 index 0000000000..7277140181 --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/min/lunr.ro.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Romanian` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,i){"function"==typeof define&&define.amd?define(i):"object"==typeof exports?module.exports=i():i()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.ro=function(){this.pipeline.reset(),this.pipeline.add(e.ro.trimmer,e.ro.stopWordFilter,e.ro.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.ro.stemmer))},e.ro.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.ro.trimmer=e.trimmerSupport.generateTrimmer(e.ro.wordCharacters),e.Pipeline.registerFunction(e.ro.trimmer,"trimmer-ro"),e.ro.stemmer=function(){var i=e.stemmerSupport.Among,r=e.stemmerSupport.SnowballProgram,n=new function(){function e(e,i){L.eq_s(1,e)&&(L.ket=L.cursor,L.in_grouping(W,97,259)&&L.slice_from(i))}function n(){for(var i,r;;){if(i=L.cursor,L.in_grouping(W,97,259)&&(r=L.cursor,L.bra=r,e("u","U"),L.cursor=r,e("i","I")),L.cursor=i,L.cursor>=L.limit)break;L.cursor++}}function t(){if(L.out_grouping(W,97,259)){for(;!L.in_grouping(W,97,259);){if(L.cursor>=L.limit)return!0;L.cursor++}return!1}return!0}function a(){if(L.in_grouping(W,97,259))for(;!L.out_grouping(W,97,259);){if(L.cursor>=L.limit)return!0;L.cursor++}return!1}function o(){var e,i,r=L.cursor;if(L.in_grouping(W,97,259)){if(e=L.cursor,!t())return void(h=L.cursor);if(L.cursor=e,!a())return void(h=L.cursor)}L.cursor=r,L.out_grouping(W,97,259)&&(i=L.cursor,t()&&(L.cursor=i,L.in_grouping(W,97,259)&&L.cursor=L.limit)return!1;L.cursor++}for(;!L.out_grouping(W,97,259);){if(L.cursor>=L.limit)return!1;L.cursor++}return!0}function c(){var e=L.cursor;h=L.limit,k=h,g=h,o(),L.cursor=e,u()&&(k=L.cursor,u()&&(g=L.cursor))}function s(){for(var e;;){if(L.bra=L.cursor,e=L.find_among(z,3))switch(L.ket=L.cursor,e){case 1:L.slice_from("i");continue;case 2:L.slice_from("u");continue;case 3:if(L.cursor>=L.limit)break;L.cursor++;continue}break}}function w(){return h<=L.cursor}function m(){return k<=L.cursor}function l(){return g<=L.cursor}function f(){var e,i;if(L.ket=L.cursor,(e=L.find_among_b(C,16))&&(L.bra=L.cursor,m()))switch(e){case 1:L.slice_del();break;case 2:L.slice_from("a");break;case 3:L.slice_from("e");break;case 4:L.slice_from("i");break;case 5:i=L.limit-L.cursor,L.eq_s_b(2,"ab")||(L.cursor=L.limit-i,L.slice_from("i"));break;case 6:L.slice_from("at");break;case 7:L.slice_from("aţi")}}function p(){var e,i=L.limit-L.cursor;if(L.ket=L.cursor,(e=L.find_among_b(P,46))&&(L.bra=L.cursor,m())){switch(e){case 1:L.slice_from("abil");break;case 2:L.slice_from("ibil");break;case 3:L.slice_from("iv");break;case 4:L.slice_from("ic");break;case 5:L.slice_from("at");break;case 6:L.slice_from("it")}return _=!0,L.cursor=L.limit-i,!0}return!1}function d(){var e,i;for(_=!1;;)if(i=L.limit-L.cursor,!p()){L.cursor=L.limit-i;break}if(L.ket=L.cursor,(e=L.find_among_b(F,62))&&(L.bra=L.cursor,l())){switch(e){case 1:L.slice_del();break;case 2:L.eq_s_b(1,"ţ")&&(L.bra=L.cursor,L.slice_from("t"));break;case 3:L.slice_from("ist")}_=!0}}function b(){var e,i,r;if(L.cursor>=h){if(i=L.limit_backward,L.limit_backward=h,L.ket=L.cursor,e=L.find_among_b(q,94))switch(L.bra=L.cursor,e){case 1:if(r=L.limit-L.cursor,!L.out_grouping_b(W,97,259)&&(L.cursor=L.limit-r,!L.eq_s_b(1,"u")))break;case 2:L.slice_del()}L.limit_backward=i}}function v(){var e;L.ket=L.cursor,(e=L.find_among_b(S,5))&&(L.bra=L.cursor,w()&&1==e&&L.slice_del())}var _,g,k,h,z=[new i("",-1,3),new i("I",0,1),new i("U",0,2)],C=[new i("ea",-1,3),new i("aţia",-1,7),new i("aua",-1,2),new i("iua",-1,4),new i("aţie",-1,7),new i("ele",-1,3),new i("ile",-1,5),new i("iile",6,4),new i("iei",-1,4),new i("atei",-1,6),new i("ii",-1,4),new i("ului",-1,1),new i("ul",-1,1),new i("elor",-1,3),new i("ilor",-1,4),new i("iilor",14,4)],P=[new i("icala",-1,4),new i("iciva",-1,4),new i("ativa",-1,5),new i("itiva",-1,6),new i("icale",-1,4),new i("aţiune",-1,5),new i("iţiune",-1,6),new i("atoare",-1,5),new i("itoare",-1,6),new i("ătoare",-1,5),new i("icitate",-1,4),new i("abilitate",-1,1),new i("ibilitate",-1,2),new i("ivitate",-1,3),new i("icive",-1,4),new i("ative",-1,5),new i("itive",-1,6),new i("icali",-1,4),new i("atori",-1,5),new i("icatori",18,4),new i("itori",-1,6),new i("ători",-1,5),new i("icitati",-1,4),new i("abilitati",-1,1),new i("ivitati",-1,3),new i("icivi",-1,4),new i("ativi",-1,5),new i("itivi",-1,6),new i("icităi",-1,4),new i("abilităi",-1,1),new i("ivităi",-1,3),new i("icităţi",-1,4),new i("abilităţi",-1,1),new i("ivităţi",-1,3),new i("ical",-1,4),new i("ator",-1,5),new i("icator",35,4),new i("itor",-1,6),new i("ător",-1,5),new i("iciv",-1,4),new i("ativ",-1,5),new i("itiv",-1,6),new i("icală",-1,4),new i("icivă",-1,4),new i("ativă",-1,5),new i("itivă",-1,6)],F=[new i("ica",-1,1),new i("abila",-1,1),new i("ibila",-1,1),new i("oasa",-1,1),new i("ata",-1,1),new i("ita",-1,1),new i("anta",-1,1),new i("ista",-1,3),new i("uta",-1,1),new i("iva",-1,1),new i("ic",-1,1),new i("ice",-1,1),new i("abile",-1,1),new i("ibile",-1,1),new i("isme",-1,3),new i("iune",-1,2),new i("oase",-1,1),new i("ate",-1,1),new i("itate",17,1),new i("ite",-1,1),new i("ante",-1,1),new i("iste",-1,3),new i("ute",-1,1),new i("ive",-1,1),new i("ici",-1,1),new i("abili",-1,1),new i("ibili",-1,1),new i("iuni",-1,2),new i("atori",-1,1),new i("osi",-1,1),new i("ati",-1,1),new i("itati",30,1),new i("iti",-1,1),new i("anti",-1,1),new i("isti",-1,3),new i("uti",-1,1),new i("işti",-1,3),new i("ivi",-1,1),new i("ităi",-1,1),new i("oşi",-1,1),new i("ităţi",-1,1),new i("abil",-1,1),new i("ibil",-1,1),new i("ism",-1,3),new i("ator",-1,1),new i("os",-1,1),new i("at",-1,1),new i("it",-1,1),new i("ant",-1,1),new i("ist",-1,3),new i("ut",-1,1),new i("iv",-1,1),new i("ică",-1,1),new i("abilă",-1,1),new i("ibilă",-1,1),new i("oasă",-1,1),new i("ată",-1,1),new i("ită",-1,1),new i("antă",-1,1),new i("istă",-1,3),new i("ută",-1,1),new i("ivă",-1,1)],q=[new i("ea",-1,1),new i("ia",-1,1),new i("esc",-1,1),new i("ăsc",-1,1),new i("ind",-1,1),new i("ând",-1,1),new i("are",-1,1),new i("ere",-1,1),new i("ire",-1,1),new i("âre",-1,1),new i("se",-1,2),new i("ase",10,1),new i("sese",10,2),new i("ise",10,1),new i("use",10,1),new i("âse",10,1),new i("eşte",-1,1),new i("ăşte",-1,1),new i("eze",-1,1),new i("ai",-1,1),new i("eai",19,1),new i("iai",19,1),new i("sei",-1,2),new i("eşti",-1,1),new i("ăşti",-1,1),new i("ui",-1,1),new i("ezi",-1,1),new i("âi",-1,1),new i("aşi",-1,1),new i("seşi",-1,2),new i("aseşi",29,1),new i("seseşi",29,2),new i("iseşi",29,1),new i("useşi",29,1),new i("âseşi",29,1),new i("işi",-1,1),new i("uşi",-1,1),new i("âşi",-1,1),new i("aţi",-1,2),new i("eaţi",38,1),new i("iaţi",38,1),new i("eţi",-1,2),new i("iţi",-1,2),new i("âţi",-1,2),new i("arăţi",-1,1),new i("serăţi",-1,2),new i("aserăţi",45,1),new i("seserăţi",45,2),new i("iserăţi",45,1),new i("userăţi",45,1),new i("âserăţi",45,1),new i("irăţi",-1,1),new i("urăţi",-1,1),new i("ârăţi",-1,1),new i("am",-1,1),new i("eam",54,1),new i("iam",54,1),new i("em",-1,2),new i("asem",57,1),new i("sesem",57,2),new i("isem",57,1),new i("usem",57,1),new i("âsem",57,1),new i("im",-1,2),new i("âm",-1,2),new i("ăm",-1,2),new i("arăm",65,1),new i("serăm",65,2),new i("aserăm",67,1),new i("seserăm",67,2),new i("iserăm",67,1),new i("userăm",67,1),new i("âserăm",67,1),new i("irăm",65,1),new i("urăm",65,1),new i("ârăm",65,1),new i("au",-1,1),new i("eau",76,1),new i("iau",76,1),new i("indu",-1,1),new i("ându",-1,1),new i("ez",-1,1),new i("ească",-1,1),new i("ară",-1,1),new i("seră",-1,2),new i("aseră",84,1),new i("seseră",84,2),new i("iseră",84,1),new i("useră",84,1),new i("âseră",84,1),new i("iră",-1,1),new i("ură",-1,1),new i("âră",-1,1),new i("ează",-1,1)],S=[new i("a",-1,1),new i("e",-1,1),new i("ie",1,1),new i("i",-1,1),new i("ă",-1,1)],W=[17,65,16,0,0,0,0,0,0,0,0,0,0,0,0,0,2,32,0,0,4],L=new r;this.setCurrent=function(e){L.setCurrent(e)},this.getCurrent=function(){return L.getCurrent()},this.stem=function(){var e=L.cursor;return n(),L.cursor=e,c(),L.limit_backward=e,L.cursor=L.limit,f(),L.cursor=L.limit,d(),L.cursor=L.limit,_||(L.cursor=L.limit,b(),L.cursor=L.limit),v(),L.cursor=L.limit_backward,s(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return n.setCurrent(e),n.stem(),n.getCurrent()}):(n.setCurrent(e),n.stem(),n.getCurrent())}}(),e.Pipeline.registerFunction(e.ro.stemmer,"stemmer-ro"),e.ro.stopWordFilter=e.generateStopWordFilter("acea aceasta această aceea acei aceia acel acela acele acelea acest acesta aceste acestea aceşti aceştia acolo acord acum ai aia aibă aici al ale alea altceva altcineva am ar are asemenea asta astea astăzi asupra au avea avem aveţi azi aş aşadar aţi bine bucur bună ca care caut ce cel ceva chiar cinci cine cineva contra cu cum cumva curând curînd când cât câte câtva câţi cînd cît cîte cîtva cîţi că căci cărei căror cărui către da dacă dar datorită dată dau de deci deja deoarece departe deşi din dinaintea dintr- dintre doi doilea două drept după dă ea ei el ele eram este eu eşti face fata fi fie fiecare fii fim fiu fiţi frumos fără graţie halbă iar ieri la le li lor lui lângă lîngă mai mea mei mele mereu meu mi mie mine mult multă mulţi mulţumesc mâine mîine mă ne nevoie nici nicăieri nimeni nimeri nimic nişte noastre noastră noi noroc nostru nouă noştri nu opt ori oricare orice oricine oricum oricând oricât oricînd oricît oriunde patra patru patrulea pe pentru peste pic poate pot prea prima primul prin puţin puţina puţină până pînă rog sa sale sau se spate spre sub sunt suntem sunteţi sută sînt sîntem sînteţi să săi său ta tale te timp tine toate toată tot totuşi toţi trei treia treilea tu tăi tău un una unde undeva unei uneia unele uneori unii unor unora unu unui unuia unul vi voastre voastră voi vostru vouă voştri vreme vreo vreun vă zece zero zi zice îi îl îmi împotriva în înainte înaintea încotro încât încît între întrucât întrucît îţi ăla ălea ăsta ăstea ăştia şapte şase şi ştiu ţi ţie".split(" ")),e.Pipeline.registerFunction(e.ro.stopWordFilter,"stopWordFilter-ro")}}); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/min/lunr.ru.min.js b/v4.0.1/assets/javascripts/lunr/min/lunr.ru.min.js new file mode 100644 index 0000000000..186cc485c2 --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/min/lunr.ru.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Russian` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,n){"function"==typeof define&&define.amd?define(n):"object"==typeof exports?module.exports=n():n()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.ru=function(){this.pipeline.reset(),this.pipeline.add(e.ru.trimmer,e.ru.stopWordFilter,e.ru.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.ru.stemmer))},e.ru.wordCharacters="Ѐ-҄҇-ԯᴫᵸⷠ-ⷿꙀ-ꚟ︮︯",e.ru.trimmer=e.trimmerSupport.generateTrimmer(e.ru.wordCharacters),e.Pipeline.registerFunction(e.ru.trimmer,"trimmer-ru"),e.ru.stemmer=function(){var n=e.stemmerSupport.Among,r=e.stemmerSupport.SnowballProgram,t=new function(){function e(){for(;!W.in_grouping(S,1072,1103);){if(W.cursor>=W.limit)return!1;W.cursor++}return!0}function t(){for(;!W.out_grouping(S,1072,1103);){if(W.cursor>=W.limit)return!1;W.cursor++}return!0}function w(){b=W.limit,_=b,e()&&(b=W.cursor,t()&&e()&&t()&&(_=W.cursor))}function i(){return _<=W.cursor}function u(e,n){var r,t;if(W.ket=W.cursor,r=W.find_among_b(e,n)){switch(W.bra=W.cursor,r){case 1:if(t=W.limit-W.cursor,!W.eq_s_b(1,"а")&&(W.cursor=W.limit-t,!W.eq_s_b(1,"я")))return!1;case 2:W.slice_del()}return!0}return!1}function o(){return u(h,9)}function s(e,n){var r;return W.ket=W.cursor,!!(r=W.find_among_b(e,n))&&(W.bra=W.cursor,1==r&&W.slice_del(),!0)}function c(){return s(g,26)}function m(){return!!c()&&(u(C,8),!0)}function f(){return s(k,2)}function l(){return u(P,46)}function a(){s(v,36)}function p(){var e;W.ket=W.cursor,(e=W.find_among_b(F,2))&&(W.bra=W.cursor,i()&&1==e&&W.slice_del())}function d(){var e;if(W.ket=W.cursor,e=W.find_among_b(q,4))switch(W.bra=W.cursor,e){case 1:if(W.slice_del(),W.ket=W.cursor,!W.eq_s_b(1,"н"))break;W.bra=W.cursor;case 2:if(!W.eq_s_b(1,"н"))break;case 3:W.slice_del()}}var _,b,h=[new n("в",-1,1),new n("ив",0,2),new n("ыв",0,2),new n("вши",-1,1),new n("ивши",3,2),new n("ывши",3,2),new n("вшись",-1,1),new n("ившись",6,2),new n("ывшись",6,2)],g=[new n("ее",-1,1),new n("ие",-1,1),new n("ое",-1,1),new n("ые",-1,1),new n("ими",-1,1),new n("ыми",-1,1),new n("ей",-1,1),new n("ий",-1,1),new n("ой",-1,1),new n("ый",-1,1),new n("ем",-1,1),new n("им",-1,1),new n("ом",-1,1),new n("ым",-1,1),new n("его",-1,1),new n("ого",-1,1),new n("ему",-1,1),new n("ому",-1,1),new n("их",-1,1),new n("ых",-1,1),new n("ею",-1,1),new n("ою",-1,1),new n("ую",-1,1),new n("юю",-1,1),new n("ая",-1,1),new n("яя",-1,1)],C=[new n("ем",-1,1),new n("нн",-1,1),new n("вш",-1,1),new n("ивш",2,2),new n("ывш",2,2),new n("щ",-1,1),new n("ющ",5,1),new n("ующ",6,2)],k=[new n("сь",-1,1),new n("ся",-1,1)],P=[new n("ла",-1,1),new n("ила",0,2),new n("ыла",0,2),new n("на",-1,1),new n("ена",3,2),new n("ете",-1,1),new n("ите",-1,2),new n("йте",-1,1),new n("ейте",7,2),new n("уйте",7,2),new n("ли",-1,1),new n("или",10,2),new n("ыли",10,2),new n("й",-1,1),new n("ей",13,2),new n("уй",13,2),new n("л",-1,1),new n("ил",16,2),new n("ыл",16,2),new n("ем",-1,1),new n("им",-1,2),new n("ым",-1,2),new n("н",-1,1),new n("ен",22,2),new n("ло",-1,1),new n("ило",24,2),new n("ыло",24,2),new n("но",-1,1),new n("ено",27,2),new n("нно",27,1),new n("ет",-1,1),new n("ует",30,2),new n("ит",-1,2),new n("ыт",-1,2),new n("ют",-1,1),new n("уют",34,2),new n("ят",-1,2),new n("ны",-1,1),new n("ены",37,2),new n("ть",-1,1),new n("ить",39,2),new n("ыть",39,2),new n("ешь",-1,1),new n("ишь",-1,2),new n("ю",-1,2),new n("ую",44,2)],v=[new n("а",-1,1),new n("ев",-1,1),new n("ов",-1,1),new n("е",-1,1),new n("ие",3,1),new n("ье",3,1),new n("и",-1,1),new n("еи",6,1),new n("ии",6,1),new n("ами",6,1),new n("ями",6,1),new n("иями",10,1),new n("й",-1,1),new n("ей",12,1),new n("ией",13,1),new n("ий",12,1),new n("ой",12,1),new n("ам",-1,1),new n("ем",-1,1),new n("ием",18,1),new n("ом",-1,1),new n("ям",-1,1),new n("иям",21,1),new n("о",-1,1),new n("у",-1,1),new n("ах",-1,1),new n("ях",-1,1),new n("иях",26,1),new n("ы",-1,1),new n("ь",-1,1),new n("ю",-1,1),new n("ию",30,1),new n("ью",30,1),new n("я",-1,1),new n("ия",33,1),new n("ья",33,1)],F=[new n("ост",-1,1),new n("ость",-1,1)],q=[new n("ейше",-1,1),new n("н",-1,2),new n("ейш",-1,1),new n("ь",-1,3)],S=[33,65,8,232],W=new r;this.setCurrent=function(e){W.setCurrent(e)},this.getCurrent=function(){return W.getCurrent()},this.stem=function(){return w(),W.cursor=W.limit,!(W.cursor=i&&(e-=i,t[e>>3]&1<<(7&e)))return this.cursor++,!0}return!1},in_grouping_b:function(t,i,s){if(this.cursor>this.limit_backward){var e=r.charCodeAt(this.cursor-1);if(e<=s&&e>=i&&(e-=i,t[e>>3]&1<<(7&e)))return this.cursor--,!0}return!1},out_grouping:function(t,i,s){if(this.cursors||e>3]&1<<(7&e)))return this.cursor++,!0}return!1},out_grouping_b:function(t,i,s){if(this.cursor>this.limit_backward){var e=r.charCodeAt(this.cursor-1);if(e>s||e>3]&1<<(7&e)))return this.cursor--,!0}return!1},eq_s:function(t,i){if(this.limit-this.cursor>1),f=0,l=o0||e==s||c)break;c=!0}}for(;;){var _=t[s];if(o>=_.s_size){if(this.cursor=n+_.s_size,!_.method)return _.result;var b=_.method();if(this.cursor=n+_.s_size,b)return _.result}if((s=_.substring_i)<0)return 0}},find_among_b:function(t,i){for(var s=0,e=i,n=this.cursor,u=this.limit_backward,o=0,h=0,c=!1;;){for(var a=s+(e-s>>1),f=0,l=o=0;m--){if(n-l==u){f=-1;break}if(f=r.charCodeAt(n-1-l)-_.s[m])break;l++}if(f<0?(e=a,h=l):(s=a,o=l),e-s<=1){if(s>0||e==s||c)break;c=!0}}for(;;){var _=t[s];if(o>=_.s_size){if(this.cursor=n-_.s_size,!_.method)return _.result;var b=_.method();if(this.cursor=n-_.s_size,b)return _.result}if((s=_.substring_i)<0)return 0}},replace_s:function(t,i,s){var e=s.length-(i-t),n=r.substring(0,t),u=r.substring(i);return r=n+s+u,this.limit+=e,this.cursor>=i?this.cursor+=e:this.cursor>t&&(this.cursor=t),e},slice_check:function(){if(this.bra<0||this.bra>this.ket||this.ket>this.limit||this.limit>r.length)throw"faulty slice operation"},slice_from:function(r){this.slice_check(),this.replace_s(this.bra,this.ket,r)},slice_del:function(){this.slice_from("")},insert:function(r,t,i){var s=this.replace_s(r,t,i);r<=this.bra&&(this.bra+=s),r<=this.ket&&(this.ket+=s)},slice_to:function(){return this.slice_check(),r.substring(this.bra,this.ket)},eq_v_b:function(r){return this.eq_s_b(r.length,r)}}}},r.trimmerSupport={generateTrimmer:function(r){var t=new RegExp("^[^"+r+"]+"),i=new RegExp("[^"+r+"]+$");return function(r){return"function"==typeof r.update?r.update(function(r){return r.replace(t,"").replace(i,"")}):r.replace(t,"").replace(i,"")}}}}}); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/min/lunr.sv.min.js b/v4.0.1/assets/javascripts/lunr/min/lunr.sv.min.js new file mode 100644 index 0000000000..3e5eb64000 --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/min/lunr.sv.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Swedish` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.sv=function(){this.pipeline.reset(),this.pipeline.add(e.sv.trimmer,e.sv.stopWordFilter,e.sv.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(e.sv.stemmer))},e.sv.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",e.sv.trimmer=e.trimmerSupport.generateTrimmer(e.sv.wordCharacters),e.Pipeline.registerFunction(e.sv.trimmer,"trimmer-sv"),e.sv.stemmer=function(){var r=e.stemmerSupport.Among,n=e.stemmerSupport.SnowballProgram,t=new function(){function e(){var e,r=w.cursor+3;if(o=w.limit,0<=r||r<=w.limit){for(a=r;;){if(e=w.cursor,w.in_grouping(l,97,246)){w.cursor=e;break}if(w.cursor=e,w.cursor>=w.limit)return;w.cursor++}for(;!w.out_grouping(l,97,246);){if(w.cursor>=w.limit)return;w.cursor++}o=w.cursor,o=o&&(w.limit_backward=o,w.cursor=w.limit,w.ket=w.cursor,e=w.find_among_b(u,37),w.limit_backward=r,e))switch(w.bra=w.cursor,e){case 1:w.slice_del();break;case 2:w.in_grouping_b(d,98,121)&&w.slice_del()}}function i(){var e=w.limit_backward;w.cursor>=o&&(w.limit_backward=o,w.cursor=w.limit,w.find_among_b(c,7)&&(w.cursor=w.limit,w.ket=w.cursor,w.cursor>w.limit_backward&&(w.bra=--w.cursor,w.slice_del())),w.limit_backward=e)}function s(){var e,r;if(w.cursor>=o){if(r=w.limit_backward,w.limit_backward=o,w.cursor=w.limit,w.ket=w.cursor,e=w.find_among_b(m,5))switch(w.bra=w.cursor,e){case 1:w.slice_del();break;case 2:w.slice_from("lös");break;case 3:w.slice_from("full")}w.limit_backward=r}}var a,o,u=[new r("a",-1,1),new r("arna",0,1),new r("erna",0,1),new r("heterna",2,1),new r("orna",0,1),new r("ad",-1,1),new r("e",-1,1),new r("ade",6,1),new r("ande",6,1),new r("arne",6,1),new r("are",6,1),new r("aste",6,1),new r("en",-1,1),new r("anden",12,1),new r("aren",12,1),new r("heten",12,1),new r("ern",-1,1),new r("ar",-1,1),new r("er",-1,1),new r("heter",18,1),new r("or",-1,1),new r("s",-1,2),new r("as",21,1),new r("arnas",22,1),new r("ernas",22,1),new r("ornas",22,1),new r("es",21,1),new r("ades",26,1),new r("andes",26,1),new r("ens",21,1),new r("arens",29,1),new r("hetens",29,1),new r("erns",21,1),new r("at",-1,1),new r("andet",-1,1),new r("het",-1,1),new r("ast",-1,1)],c=[new r("dd",-1,-1),new r("gd",-1,-1),new r("nn",-1,-1),new r("dt",-1,-1),new r("gt",-1,-1),new r("kt",-1,-1),new r("tt",-1,-1)],m=[new r("ig",-1,1),new r("lig",0,1),new r("els",-1,1),new r("fullt",-1,3),new r("löst",-1,2)],l=[17,65,16,1,0,0,0,0,0,0,0,0,0,0,0,0,24,0,32],d=[119,127,149],w=new n;this.setCurrent=function(e){w.setCurrent(e)},this.getCurrent=function(){return w.getCurrent()},this.stem=function(){var r=w.cursor;return e(),w.limit_backward=r,w.cursor=w.limit,t(),w.cursor=w.limit,i(),w.cursor=w.limit,s(),!0}};return function(e){return"function"==typeof e.update?e.update(function(e){return t.setCurrent(e),t.stem(),t.getCurrent()}):(t.setCurrent(e),t.stem(),t.getCurrent())}}(),e.Pipeline.registerFunction(e.sv.stemmer,"stemmer-sv"),e.sv.stopWordFilter=e.generateStopWordFilter("alla allt att av blev bli blir blivit de dem den denna deras dess dessa det detta dig din dina ditt du där då efter ej eller en er era ert ett från för ha hade han hans har henne hennes hon honom hur här i icke ingen inom inte jag ju kan kunde man med mellan men mig min mina mitt mot mycket ni nu när någon något några och om oss på samma sedan sig sin sina sitta själv skulle som så sådan sådana sådant till under upp ut utan vad var vara varför varit varje vars vart vem vi vid vilka vilkas vilken vilket vår våra vårt än är åt över".split(" ")),e.Pipeline.registerFunction(e.sv.stopWordFilter,"stopWordFilter-sv")}}); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/min/lunr.tr.min.js b/v4.0.1/assets/javascripts/lunr/min/lunr.tr.min.js new file mode 100644 index 0000000000..563f6ec1f5 --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/min/lunr.tr.min.js @@ -0,0 +1,18 @@ +/*! + * Lunr languages, `Turkish` language + * https://github.com/MihaiValentin/lunr-languages + * + * Copyright 2014, Mihai Valentin + * http://www.mozilla.org/MPL/ + */ +/*! + * based on + * Snowball JavaScript Library v0.3 + * http://code.google.com/p/urim/ + * http://snowball.tartarus.org/ + * + * Copyright 2010, Oleg Mazko + * http://www.mozilla.org/MPL/ + */ + +!function(r,i){"function"==typeof define&&define.amd?define(i):"object"==typeof exports?module.exports=i():i()(r.lunr)}(this,function(){return function(r){if(void 0===r)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===r.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");r.tr=function(){this.pipeline.reset(),this.pipeline.add(r.tr.trimmer,r.tr.stopWordFilter,r.tr.stemmer),this.searchPipeline&&(this.searchPipeline.reset(),this.searchPipeline.add(r.tr.stemmer))},r.tr.wordCharacters="A-Za-zªºÀ-ÖØ-öø-ʸˠ-ˤᴀ-ᴥᴬ-ᵜᵢ-ᵥᵫ-ᵷᵹ-ᶾḀ-ỿⁱⁿₐ-ₜKÅℲⅎⅠ-ↈⱠ-ⱿꜢ-ꞇꞋ-ꞭꞰ-ꞷꟷ-ꟿꬰ-ꭚꭜ-ꭤff-stＡ-Ｚａ-ｚ",r.tr.trimmer=r.trimmerSupport.generateTrimmer(r.tr.wordCharacters),r.Pipeline.registerFunction(r.tr.trimmer,"trimmer-tr"),r.tr.stemmer=function(){var i=r.stemmerSupport.Among,e=r.stemmerSupport.SnowballProgram,n=new function(){function r(r,i,e){for(;;){var n=Dr.limit-Dr.cursor;if(Dr.in_grouping_b(r,i,e)){Dr.cursor=Dr.limit-n;break}if(Dr.cursor=Dr.limit-n,Dr.cursor<=Dr.limit_backward)return!1;Dr.cursor--}return!0}function n(){var i,e;i=Dr.limit-Dr.cursor,r(Wr,97,305);for(var n=0;nDr.limit_backward&&(Dr.cursor--,e=Dr.limit-Dr.cursor,i()))?(Dr.cursor=Dr.limit-e,!0):(Dr.cursor=Dr.limit-n,r()?(Dr.cursor=Dr.limit-n,!1):(Dr.cursor=Dr.limit-n,!(Dr.cursor<=Dr.limit_backward)&&(Dr.cursor--,!!i()&&(Dr.cursor=Dr.limit-n,!0))))}function u(r){return t(r,function(){return Dr.in_grouping_b(Wr,97,305)})}function o(){return u(function(){return Dr.eq_s_b(1,"n")})}function s(){return u(function(){return Dr.eq_s_b(1,"s")})}function c(){return u(function(){return Dr.eq_s_b(1,"y")})}function l(){return t(function(){return Dr.in_grouping_b(Lr,105,305)},function(){return Dr.out_grouping_b(Wr,97,305)})}function a(){return Dr.find_among_b(ur,10)&&l()}function m(){return n()&&Dr.in_grouping_b(Lr,105,305)&&s()}function d(){return Dr.find_among_b(or,2)}function f(){return n()&&Dr.in_grouping_b(Lr,105,305)&&c()}function b(){return n()&&Dr.find_among_b(sr,4)}function w(){return n()&&Dr.find_among_b(cr,4)&&o()}function _(){return n()&&Dr.find_among_b(lr,2)&&c()}function k(){return n()&&Dr.find_among_b(ar,2)}function p(){return n()&&Dr.find_among_b(mr,4)}function g(){return n()&&Dr.find_among_b(dr,2)}function y(){return n()&&Dr.find_among_b(fr,4)}function z(){return n()&&Dr.find_among_b(br,2)}function v(){return n()&&Dr.find_among_b(wr,2)&&c()}function h(){return Dr.eq_s_b(2,"ki")}function q(){return n()&&Dr.find_among_b(_r,2)&&o()}function C(){return n()&&Dr.find_among_b(kr,4)&&c()}function P(){return n()&&Dr.find_among_b(pr,4)}function F(){return n()&&Dr.find_among_b(gr,4)&&c()}function S(){return Dr.find_among_b(yr,4)}function W(){return n()&&Dr.find_among_b(zr,2)}function L(){return n()&&Dr.find_among_b(vr,4)}function x(){return n()&&Dr.find_among_b(hr,8)}function A(){return Dr.find_among_b(qr,2)}function E(){return n()&&Dr.find_among_b(Cr,32)&&c()}function j(){return Dr.find_among_b(Pr,8)&&c()}function T(){return n()&&Dr.find_among_b(Fr,4)&&c()}function Z(){return Dr.eq_s_b(3,"ken")&&c()}function B(){var r=Dr.limit-Dr.cursor;return!(T()||(Dr.cursor=Dr.limit-r,E()||(Dr.cursor=Dr.limit-r,j()||(Dr.cursor=Dr.limit-r,Z()))))}function D(){if(A()){var r=Dr.limit-Dr.cursor;if(S()||(Dr.cursor=Dr.limit-r,W()||(Dr.cursor=Dr.limit-r,C()||(Dr.cursor=Dr.limit-r,P()||(Dr.cursor=Dr.limit-r,F()||(Dr.cursor=Dr.limit-r))))),T())return!1}return!0}function G(){if(W()){Dr.bra=Dr.cursor,Dr.slice_del();var r=Dr.limit-Dr.cursor;return Dr.ket=Dr.cursor,x()||(Dr.cursor=Dr.limit-r,E()||(Dr.cursor=Dr.limit-r,j()||(Dr.cursor=Dr.limit-r,T()||(Dr.cursor=Dr.limit-r)))),nr=!1,!1}return!0}function H(){if(!L())return!0;var r=Dr.limit-Dr.cursor;return!E()&&(Dr.cursor=Dr.limit-r,!j())}function I(){var r,i=Dr.limit-Dr.cursor;return!(S()||(Dr.cursor=Dr.limit-i,F()||(Dr.cursor=Dr.limit-i,P()||(Dr.cursor=Dr.limit-i,C()))))||(Dr.bra=Dr.cursor,Dr.slice_del(),r=Dr.limit-Dr.cursor,Dr.ket=Dr.cursor,T()||(Dr.cursor=Dr.limit-r),!1)}function J(){var r,i=Dr.limit-Dr.cursor;if(Dr.ket=Dr.cursor,nr=!0,B()&&(Dr.cursor=Dr.limit-i,D()&&(Dr.cursor=Dr.limit-i,G()&&(Dr.cursor=Dr.limit-i,H()&&(Dr.cursor=Dr.limit-i,I()))))){if(Dr.cursor=Dr.limit-i,!x())return;Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,r=Dr.limit-Dr.cursor,S()||(Dr.cursor=Dr.limit-r,W()||(Dr.cursor=Dr.limit-r,C()||(Dr.cursor=Dr.limit-r,P()||(Dr.cursor=Dr.limit-r,F()||(Dr.cursor=Dr.limit-r))))),T()||(Dr.cursor=Dr.limit-r)}Dr.bra=Dr.cursor,Dr.slice_del()}function K(){var r,i,e,n;if(Dr.ket=Dr.cursor,h()){if(r=Dr.limit-Dr.cursor,p())return Dr.bra=Dr.cursor,Dr.slice_del(),i=Dr.limit-Dr.cursor,Dr.ket=Dr.cursor,W()?(Dr.bra=Dr.cursor,Dr.slice_del(),K()):(Dr.cursor=Dr.limit-i,a()&&(Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K()))),!0;if(Dr.cursor=Dr.limit-r,w()){if(Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,e=Dr.limit-Dr.cursor,d())Dr.bra=Dr.cursor,Dr.slice_del();else{if(Dr.cursor=Dr.limit-e,Dr.ket=Dr.cursor,!a()&&(Dr.cursor=Dr.limit-e,!m()&&(Dr.cursor=Dr.limit-e,!K())))return!0;Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K())}return!0}if(Dr.cursor=Dr.limit-r,g()){if(n=Dr.limit-Dr.cursor,d())Dr.bra=Dr.cursor,Dr.slice_del();else if(Dr.cursor=Dr.limit-n,m())Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K());else if(Dr.cursor=Dr.limit-n,!K())return!1;return!0}}return!1}function M(r){if(Dr.ket=Dr.cursor,!g()&&(Dr.cursor=Dr.limit-r,!k()))return!1;var i=Dr.limit-Dr.cursor;if(d())Dr.bra=Dr.cursor,Dr.slice_del();else if(Dr.cursor=Dr.limit-i,m())Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K());else if(Dr.cursor=Dr.limit-i,!K())return!1;return!0}function N(r){if(Dr.ket=Dr.cursor,!z()&&(Dr.cursor=Dr.limit-r,!b()))return!1;var i=Dr.limit-Dr.cursor;return!(!m()&&(Dr.cursor=Dr.limit-i,!d()))&&(Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K()),!0)}function O(){var r,i=Dr.limit-Dr.cursor;return Dr.ket=Dr.cursor,!(!w()&&(Dr.cursor=Dr.limit-i,!v()))&&(Dr.bra=Dr.cursor,Dr.slice_del(),r=Dr.limit-Dr.cursor,Dr.ket=Dr.cursor,!(!W()||(Dr.bra=Dr.cursor,Dr.slice_del(),!K()))||(Dr.cursor=Dr.limit-r,Dr.ket=Dr.cursor,!(a()||(Dr.cursor=Dr.limit-r,m()||(Dr.cursor=Dr.limit-r,K())))||(Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K()),!0)))}function Q(){var r,i,e=Dr.limit-Dr.cursor;if(Dr.ket=Dr.cursor,!p()&&(Dr.cursor=Dr.limit-e,!f()&&(Dr.cursor=Dr.limit-e,!_())))return!1;if(Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,r=Dr.limit-Dr.cursor,a())Dr.bra=Dr.cursor,Dr.slice_del(),i=Dr.limit-Dr.cursor,Dr.ket=Dr.cursor,W()||(Dr.cursor=Dr.limit-i);else if(Dr.cursor=Dr.limit-r,!W())return!0;return Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,K(),!0}function R(){var r,i,e=Dr.limit-Dr.cursor;if(Dr.ket=Dr.cursor,W())return Dr.bra=Dr.cursor,Dr.slice_del(),void K();if(Dr.cursor=Dr.limit-e,Dr.ket=Dr.cursor,q())if(Dr.bra=Dr.cursor,Dr.slice_del(),r=Dr.limit-Dr.cursor,Dr.ket=Dr.cursor,d())Dr.bra=Dr.cursor,Dr.slice_del();else{if(Dr.cursor=Dr.limit-r,Dr.ket=Dr.cursor,!a()&&(Dr.cursor=Dr.limit-r,!m())){if(Dr.cursor=Dr.limit-r,Dr.ket=Dr.cursor,!W())return;if(Dr.bra=Dr.cursor,Dr.slice_del(),!K())return}Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K())}else if(Dr.cursor=Dr.limit-e,!M(e)&&(Dr.cursor=Dr.limit-e,!N(e))){if(Dr.cursor=Dr.limit-e,Dr.ket=Dr.cursor,y())return Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,i=Dr.limit-Dr.cursor,void(a()?(Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K())):(Dr.cursor=Dr.limit-i,W()?(Dr.bra=Dr.cursor,Dr.slice_del(),K()):(Dr.cursor=Dr.limit-i,K())));if(Dr.cursor=Dr.limit-e,!O()){if(Dr.cursor=Dr.limit-e,d())return Dr.bra=Dr.cursor,void Dr.slice_del();Dr.cursor=Dr.limit-e,K()||(Dr.cursor=Dr.limit-e,Q()||(Dr.cursor=Dr.limit-e,Dr.ket=Dr.cursor,(a()||(Dr.cursor=Dr.limit-e,m()))&&(Dr.bra=Dr.cursor,Dr.slice_del(),Dr.ket=Dr.cursor,W()&&(Dr.bra=Dr.cursor,Dr.slice_del(),K()))))}}}function U(){var r;if(Dr.ket=Dr.cursor,r=Dr.find_among_b(Sr,4))switch(Dr.bra=Dr.cursor,r){case 1:Dr.slice_from("p");break;case 2:Dr.slice_from("ç");break;case 3:Dr.slice_from("t");break;case 4:Dr.slice_from("k")}}function V(){for(;;){var r=Dr.limit-Dr.cursor;if(Dr.in_grouping_b(Wr,97,305)){Dr.cursor=Dr.limit-r;break}if(Dr.cursor=Dr.limit-r,Dr.cursor<=Dr.limit_backward)return!1;Dr.cursor--}return!0}function X(r,i,e){if(Dr.cursor=Dr.limit-r,V()){var n=Dr.limit-Dr.cursor;if(!Dr.eq_s_b(1,i)&&(Dr.cursor=Dr.limit-n,!Dr.eq_s_b(1,e)))return!0;Dr.cursor=Dr.limit-r;var t=Dr.cursor;return Dr.insert(Dr.cursor,Dr.cursor,e),Dr.cursor=t,!1}return!0}function Y(){var r=Dr.limit-Dr.cursor;(Dr.eq_s_b(1,"d")||(Dr.cursor=Dr.limit-r,Dr.eq_s_b(1,"g")))&&X(r,"a","ı")&&X(r,"e","i")&&X(r,"o","u")&&X(r,"ö","ü")}function $(){for(var r,i=Dr.cursor,e=2;;){for(r=Dr.cursor;!Dr.in_grouping(Wr,97,305);){if(Dr.cursor>=Dr.limit)return Dr.cursor=r,!(e>0)&&(Dr.cursor=i,!0);Dr.cursor++}e--}}function rr(r,i,e){for(;!Dr.eq_s(i,e);){if(Dr.cursor>=Dr.limit)return!0;Dr.cursor++}return(tr=i)!=Dr.limit||(Dr.cursor=r,!1)}function ir(){var r=Dr.cursor;return!rr(r,2,"ad")||(Dr.cursor=r,!rr(r,5,"soyad"))}function er(){var r=Dr.cursor;return!ir()&&(Dr.limit_backward=r,Dr.cursor=Dr.limit,Y(),Dr.cursor=Dr.limit,U(),!0)}var nr,tr,ur=[new i("m",-1,-1),new i("n",-1,-1),new i("miz",-1,-1),new i("niz",-1,-1),new i("muz",-1,-1),new i("nuz",-1,-1),new i("müz",-1,-1),new i("nüz",-1,-1),new i("mız",-1,-1),new i("nız",-1,-1)],or=[new i("leri",-1,-1),new i("ları",-1,-1)],sr=[new i("ni",-1,-1),new i("nu",-1,-1),new i("nü",-1,-1),new i("nı",-1,-1)],cr=[new i("in",-1,-1),new i("un",-1,-1),new i("ün",-1,-1),new i("ın",-1,-1)],lr=[new i("a",-1,-1),new i("e",-1,-1)],ar=[new i("na",-1,-1),new i("ne",-1,-1)],mr=[new i("da",-1,-1),new i("ta",-1,-1),new i("de",-1,-1),new i("te",-1,-1)],dr=[new i("nda",-1,-1),new i("nde",-1,-1)],fr=[new i("dan",-1,-1),new i("tan",-1,-1),new i("den",-1,-1),new i("ten",-1,-1)],br=[new i("ndan",-1,-1),new i("nden",-1,-1)],wr=[new i("la",-1,-1),new i("le",-1,-1)],_r=[new i("ca",-1,-1),new i("ce",-1,-1)],kr=[new i("im",-1,-1),new i("um",-1,-1),new i("üm",-1,-1),new i("ım",-1,-1)],pr=[new i("sin",-1,-1),new i("sun",-1,-1),new i("sün",-1,-1),new i("sın",-1,-1)],gr=[new i("iz",-1,-1),new i("uz",-1,-1),new i("üz",-1,-1),new i("ız",-1,-1)],yr=[new i("siniz",-1,-1),new i("sunuz",-1,-1),new i("sünüz",-1,-1),new i("sınız",-1,-1)],zr=[new i("lar",-1,-1),new i("ler",-1,-1)],vr=[new i("niz",-1,-1),new i("nuz",-1,-1),new i("nüz",-1,-1),new i("nız",-1,-1)],hr=[new i("dir",-1,-1),new i("tir",-1,-1),new i("dur",-1,-1),new i("tur",-1,-1),new i("dür",-1,-1),new i("tür",-1,-1),new i("dır",-1,-1),new i("tır",-1,-1)],qr=[new i("casına",-1,-1),new i("cesine",-1,-1)],Cr=[new i("di",-1,-1),new i("ti",-1,-1),new i("dik",-1,-1),new i("tik",-1,-1),new i("duk",-1,-1),new i("tuk",-1,-1),new i("dük",-1,-1),new i("tük",-1,-1),new i("dık",-1,-1),new i("tık",-1,-1),new i("dim",-1,-1),new i("tim",-1,-1),new i("dum",-1,-1),new i("tum",-1,-1),new i("düm",-1,-1),new i("tüm",-1,-1),new i("dım",-1,-1),new i("tım",-1,-1),new i("din",-1,-1),new i("tin",-1,-1),new i("dun",-1,-1),new i("tun",-1,-1),new i("dün",-1,-1),new i("tün",-1,-1),new i("dın",-1,-1),new i("tın",-1,-1),new i("du",-1,-1),new i("tu",-1,-1),new i("dü",-1,-1),new i("tü",-1,-1),new i("dı",-1,-1),new i("tı",-1,-1)],Pr=[new i("sa",-1,-1),new i("se",-1,-1),new i("sak",-1,-1),new i("sek",-1,-1),new i("sam",-1,-1),new i("sem",-1,-1),new i("san",-1,-1),new i("sen",-1,-1)],Fr=[new i("miş",-1,-1),new i("muş",-1,-1),new i("müş",-1,-1),new i("mış",-1,-1)],Sr=[new i("b",-1,1),new i("c",-1,2),new i("d",-1,3),new i("ğ",-1,4)],Wr=[17,65,16,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,32,8,0,0,0,0,0,0,1],Lr=[1,16,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,8,0,0,0,0,0,0,1],xr=[1,64,16,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1],Ar=[17,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,130],Er=[1,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1],jr=[17],Tr=[65],Zr=[65],Br=[["a",xr,97,305],["e",Ar,101,252],["ı",Er,97,305],["i",jr,101,105],["o",Tr,111,117],["ö",Zr,246,252],["u",Tr,111,117]],Dr=new e;this.setCurrent=function(r){Dr.setCurrent(r)},this.getCurrent=function(){return Dr.getCurrent()},this.stem=function(){return!!($()&&(Dr.limit_backward=Dr.cursor,Dr.cursor=Dr.limit,J(),Dr.cursor=Dr.limit,nr&&(R(),Dr.cursor=Dr.limit_backward,er())))}};return function(r){return"function"==typeof r.update?r.update(function(r){return n.setCurrent(r),n.stem(),n.getCurrent()}):(n.setCurrent(r),n.stem(),n.getCurrent())}}(),r.Pipeline.registerFunction(r.tr.stemmer,"stemmer-tr"),r.tr.stopWordFilter=r.generateStopWordFilter("acaba altmış altı ama ancak arada aslında ayrıca bana bazı belki ben benden beni benim beri beş bile bin bir biri birkaç birkez birçok birşey birşeyi biz bizden bize bizi bizim bu buna bunda bundan bunlar bunları bunların bunu bunun burada böyle böylece da daha dahi de defa değil diye diğer doksan dokuz dolayı dolayısıyla dört edecek eden ederek edilecek ediliyor edilmesi ediyor elli en etmesi etti ettiği ettiğini eğer gibi göre halen hangi hatta hem henüz hep hepsi her herhangi herkesin hiç hiçbir iki ile ilgili ise itibaren itibariyle için işte kadar karşın katrilyon kendi kendilerine kendini kendisi kendisine kendisini kez ki kim kimden kime kimi kimse kırk milyar milyon mu mü mı nasıl ne neden nedenle nerde nerede nereye niye niçin o olan olarak oldu olduklarını olduğu olduğunu olmadı olmadığı olmak olması olmayan olmaz olsa olsun olup olur olursa oluyor on ona ondan onlar onlardan onları onların onu onun otuz oysa pek rağmen sadece sanki sekiz seksen sen senden seni senin siz sizden sizi sizin tarafından trilyon tüm var vardı ve veya ya yani yapacak yapmak yaptı yaptıkları yaptığı yaptığını yapılan yapılması yapıyor yedi yerine yetmiş yine yirmi yoksa yüz zaten çok çünkü öyle üzere üç şey şeyden şeyi şeyler şu şuna şunda şundan şunları şunu şöyle".split(" ")),r.Pipeline.registerFunction(r.tr.stopWordFilter,"stopWordFilter-tr")}}); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/min/lunr.vi.min.js b/v4.0.1/assets/javascripts/lunr/min/lunr.vi.min.js new file mode 100644 index 0000000000..22aed28c49 --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/min/lunr.vi.min.js @@ -0,0 +1 @@ +!function(e,r){"function"==typeof define&&define.amd?define(r):"object"==typeof exports?module.exports=r():r()(e.lunr)}(this,function(){return function(e){if(void 0===e)throw new Error("Lunr is not present. Please include / require Lunr before this script.");if(void 0===e.stemmerSupport)throw new Error("Lunr stemmer support is not present. Please include / require Lunr stemmer support before this script.");e.vi=function(){this.pipeline.reset(),this.pipeline.add(e.vi.stopWordFilter,e.vi.trimmer)},e.vi.wordCharacters="[A-Za-ẓ̀͐́͑̉̃̓ÂâÊêÔôĂ-ăĐ-đƠ-ơƯ-ư]",e.vi.trimmer=e.trimmerSupport.generateTrimmer(e.vi.wordCharacters),e.Pipeline.registerFunction(e.vi.trimmer,"trimmer-vi"),e.vi.stopWordFilter=e.generateStopWordFilter("là cái nhưng mà".split(" "))}}); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/lunr/tinyseg.min.js b/v4.0.1/assets/javascripts/lunr/tinyseg.min.js new file mode 100644 index 0000000000..302befbb31 --- /dev/null +++ b/v4.0.1/assets/javascripts/lunr/tinyseg.min.js @@ -0,0 +1 @@ +!function(_,t){"function"==typeof define&&define.amd?define(t):"object"==typeof exports?module.exports=t():t()(_.lunr)}(this,(function(){return function(_){function t(){var _={"[一二三四五六七八九十百千万億兆]":"M","[一-龠々〆ヵヶ]":"H","[ぁ-ん]":"I","[ァ-ヴーｱ-ﾝﾞｰ]":"K","[a-zA-Zａ-ｚＡ-Ｚ]":"A","[0-9０-９]":"N"};for(var t in this.chartype_=[],_){var H=new RegExp(t);this.chartype_.push([H,_[t]])}return this.BIAS__=-332,this.BC1__={HH:6,II:2461,KH:406,OH:-1378},this.BC2__={AA:-3267,AI:2744,AN:-878,HH:-4070,HM:-1711,HN:4012,HO:3761,IA:1327,IH:-1184,II:-1332,IK:1721,IO:5492,KI:3831,KK:-8741,MH:-3132,MK:3334,OO:-2920},this.BC3__={HH:996,HI:626,HK:-721,HN:-1307,HO:-836,IH:-301,KK:2762,MK:1079,MM:4034,OA:-1652,OH:266},this.BP1__={BB:295,OB:304,OO:-125,UB:352},this.BP2__={BO:60,OO:-1762},this.BQ1__={BHH:1150,BHM:1521,BII:-1158,BIM:886,BMH:1208,BNH:449,BOH:-91,BOO:-2597,OHI:451,OIH:-296,OKA:1851,OKH:-1020,OKK:904,OOO:2965},this.BQ2__={BHH:118,BHI:-1159,BHM:466,BIH:-919,BKK:-1720,BKO:864,OHH:-1139,OHM:-181,OIH:153,UHI:-1146},this.BQ3__={BHH:-792,BHI:2664,BII:-299,BKI:419,BMH:937,BMM:8335,BNN:998,BOH:775,OHH:2174,OHM:439,OII:280,OKH:1798,OKI:-793,OKO:-2242,OMH:-2402,OOO:11699},this.BQ4__={BHH:-3895,BIH:3761,BII:-4654,BIK:1348,BKK:-1806,BMI:-3385,BOO:-12396,OAH:926,OHH:266,OHK:-2036,ONN:-973},this.BW1__={",と":660,",同":727,"B1あ":1404,"B1同":542,"、と":660,"、同":727,"」と":1682,"あっ":1505,"いう":1743,"いっ":-2055,"いる":672,"うし":-4817,"うん":665,"から":3472,"がら":600,"こう":-790,"こと":2083,"こん":-1262,"さら":-4143,"さん":4573,"した":2641,"して":1104,"すで":-3399,"そこ":1977,"それ":-871,"たち":1122,"ため":601,"った":3463,"つい":-802,"てい":805,"てき":1249,"でき":1127,"です":3445,"では":844,"とい":-4915,"とみ":1922,"どこ":3887,"ない":5713,"なっ":3015,"など":7379,"なん":-1113,"にし":2468,"には":1498,"にも":1671,"に対":-912,"の一":-501,"の中":741,"ませ":2448,"まで":1711,"まま":2600,"まる":-2155,"やむ":-1947,"よっ":-2565,"れた":2369,"れで":-913,"をし":1860,"を見":731,"亡く":-1886,"京都":2558,"取り":-2784,"大き":-2604,"大阪":1497,"平方":-2314,"引き":-1336,"日本":-195,"本当":-2423,"毎日":-2113,"目指":-724,"Ｂ１あ":1404,"Ｂ１同":542,"｣と":1682},this.BW2__={"..":-11822,11:-669,"――":-5730,"−−":-13175,"いう":-1609,"うか":2490,"かし":-1350,"かも":-602,"から":-7194,"かれ":4612,"がい":853,"がら":-3198,"きた":1941,"くな":-1597,"こと":-8392,"この":-4193,"させ":4533,"され":13168,"さん":-3977,"しい":-1819,"しか":-545,"した":5078,"して":972,"しな":939,"その":-3744,"たい":-1253,"たた":-662,"ただ":-3857,"たち":-786,"たと":1224,"たは":-939,"った":4589,"って":1647,"っと":-2094,"てい":6144,"てき":3640,"てく":2551,"ては":-3110,"ても":-3065,"でい":2666,"でき":-1528,"でし":-3828,"です":-4761,"でも":-4203,"とい":1890,"とこ":-1746,"とと":-2279,"との":720,"とみ":5168,"とも":-3941,"ない":-2488,"なが":-1313,"など":-6509,"なの":2614,"なん":3099,"にお":-1615,"にし":2748,"にな":2454,"によ":-7236,"に対":-14943,"に従":-4688,"に関":-11388,"のか":2093,"ので":-7059,"のに":-6041,"のの":-6125,"はい":1073,"はが":-1033,"はず":-2532,"ばれ":1813,"まし":-1316,"まで":-6621,"まれ":5409,"めて":-3153,"もい":2230,"もの":-10713,"らか":-944,"らし":-1611,"らに":-1897,"りし":651,"りま":1620,"れた":4270,"れて":849,"れば":4114,"ろう":6067,"われ":7901,"を通":-11877,"んだ":728,"んな":-4115,"一人":602,"一方":-1375,"一日":970,"一部":-1051,"上が":-4479,"会社":-1116,"出て":2163,"分の":-7758,"同党":970,"同日":-913,"大阪":-2471,"委員":-1250,"少な":-1050,"年度":-8669,"年間":-1626,"府県":-2363,"手権":-1982,"新聞":-4066,"日新":-722,"日本":-7068,"日米":3372,"曜日":-601,"朝鮮":-2355,"本人":-2697,"東京":-1543,"然と":-1384,"社会":-1276,"立て":-990,"第に":-1612,"米国":-4268,"１１":-669},this.BW3__={"あた":-2194,"あり":719,"ある":3846,"い.":-1185,"い。":-1185,"いい":5308,"いえ":2079,"いく":3029,"いた":2056,"いっ":1883,"いる":5600,"いわ":1527,"うち":1117,"うと":4798,"えと":1454,"か.":2857,"か。":2857,"かけ":-743,"かっ":-4098,"かに":-669,"から":6520,"かり":-2670,"が,":1816,"が、":1816,"がき":-4855,"がけ":-1127,"がっ":-913,"がら":-4977,"がり":-2064,"きた":1645,"けど":1374,"こと":7397,"この":1542,"ころ":-2757,"さい":-714,"さを":976,"し,":1557,"し、":1557,"しい":-3714,"した":3562,"して":1449,"しな":2608,"しま":1200,"す.":-1310,"す。":-1310,"する":6521,"ず,":3426,"ず、":3426,"ずに":841,"そう":428,"た.":8875,"た。":8875,"たい":-594,"たの":812,"たり":-1183,"たる":-853,"だ.":4098,"だ。":4098,"だっ":1004,"った":-4748,"って":300,"てい":6240,"てお":855,"ても":302,"です":1437,"でに":-1482,"では":2295,"とう":-1387,"とし":2266,"との":541,"とも":-3543,"どう":4664,"ない":1796,"なく":-903,"など":2135,"に,":-1021,"に、":-1021,"にし":1771,"にな":1906,"には":2644,"の,":-724,"の、":-724,"の子":-1e3,"は,":1337,"は、":1337,"べき":2181,"まし":1113,"ます":6943,"まっ":-1549,"まで":6154,"まれ":-793,"らし":1479,"られ":6820,"るる":3818,"れ,":854,"れ、":854,"れた":1850,"れて":1375,"れば":-3246,"れる":1091,"われ":-605,"んだ":606,"んで":798,"カ月":990,"会議":860,"入り":1232,"大会":2217,"始め":1681,"市":965,"新聞":-5055,"日,":974,"日、":974,"社会":2024,"ｶ月":990},this.TC1__={AAA:1093,HHH:1029,HHM:580,HII:998,HOH:-390,HOM:-331,IHI:1169,IOH:-142,IOI:-1015,IOM:467,MMH:187,OOI:-1832},this.TC2__={HHO:2088,HII:-1023,HMM:-1154,IHI:-1965,KKH:703,OII:-2649},this.TC3__={AAA:-294,HHH:346,HHI:-341,HII:-1088,HIK:731,HOH:-1486,IHH:128,IHI:-3041,IHO:-1935,IIH:-825,IIM:-1035,IOI:-542,KHH:-1216,KKA:491,KKH:-1217,KOK:-1009,MHH:-2694,MHM:-457,MHO:123,MMH:-471,NNH:-1689,NNO:662,OHO:-3393},this.TC4__={HHH:-203,HHI:1344,HHK:365,HHM:-122,HHN:182,HHO:669,HIH:804,HII:679,HOH:446,IHH:695,IHO:-2324,IIH:321,III:1497,IIO:656,IOO:54,KAK:4845,KKA:3386,KKK:3065,MHH:-405,MHI:201,MMH:-241,MMM:661,MOM:841},this.TQ1__={BHHH:-227,BHHI:316,BHIH:-132,BIHH:60,BIII:1595,BNHH:-744,BOHH:225,BOOO:-908,OAKK:482,OHHH:281,OHIH:249,OIHI:200,OIIH:-68},this.TQ2__={BIHH:-1401,BIII:-1033,BKAK:-543,BOOO:-5591},this.TQ3__={BHHH:478,BHHM:-1073,BHIH:222,BHII:-504,BIIH:-116,BIII:-105,BMHI:-863,BMHM:-464,BOMH:620,OHHH:346,OHHI:1729,OHII:997,OHMH:481,OIHH:623,OIIH:1344,OKAK:2792,OKHH:587,OKKA:679,OOHH:110,OOII:-685},this.TQ4__={BHHH:-721,BHHM:-3604,BHII:-966,BIIH:-607,BIII:-2181,OAAA:-2763,OAKK:180,OHHH:-294,OHHI:2446,OHHO:480,OHIH:-1573,OIHH:1935,OIHI:-493,OIIH:626,OIII:-4007,OKAK:-8156},this.TW1__={"につい":-4681,"東京都":2026},this.TW2__={"ある程":-2049,"いった":-1256,"ころが":-2434,"しょう":3873,"その後":-4430,"だって":-1049,"ていた":1833,"として":-4657,"ともに":-4517,"もので":1882,"一気に":-792,"初めて":-1512,"同時に":-8097,"大きな":-1255,"対して":-2721,"社会党":-3216},this.TW3__={"いただ":-1734,"してい":1314,"として":-4314,"につい":-5483,"にとっ":-5989,"に当た":-6247,"ので,":-727,"ので、":-727,"のもの":-600,"れから":-3752,"十二月":-2287},this.TW4__={"いう.":8576,"いう。":8576,"からな":-2348,"してい":2958,"たが,":1516,"たが、":1516,"ている":1538,"という":1349,"ました":5543,"ません":1097,"ようと":-4258,"よると":5865},this.UC1__={A:484,K:93,M:645,O:-505},this.UC2__={A:819,H:1059,I:409,M:3987,N:5775,O:646},this.UC3__={A:-1370,I:2311},this.UC4__={A:-2643,H:1809,I:-1032,K:-3450,M:3565,N:3876,O:6646},this.UC5__={H:313,I:-1238,K:-799,M:539,O:-831},this.UC6__={H:-506,I:-253,K:87,M:247,O:-387},this.UP1__={O:-214},this.UP2__={B:69,O:935},this.UP3__={B:189},this.UQ1__={BH:21,BI:-12,BK:-99,BN:142,BO:-56,OH:-95,OI:477,OK:410,OO:-2422},this.UQ2__={BH:216,BI:113,OK:1759},this.UQ3__={BA:-479,BH:42,BI:1913,BK:-7198,BM:3160,BN:6427,BO:14761,OI:-827,ON:-3212},this.UW1__={",":156,"、":156,"「":-463,"あ":-941,"う":-127,"が":-553,"き":121,"こ":505,"で":-201,"と":-547,"ど":-123,"に":-789,"の":-185,"は":-847,"も":-466,"や":-470,"よ":182,"ら":-292,"り":208,"れ":169,"を":-446,"ん":-137,"・":-135,"主":-402,"京":-268,"区":-912,"午":871,"国":-460,"大":561,"委":729,"市":-411,"日":-141,"理":361,"生":-408,"県":-386,"都":-718,"｢":-463,"･":-135},this.UW2__={",":-829,"、":-829,"〇":892,"「":-645,"」":3145,"あ":-538,"い":505,"う":134,"お":-502,"か":1454,"が":-856,"く":-412,"こ":1141,"さ":878,"ざ":540,"し":1529,"す":-675,"せ":300,"そ":-1011,"た":188,"だ":1837,"つ":-949,"て":-291,"で":-268,"と":-981,"ど":1273,"な":1063,"に":-1764,"の":130,"は":-409,"ひ":-1273,"べ":1261,"ま":600,"も":-1263,"や":-402,"よ":1639,"り":-579,"る":-694,"れ":571,"を":-2516,"ん":2095,"ア":-587,"カ":306,"キ":568,"ッ":831,"三":-758,"不":-2150,"世":-302,"中":-968,"主":-861,"事":492,"人":-123,"会":978,"保":362,"入":548,"初":-3025,"副":-1566,"北":-3414,"区":-422,"大":-1769,"天":-865,"太":-483,"子":-1519,"学":760,"実":1023,"小":-2009,"市":-813,"年":-1060,"強":1067,"手":-1519,"揺":-1033,"政":1522,"文":-1355,"新":-1682,"日":-1815,"明":-1462,"最":-630,"朝":-1843,"本":-1650,"東":-931,"果":-665,"次":-2378,"民":-180,"気":-1740,"理":752,"発":529,"目":-1584,"相":-242,"県":-1165,"立":-763,"第":810,"米":509,"自":-1353,"行":838,"西":-744,"見":-3874,"調":1010,"議":1198,"込":3041,"開":1758,"間":-1257,"｢":-645,"｣":3145,"ｯ":831,"ｱ":-587,"ｶ":306,"ｷ":568},this.UW3__={",":4889,1:-800,"−":-1723,"、":4889,"々":-2311,"〇":5827,"」":2670,"〓":-3573,"あ":-2696,"い":1006,"う":2342,"え":1983,"お":-4864,"か":-1163,"が":3271,"く":1004,"け":388,"げ":401,"こ":-3552,"ご":-3116,"さ":-1058,"し":-395,"す":584,"せ":3685,"そ":-5228,"た":842,"ち":-521,"っ":-1444,"つ":-1081,"て":6167,"で":2318,"と":1691,"ど":-899,"な":-2788,"に":2745,"の":4056,"は":4555,"ひ":-2171,"ふ":-1798,"へ":1199,"ほ":-5516,"ま":-4384,"み":-120,"め":1205,"も":2323,"や":-788,"よ":-202,"ら":727,"り":649,"る":5905,"れ":2773,"わ":-1207,"を":6620,"ん":-518,"ア":551,"グ":1319,"ス":874,"ッ":-1350,"ト":521,"ム":1109,"ル":1591,"ロ":2201,"ン":278,"・":-3794,"一":-1619,"下":-1759,"世":-2087,"両":3815,"中":653,"主":-758,"予":-1193,"二":974,"人":2742,"今":792,"他":1889,"以":-1368,"低":811,"何":4265,"作":-361,"保":-2439,"元":4858,"党":3593,"全":1574,"公":-3030,"六":755,"共":-1880,"円":5807,"再":3095,"分":457,"初":2475,"別":1129,"前":2286,"副":4437,"力":365,"動":-949,"務":-1872,"化":1327,"北":-1038,"区":4646,"千":-2309,"午":-783,"協":-1006,"口":483,"右":1233,"各":3588,"合":-241,"同":3906,"和":-837,"員":4513,"国":642,"型":1389,"場":1219,"外":-241,"妻":2016,"学":-1356,"安":-423,"実":-1008,"家":1078,"小":-513,"少":-3102,"州":1155,"市":3197,"平":-1804,"年":2416,"広":-1030,"府":1605,"度":1452,"建":-2352,"当":-3885,"得":1905,"思":-1291,"性":1822,"戸":-488,"指":-3973,"政":-2013,"教":-1479,"数":3222,"文":-1489,"新":1764,"日":2099,"旧":5792,"昨":-661,"時":-1248,"曜":-951,"最":-937,"月":4125,"期":360,"李":3094,"村":364,"東":-805,"核":5156,"森":2438,"業":484,"氏":2613,"民":-1694,"決":-1073,"法":1868,"海":-495,"無":979,"物":461,"特":-3850,"生":-273,"用":914,"町":1215,"的":7313,"直":-1835,"省":792,"県":6293,"知":-1528,"私":4231,"税":401,"立":-960,"第":1201,"米":7767,"系":3066,"約":3663,"級":1384,"統":-4229,"総":1163,"線":1255,"者":6457,"能":725,"自":-2869,"英":785,"見":1044,"調":-562,"財":-733,"費":1777,"車":1835,"軍":1375,"込":-1504,"通":-1136,"選":-681,"郎":1026,"郡":4404,"部":1200,"金":2163,"長":421,"開":-1432,"間":1302,"関":-1282,"雨":2009,"電":-1045,"非":2066,"駅":1620,"１":-800,"｣":2670,"･":-3794,"ｯ":-1350,"ｱ":551,"ｸﾞ":1319,"ｽ":874,"ﾄ":521,"ﾑ":1109,"ﾙ":1591,"ﾛ":2201,"ﾝ":278},this.UW4__={",":3930,".":3508,"―":-4841,"、":3930,"。":3508,"〇":4999,"「":1895,"」":3798,"〓":-5156,"あ":4752,"い":-3435,"う":-640,"え":-2514,"お":2405,"か":530,"が":6006,"き":-4482,"ぎ":-3821,"く":-3788,"け":-4376,"げ":-4734,"こ":2255,"ご":1979,"さ":2864,"し":-843,"じ":-2506,"す":-731,"ず":1251,"せ":181,"そ":4091,"た":5034,"だ":5408,"ち":-3654,"っ":-5882,"つ":-1659,"て":3994,"で":7410,"と":4547,"な":5433,"に":6499,"ぬ":1853,"ね":1413,"の":7396,"は":8578,"ば":1940,"ひ":4249,"び":-4134,"ふ":1345,"へ":6665,"べ":-744,"ほ":1464,"ま":1051,"み":-2082,"む":-882,"め":-5046,"も":4169,"ゃ":-2666,"や":2795,"ょ":-1544,"よ":3351,"ら":-2922,"り":-9726,"る":-14896,"れ":-2613,"ろ":-4570,"わ":-1783,"を":13150,"ん":-2352,"カ":2145,"コ":1789,"セ":1287,"ッ":-724,"ト":-403,"メ":-1635,"ラ":-881,"リ":-541,"ル":-856,"ン":-3637,"・":-4371,"ー":-11870,"一":-2069,"中":2210,"予":782,"事":-190,"井":-1768,"人":1036,"以":544,"会":950,"体":-1286,"作":530,"側":4292,"先":601,"党":-2006,"共":-1212,"内":584,"円":788,"初":1347,"前":1623,"副":3879,"力":-302,"動":-740,"務":-2715,"化":776,"区":4517,"協":1013,"参":1555,"合":-1834,"和":-681,"員":-910,"器":-851,"回":1500,"国":-619,"園":-1200,"地":866,"場":-1410,"塁":-2094,"士":-1413,"多":1067,"大":571,"子":-4802,"学":-1397,"定":-1057,"寺":-809,"小":1910,"屋":-1328,"山":-1500,"島":-2056,"川":-2667,"市":2771,"年":374,"庁":-4556,"後":456,"性":553,"感":916,"所":-1566,"支":856,"改":787,"政":2182,"教":704,"文":522,"方":-856,"日":1798,"時":1829,"最":845,"月":-9066,"木":-485,"来":-442,"校":-360,"業":-1043,"氏":5388,"民":-2716,"気":-910,"沢":-939,"済":-543,"物":-735,"率":672,"球":-1267,"生":-1286,"産":-1101,"田":-2900,"町":1826,"的":2586,"目":922,"省":-3485,"県":2997,"空":-867,"立":-2112,"第":788,"米":2937,"系":786,"約":2171,"経":1146,"統":-1169,"総":940,"線":-994,"署":749,"者":2145,"能":-730,"般":-852,"行":-792,"規":792,"警":-1184,"議":-244,"谷":-1e3,"賞":730,"車":-1481,"軍":1158,"輪":-1433,"込":-3370,"近":929,"道":-1291,"選":2596,"郎":-4866,"都":1192,"野":-1100,"銀":-2213,"長":357,"間":-2344,"院":-2297,"際":-2604,"電":-878,"領":-1659,"題":-792,"館":-1984,"首":1749,"高":2120,"｢":1895,"｣":3798,"･":-4371,"ｯ":-724,"ｰ":-11870,"ｶ":2145,"ｺ":1789,"ｾ":1287,"ﾄ":-403,"ﾒ":-1635,"ﾗ":-881,"ﾘ":-541,"ﾙ":-856,"ﾝ":-3637},this.UW5__={",":465,".":-299,1:-514,E2:-32768,"]":-2762,"、":465,"。":-299,"「":363,"あ":1655,"い":331,"う":-503,"え":1199,"お":527,"か":647,"が":-421,"き":1624,"ぎ":1971,"く":312,"げ":-983,"さ":-1537,"し":-1371,"す":-852,"だ":-1186,"ち":1093,"っ":52,"つ":921,"て":-18,"で":-850,"と":-127,"ど":1682,"な":-787,"に":-1224,"の":-635,"は":-578,"べ":1001,"み":502,"め":865,"ゃ":3350,"ょ":854,"り":-208,"る":429,"れ":504,"わ":419,"を":-1264,"ん":327,"イ":241,"ル":451,"ン":-343,"中":-871,"京":722,"会":-1153,"党":-654,"務":3519,"区":-901,"告":848,"員":2104,"大":-1296,"学":-548,"定":1785,"嵐":-1304,"市":-2991,"席":921,"年":1763,"思":872,"所":-814,"挙":1618,"新":-1682,"日":218,"月":-4353,"査":932,"格":1356,"機":-1508,"氏":-1347,"田":240,"町":-3912,"的":-3149,"相":1319,"省":-1052,"県":-4003,"研":-997,"社":-278,"空":-813,"統":1955,"者":-2233,"表":663,"語":-1073,"議":1219,"選":-1018,"郎":-368,"長":786,"間":1191,"題":2368,"館":-689,"１":-514,"Ｅ２":-32768,"｢":363,"ｲ":241,"ﾙ":451,"ﾝ":-343},this.UW6__={",":227,".":808,1:-270,E1:306,"、":227,"。":808,"あ":-307,"う":189,"か":241,"が":-73,"く":-121,"こ":-200,"じ":1782,"す":383,"た":-428,"っ":573,"て":-1014,"で":101,"と":-105,"な":-253,"に":-149,"の":-417,"は":-236,"も":-206,"り":187,"る":-135,"を":195,"ル":-673,"ン":-496,"一":-277,"中":201,"件":-800,"会":624,"前":302,"区":1792,"員":-1212,"委":798,"学":-960,"市":887,"広":-695,"後":535,"業":-697,"相":753,"社":-507,"福":974,"空":-822,"者":1811,"連":463,"郎":1082,"１":-270,"Ｅ１":306,"ﾙ":-673,"ﾝ":-496},this}t.prototype.ctype_=function(_){for(var t in this.chartype_)if(_.match(this.chartype_[t][0]))return this.chartype_[t][1];return"O"},t.prototype.ts_=function(_){return _||0},t.prototype.segment=function(_){if(null==_||null==_||""==_)return[];var t=[],H=["B3","B2","B1"],s=["O","O","O"],h=_.split("");for(K=0;K0&&(t.push(i),i="",N="B"),I=O,O=B,B=N,i+=H[K]}return t.push(i),t},_.TinySegmenter=t}})); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/vendor.4d7724a9.min.js b/v4.0.1/assets/javascripts/vendor.4d7724a9.min.js new file mode 100644 index 0000000000..6543295210 --- /dev/null +++ b/v4.0.1/assets/javascripts/vendor.4d7724a9.min.js @@ -0,0 +1,29 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[1],[,,function(t,e,n){"use strict";function r(t){return"function"==typeof(null==t?void 0:t.lift)}function i(t){return e=>{if(r(e))return e.lift((function(e){try{return t(e,this)}catch(t){this.error(t)}}));throw new TypeError("Unable to lift unknown Observable type")}}n.d(e,"a",(function(){return r})),n.d(e,"b",(function(){return i}))},function(t,e,n){"use strict";n.d(e,"a",(function(){return i}));var r=n(25);class i extends r.b{constructor(t,e,n,r,i){super(t),this.onUnsubscribe=i,e&&(this._next=function(t){try{e(t)}catch(t){this.error(t)}}),n&&(this._error=function(t){try{n(t)}catch(t){this.destination.error(t)}this.unsubscribe()}),r&&(this._complete=function(){try{r()}catch(t){this.destination.error(t)}this.unsubscribe()})}unsubscribe(){var t;!this.closed&&(null===(t=this.onUnsubscribe)||void 0===t||t.call(this)),super.unsubscribe()}}},,,function(t,e,n){"use strict";n.d(e,"a",(function(){return a}));var r=n(25),i=n(8),o=n(14),s=n(34),c=n(19),u=n(31);class a{constructor(t){t&&(this._subscribe=t)}lift(t){const e=new a;return e.source=this,e.operator=t,e}subscribe(t,e,n){const o=(s=t)&&s instanceof r.b||function(t){return t&&"function"==typeof t.next&&"function"==typeof t.error&&"function"==typeof t.complete}(s)&&Object(i.c)(s)?t:new r.a(t,e,n);var s;const{operator:u,source:a}=this;return o.add(u?u.call(o,a):a||c.a.useDeprecatedSynchronousErrorHandling?this._subscribe(o):this._trySubscribe(o)),o}_trySubscribe(t){try{return this._subscribe(t)}catch(e){if(c.a.useDeprecatedSynchronousErrorHandling)throw e;!function(t){for(;t;){const{closed:e,destination:n,isStopped:i}=t;if(e||i)return!1;t=n&&n instanceof r.b?n:null}return!0}(t)?Object(u.a)(e):t.error(e)}}forEach(t,e){return new(e=l(e))((e,n)=>{let r;r=this.subscribe(e=>{try{t(e)}catch(t){n(t),null==r||r.unsubscribe()}},n,e)})}_subscribe(t){var e;return null===(e=this.source)||void 0===e?void 0:e.subscribe(t)}[o.a](){return this}pipe(...t){return t.length?Object(s.b)(t)(this):this}toPromise(t){return new(t=l(t))((t,e)=>{let n;this.subscribe(t=>n=t,t=>e(t),()=>t(n))})}}function l(t){var e;return null!==(e=null!=t?t:c.a.Promise)&&void 0!==e?e:Promise}a.create=t=>new a(t)},,function(t,e,n){"use strict";n.d(e,"b",(function(){return u})),n.d(e,"a",(function(){return a})),n.d(e,"c",(function(){return l}));var r=n(21),i=n(44);const o=Object(i.a)(t=>function(e){t(this),this.message=e?`${e.length} errors occurred during unsubscription:\n${e.map((t,e)=>`${e+1}) ${t.toString()}`).join("\n ")}`:"",this.name="UnsubscriptionError",this.errors=e});var s,c=n(18);class u{constructor(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._teardowns=null}unsubscribe(){let t;if(!this.closed){this.closed=!0;const{_parentage:e}=this;if(Array.isArray(e))for(const t of e)t.remove(this);else null==e||e.remove(this);const{initialTeardown:n}=this;if(Object(r.a)(n))try{n()}catch(e){t=e instanceof o?e.errors:[e]}const{_teardowns:i}=this;if(i){this._teardowns=null;for(const e of i)try{f(e)}catch(e){t=null!=t?t:[],e instanceof o?t=[...t,...e.errors]:t.push(e)}}if(t)throw new o(t)}}add(t){var e;if(t&&t!==this)if(this.closed)f(t);else{if(t instanceof u){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._teardowns=null!==(e=this._teardowns)&&void 0!==e?e:[]).push(t)}}_hasParent(t){const{_parentage:e}=this;return e===t||Array.isArray(e)&&e.includes(t)}_addParent(t){const{_parentage:e}=this;this._parentage=Array.isArray(e)?(e.push(t),e):e?[e,t]:t}_removeParent(t){const{_parentage:e}=this;e===t?this._parentage=null:Array.isArray(e)&&Object(c.a)(e,t)}remove(t){const{_teardowns:e}=this;e&&Object(c.a)(e,t),t instanceof u&&t._removeParent(this)}}u.EMPTY=((s=new u).closed=!0,s);const a=u.EMPTY;function l(t){return t instanceof u||t&&"closed"in t&&"function"==typeof t.remove&&"function"==typeof t.add&&"function"==typeof t.unsubscribe}function f(t){"function"==typeof t?t():t.unsubscribe()}},function(t,e,n){"use strict";n.d(e,"a",(function(){return m}));var r=n(47),i=n(31);const o="function"==typeof Symbol&&Symbol.iterator?Symbol.iterator:"@@iterator";var s=n(14);var c=n(32);function u(t){return!!t&&"function"!=typeof t.subscribe&&"function"==typeof t.then}function a(t,e,n,r){return new(n||(n=Promise))((function(i,o){function s(t){try{u(r.next(t))}catch(t){o(t)}}function c(t){try{u(r.throw(t))}catch(t){o(t)}}function u(t){var e;t.done?i(t.value):(e=t.value,e instanceof n?e:new n((function(t){t(e)}))).then(s,c)}u((r=r.apply(t,e||[])).next())}))}Object.create;function l(t){var e="function"==typeof Symbol&&Symbol.iterator,n=e&&t[e],r=0;if(n)return n.call(t);if(t&&"number"==typeof t.length)return{next:function(){return t&&r>=t.length&&(t=void 0),{value:t&&t[r++],done:!t}}};throw new TypeError(e?"Object is not iterable.":"Symbol.iterator is not defined.")}function f(t){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var e,n=t[Symbol.asyncIterator];return n?n.call(t):(t=l(t),e={},r("next"),r("throw"),r("return"),e[Symbol.asyncIterator]=function(){return this},e);function r(n){e[n]=t[n]&&function(e){return new Promise((function(r,i){(function(t,e,n,r){Promise.resolve(r).then((function(e){t({value:e,done:n})}),e)})(r,i,(e=t[n](e)).done,e.value)}))}}}Object.create;function d(t){return e=>{(function(t,e){var n,r,i,o;return a(this,void 0,void 0,(function*(){try{for(n=f(t);!(r=yield n.next()).done;){const t=r.value;e.next(t)}}catch(t){i={error:t}}finally{try{r&&!r.done&&(o=n.return)&&(yield o.call(n))}finally{if(i)throw i.error}}e.complete()}))})(t,e).catch(t=>e.error(t))}}var h=n(6),b=n(8);var p=n(33);function v(t,e){if(null!=t){if(function(t){return t&&"function"==typeof t[s.a]}(t))return function(t,e){return new h.a(n=>{const r=new b.b;return r.add(e.schedule(()=>{const i=t[s.a]();r.add(i.subscribe({next(t){r.add(e.schedule(()=>n.next(t)))},error(t){r.add(e.schedule(()=>n.error(t)))},complete(){r.add(e.schedule(()=>n.complete()))}}))})),r})}(t,e);if(u(t))return function(t,e){return new h.a(n=>{const r=new b.b;return r.add(e.schedule(()=>t.then(t=>{r.add(e.schedule(()=>{n.next(t),r.add(e.schedule(()=>n.complete()))}))},t=>{r.add(e.schedule(()=>n.error(t)))}))),r})}(t,e);if(Object(c.a)(t))return Object(p.a)(t,e);if(function(t){return t&&"function"==typeof t[o]}(t)||"string"==typeof t)return function(t,e){if(!t)throw new Error("Iterable cannot be null");return new h.a(n=>{const r=new b.b;let i;return r.add(()=>{i&&"function"==typeof i.return&&i.return()}),r.add(e.schedule(()=>{i=t[o](),r.add(e.schedule((function(){if(n.closed)return;let t,e;try{const n=i.next();t=n.value,e=n.done}catch(t){return void n.error(t)}e?n.complete():(n.next(t),this.schedule())})))})),r})}(t,e);if(Symbol&&Symbol.asyncIterator&&"function"==typeof t[Symbol.asyncIterator])return function(t,e){if(!t)throw new Error("Iterable cannot be null");return new h.a(n=>{const r=new b.b;return r.add(e.schedule(()=>{const i=t[Symbol.asyncIterator]();r.add(e.schedule((function(){i.next().then(t=>{t.done?n.complete():(n.next(t.value),this.schedule())})})))})),r})}(t,e)}throw new TypeError((null!==t&&typeof t||t)+" is not observable")}function m(t,e){return e?v(t,e):t instanceof h.a?t:new h.a(function(t){if(t&&"function"==typeof t[s.a])return l=t,t=>{const e=l[s.a]();if("function"!=typeof e.subscribe)throw new TypeError("Provided object does not correctly implement Symbol.observable");return e.subscribe(t)};if(Object(c.a)(t))return Object(r.a)(t);if(u(t))return a=t,t=>(a.then(e=>{t.closed||(t.next(e),t.complete())},e=>t.error(e)).then(null,i.a),t);if(t&&"function"==typeof t[o])return n=t,t=>{const e=n[o]();for(;;){let n;try{n=e.next()}catch(e){return void t.error(e)}if(n.done){t.complete();break}if(t.next(n.value),t.closed)break}return"function"==typeof e.return&&t.add(()=>{e.return&&e.return()}),t};if(Symbol&&Symbol.asyncIterator&&t&&"function"==typeof t[Symbol.asyncIterator])return d(t);{const n=null!==(e=t)&&"object"==typeof e?"an invalid object":`'${t}'`;throw new TypeError(`You provided ${n} where a stream was expected. You can provide an Observable, Promise, Array, AsyncIterable, or Iterable.`)}var e; +/*! ***************************************************************************** +Copyright (c) Microsoft Corporation. + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH +REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY +AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, +INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM +LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR +OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR +PERFORMANCE OF THIS SOFTWARE. +***************************************************************************** */var n;var a;var l}(t))}},function(t,e,n){"use strict";n.d(e,"a",(function(){return o}));var r=n(2),i=n(3);function o(t,e){return Object(r.b)((n,r)=>{let o=0;n.subscribe(new i.a(r,n=>{r.next(t.call(e,n,o++))}))})}},,function(t,e,n){"use strict";function r(t){return t}n.d(e,"a",(function(){return r}))},function(t,e,n){"use strict";n.d(e,"a",(function(){return s}));var r=n(9),i=n(2),o=n(3);function s(t,e){return Object(i.b)((n,i)=>{let s=null,c=0,u=!1;const a=()=>u&&!s&&i.complete();n.subscribe(new o.a(i,n=>{null==s||s.unsubscribe();let u=0,l=c++;Object(r.a)(t(n,l)).subscribe(s=new o.a(i,t=>i.next(e?e(n,t,l,u++):t),void 0,()=>{s=null,a()}))},void 0,()=>{u=!0,a()}))})}},function(t,e,n){"use strict";n.d(e,"a",(function(){return r}));const r="function"==typeof Symbol&&Symbol.observable||"@@observable"},function(t,e,n){"use strict";function r(t){return t&&"function"==typeof t.schedule}n.d(e,"a",(function(){return r}))},function(t,e,n){"use strict";function r(){}n.d(e,"a",(function(){return r}))},,function(t,e,n){"use strict";function r(t,e){if(t){const n=t.indexOf(e);0<=n&&t.splice(n,1)}}n.d(e,"a",(function(){return r}))},function(t,e,n){"use strict";n.d(e,"a",(function(){return r}));const r={onUnhandledError:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1}},,function(t,e,n){"use strict";function r(t){return"function"==typeof t}n.d(e,"a",(function(){return r}))},function(t,e,n){"use strict";n.d(e,"a",(function(){return s}));var r=n(6),i=n(47),o=n(33);function s(t,e){return e?Object(o.a)(t,e):new r.a(Object(i.a)(t))}},,,function(t,e,n){"use strict";n.d(e,"b",(function(){return u})),n.d(e,"a",(function(){return a}));var r=n(21),i=n(8),o=n(19),s=n(31),c=n(16);class u extends i.b{constructor(t){super(),this.isStopped=!1,t?(this.destination=t,Object(i.c)(t)&&t.add(this)):this.destination=f}static create(t,e,n){return new a(t,e,n)}next(t){this.isStopped||this._next(t)}error(t){this.isStopped||(this.isStopped=!0,this._error(t))}complete(){this.isStopped||(this.isStopped=!0,this._complete())}unsubscribe(){this.closed||(this.isStopped=!0,super.unsubscribe())}_next(t){this.destination.next(t)}_error(t){this.destination.error(t),this.unsubscribe()}_complete(){this.destination.complete(),this.unsubscribe()}}class a extends u{constructor(t,e,n){if(super(),this.destination=f,(t||e||n)&&t!==f){let i;if(Object(r.a)(t))i=t;else if(t){let r;({next:i,error:e,complete:n}=t),this&&o.a.useDeprecatedNextContext?(r=Object.create(t),r.unsubscribe=()=>this.unsubscribe()):r=t,i=null==i?void 0:i.bind(r),e=null==e?void 0:e.bind(r),n=null==n?void 0:n.bind(r)}this.destination={next:i||c.a,error:e||l,complete:n||c.a}}}}function l(t){if(o.a.useDeprecatedSynchronousErrorHandling)throw t;Object(s.a)(t)}const f={closed:!0,next:c.a,error:l,complete:c.a}},function(t,e,n){"use strict";n.d(e,"a",(function(){return i}));var r=n(6);const i=new r.a(t=>t.complete())},,function(t,e,n){"use strict";n.d(e,"a",(function(){return c}));var r=n(10),i=n(9),o=n(2),s=n(3);function c(t,e,n=1/0){return"function"==typeof e?o=>o.pipe(c((n,o)=>Object(i.a)(t(n,o)).pipe(Object(r.a)((t,r)=>e(n,t,o,r))),n)):("number"==typeof e&&(n=e),Object(o.b)((e,r)=>{let o=!1,c=0,u=0,a=[];const l=()=>o&&!c&&r.complete(),f=e=>{c++,r.add(Object(i.a)(t(e,u++)).subscribe(new s.a(r,t=>r.next(t),void 0,()=>{c--,a.length&&(()=>{for(;c0;)f(a.shift())})(),l()})))};let d;return d=e.subscribe(new s.a(r,t=>c{o=!0,l(),null==d||d.unsubscribe()})),()=>{a=null}}))}},function(t,e,n){"use strict";n.d(e,"a",(function(){return u}));var r=n(6),i=n(8),o=n(44);const s=Object(o.a)(t=>function(){t(this),this.message="object unsubscribed"});var c=n(18);class u extends r.a{constructor(){super(),this.observers=[],this.closed=!1,this.isStopped=!1,this.hasError=!1,this.thrownError=null}lift(t){const e=new a(this,this);return e.operator=t,e}_throwIfClosed(){if(this.closed)throw new s}next(t){if(this._throwIfClosed(),!this.isStopped){const e=this.observers.slice();for(const n of e)n.next(t)}}error(t){if(this._throwIfClosed(),!this.isStopped){this.hasError=this.isStopped=!0,this.thrownError=t;const{observers:e}=this;for(;e.length;)e.shift().error(t)}}complete(){if(this._throwIfClosed(),!this.isStopped){this.isStopped=!0;const{observers:t}=this;for(;t.length;)t.shift().complete()}}unsubscribe(){this.isStopped=this.closed=!0,this.observers=null}_trySubscribe(t){return this._throwIfClosed(),super._trySubscribe(t)}_subscribe(t){return this._throwIfClosed(),this._checkFinalizedStatuses(t),this._innerSubscribe(t)}_innerSubscribe(t){const{hasError:e,isStopped:n,observers:r}=this;return e||n?i.a:(r.push(t),new i.b(()=>Object(c.a)(this.observers,t)))}_checkFinalizedStatuses(t){const{hasError:e,thrownError:n,isStopped:r}=this;e?t.error(n):r&&t.complete()}asObservable(){const t=new r.a;return t.source=this,t}}u.create=(t,e)=>new a(t,e);class a extends u{constructor(t,e){super(),this.destination=t,this.source=e}next(t){var e,n;null===(n=null===(e=this.destination)||void 0===e?void 0:e.next)||void 0===n||n.call(e,t)}error(t){var e,n;null===(n=null===(e=this.destination)||void 0===e?void 0:e.error)||void 0===n||n.call(e,t)}complete(){var t,e;null===(e=null===(t=this.destination)||void 0===t?void 0:t.complete)||void 0===e||e.call(t)}_subscribe(t){var e,n;return null!==(n=null===(e=this.source)||void 0===e?void 0:e.subscribe(t))&&void 0!==n?n:i.a}}},function(t,e,n){"use strict";n.d(e,"a",(function(){return o}));var r=n(2),i=n(3);function o(t,e){return Object(r.b)((n,r)=>{let o=0;n.subscribe(new i.a(r,n=>t.call(e,n,o++)&&r.next(n)))})}},function(t,e,n){"use strict";n.d(e,"a",(function(){return i}));var r=n(19);function i(t){setTimeout(()=>{const{onUnhandledError:e}=r.a;if(!e)throw t;e(t)})}},function(t,e,n){"use strict";n.d(e,"a",(function(){return r}));const r=t=>t&&"number"==typeof t.length&&"function"!=typeof t},function(t,e,n){"use strict";n.d(e,"a",(function(){return o}));var r=n(6),i=n(8);function o(t,e){return new r.a(n=>{const r=new i.b;let o=0;return r.add(e.schedule((function(){o!==t.length?(n.next(t[o++]),n.closed||r.add(this.schedule())):n.complete()}))),r})}},function(t,e,n){"use strict";n.d(e,"a",(function(){return i})),n.d(e,"b",(function(){return o}));var r=n(12);function i(...t){return o(t)}function o(t){return 0===t.length?r.a:1===t.length?t[0]:function(e){return t.reduce((t,e)=>e(t),e)}}},function(t,e,n){"use strict";n.d(e,"a",(function(){return o}));var r=n(2),i=n(3);function o(t,e){return t=null!=t?t:s,Object(r.b)((n,r)=>{let o,s=!0;n.subscribe(new i.a(r,n=>{(s&&(o=n,1)||!t(o,o=e?e(n):n))&&r.next(n),s=!1}))})}function s(t,e){return t===e}},function(t,e,n){"use strict";n.d(e,"a",(function(){return c}));var r=n(21),i=n(2),o=n(3),s=n(12);function c(t,e,n){const c=Object(r.a)(t)||e||n?{next:t,error:e,complete:n}:t;return c?Object(i.b)((t,e)=>{t.subscribe(new o.a(e,t=>{var n;null===(n=c.next)||void 0===n||n.call(c,t),e.next(t)},t=>{var n;null===(n=c.error)||void 0===n||n.call(c,t),e.error(t)},()=>{var t;null===(t=c.complete)||void 0===t||t.call(c),e.complete()}))}):s.a}},function(t,e,n){"use strict";n.d(e,"a",(function(){return f}));var r=n(6),i=n(8),o=n(2),s=n(3);function c(){return Object(o.b)((t,e)=>{let n=null;t._refCount++;const r=new s.a(e,void 0,void 0,void 0,()=>{if(!t||t._refCount<=0||0<--t._refCount)return void(n=null);const r=t._connection,i=n;n=null,!r||i&&r!==i||r.unsubscribe(),e.unsubscribe()});t.subscribe(r),r.closed||(n=t.connect())})}class u extends r.a{constructor(t,e){super(),this.source=t,this.subjectFactory=e,this._subject=null,this._refCount=0,this._connection=null}_subscribe(t){return this.getSubject().subscribe(t)}getSubject(){const t=this._subject;return t&&!t.isStopped||(this._subject=this.subjectFactory()),this._subject}_teardown(){this._refCount=0;const{_connection:t}=this;this._subject=this._connection=null,null==t||t.unsubscribe()}connect(){let t=this._connection;if(!t){t=this._connection=new i.b;const e=this.getSubject();t.add(this.source.subscribe(new s.a(e,void 0,t=>{this._teardown(),e.error(t)},()=>{this._teardown(),e.complete()},()=>this._teardown()))),t.closed&&(this._connection=null,t=i.b.EMPTY)}return t}refCount(){return c()(this)}}var a=n(29);function l(){return new a.a}function f(){return t=>c()(function(t,e){const n="function"==typeof t?t:()=>t;return"function"==typeof e?Object(o.b)((t,r)=>{const i=n();e(i).subscribe(r).add(t.subscribe(i))}):t=>{const e=new u(t,n);return Object(o.a)(t)&&(e.lift=t.lift),e.source=t,e.subjectFactory=n,e}}(l)(t))}},,,,function(t,e,n){"use strict";n.d(e,"a",(function(){return s}));var r=n(15),i=n(22),o=n(33);function s(...t){let e=t[t.length-1];return Object(r.a)(e)?(t.pop(),Object(o.a)(t,e)):Object(i.a)(t)}},,,function(t,e,n){"use strict";function r(t){const e=t(t=>{Error.call(t),t.name=t.constructor.name,t.stack=(new Error).stack});return e.prototype=Object.create(Error.prototype),e.prototype.constructor=e,e}n.d(e,"a",(function(){return r}))},function(t,e,n){"use strict";n.d(e,"a",(function(){return r}));const r={now:()=>(r.delegate||Date).now(),delegate:void 0}},function(t,e,n){"use strict";n.d(e,"a",(function(){return o}));var r=n(10);const{isArray:i}=Array;function o(t){return Object(r.a)(e=>function(t,e){return i(e)?t(...e):t(e)}(t,e))}},function(t,e,n){"use strict";n.d(e,"a",(function(){return r}));const r=t=>e=>{for(let n=0,r=t.length;n{const u=t.length,a=new Array(u);let l=t.map(()=>!1),f=!1;n.subscribe(new i.a(r,t=>{if(f){const n=[t,...a];r.next(e?e(...n):n)}}));for(let e=0;e{a[e]=t,f||l[e]||(l[e]=!0,(f=l.every(s.a))&&(l=null))},void 0,c.a))}})}},function(t,e,n){ +/*! + * clipboard.js v2.0.6 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */ +var r;r=function(){return function(t){var e={};function n(r){if(e[r])return e[r].exports;var i=e[r]={i:r,l:!1,exports:{}};return t[r].call(i.exports,i,i.exports,n),i.l=!0,i.exports}return n.m=t,n.c=e,n.d=function(t,e,r){n.o(t,e)||Object.defineProperty(t,e,{enumerable:!0,get:r})},n.r=function(t){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})},n.t=function(t,e){if(1&e&&(t=n(t)),8&e)return t;if(4&e&&"object"==typeof t&&t&&t.__esModule)return t;var r=Object.create(null);if(n.r(r),Object.defineProperty(r,"default",{enumerable:!0,value:t}),2&e&&"string"!=typeof t)for(var i in t)n.d(r,i,function(e){return t[e]}.bind(null,i));return r},n.n=function(t){var e=t&&t.__esModule?function(){return t.default}:function(){return t};return n.d(e,"a",e),e},n.o=function(t,e){return Object.prototype.hasOwnProperty.call(t,e)},n.p="",n(n.s=6)}([function(t,e){t.exports=function(t){var e;if("SELECT"===t.nodeName)t.focus(),e=t.value;else if("INPUT"===t.nodeName||"TEXTAREA"===t.nodeName){var n=t.hasAttribute("readonly");n||t.setAttribute("readonly",""),t.select(),t.setSelectionRange(0,t.value.length),n||t.removeAttribute("readonly"),e=t.value}else{t.hasAttribute("contenteditable")&&t.focus();var r=window.getSelection(),i=document.createRange();i.selectNodeContents(t),r.removeAllRanges(),r.addRange(i),e=r.toString()}return e}},function(t,e){function n(){}n.prototype={on:function(t,e,n){var r=this.e||(this.e={});return(r[t]||(r[t]=[])).push({fn:e,ctx:n}),this},once:function(t,e,n){var r=this;function i(){r.off(t,i),e.apply(n,arguments)}return i._=e,this.on(t,i,n)},emit:function(t){for(var e=[].slice.call(arguments,1),n=((this.e||(this.e={}))[t]||[]).slice(),r=0,i=n.length;r0&&void 0!==arguments[0]?arguments[0]:{};this.action=t.action,this.container=t.container,this.emitter=t.emitter,this.target=t.target,this.text=t.text,this.trigger=t.trigger,this.selectedText=""}},{key:"initSelection",value:function(){this.text?this.selectFake():this.target&&this.selectTarget()}},{key:"selectFake",value:function(){var t=this,e="rtl"==document.documentElement.getAttribute("dir");this.removeFake(),this.fakeHandlerCallback=function(){return t.removeFake()},this.fakeHandler=this.container.addEventListener("click",this.fakeHandlerCallback)||!0,this.fakeElem=document.createElement("textarea"),this.fakeElem.style.fontSize="12pt",this.fakeElem.style.border="0",this.fakeElem.style.padding="0",this.fakeElem.style.margin="0",this.fakeElem.style.position="absolute",this.fakeElem.style[e?"right":"left"]="-9999px";var n=window.pageYOffset||document.documentElement.scrollTop;this.fakeElem.style.top=n+"px",this.fakeElem.setAttribute("readonly",""),this.fakeElem.value=this.text,this.container.appendChild(this.fakeElem),this.selectedText=i()(this.fakeElem),this.copyText()}},{key:"removeFake",value:function(){this.fakeHandler&&(this.container.removeEventListener("click",this.fakeHandlerCallback),this.fakeHandler=null,this.fakeHandlerCallback=null),this.fakeElem&&(this.container.removeChild(this.fakeElem),this.fakeElem=null)}},{key:"selectTarget",value:function(){this.selectedText=i()(this.target),this.copyText()}},{key:"copyText",value:function(){var t=void 0;try{t=document.execCommand(this.action)}catch(e){t=!1}this.handleResult(t)}},{key:"handleResult",value:function(t){this.emitter.emit(t?"success":"error",{action:this.action,text:this.selectedText,trigger:this.trigger,clearSelection:this.clearSelection.bind(this)})}},{key:"clearSelection",value:function(){this.trigger&&this.trigger.focus(),document.activeElement.blur(),window.getSelection().removeAllRanges()}},{key:"destroy",value:function(){this.removeFake()}},{key:"action",set:function(){var t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:"copy";if(this._action=t,"copy"!==this._action&&"cut"!==this._action)throw new Error('Invalid "action" value, use either "copy" or "cut"')},get:function(){return this._action}},{key:"target",set:function(t){if(void 0!==t){if(!t||"object"!==(void 0===t?"undefined":o(t))||1!==t.nodeType)throw new Error('Invalid "target" value, use a valid Element');if("copy"===this.action&&t.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if("cut"===this.action&&(t.hasAttribute("readonly")||t.hasAttribute("disabled")))throw new Error('Invalid "target" attribute. You can\'t cut text from elements with "readonly" or "disabled" attributes');this._target=t}},get:function(){return this._target}}]),t}(),u=n(1),a=n.n(u),l=n(2),f=n.n(l),d="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(t){return typeof t}:function(t){return t&&"function"==typeof Symbol&&t.constructor===Symbol&&t!==Symbol.prototype?"symbol":typeof t},h=function(){function t(t,e){for(var n=0;n0&&void 0!==arguments[0]?arguments[0]:{};this.action="function"==typeof t.action?t.action:this.defaultAction,this.target="function"==typeof t.target?t.target:this.defaultTarget,this.text="function"==typeof t.text?t.text:this.defaultText,this.container="object"===d(t.container)?t.container:document.body}},{key:"listenClick",value:function(t){var e=this;this.listener=f()(t,"click",(function(t){return e.onClick(t)}))}},{key:"onClick",value:function(t){var e=t.delegateTarget||t.currentTarget;this.clipboardAction&&(this.clipboardAction=null),this.clipboardAction=new c({action:this.action(e),target:this.target(e),text:this.text(e),container:this.container,trigger:e,emitter:this})}},{key:"defaultAction",value:function(t){return p("action",t)}},{key:"defaultTarget",value:function(t){var e=p("target",t);if(e)return document.querySelector(e)}},{key:"defaultText",value:function(t){return p("text",t)}},{key:"destroy",value:function(){this.listener.destroy(),this.clipboardAction&&(this.clipboardAction.destroy(),this.clipboardAction=null)}}],[{key:"isSupported",value:function(){var t=arguments.length>0&&void 0!==arguments[0]?arguments[0]:["copy","cut"],e="string"==typeof t?[t]:t,n=!!document.queryCommandSupported;return e.forEach((function(t){n=n&&!!document.queryCommandSupported(t)})),n}}]),e}(a.a);function p(t,e){var n="data-clipboard-"+t;if(e.hasAttribute(n))return e.getAttribute(n)}e.default=b}]).default},t.exports=r()},function(t,e,n){"use strict";n.d(e,"a",(function(){return a}));var r=n(6),i=n(28),o=n(32),s=n(21),c=n(46),u=n(22);function a(t,e,n,l){return Object(s.a)(n)&&(l=n,n=void 0),l?a(t,e,n).pipe(Object(c.a)(l)):new r.a(r=>{const s=(...t)=>r.next(t.length>1?t:t[0]);return(c=t)&&"function"==typeof c.addEventListener&&"function"==typeof c.removeEventListener?(t.addEventListener(e,s,n),()=>t.removeEventListener(e,s,n)):function(t){return t&&"function"==typeof t.on&&"function"==typeof t.off}(t)?(t.on(e,s),()=>t.off(e,s)):function(t){return t&&"function"==typeof t.addListener&&"function"==typeof t.removeListener}(t)?(t.addListener(e,s),()=>t.removeListener(e,s)):Object(o.a)(t)?Object(i.a)(t=>a(t,e,n))(Object(u.a)(t)).subscribe(r):void r.error(new TypeError("Invalid event target"));var c})}},function(t,e,n){"use strict";n.d(e,"a",(function(){return o}));var r=n(6),i=n(16);const o=new r.a(i.a)},function(t,e,n){"use strict";n.d(e,"a",(function(){return i}));var r=n(35);function i(t,e){return Object(r.a)((n,r)=>e?e(n[t],r[t]):n[t]===r[t])}},function(t,e,n){"use strict";n.d(e,"a",(function(){return o}));var r=n(2),i=n(3);function o(t,e=0){return Object(r.b)((n,r)=>{n.subscribe(new i.a(r,n=>r.add(t.schedule(()=>r.next(n),e)),n=>r.add(t.schedule(()=>r.error(n),e)),()=>r.add(t.schedule(()=>r.complete(),e))))})}},function(t,e,n){"use strict";n.d(e,"a",(function(){return a}));var r=n(50),i=n(8);const o={schedule(t){let e=requestAnimationFrame,n=cancelAnimationFrame;const{delegate:r}=o;r&&(e=r.requestAnimationFrame,n=r.cancelAnimationFrame);const s=e(e=>{n=void 0,t(e)});return new i.b(()=>null==n?void 0:n(s))},requestAnimationFrame(...t){const{delegate:e}=o;return((null==e?void 0:e.requestAnimationFrame)||requestAnimationFrame)(...t)},cancelAnimationFrame(...t){const{delegate:e}=o;return((null==e?void 0:e.cancelAnimationFrame)||cancelAnimationFrame)(...t)},delegate:void 0};class s extends r.a{constructor(t,e){super(t,e),this.scheduler=t,this.work=e}requestAsyncId(t,e,n=0){return null!==n&&n>0?super.requestAsyncId(t,e,n):(t.actions.push(this),t.scheduled||(t.scheduled=o.requestAnimationFrame(()=>t.flush(void 0))))}recycleAsyncId(t,e,n=0){if(null!=n&&n>0||null==n&&this.delay>0)return super.recycleAsyncId(t,e,n);0===t.actions.length&&(o.cancelAnimationFrame(e),t.scheduled=void 0)}}var c=n(51);class u extends c.a{flush(t){this.active=!0,this.scheduled=void 0;const{actions:e}=this;let n,r=-1;t=t||e.shift();let i=e.length;do{if(n=t.execute(t.state,t.delay))break}while(++rn[t]),keys:t}}}var e;return{args:t,keys:null}}var l=n(25),f=n(9),d=n(12),h=n(46);function b(...t){let e=void 0,n=void 0;Object(i.a)(t[t.length-1])&&(n=t.pop()),"function"==typeof t[t.length-1]&&(e=t.pop());const{args:o,keys:s}=a(t),c=new r.a(function(t,e,n=d.a){return r=>{v(e,()=>{const{length:i}=t,o=new Array(i);let s=i;const c=t.map(()=>!1);let u=!0;for(let a=0;a{Object(f.a)(t[a],e).subscribe(new p(r,t=>{o[a]=t,u&&(c[a]=!0,u=!c.every(d.a)),u||r.next(n(o.slice()))},()=>0==--s))},r)}},r)}}(o,n,s?t=>{const e={};for(let n=0;n{const i=(s=t)instanceof Date&&!isNaN(s);var s;let c=!1,u=0,a=i?[]:null;const l=()=>c&&!u&&!(null==a?void 0:a.length)&&r.complete();return i&&(u++,r.add(e.schedule(()=>{if(u--,a){const t=a;a=null;for(const e of t)r.next(e)}l()},+t-e.now()))),n.subscribe(new o.a(r,n=>{i?a?a.push(n):r.next(n):(u++,r.add(e.schedule(()=>{u--,r.next(n),l()},t)))},void 0,()=>{c=!0,l()})),()=>{a=null}})}},,,,,,,,,,,,,,,,,,,,function(t,e,n){"use strict";n.d(e,"a",(function(){return o}));var r=n(29),i=n(45);class o extends r.a{constructor(t=1/0,e=1/0,n=i.a){super(),this.bufferSize=t,this.windowTime=e,this.timestampProvider=n,this.buffer=[],this.infiniteTimeWindow=!0,this.infiniteTimeWindow=e===1/0,this.bufferSize=Math.max(1,t),this.windowTime=Math.max(1,e)}next(t){const{isStopped:e,buffer:n,infiniteTimeWindow:r,timestampProvider:i,windowTime:o}=this;e||(n.push(t),!r&&n.push(i.now()+o)),this.trimBuffer(),super.next(t)}_subscribe(t){this._throwIfClosed(),this.trimBuffer();const e=this._innerSubscribe(t),{infiniteTimeWindow:n,buffer:r}=this,i=r.slice();for(let e=0;e0},t.prototype.connect_=function(){r&&!this.connected_&&(document.addEventListener("transitionend",this.onTransitionEnd_),window.addEventListener("resize",this.refresh),c?(this.mutationsObserver_=new MutationObserver(this.refresh),this.mutationsObserver_.observe(document,{attributes:!0,childList:!0,characterData:!0,subtree:!0})):(document.addEventListener("DOMSubtreeModified",this.refresh),this.mutationEventsAdded_=!0),this.connected_=!0)},t.prototype.disconnect_=function(){r&&this.connected_&&(document.removeEventListener("transitionend",this.onTransitionEnd_),window.removeEventListener("resize",this.refresh),this.mutationsObserver_&&this.mutationsObserver_.disconnect(),this.mutationEventsAdded_&&document.removeEventListener("DOMSubtreeModified",this.refresh),this.mutationsObserver_=null,this.mutationEventsAdded_=!1,this.connected_=!1)},t.prototype.onTransitionEnd_=function(t){var e=t.propertyName,n=void 0===e?"":e;s.some((function(t){return!!~n.indexOf(t)}))&&this.refresh()},t.getInstance=function(){return this.instance_||(this.instance_=new t),this.instance_},t.instance_=null,t}(),a=function(t,e){for(var n=0,r=Object.keys(e);n0},t}(),_="undefined"!=typeof WeakMap?new WeakMap:new n,E=function t(e){if(!(this instanceof t))throw new TypeError("Cannot call a class as a function.");if(!arguments.length)throw new TypeError("1 argument required, but only 0 present.");var n=u.getInstance(),r=new g(e,n,this);_.set(this,r)};["observe","unobserve","disconnect"].forEach((function(t){E.prototype[t]=function(){var e;return(e=_.get(this))[t].apply(e,arguments)}}));var O=void 0!==i.ResizeObserver?i.ResizeObserver:E;e.a=O}).call(this,n(90))},function(t,e,n){"use strict";n.d(e,"a",(function(){return o}));var r=n(6),i=n(9);function o(t){return new r.a(e=>{let n;try{n=t()}catch(t){return void e.error(t)}return Object(i.a)(n).subscribe(e)})}},function(t,e,n){"use strict"; +/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var r=/["'&<>]/;t.exports=function(t){var e,n=""+t,i=r.exec(n);if(!i)return n;var o="",s=0,c=0;for(s=i.index;s{e.subscribe(n),n.add(t)})}},function(t,e,n){"use strict";n.d(e,"a",(function(){return o}));var r=n(2),i=n(3);function o(t,e){const n=arguments.length>=2;return Object(r.b)((r,o)=>{let s=n,c=e,u=0;r.subscribe(new i.a(o,e=>{const n=u++;o.next(c=s?t(c,e,n):(s=!0,e))}))})}},function(t,e,n){"use strict";n.d(e,"a",(function(){return o}));var r=n(2),i=n(3);function o(t){return Object(r.b)((e,n)=>{let r=!1,o=null;e.subscribe(new i.a(n,t=>{r=!0,o=t}));const s=()=>{if(r){r=!1;const t=o;o=null,n.next(t)}};t.subscribe(new i.a(n,s,void 0,s))})}},function(t,e,n){"use strict";n.d(e,"a",(function(){return s}));var r=n(2),i=n(3),o=n(18);function s(t,e=null){return e=null!=e?e:t,Object(r.b)((n,r)=>{let s=[],c=0;n.subscribe(new i.a(r,n=>{let i=null;c++%e==0&&s.push([]);for(const e of s)e.push(n),t<=e.length&&(i=null!=i?i:[],i.push(e));if(i)for(const t of i)Object(o.a)(s,t),r.next(t)},void 0,()=>{for(const t of s)r.next(t);r.complete()},()=>{s=null}))})}},function(t,e,n){!function(){"use strict";function t(t){var e=!0,n=!1,r=null,i={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function o(t){return!!(t&&t!==document&&"HTML"!==t.nodeName&&"BODY"!==t.nodeName&&"classList"in t&&"contains"in t.classList)}function s(t){t.classList.contains("focus-visible")||(t.classList.add("focus-visible"),t.setAttribute("data-focus-visible-added",""))}function c(t){e=!1}function u(){document.addEventListener("mousemove",a),document.addEventListener("mousedown",a),document.addEventListener("mouseup",a),document.addEventListener("pointermove",a),document.addEventListener("pointerdown",a),document.addEventListener("pointerup",a),document.addEventListener("touchmove",a),document.addEventListener("touchstart",a),document.addEventListener("touchend",a)}function a(t){t.target.nodeName&&"html"===t.target.nodeName.toLowerCase()||(e=!1,document.removeEventListener("mousemove",a),document.removeEventListener("mousedown",a),document.removeEventListener("mouseup",a),document.removeEventListener("pointermove",a),document.removeEventListener("pointerdown",a),document.removeEventListener("pointerup",a),document.removeEventListener("touchmove",a),document.removeEventListener("touchstart",a),document.removeEventListener("touchend",a))}document.addEventListener("keydown",(function(n){n.metaKey||n.altKey||n.ctrlKey||(o(t.activeElement)&&s(t.activeElement),e=!0)}),!0),document.addEventListener("mousedown",c,!0),document.addEventListener("pointerdown",c,!0),document.addEventListener("touchstart",c,!0),document.addEventListener("visibilitychange",(function(t){"hidden"===document.visibilityState&&(n&&(e=!0),u())}),!0),u(),t.addEventListener("focus",(function(t){var n,r,c;o(t.target)&&(e||(n=t.target,r=n.type,"INPUT"===(c=n.tagName)&&i[r]&&!n.readOnly||"TEXTAREA"===c&&!n.readOnly||n.isContentEditable))&&s(t.target)}),!0),t.addEventListener("blur",(function(t){var e;o(t.target)&&(t.target.classList.contains("focus-visible")||t.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(r),r=window.setTimeout((function(){n=!1}),100),(e=t.target).hasAttribute("data-focus-visible-added")&&(e.classList.remove("focus-visible"),e.removeAttribute("data-focus-visible-added")))}),!0),t.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&t.host?t.host.setAttribute("data-js-focus-visible",""):t.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if("undefined"!=typeof window&&"undefined"!=typeof document){var e;window.applyFocusVisiblePolyfill=t;try{e=new CustomEvent("focus-visible-polyfill-ready")}catch(t){(e=document.createEvent("CustomEvent")).initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(e)}"undefined"!=typeof document&&t(document)}()},function(t,e){var n;n=function(){return this}();try{n=n||new Function("return this")()}catch(t){"object"==typeof window&&(n=window)}t.exports=n},,,,,function(t,e,n){"use strict";n.d(e,"a",(function(){return o}));var r=n(2),i=n(3);function o(t){return Object(r.b)((e,n)=>{e.subscribe(new i.a(n,()=>n.next(t)))})}},function(t,e,n){"use strict";n.d(e,"a",(function(){return o}));var r=n(81),i=n(2);function o(t,e,n){let o;return o=t&&"object"==typeof t?t:{bufferSize:t,windowTime:e,refCount:!1,scheduler:n},Object(i.b)(function({bufferSize:t=1/0,windowTime:e=1/0,refCount:n,scheduler:i}){let o,s,c=0;return(u,a)=>{let l;c++,o?l=o.subscribe(a):(o=new r.a(t,e,i),l=o.subscribe(a),s=u.subscribe({next(t){o.next(t)},error(t){const e=o;s=void 0,o=void 0,e.error(t)},complete(){s=void 0,o.complete()}}),s.closed&&(s=void 0)),a.add(()=>{c--,l.unsubscribe(),n&&0===c&&s&&(s.unsubscribe(),s=void 0,o=void 0)})}}(o))}},function(t,e,n){"use strict";n.d(e,"a",(function(){return o}));var r=n(2),i=n(3);function o(t){return Object(r.b)((e,n)=>{let r=0;e.subscribe(new i.a(n,e=>t===r?n.next(e):r++))})}},function(t,e,n){"use strict";n.d(e,"a",(function(){return s}));var r=n(9),i=n(3),o=n(2);function s(t){return Object(o.b)((e,n)=>{let o,c=null,u=!1;c=e.subscribe(new i.a(n,void 0,i=>{o=Object(r.a)(t(i,s(t)(e))),c?(c.unsubscribe(),c=null,o.subscribe(n)):u=!0})),u&&(c.unsubscribe(),c=null,o.subscribe(n))})}},function(t,e,n){"use strict";n.d(e,"a",(function(){return s}));var r=n(49),i=n(2),o=n(3);function s(t,e=r.a){return Object(i.b)((n,r)=>{let i=!1,s=null,c=null;const u=()=>{i=!1;const t=s;s=null,r.next(t)};n.subscribe(new o.a(r,n=>{null==c||c.unsubscribe(),i=!0,s=n,r.add(c=e.schedule(()=>{c=null,u()},t))},void 0,()=>{i&&u(),r.complete()}))})}},function(t,e,n){"use strict";n.d(e,"a",(function(){return c}));var r=n(48);var i=n(15),o=n(22);function s(...t){let e;return Object(i.a)(t[t.length-1])&&(e=t.pop()),Object(r.a)(1)(Object(o.a)(t,e))}function c(...t){const e=t[t.length-1];return Object(i.a)(e)?(t.pop(),n=>s(t,n,e)):e=>s(t,e)}},function(t,e,n){"use strict";n.d(e,"a",(function(){return i}));var r=n(29);class i extends r.a{constructor(t){super(),this._value=t}get value(){return this.getValue()}_subscribe(t){const e=super._subscribe(t);return!e.closed&&t.next(this._value),e}getValue(){const{hasError:t,thrownError:e,_value:n}=this;if(t)throw e;return this._throwIfClosed(),n}next(t){super.next(this._value=t)}}},function(t,e,n){"use strict";n.d(e,"a",(function(){return s}));var r=n(26),i=n(2),o=n(3);function s(t){return t<=0?()=>r.a:Object(i.b)((e,n)=>{let r=0;e.subscribe(new o.a(n,e=>{++r<=t&&(n.next(e),t<=r&&n.complete())}))})}},function(t,e,n){"use strict";n.d(e,"a",(function(){return c}));var r=n(2),i=n(3),o=n(9);const s={leading:!0,trailing:!1};function c(t,{leading:e,trailing:n}=s){return Object(r.b)((r,s)=>{let c=!1,u=null,a=null;const l=()=>{null==a||a.unsubscribe(),a=null,n&&d()},f=e=>a=Object(o.a)(t(e)).subscribe(new i.a(s,l,void 0,l)),d=()=>{c&&(s.next(u),f(u)),c=!1,u=null};r.subscribe(new i.a(s,t=>{c=!0,u=t,!a&&(e?d():f(t))}))})}},function(t,e,n){"use strict";n.d(e,"a",(function(){return i}));var r=n(13);function i(t,e){return e?Object(r.a)(()=>t,e):Object(r.a)(()=>t)}},function(t,e,n){"use strict";n.d(e,"a",(function(){return i}));var r=n(28);function i(t,e){return"function"==typeof e?Object(r.a)(t,e,1):Object(r.a)(t,1)}},function(t,e,n){"use strict";n.d(e,"a",(function(){return o}));var r=n(83),i=n(26);function o(t,e=i.a,n=i.a){return Object(r.a)(()=>t()?e:n)}},function(t,e,n){"use strict";n.d(e,"a",(function(){return u}));var r=n(6),i=n(8),o=n(9);var s=n(2);function c(...t){return Object(s.b)((e,n)=>{(function(...t){let e=void 0;return"function"==typeof t[t.length-1]&&(e=t.pop()),new r.a(n=>{const r=t.map(()=>[]),s=t.map(()=>!1),c=new i.b,u=()=>{if(r.every(t=>t.length>0)){let t=r.map(t=>t.shift());if(e)try{t=e(...t)}catch(t){return void n.error(t)}n.next(t),r.some((t,e)=>0===t.length&&s[e])&&n.complete()}};for(let e=0;!n.closed&&e{r[e].push(t),u()},error:t=>n.error(t),complete:()=>{s[e]=!0,0===r[e].length&&n.complete()}}))}return c})})(e,...t).subscribe(n)})}function u(...t){return c(...t)}}]]); \ No newline at end of file diff --git a/v4.0.1/assets/javascripts/worker/search.0f64ce30.min.js b/v4.0.1/assets/javascripts/worker/search.0f64ce30.min.js new file mode 100644 index 0000000000..99676d0b69 --- /dev/null +++ b/v4.0.1/assets/javascripts/worker/search.0f64ce30.min.js @@ -0,0 +1,58 @@ +!function(e){var t={};function r(n){if(t[n])return t[n].exports;var i=t[n]={i:n,l:!1,exports:{}};return e[n].call(i.exports,i,i.exports,r),i.l=!0,i.exports}r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var i in e)r.d(n,i,function(t){return e[t]}.bind(null,i));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=5)}([function(e,t,r){"use strict"; +/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var n=/["'&<>]/;e.exports=function(e){var t,r=""+e,i=n.exec(r);if(!i)return r;var s="",o=0,a=0;for(o=i.index;o0){var u=I.utils.clone(t)||{};u.position=[o,a],u.index=i.length,i.push(new I.Token(r.slice(o,s),u))}o=s+1}}return i},I.tokenizer.separator=/[\s\-]+/ +/*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + */,I.Pipeline=function(){this._stack=[]},I.Pipeline.registeredFunctions=Object.create(null),I.Pipeline.registerFunction=function(e,t){t in this.registeredFunctions&&I.utils.warn("Overwriting existing registered function: "+t),e.label=t,I.Pipeline.registeredFunctions[e.label]=e},I.Pipeline.warnIfFunctionNotRegistered=function(e){e.label&&e.label in this.registeredFunctions||I.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},I.Pipeline.load=function(e){var t=new I.Pipeline;return e.forEach((function(e){var r=I.Pipeline.registeredFunctions[e];if(!r)throw new Error("Cannot load unregistered function: "+e);t.add(r)})),t},I.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach((function(e){I.Pipeline.warnIfFunctionNotRegistered(e),this._stack.push(e)}),this)},I.Pipeline.prototype.after=function(e,t){I.Pipeline.warnIfFunctionNotRegistered(t);var r=this._stack.indexOf(e);if(-1==r)throw new Error("Cannot find existingFn");r+=1,this._stack.splice(r,0,t)},I.Pipeline.prototype.before=function(e,t){I.Pipeline.warnIfFunctionNotRegistered(t);var r=this._stack.indexOf(e);if(-1==r)throw new Error("Cannot find existingFn");this._stack.splice(r,0,t)},I.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);-1!=t&&this._stack.splice(t,1)},I.Pipeline.prototype.run=function(e){for(var t=this._stack.length,r=0;r1&&(se&&(r=i),s!=e);)n=r-t,i=t+Math.floor(n/2),s=this.elements[2*i];return s==e||s>e?2*i:sa?l+=2:o==a&&(t+=r[u+1]*n[l+1],u+=2,l+=2);return t},I.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},I.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,r=0;t0){var s,o=i.str.charAt(0);o in i.node.edges?s=i.node.edges[o]:(s=new I.TokenSet,i.node.edges[o]=s),1==i.str.length&&(s.final=!0),n.push({node:s,editsRemaining:i.editsRemaining,str:i.str.slice(1)})}if(0!=i.editsRemaining){if("*"in i.node.edges)var a=i.node.edges["*"];else{a=new I.TokenSet;i.node.edges["*"]=a}if(0==i.str.length&&(a.final=!0),n.push({node:a,editsRemaining:i.editsRemaining-1,str:i.str}),i.str.length>1&&n.push({node:i.node,editsRemaining:i.editsRemaining-1,str:i.str.slice(1)}),1==i.str.length&&(i.node.final=!0),i.str.length>=1){if("*"in i.node.edges)var u=i.node.edges["*"];else{u=new I.TokenSet;i.node.edges["*"]=u}1==i.str.length&&(u.final=!0),n.push({node:u,editsRemaining:i.editsRemaining-1,str:i.str.slice(1)})}if(i.str.length>1){var l,c=i.str.charAt(0),h=i.str.charAt(1);h in i.node.edges?l=i.node.edges[h]:(l=new I.TokenSet,i.node.edges[h]=l),1==i.str.length&&(l.final=!0),n.push({node:l,editsRemaining:i.editsRemaining-1,str:c+i.str.slice(2)})}}}return r},I.TokenSet.fromString=function(e){for(var t=new I.TokenSet,r=t,n=0,i=e.length;n=e;t--){var r=this.uncheckedNodes[t],n=r.child.toString();n in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[n]:(r.child._str=n,this.minimizedNodes[n]=r.child),this.uncheckedNodes.pop()}} +/*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + */,I.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},I.Index.prototype.search=function(e){return this.query((function(t){new I.QueryParser(e,t).parse()}))},I.Index.prototype.query=function(e){for(var t=new I.Query(this.fields),r=Object.create(null),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=0;a1?1:e},I.Builder.prototype.k1=function(e){this._k1=e},I.Builder.prototype.add=function(e,t){var r=e[this._ref],n=Object.keys(this._fields);this._documents[r]=t||{},this.documentCount+=1;for(var i=0;i=this.length)return I.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},I.QueryLexer.prototype.width=function(){return this.pos-this.start},I.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},I.QueryLexer.prototype.backup=function(){this.pos-=1},I.QueryLexer.prototype.acceptDigitRun=function(){var e,t;do{t=(e=this.next()).charCodeAt(0)}while(t>47&&t<58);e!=I.QueryLexer.EOS&&this.backup()},I.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(I.QueryLexer.TERM)),e.ignore(),e.more())return I.QueryLexer.lexText},I.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(I.QueryLexer.EDIT_DISTANCE),I.QueryLexer.lexText},I.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(I.QueryLexer.BOOST),I.QueryLexer.lexText},I.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(I.QueryLexer.TERM)},I.QueryLexer.termSeparator=I.tokenizer.separator,I.QueryLexer.lexText=function(e){for(;;){var t=e.next();if(t==I.QueryLexer.EOS)return I.QueryLexer.lexEOS;if(92!=t.charCodeAt(0)){if(":"==t)return I.QueryLexer.lexField;if("~"==t)return e.backup(),e.width()>0&&e.emit(I.QueryLexer.TERM),I.QueryLexer.lexEditDistance;if("^"==t)return e.backup(),e.width()>0&&e.emit(I.QueryLexer.TERM),I.QueryLexer.lexBoost;if("+"==t&&1===e.width())return e.emit(I.QueryLexer.PRESENCE),I.QueryLexer.lexText;if("-"==t&&1===e.width())return e.emit(I.QueryLexer.PRESENCE),I.QueryLexer.lexText;if(t.match(I.QueryLexer.termSeparator))return I.QueryLexer.lexTerm}else e.escapeCharacter()}},I.QueryParser=function(e,t){this.lexer=new I.QueryLexer(e),this.query=t,this.currentClause={},this.lexemeIdx=0},I.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=I.QueryParser.parseClause;e;)e=e(this);return this.query},I.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},I.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},I.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},I.QueryParser.parseClause=function(e){var t=e.peekLexeme();if(null!=t)switch(t.type){case I.QueryLexer.PRESENCE:return I.QueryParser.parsePresence;case I.QueryLexer.FIELD:return I.QueryParser.parseField;case I.QueryLexer.TERM:return I.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+t.type;throw t.str.length>=1&&(r+=" with value '"+t.str+"'"),new I.QueryParseError(r,t.start,t.end)}},I.QueryParser.parsePresence=function(e){var t=e.consumeLexeme();if(null!=t){switch(t.str){case"-":e.currentClause.presence=I.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=I.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+t.str+"'";throw new I.QueryParseError(r,t.start,t.end)}var n=e.peekLexeme();if(null==n){r="expecting term or field, found nothing";throw new I.QueryParseError(r,t.start,t.end)}switch(n.type){case I.QueryLexer.FIELD:return I.QueryParser.parseField;case I.QueryLexer.TERM:return I.QueryParser.parseTerm;default:r="expecting term or field, found '"+n.type+"'";throw new I.QueryParseError(r,n.start,n.end)}}},I.QueryParser.parseField=function(e){var t=e.consumeLexeme();if(null!=t){if(-1==e.query.allFields.indexOf(t.str)){var r=e.query.allFields.map((function(e){return"'"+e+"'"})).join(", "),n="unrecognised field '"+t.str+"', possible fields: "+r;throw new I.QueryParseError(n,t.start,t.end)}e.currentClause.fields=[t.str];var i=e.peekLexeme();if(null==i){n="expecting term, found nothing";throw new I.QueryParseError(n,t.start,t.end)}switch(i.type){case I.QueryLexer.TERM:return I.QueryParser.parseTerm;default:n="expecting term, found '"+i.type+"'";throw new I.QueryParseError(n,i.start,i.end)}}},I.QueryParser.parseTerm=function(e){var t=e.consumeLexeme();if(null!=t){e.currentClause.term=t.str.toLowerCase(),-1!=t.str.indexOf("*")&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(null!=r)switch(r.type){case I.QueryLexer.TERM:return e.nextClause(),I.QueryParser.parseTerm;case I.QueryLexer.FIELD:return e.nextClause(),I.QueryParser.parseField;case I.QueryLexer.EDIT_DISTANCE:return I.QueryParser.parseEditDistance;case I.QueryLexer.BOOST:return I.QueryParser.parseBoost;case I.QueryLexer.PRESENCE:return e.nextClause(),I.QueryParser.parsePresence;default:var n="Unexpected lexeme type '"+r.type+"'";throw new I.QueryParseError(n,r.start,r.end)}else e.nextClause()}},I.QueryParser.parseEditDistance=function(e){var t=e.consumeLexeme();if(null!=t){var r=parseInt(t.str,10);if(isNaN(r)){var n="edit distance must be numeric";throw new I.QueryParseError(n,t.start,t.end)}e.currentClause.editDistance=r;var i=e.peekLexeme();if(null!=i)switch(i.type){case I.QueryLexer.TERM:return e.nextClause(),I.QueryParser.parseTerm;case I.QueryLexer.FIELD:return e.nextClause(),I.QueryParser.parseField;case I.QueryLexer.EDIT_DISTANCE:return I.QueryParser.parseEditDistance;case I.QueryLexer.BOOST:return I.QueryParser.parseBoost;case I.QueryLexer.PRESENCE:return e.nextClause(),I.QueryParser.parsePresence;default:n="Unexpected lexeme type '"+i.type+"'";throw new I.QueryParseError(n,i.start,i.end)}else e.nextClause()}},I.QueryParser.parseBoost=function(e){var t=e.consumeLexeme();if(null!=t){var r=parseInt(t.str,10);if(isNaN(r)){var n="boost must be numeric";throw new I.QueryParseError(n,t.start,t.end)}e.currentClause.boost=r;var i=e.peekLexeme();if(null!=i)switch(i.type){case I.QueryLexer.TERM:return e.nextClause(),I.QueryParser.parseTerm;case I.QueryLexer.FIELD:return e.nextClause(),I.QueryParser.parseField;case I.QueryLexer.EDIT_DISTANCE:return I.QueryParser.parseEditDistance;case I.QueryLexer.BOOST:return I.QueryParser.parseBoost;case I.QueryLexer.PRESENCE:return e.nextClause(),I.QueryParser.parsePresence;default:n="Unexpected lexeme type '"+i.type+"'";throw new I.QueryParseError(n,i.start,i.end)}else e.nextClause()}},void 0===(i="function"==typeof(n=function(){return I})?n.call(t,r,t,e):n)||(e.exports=i)}()},function(e,t,r){"use strict";(function(t){e.exports=function(){if("object"==typeof globalThis)return globalThis;var e;try{e=this||new Function("return this")()}catch(e){if("object"==typeof window)return window;if("object"==typeof self)return self;if(void 0!==t)return t}return e}()}).call(this,r(4))},function(e,t){var r;r=function(){return this}();try{r=r||new Function("return this")()}catch(e){"object"==typeof window&&(r=window)}e.exports=r},function(e,t,r){"use strict";r.r(t),r.d(t,"handler",(function(){return u}));function n(e,t,r,n){return new(r||(r=Promise))((function(i,s){function o(e){try{u(n.next(e))}catch(e){s(e)}}function a(e){try{u(n.throw(e))}catch(e){s(e)}}function u(e){var t;e.done?i(e.value):(t=e.value,t instanceof r?t:new r((function(e){e(t)}))).then(o,a)}u((n=n.apply(e,t||[])).next())}))}Object.create;Object.create;r(1);var i,s=r(0);class o{constructor({config:e,docs:t,index:r,options:n}){this.options=n,this.documents=function(e){const t=new Map,r=new Set;for(const n of e){const[e,i]=n.location.split("#"),o=n.location,a=n.title,u=s(n.text).replace(/\s+(?=[,.:;!?])/g,"").replace(/\s+/g," ");if(i){const i=t.get(e);r.has(i)?t.set(o,{location:o,title:a,text:u,parent:i}):(i.title=n.title,i.text=u,r.add(i))}else t.set(o,{location:o,title:a,text:u})}return t}(t),this.highlight=function(e){const t=new RegExp(e.separator,"img"),r=(e,t,r)=>`${t}${r}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").trim();const i=new RegExp(`(^|${e.separator})(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(t,"|")})`,"img");return e=>e.replace(i,r).replace(/<\/mark>(\s+)]*>/gim,"$1")}}(e),lunr.tokenizer.separator=new RegExp(e.separator),this.index=void 0===r?lunr((function(){1===e.lang.length&&"en"!==e.lang[0]?this.use(lunr[e.lang[0]]):e.lang.length>1&&this.use(lunr.multiLanguage(...e.lang));const r=function(e,t){const[r,n]=[new Set(e),new Set(t)];return[...new Set([...r].filter(e=>!n.has(e)))]}(["trimmer","stopWordFilter","stemmer"],n.pipeline);for(const t of e.lang.map(e=>"en"===e?lunr:lunr[e]))for(const e of r)this.pipeline.remove(t[e]),this.searchPipeline.remove(t[e]);this.field("title",{boost:1e3}),this.field("text"),this.ref("location");for(const e of t)this.add(e)})):lunr.Index.load(r)}search(e){if(e)try{const t=this.highlight(e),r=function(e){const t=new lunr.Query(["title","text"]);return new lunr.QueryParser(e,t).parse(),t.clauses}(e).filter(e=>e.presence!==lunr.Query.presence.PROHIBITED),n=this.index.search(e+"*").reduce((e,{ref:n,score:i,matchData:s})=>{const o=this.documents.get(n);if(void 0!==o){const{location:n,title:a,text:u,parent:l}=o,c=function(e,t){const r=new Set(e),n={};for(let e=0;ee);e.push({location:n,title:t(a),text:t(u),score:i*(1+h),terms:c})}return e},[]).sort((e,t)=>t.score-e.score).reduce((e,t)=>{const r=this.documents.get(t.location);if(void 0!==r){const n="parent"in r?r.parent.location:r.location;e.set(n,[...e.get(n)||[],t])}return e},new Map);let i;if(this.options.suggestions){const e=this.index.query(e=>{for(const t of r)e.term(t.term,{fields:["title"],presence:lunr.Query.presence.REQUIRED,wildcard:lunr.Query.wildcard.TRAILING})});i=e.length?Object.keys(e[0].matchData.metadata):[]}return Object.assign({items:[...n.values()]},void 0!==i&&{suggestions:i})}catch(t){console.warn(`Invalid query: ${e} – see https://bit.ly/2s3ChXG`)}return{items:[]}}}let a;function u(e){return n(this,void 0,void 0,(function*(){switch(e.type){case i.SETUP:return yield function(e){return n(this,void 0,void 0,(function*(){let t="../lunr";if("undefined"!=typeof parent&&"IFrameWorker"in parent){const e=document.querySelector("script[src]"),[r]=e.src.split("/worker");t=t.replace("..",r)}const r=[];for(const n of e.lang)"ja"===n&&r.push(t+"/tinyseg.min.js"),"en"!==n&&r.push(`${t}/min/lunr.${n}.min.js`);e.lang.length>1&&r.push(t+"/min/lunr.multi.min.js"),r.length&&(yield importScripts(t+"/min/lunr.stemmer.support.min.js",...r))}))}(e.data.config),a=new o(e.data),{type:i.READY};case i.QUERY:return{type:i.RESULT,data:a?a.search(e.data):{items:[]}};default:throw new TypeError("Invalid message type")}}))}!function(e){e[e.SETUP=0]="SETUP",e[e.READY=1]="READY",e[e.QUERY=2]="QUERY",e[e.RESULT=3]="RESULT"}(i||(i={})),addEventListener("message",e=>n(void 0,void 0,void 0,(function*(){postMessage(yield u(e.data))})))}]); \ No newline at end of file diff --git a/v4.0.1/assets/stylesheets/main.406af9ae.min.css b/v4.0.1/assets/stylesheets/main.406af9ae.min.css new file mode 100644 index 0000000000..7db79c6606 --- /dev/null +++ b/v4.0.1/assets/stylesheets/main.406af9ae.min.css @@ -0,0 +1 @@ +html{box-sizing:border-box;-webkit-text-size-adjust:none;-moz-text-size-adjust:none;-ms-text-size-adjust:none;text-size-adjust:none}*,*::before,*::after{box-sizing:inherit}body{margin:0}hr{box-sizing:content-box;overflow:visible}a,button,label,input{-webkit-tap-highlight-color:transparent}a{color:inherit;text-decoration:none}small{font-size:80%}sub,sup{line-height:1em}img{border-style:none}table{border-collapse:separate;border-spacing:0}td,th{font-weight:normal;vertical-align:top}button{margin:0;padding:0;font-size:inherit;background:transparent;border:0}input{border:0;outline:none}:root{--md-default-fg-color: hsla(0, 0%, 0%, 0.87);--md-default-fg-color--light: hsla(0, 0%, 0%, 0.54);--md-default-fg-color--lighter: hsla(0, 0%, 0%, 0.32);--md-default-fg-color--lightest: hsla(0, 0%, 0%, 0.07);--md-default-bg-color: hsla(0, 0%, 100%, 1);--md-default-bg-color--light: hsla(0, 0%, 100%, 0.7);--md-default-bg-color--lighter: hsla(0, 0%, 100%, 0.3);--md-default-bg-color--lightest: hsla(0, 0%, 100%, 0.12);--md-primary-fg-color: hsla(231, 48%, 48%, 1);--md-primary-fg-color--light: hsla(230, 44%, 64%, 1);--md-primary-fg-color--dark: hsla(232, 54%, 41%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7);--md-accent-fg-color: hsla(231, 99%, 66%, 1);--md-accent-fg-color--transparent: hsla(231, 99%, 66%, 0.1);--md-accent-bg-color: hsla(0, 0%, 100%, 1);--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7)}:root>*{--md-code-fg-color: hsla(200, 18%, 26%, 1);--md-code-bg-color: hsla(0, 0%, 96%, 1);--md-code-hl-color: hsla(60, 100%, 50%, 0.5);--md-code-hl-number-color: hsla(0, 67%, 50%, 1);--md-code-hl-special-color: hsla(340, 83%, 47%, 1);--md-code-hl-function-color: hsla(291, 45%, 50%, 1);--md-code-hl-constant-color: hsla(250, 63%, 60%, 1);--md-code-hl-keyword-color: hsla(219, 54%, 51%, 1);--md-code-hl-string-color: hsla(150, 63%, 30%, 1);--md-code-hl-name-color: var(--md-code-fg-color);--md-code-hl-operator-color: var(--md-default-fg-color--light);--md-code-hl-punctuation-color: var(--md-default-fg-color--light);--md-code-hl-comment-color: var(--md-default-fg-color--light);--md-code-hl-generic-color: var(--md-default-fg-color--light);--md-code-hl-variable-color: var(--md-default-fg-color--light);--md-typeset-color: var(--md-default-fg-color);--md-typeset-a-color: var(--md-primary-fg-color);--md-typeset-mark-color: hsla(60, 100%, 50%, 0.5);--md-typeset-del-color: hsla(6, 90%, 60%, 0.15);--md-typeset-ins-color: hsla(150, 90%, 44%, 0.15);--md-typeset-kbd-color: hsla(0, 0%, 98%, 1);--md-typeset-kbd-accent-color: hsla(0, 100%, 100%, 1);--md-typeset-kbd-border-color: hsla(0, 0%, 72%, 1);--md-admonition-fg-color: var(--md-default-fg-color);--md-admonition-bg-color: var(--md-default-bg-color);--md-footer-fg-color: hsla(0, 0%, 100%, 1);--md-footer-fg-color--light: hsla(0, 0%, 100%, 0.7);--md-footer-fg-color--lighter: hsla(0, 0%, 100%, 0.3);--md-footer-bg-color: hsla(0, 0%, 0%, 0.87);--md-footer-bg-color--dark: hsla(0, 0%, 0%, 0.32)}.md-icon svg{display:block;width:1.2rem;height:1.2rem;fill:currentColor}body{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}body,input{color:var(--md-typeset-color);font-feature-settings:"kern","liga";font-family:-apple-system,BlinkMacSystemFont,Helvetica,Arial,sans-serif}code,pre,kbd{color:var(--md-typeset-color);font-feature-settings:"kern";font-family:SFMono-Regular,Consolas,Menlo,monospace}:root{--md-typeset-table--ascending: url('data:image/svg+xml;charset=utf-8,');--md-typeset-table--descending: url('data:image/svg+xml;charset=utf-8,')}.md-typeset{font-size:.8rem;line-height:1.6;-webkit-print-color-adjust:exact;color-adjust:exact}@media print{.md-typeset{font-size:.68rem}}.md-typeset p,.md-typeset ul,.md-typeset ol,.md-typeset blockquote{margin:1em 0}.md-typeset h1{margin:0 0 1.25em;color:var(--md-default-fg-color--light);font-weight:300;font-size:2em;line-height:1.3;letter-spacing:-0.01em}.md-typeset h2{margin:1.6em 0 .64em;font-weight:300;font-size:1.5625em;line-height:1.4;letter-spacing:-0.01em}.md-typeset h3{margin:1.6em 0 .8em;font-weight:400;font-size:1.25em;line-height:1.5;letter-spacing:-0.01em}.md-typeset h2+h3{margin-top:.8em}.md-typeset h4{margin:1em 0;font-weight:700;letter-spacing:-0.01em}.md-typeset h5,.md-typeset h6{margin:1.25em 0;color:var(--md-default-fg-color--light);font-weight:700;font-size:.8em;letter-spacing:-0.01em}.md-typeset h5{text-transform:uppercase}.md-typeset hr{margin:1.5em 0;border-bottom:.05rem dotted var(--md-default-fg-color--lighter)}.md-typeset a{color:var(--md-typeset-a-color);word-break:break-word}.md-typeset a,.md-typeset a::before{transition:color 125ms}.md-typeset a:focus,.md-typeset a:hover{color:var(--md-accent-fg-color)}.md-typeset code,.md-typeset pre,.md-typeset kbd{color:var(--md-code-fg-color);direction:ltr}@media print{.md-typeset code,.md-typeset pre,.md-typeset kbd{white-space:pre-wrap}}.md-typeset code{padding:0 .2941176471em;font-size:.85em;word-break:break-word;background-color:var(--md-code-bg-color);border-radius:.1rem;-webkit-box-decoration-break:clone;box-decoration-break:clone}.md-typeset h1 code,.md-typeset h2 code,.md-typeset h3 code,.md-typeset h4 code,.md-typeset h5 code,.md-typeset h6 code{margin:initial;padding:initial;background-color:transparent;box-shadow:none}.md-typeset a>code{color:currentColor}.md-typeset pre{position:relative;margin:1em 0;line-height:1.4}.md-typeset pre>code{display:block;margin:0;padding:.7720588235em 1.1764705882em;overflow:auto;word-break:normal;box-shadow:none;-webkit-box-decoration-break:slice;box-decoration-break:slice;touch-action:auto;scrollbar-width:thin;scrollbar-color:var(--md-default-fg-color--lighter) transparent}.md-typeset pre>code:hover{scrollbar-color:var(--md-accent-fg-color) transparent}.md-typeset pre>code::-webkit-scrollbar{width:.2rem;height:.2rem}.md-typeset pre>code::-webkit-scrollbar-thumb{background-color:var(--md-default-fg-color--lighter)}.md-typeset pre>code::-webkit-scrollbar-thumb:hover{background-color:var(--md-accent-fg-color)}@media screen and (max-width: 44.9375em){.md-typeset>pre{margin:1em -0.8rem}.md-typeset>pre code{border-radius:0}}.md-typeset kbd{display:inline-block;padding:0 .6666666667em;color:var(--md-default-fg-color);font-size:.75em;vertical-align:text-top;word-break:break-word;background-color:var(--md-typeset-kbd-color);border-radius:.1rem;box-shadow:0 .1rem 0 .05rem var(--md-typeset-kbd-border-color),0 .1rem 0 var(--md-typeset-kbd-border-color),0 -0.1rem .2rem var(--md-typeset-kbd-accent-color) inset}.md-typeset mark{color:inherit;word-break:break-word;background-color:var(--md-typeset-mark-color);-webkit-box-decoration-break:clone;box-decoration-break:clone}.md-typeset abbr{text-decoration:none;border-bottom:.05rem dotted var(--md-default-fg-color--light);cursor:help}@media(hover: none){.md-typeset abbr{position:relative}.md-typeset abbr[title]:focus::after,.md-typeset abbr[title]:hover::after{box-shadow:0 2px 2px 0 rgba(0,0,0,.14),0 1px 5px 0 rgba(0,0,0,.12),0 3px 1px -2px rgba(0,0,0,.2);position:absolute;left:0;display:inline-block;width:auto;min-width:-webkit-max-content;min-width:-moz-max-content;min-width:max-content;max-width:80%;margin-top:2em;padding:.2rem .3rem;color:var(--md-default-bg-color);font-size:.7rem;background-color:var(--md-default-fg-color);border-radius:.1rem;content:attr(title)}}.md-typeset small{opacity:.75}.md-typeset sup,.md-typeset sub{margin-left:.078125em}[dir=rtl] .md-typeset sup,[dir=rtl] .md-typeset sub{margin-right:.078125em;margin-left:initial}.md-typeset blockquote{padding-left:.6rem;color:var(--md-default-fg-color--light);border-left:.2rem solid var(--md-default-fg-color--lighter)}[dir=rtl] .md-typeset blockquote{padding-right:.6rem;padding-left:initial;border-right:.2rem solid var(--md-default-fg-color--lighter);border-left:initial}.md-typeset ul{list-style-type:disc}.md-typeset ul,.md-typeset ol{margin-left:.625em;padding:0}[dir=rtl] .md-typeset ul,[dir=rtl] .md-typeset ol{margin-right:.625em;margin-left:initial}.md-typeset ul ol,.md-typeset ol ol{list-style-type:lower-alpha}.md-typeset ul ol ol,.md-typeset ol ol ol{list-style-type:lower-roman}.md-typeset ul li,.md-typeset ol li{margin-bottom:.5em;margin-left:1.25em}[dir=rtl] .md-typeset ul li,[dir=rtl] .md-typeset ol li{margin-right:1.25em;margin-left:initial}.md-typeset ul li p,.md-typeset ul li blockquote,.md-typeset ol li p,.md-typeset ol li blockquote{margin:.5em 0}.md-typeset ul li:last-child,.md-typeset ol li:last-child{margin-bottom:0}.md-typeset ul li ul,.md-typeset ul li ol,.md-typeset ol li ul,.md-typeset ol li ol{margin:.5em 0 .5em .625em}[dir=rtl] .md-typeset ul li ul,[dir=rtl] .md-typeset ul li ol,[dir=rtl] .md-typeset ol li ul,[dir=rtl] .md-typeset ol li ol{margin-right:.625em;margin-left:initial}.md-typeset dd{margin:1em 0 1.5em 1.875em}[dir=rtl] .md-typeset dd{margin-right:1.875em;margin-left:initial}.md-typeset img,.md-typeset svg{max-width:100%;height:auto}.md-typeset img[align=left],.md-typeset svg[align=left]{margin:1em;margin-left:0}.md-typeset img[align=right],.md-typeset svg[align=right]{margin:1em;margin-right:0}.md-typeset img[align]:only-child,.md-typeset svg[align]:only-child{margin-top:0}.md-typeset figure{width:-webkit-fit-content;width:-moz-fit-content;width:fit-content;max-width:100%;margin:0 auto;text-align:center}.md-typeset figcaption{max-width:24rem;margin:.5em auto 2em;font-style:italic}.md-typeset iframe{max-width:100%}.md-typeset table:not([class]){display:inline-block;max-width:100%;overflow:auto;font-size:.64rem;background-color:var(--md-default-bg-color);border-radius:.1rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .05rem rgba(0,0,0,.1);touch-action:auto}@media print{.md-typeset table:not([class]){display:table}}.md-typeset table:not([class])+*{margin-top:1.5em}.md-typeset table:not([class]) th>*:first-child,.md-typeset table:not([class]) td>*:first-child{margin-top:0}.md-typeset table:not([class]) th>*:last-child,.md-typeset table:not([class]) td>*:last-child{margin-bottom:0}.md-typeset table:not([class]) th:not([align]),.md-typeset table:not([class]) td:not([align]){text-align:left}[dir=rtl] .md-typeset table:not([class]) th:not([align]),[dir=rtl] .md-typeset table:not([class]) td:not([align]){text-align:right}.md-typeset table:not([class]) th{min-width:5rem;padding:.9375em 1.25em;color:var(--md-default-bg-color);vertical-align:top;background-color:var(--md-default-fg-color--light)}.md-typeset table:not([class]) th a{color:inherit}.md-typeset table:not([class]) td{padding:.9375em 1.25em;vertical-align:top;border-top:.05rem solid var(--md-default-fg-color--lightest)}.md-typeset table:not([class]) tr{transition:background-color 125ms}.md-typeset table:not([class]) tr:hover{background-color:rgba(0,0,0,.035);box-shadow:0 .05rem 0 var(--md-default-bg-color) inset}.md-typeset table:not([class]) tr:first-child td{border-top:0}.md-typeset table:not([class]) a{word-break:normal}.md-typeset table th[role=columnheader]{cursor:pointer}.md-typeset table th[role=columnheader]::after{display:inline-block;width:1.2em;height:1.2em;margin-left:.5em;vertical-align:sub;-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;content:" "}.md-typeset table th[role=columnheader][aria-sort=ascending]::after{background-color:currentColor;-webkit-mask-image:var(--md-typeset-table--ascending);mask-image:var(--md-typeset-table--ascending)}.md-typeset table th[role=columnheader][aria-sort=descending]::after{background-color:currentColor;-webkit-mask-image:var(--md-typeset-table--descending);mask-image:var(--md-typeset-table--descending)}.md-typeset__scrollwrap{margin:1em -0.8rem;overflow-x:auto;touch-action:auto}.md-typeset__table{display:inline-block;margin-bottom:.5em;padding:0 .8rem}@media print{.md-typeset__table{display:block}}html .md-typeset__table table{display:table;width:100%;margin:0;overflow:hidden}html{height:100%;overflow-x:hidden;font-size:125%}@media screen and (min-width: 100em){html{font-size:137.5%}}@media screen and (min-width: 125em){html{font-size:150%}}body{position:relative;display:flex;flex-direction:column;width:100%;min-height:100%;font-size:.5rem;background-color:var(--md-default-bg-color)}@media screen and (max-width: 59.9375em){body[data-md-state=lock]{position:fixed}}@media print{body{display:block}}hr{display:block;height:.05rem;padding:0;border:0}.md-grid{max-width:61rem;margin-right:auto;margin-left:auto}.md-container{display:flex;flex-direction:column;flex-grow:1}@media print{.md-container{display:block}}.md-main{flex-grow:1}.md-main__inner{display:flex;height:100%;margin-top:1.5rem}.md-ellipsis{overflow:hidden;white-space:nowrap;text-overflow:ellipsis}.md-toggle{display:none}.md-overlay{position:fixed;top:0;z-index:3;width:0;height:0;background-color:rgba(0,0,0,.54);opacity:0;transition:width 0ms 250ms,height 0ms 250ms,opacity 250ms}@media screen and (max-width: 76.1875em){[data-md-toggle=drawer]:checked~.md-overlay{width:100%;height:100%;opacity:1;transition:width 0ms,height 0ms,opacity 250ms}}.md-skip{position:fixed;z-index:-1;margin:.5rem;padding:.3rem .5rem;color:var(--md-default-bg-color);font-size:.64rem;background-color:var(--md-default-fg-color);border-radius:.1rem;transform:translateY(0.4rem);opacity:0}.md-skip:focus{z-index:10;transform:translateY(0);opacity:1;transition:transform 250ms cubic-bezier(0.4, 0, 0.2, 1),opacity 175ms 75ms}@page{margin:25mm}.md-announce{overflow:auto;background-color:var(--md-footer-bg-color)}.md-announce__inner{margin:.6rem auto;padding:0 .8rem;color:var(--md-footer-fg-color);font-size:.7rem}@media print{.md-announce{display:none}}.md-typeset .md-button{display:inline-block;padding:.625em 2em;color:var(--md-primary-fg-color);font-weight:700;border:.1rem solid currentColor;border-radius:.1rem;transition:color 125ms,background-color 125ms,border-color 125ms}.md-typeset .md-button--primary{color:var(--md-primary-bg-color);background-color:var(--md-primary-fg-color);border-color:var(--md-primary-fg-color)}.md-typeset .md-button:focus,.md-typeset .md-button:hover{color:var(--md-accent-bg-color);background-color:var(--md-accent-fg-color);border-color:var(--md-accent-fg-color)}:root{--md-clipboard-icon: url('data:image/svg+xml;charset=utf-8,')}.md-clipboard{position:absolute;top:.5em;right:.5em;z-index:1;width:1.5em;height:1.5em;color:var(--md-default-fg-color--lightest);border-radius:.1rem;cursor:pointer;transition:color 250ms}@media print{.md-clipboard{display:none}}.md-clipboard::after{display:block;width:1.125em;height:1.125em;margin:0 auto;background-color:currentColor;-webkit-mask-image:var(--md-clipboard-icon);mask-image:var(--md-clipboard-icon);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;content:""}pre:hover .md-clipboard{color:var(--md-default-fg-color--light)}pre .md-clipboard:focus,pre .md-clipboard:hover{color:var(--md-accent-fg-color)}.md-content{flex-grow:1;overflow:auto}.md-content__inner{margin:0 .8rem 1.2rem;padding-top:.6rem}@media screen and (min-width: 76.25em){.md-content__inner{margin-right:1.2rem;margin-left:1.2rem}}.md-content__inner::before{display:block;height:.4rem;content:""}.md-content__inner>:last-child{margin-bottom:0}.md-content__button{float:right;margin:.4rem 0;margin-left:.4rem;padding:0}[dir=rtl] .md-content__button{float:left;margin-right:.4rem;margin-left:initial}[dir=rtl] .md-content__button svg{transform:scaleX(-1)}.md-typeset .md-content__button{color:var(--md-default-fg-color--lighter)}.md-content__button svg{display:inline;vertical-align:top}@media print{.md-content__button{display:none}}.md-dialog{box-shadow:0 2px 2px 0 rgba(0,0,0,.14),0 1px 5px 0 rgba(0,0,0,.12),0 3px 1px -2px rgba(0,0,0,.2);position:fixed;right:.8rem;bottom:.8rem;left:initial;z-index:2;display:block;min-width:11.1rem;padding:.4rem .6rem;color:var(--md-default-bg-color);font-size:.7rem;background-color:var(--md-default-fg-color);border:none;border-radius:.1rem;transform:translateY(100%);opacity:0;transition:transform 0ms 400ms,opacity 400ms}[dir=rtl] .md-dialog{right:initial;left:.8rem}.md-dialog[data-md-state=open]{transform:translateY(0);opacity:1;transition:transform 400ms cubic-bezier(0.075, 0.85, 0.175, 1),opacity 400ms}@media print{.md-dialog{display:none}}.md-header{position:-webkit-sticky;position:sticky;top:0;right:0;left:0;z-index:2;height:2.4rem;color:var(--md-primary-bg-color);background-color:var(--md-primary-fg-color);box-shadow:0 0 .2rem rgba(0,0,0,0),0 .2rem .4rem rgba(0,0,0,0);transition:color 250ms,background-color 250ms}.no-js .md-header{box-shadow:none;transition:none}.md-header[data-md-state=shadow]{box-shadow:0 0 .2rem rgba(0,0,0,.1),0 .2rem .4rem rgba(0,0,0,.2);transition:transform 250ms cubic-bezier(0.1, 0.7, 0.1, 1),color 250ms,background-color 250ms,box-shadow 250ms}.md-header[data-md-state=hidden]{transform:translateY(-100%);transition:transform 250ms cubic-bezier(0.8, 0, 0.6, 1),color 250ms,background-color 250ms,box-shadow 250ms}@media print{.md-header{display:none}}.md-header-nav{display:flex;padding:0 .2rem}.md-header-nav__button{position:relative;z-index:1;display:block;margin:.2rem;padding:.4rem;color:currentColor;cursor:pointer;transition:opacity 250ms}.md-header-nav__button:not(.focus-visible){outline:none}.md-header-nav__button:focus,.md-header-nav__button:hover{opacity:.7}.md-header-nav__button.md-logo{margin:.2rem;padding:.4rem}.md-header-nav__button.md-logo img,.md-header-nav__button.md-logo svg{display:block;width:1.2rem;height:1.2rem;fill:currentColor}[dir=rtl] .md-header-nav__button[for=__search] svg{transform:scaleX(-1)}.no-js .md-header-nav__button[for=__search]{display:none}@media screen and (min-width: 60em){.md-header-nav__button[for=__search]{display:none}}@media screen and (max-width: 76.1875em){.md-header-nav__button.md-logo{display:none}}@media screen and (min-width: 76.25em){.md-header-nav__button[for=__drawer]{display:none}}.md-header-nav__topic{position:absolute;display:flex;max-width:100%;transition:transform 400ms cubic-bezier(0.1, 0.7, 0.1, 1),opacity 150ms}.md-header-nav__topic+.md-header-nav__topic{z-index:-1;transform:translateX(1.25rem);opacity:0;transition:transform 400ms cubic-bezier(1, 0.7, 0.1, 0.1),opacity 150ms;pointer-events:none}[dir=rtl] .md-header-nav__topic+.md-header-nav__topic{transform:translateX(-1.25rem)}.no-js .md-header-nav__topic{position:initial}.no-js .md-header-nav__topic+.md-header-nav__topic{display:none}.md-header-nav__title{flex-grow:1;margin-right:.4rem;margin-left:1rem;font-size:.9rem;line-height:2.4rem}.md-header-nav__title[data-md-state=active] .md-header-nav__topic{z-index:-1;transform:translateX(-1.25rem);opacity:0;transition:transform 400ms cubic-bezier(1, 0.7, 0.1, 0.1),opacity 150ms;pointer-events:none}[dir=rtl] .md-header-nav__title[data-md-state=active] .md-header-nav__topic{transform:translateX(1.25rem)}.md-header-nav__title[data-md-state=active] .md-header-nav__topic+.md-header-nav__topic{z-index:0;transform:translateX(0);opacity:1;transition:transform 400ms cubic-bezier(0.1, 0.7, 0.1, 1),opacity 150ms;pointer-events:initial}.md-header-nav__title>.md-header-nav__ellipsis{position:relative;width:100%;height:100%}.md-header-nav__options{max-width:100%;transition:max-width 0ms 250ms,opacity 250ms 250ms}[data-md-toggle=search]:checked~.md-header .md-header-nav__options{max-width:0;opacity:0;transition:max-width 0ms,opacity 0ms}.md-header-nav__options>[data-md-state=hidden]{display:none}.md-header-nav__source{display:none}@media screen and (min-width: 60em){.md-header-nav__source{display:block;width:11.7rem;max-width:11.7rem;margin-left:1rem}[dir=rtl] .md-header-nav__source{margin-right:1rem;margin-left:initial}}@media screen and (min-width: 76.25em){.md-header-nav__source{margin-left:1.4rem}[dir=rtl] .md-header-nav__source{margin-right:1.4rem}}.md-footer{color:var(--md-footer-fg-color);background-color:var(--md-footer-bg-color)}@media print{.md-footer{display:none}}.md-footer-nav__inner{padding:.2rem;overflow:auto}.md-footer-nav__link{display:flex;padding-top:1.4rem;padding-bottom:.4rem;transition:opacity 250ms}@media screen and (min-width: 45em){.md-footer-nav__link{width:50%}}.md-footer-nav__link:focus,.md-footer-nav__link:hover{opacity:.7}.md-footer-nav__link--prev{float:left}[dir=rtl] .md-footer-nav__link--prev{float:right}[dir=rtl] .md-footer-nav__link--prev svg{transform:scaleX(-1)}@media screen and (max-width: 44.9375em){.md-footer-nav__link--prev{width:25%}.md-footer-nav__link--prev .md-footer-nav__title{display:none}}.md-footer-nav__link--next{float:right;text-align:right}[dir=rtl] .md-footer-nav__link--next{float:left;text-align:left}[dir=rtl] .md-footer-nav__link--next svg{transform:scaleX(-1)}@media screen and (max-width: 44.9375em){.md-footer-nav__link--next{width:75%}}.md-footer-nav__title{position:relative;flex-grow:1;max-width:calc(100% - 2.4rem);padding:0 1rem;font-size:.9rem;line-height:2.4rem}.md-footer-nav__button{margin:.2rem;padding:.4rem}.md-footer-nav__direction{position:absolute;right:0;left:0;margin-top:-1rem;padding:0 1rem;font-size:.64rem;opacity:.7}.md-footer-meta{background-color:var(--md-footer-bg-color--dark)}.md-footer-meta__inner{display:flex;flex-wrap:wrap;justify-content:space-between;padding:.2rem}html .md-footer-meta.md-typeset a{color:var(--md-footer-fg-color--light)}html .md-footer-meta.md-typeset a:focus,html .md-footer-meta.md-typeset a:hover{color:var(--md-footer-fg-color)}.md-footer-copyright{width:100%;margin:auto .6rem;padding:.4rem 0;color:var(--md-footer-fg-color--lighter);font-size:.64rem}@media screen and (min-width: 45em){.md-footer-copyright{width:auto}}.md-footer-copyright__highlight{color:var(--md-footer-fg-color--light)}.md-footer-social{margin:0 .4rem;padding:.2rem 0 .6rem}@media screen and (min-width: 45em){.md-footer-social{padding:.6rem 0}}.md-footer-social__link{display:inline-block;width:1.6rem;height:1.6rem;text-align:center}.md-footer-social__link::before{line-height:1.9}.md-footer-social__link svg{max-height:.8rem;vertical-align:-25%;fill:currentColor}:root{--md-nav-icon--prev: url('data:image/svg+xml;charset=utf-8,');--md-nav-icon--next: url('data:image/svg+xml;charset=utf-8,');--md-toc-icon: url('data:image/svg+xml;charset=utf-8,')}.md-nav{font-size:.7rem;line-height:1.3}.md-nav__title{display:block;padding:0 .6rem;overflow:hidden;font-weight:700;text-overflow:ellipsis}.md-nav__title .md-nav__button{display:none}.md-nav__title .md-nav__button img{width:100%;height:auto}.md-nav__title .md-nav__button.md-logo img,.md-nav__title .md-nav__button.md-logo svg{display:block;width:2.4rem;height:2.4rem}.md-nav__title .md-nav__button.md-logo svg{fill:currentColor}.md-nav__list{margin:0;padding:0;list-style:none}.md-nav__item{padding:0 .6rem}.md-nav__item:last-child{padding-bottom:.6rem}.md-nav__item .md-nav__item{padding-right:0}[dir=rtl] .md-nav__item .md-nav__item{padding-right:.6rem;padding-left:0}.md-nav__item .md-nav__item:last-child{padding-bottom:0}.md-nav__link{display:block;margin-top:.625em;overflow:hidden;text-overflow:ellipsis;cursor:pointer;transition:color 125ms;scroll-snap-align:start}html .md-nav__link[for=__toc]{display:none}html .md-nav__link[for=__toc]~.md-nav{display:none}.md-nav__link[data-md-state=blur]{color:var(--md-default-fg-color--light)}.md-nav__item .md-nav__link--active{color:var(--md-typeset-a-color)}.md-nav__item--nested>.md-nav__link{color:inherit}.md-nav__link:focus,.md-nav__link:hover{color:var(--md-accent-fg-color)}.md-nav__source{display:none}@media screen and (max-width: 76.1875em){.md-nav{background-color:var(--md-default-bg-color)}.md-nav--primary,.md-nav--primary .md-nav{position:absolute;top:0;right:0;left:0;z-index:1;display:flex;flex-direction:column;height:100%}.md-nav--primary .md-nav__title,.md-nav--primary .md-nav__item{font-size:.8rem;line-height:1.5}.md-nav--primary .md-nav__title{position:relative;height:5.6rem;padding:3rem .8rem .2rem;color:var(--md-default-fg-color--light);font-weight:400;line-height:2.4rem;white-space:nowrap;background-color:var(--md-default-fg-color--lightest);cursor:pointer}.md-nav--primary .md-nav__title .md-nav__icon{position:absolute;top:.4rem;left:.4rem;display:block;width:1.2rem;height:1.2rem;margin:.2rem}.md-nav--primary .md-nav__title .md-nav__icon::after{display:block;width:100%;height:100%;background-color:currentColor;-webkit-mask-image:var(--md-nav-icon--prev);mask-image:var(--md-nav-icon--prev);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;content:""}[dir=rtl] .md-nav--primary .md-nav__title .md-nav__icon{right:.4rem;left:initial}.md-nav--primary .md-nav__title~.md-nav__list{overflow-y:auto;background-color:var(--md-default-bg-color);box-shadow:0 .05rem 0 var(--md-default-fg-color--lightest) inset;-webkit-scroll-snap-type:y mandatory;-ms-scroll-snap-type:y mandatory;scroll-snap-type:y mandatory;touch-action:pan-y}.md-nav--primary .md-nav__title~.md-nav__list>.md-nav__item:first-child{border-top:0}.md-nav--primary .md-nav__title[for=__drawer]{position:relative;color:var(--md-primary-bg-color);background-color:var(--md-primary-fg-color)}.md-nav--primary .md-nav__title[for=__drawer] .md-nav__button{position:absolute;top:.2rem;left:.2rem;display:block;margin:.2rem;padding:.4rem;font-size:2.4rem}html [dir=rtl] .md-nav--primary .md-nav__title[for=__drawer] .md-nav__button{right:.2rem;left:initial}.md-nav--primary .md-nav__list{flex:1}.md-nav--primary .md-nav__item{padding:0;border-top:.05rem solid var(--md-default-fg-color--lightest)}[dir=rtl] .md-nav--primary .md-nav__item{padding:0}.md-nav--primary .md-nav__item--nested>.md-nav__link{padding-right:2.4rem}[dir=rtl] .md-nav--primary .md-nav__item--nested>.md-nav__link{padding-right:.8rem;padding-left:2.4rem}.md-nav--primary .md-nav__item--active>.md-nav__link{color:var(--md-typeset-a-color)}.md-nav--primary .md-nav__item--active>.md-nav__link:focus,.md-nav--primary .md-nav__item--active>.md-nav__link:hover{color:var(--md-accent-fg-color)}.md-nav--primary .md-nav__link{position:relative;margin-top:0;padding:.6rem .8rem}.md-nav--primary .md-nav__link .md-nav__icon{position:absolute;top:50%;right:.6rem;width:1.2rem;height:1.2rem;margin-top:-0.6rem;color:inherit;font-size:1.2rem}.md-nav--primary .md-nav__link .md-nav__icon::after{display:block;width:100%;height:100%;background-color:currentColor;-webkit-mask-image:var(--md-nav-icon--next);mask-image:var(--md-nav-icon--next);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;content:""}[dir=rtl] .md-nav--primary .md-nav__link .md-nav__icon{right:initial;left:.6rem}[dir=rtl] .md-nav--primary .md-nav__icon::after{transform:scale(-1)}.md-nav--primary .md-nav--secondary .md-nav__link{position:static}.md-nav--primary .md-nav--secondary .md-nav{position:static;background-color:transparent}.md-nav--primary .md-nav--secondary .md-nav .md-nav__link{padding-left:1.4rem}[dir=rtl] .md-nav--primary .md-nav--secondary .md-nav .md-nav__link{padding-right:1.4rem;padding-left:initial}.md-nav--primary .md-nav--secondary .md-nav .md-nav .md-nav__link{padding-left:2rem}[dir=rtl] .md-nav--primary .md-nav--secondary .md-nav .md-nav .md-nav__link{padding-right:2rem;padding-left:initial}.md-nav--primary .md-nav--secondary .md-nav .md-nav .md-nav .md-nav__link{padding-left:2.6rem}[dir=rtl] .md-nav--primary .md-nav--secondary .md-nav .md-nav .md-nav .md-nav__link{padding-right:2.6rem;padding-left:initial}.md-nav--primary .md-nav--secondary .md-nav .md-nav .md-nav .md-nav .md-nav__link{padding-left:3.2rem}[dir=rtl] .md-nav--primary .md-nav--secondary .md-nav .md-nav .md-nav .md-nav .md-nav__link{padding-right:3.2rem;padding-left:initial}.md-nav__toggle~.md-nav{display:flex;transform:translateX(100%);opacity:0;transition:transform 250ms cubic-bezier(0.8, 0, 0.6, 1),opacity 125ms 50ms}[dir=rtl] .md-nav__toggle~.md-nav{transform:translateX(-100%)}.md-nav__toggle:checked~.md-nav{transform:translateX(0);opacity:1;transition:transform 250ms cubic-bezier(0.4, 0, 0.2, 1),opacity 125ms 125ms}.md-nav__toggle:checked~.md-nav>.md-nav__list{-webkit-backface-visibility:hidden;backface-visibility:hidden}}@media screen and (max-width: 59.9375em){html .md-nav__link[for=__toc]{display:block;padding-right:2.4rem}html .md-nav__link[for=__toc]+.md-nav__link{display:none}html .md-nav__link[for=__toc] .md-icon::after{display:block;width:100%;height:100%;-webkit-mask-image:var(--md-toc-icon);mask-image:var(--md-toc-icon);background-color:currentColor;content:""}html .md-nav__link[for=__toc]~.md-nav{display:flex}html [dir=rtl] .md-nav__link{padding-right:.8rem;padding-left:2.4rem}.md-nav__source{display:block;padding:0 .2rem;color:var(--md-primary-bg-color);background-color:var(--md-primary-fg-color--dark)}}@media screen and (min-width: 60em){.md-nav--secondary .md-nav__title[for=__toc]{scroll-snap-align:start}.md-nav--secondary .md-nav__title .md-nav__icon{display:none}}@media screen and (min-width: 76.25em){.md-nav{transition:max-height 250ms cubic-bezier(0.86, 0, 0.07, 1)}.md-nav--primary .md-nav__title[for=__drawer]{scroll-snap-align:start}.md-nav--primary .md-nav__title .md-nav__icon{display:none}.md-nav__toggle~.md-nav{display:none}.md-nav__toggle:checked~.md-nav,.md-nav__toggle:indeterminate~.md-nav{display:block}.md-nav__item--nested>.md-nav>.md-nav__title{display:none}.md-nav__icon{float:right;width:.9rem;height:.9rem;transition:transform 250ms}[dir=rtl] .md-nav__icon{float:left;transform:rotate(180deg)}.md-nav__icon::after{display:inline-block;width:100%;height:100%;vertical-align:-0.1rem;background-color:currentColor;-webkit-mask-image:var(--md-nav-icon--next);mask-image:var(--md-nav-icon--next);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;content:""}.md-nav__item--nested .md-nav__toggle:checked~.md-nav__link .md-nav__icon,.md-nav__item--nested .md-nav__toggle:indeterminate~.md-nav__link .md-nav__icon{transform:rotate(90deg)}}:root{--md-search-result-icon: url('data:image/svg+xml;charset=utf-8,')}.md-search{position:relative}.no-js .md-search{display:none}@media screen and (min-width: 60em){.md-search{padding:.2rem 0}}.md-search__overlay{z-index:1;opacity:0}@media screen and (max-width: 59.9375em){.md-search__overlay{position:absolute;top:.2rem;left:-2.2rem;width:2rem;height:2rem;overflow:hidden;background-color:var(--md-default-bg-color);border-radius:1rem;transform-origin:center;transition:transform 300ms 100ms,opacity 200ms 200ms;pointer-events:none}[dir=rtl] .md-search__overlay{right:-2.2rem;left:initial}[data-md-toggle=search]:checked~.md-header .md-search__overlay{opacity:1;transition:transform 400ms,opacity 100ms}}@media screen and (max-width: 29.9375em){[data-md-toggle=search]:checked~.md-header .md-search__overlay{transform:scale(45)}}@media screen and (min-width: 30em)and (max-width: 44.9375em){[data-md-toggle=search]:checked~.md-header .md-search__overlay{transform:scale(60)}}@media screen and (min-width: 45em)and (max-width: 59.9375em){[data-md-toggle=search]:checked~.md-header .md-search__overlay{transform:scale(75)}}@media screen and (min-width: 60em){.md-search__overlay{position:fixed;top:0;left:0;width:0;height:0;background-color:rgba(0,0,0,.54);cursor:pointer;transition:width 0ms 250ms,height 0ms 250ms,opacity 250ms}[dir=rtl] .md-search__overlay{right:0;left:initial}[data-md-toggle=search]:checked~.md-header .md-search__overlay{width:100%;height:100%;opacity:1;transition:width 0ms,height 0ms,opacity 250ms}}.md-search__inner{-webkit-backface-visibility:hidden;backface-visibility:hidden}@media screen and (max-width: 59.9375em){.md-search__inner{position:fixed;top:0;left:100%;z-index:2;width:100%;height:100%;transform:translateX(5%);opacity:0;transition:right 0ms 300ms,left 0ms 300ms,transform 150ms 150ms cubic-bezier(0.4, 0, 0.2, 1),opacity 150ms 150ms}[data-md-toggle=search]:checked~.md-header .md-search__inner{left:0;transform:translateX(0);opacity:1;transition:right 0ms 0ms,left 0ms 0ms,transform 150ms 150ms cubic-bezier(0.1, 0.7, 0.1, 1),opacity 150ms 150ms}[dir=rtl] [data-md-toggle=search]:checked~.md-header .md-search__inner{right:0;left:initial}html [dir=rtl] .md-search__inner{right:100%;left:initial;transform:translateX(-5%)}}@media screen and (min-width: 60em){.md-search__inner{position:relative;float:right;width:11.7rem;padding:.1rem 0;transition:width 250ms cubic-bezier(0.1, 0.7, 0.1, 1)}[dir=rtl] .md-search__inner{float:left}}@media screen and (min-width: 60em)and (max-width: 76.1875em){[data-md-toggle=search]:checked~.md-header .md-search__inner{width:23.4rem}}@media screen and (min-width: 76.25em){[data-md-toggle=search]:checked~.md-header .md-search__inner{width:34.4rem}}.md-search__form{position:relative;z-index:2;height:2.4rem;background-color:var(--md-default-bg-color);transition:color 250ms,background-color 250ms}@media screen and (min-width: 60em){.md-search__form{height:1.8rem;background-color:rgba(0,0,0,.26);border-radius:.1rem}.md-search__form:hover{background-color:rgba(255,255,255,.12)}}[data-md-toggle=search]:checked~.md-header .md-search__form{background-color:var(--md-default-bg-color);border-radius:.1rem .1rem 0 0}.md-search__input{position:relative;z-index:2;width:100%;height:100%;padding:0 2.2rem 0 3.6rem;font-size:.9rem;text-overflow:ellipsis;background:transparent}[dir=rtl] .md-search__input{padding:0 3.6rem 0 2.2rem}.md-search__input::-webkit-input-placeholder{-webkit-transition:color 250ms;transition:color 250ms}.md-search__input::-moz-placeholder{-moz-transition:color 250ms;transition:color 250ms}.md-search__input::-ms-input-placeholder{-ms-transition:color 250ms;transition:color 250ms}.md-search__input::placeholder{transition:color 250ms}.md-search__input::-webkit-input-placeholder{color:var(--md-default-fg-color--light)}.md-search__input::-moz-placeholder{color:var(--md-default-fg-color--light)}.md-search__input::-ms-input-placeholder{color:var(--md-default-fg-color--light)}.md-search__input~.md-search__icon,.md-search__input::placeholder{color:var(--md-default-fg-color--light)}.md-search__input::-ms-clear{display:none}@media screen and (min-width: 60em){.md-search__input{padding-left:2.2rem;color:inherit;font-size:.8rem}[dir=rtl] .md-search__input{padding-right:2.2rem}.md-search__input+.md-search__icon{color:var(--md-primary-bg-color)}.md-search__input::-webkit-input-placeholder{color:var(--md-primary-bg-color--light)}.md-search__input::-moz-placeholder{color:var(--md-primary-bg-color--light)}.md-search__input::-ms-input-placeholder{color:var(--md-primary-bg-color--light)}.md-search__input::placeholder{color:var(--md-primary-bg-color--light)}[data-md-toggle=search]:checked~.md-header .md-search__input{color:var(--md-default-fg-color);text-overflow:clip}[data-md-toggle=search]:checked~.md-header .md-search__input::-webkit-input-placeholder{color:var(--md-default-fg-color--light)}[data-md-toggle=search]:checked~.md-header .md-search__input::-moz-placeholder{color:var(--md-default-fg-color--light)}[data-md-toggle=search]:checked~.md-header .md-search__input::-ms-input-placeholder{color:var(--md-default-fg-color--light)}[data-md-toggle=search]:checked~.md-header .md-search__input+.md-search__icon,[data-md-toggle=search]:checked~.md-header .md-search__input::placeholder{color:var(--md-default-fg-color--light)}}.md-search__suggest{position:absolute;top:0;display:flex;align-items:center;width:100%;height:100%;padding:0 2.2rem 0 3.6rem;color:var(--md-default-fg-color--lighter);font-size:.9rem}[dir=rtl] .md-search__suggest{padding:0 3.6rem 0 2.2rem}@media screen and (min-width: 60em){.md-search__suggest{padding-left:2.2rem;font-size:.8rem}[dir=rtl] .md-search__suggest{padding-right:2.2rem}}.md-search__icon{position:absolute;z-index:2;width:1.2rem;height:1.2rem;cursor:pointer;transition:color 250ms,opacity 250ms}.md-search__icon:hover{opacity:.7}.md-search__icon[for=__search]{top:.3rem;left:.5rem}[dir=rtl] .md-search__icon[for=__search]{right:.5rem;left:initial}[dir=rtl] .md-search__icon[for=__search] svg{transform:scaleX(-1)}@media screen and (max-width: 59.9375em){.md-search__icon[for=__search]{top:.6rem;left:.8rem}[dir=rtl] .md-search__icon[for=__search]{right:.8rem;left:initial}.md-search__icon[for=__search] svg:first-child{display:none}}@media screen and (min-width: 60em){.md-search__icon[for=__search]{pointer-events:none}.md-search__icon[for=__search] svg:last-child{display:none}}.md-search__icon[type=reset]{top:.3rem;right:.5rem;transform:scale(0.75);opacity:0;transition:transform 150ms cubic-bezier(0.1, 0.7, 0.1, 1),opacity 150ms;pointer-events:none}[dir=rtl] .md-search__icon[type=reset]{right:initial;left:.5rem}@media screen and (max-width: 59.9375em){.md-search__icon[type=reset]{top:.6rem;right:.8rem}[dir=rtl] .md-search__icon[type=reset]{right:initial;left:.8rem}}[data-md-toggle=search]:checked~.md-header .md-search__input:not(:-moz-placeholder-shown)~.md-search__icon[type=reset]{transform:scale(1);opacity:1;pointer-events:initial}[data-md-toggle=search]:checked~.md-header .md-search__input:not(:placeholder-shown)~.md-search__icon[type=reset]{transform:scale(1);opacity:1;pointer-events:initial}[data-md-toggle=search]:checked~.md-header .md-search__input:not(:-moz-placeholder-shown)~.md-search__icon[type=reset]:hover{opacity:.7}[data-md-toggle=search]:checked~.md-header .md-search__input:not(:placeholder-shown)~.md-search__icon[type=reset]:hover{opacity:.7}.md-search__output{position:absolute;z-index:1;width:100%;overflow:hidden;border-radius:0 0 .1rem .1rem}@media screen and (max-width: 59.9375em){.md-search__output{top:2.4rem;bottom:0}}@media screen and (min-width: 60em){.md-search__output{top:1.9rem;opacity:0;transition:opacity 400ms}[data-md-toggle=search]:checked~.md-header .md-search__output{box-shadow:0 6px 10px 0 rgba(0,0,0,.14),0 1px 18px 0 rgba(0,0,0,.12),0 3px 5px -1px rgba(0,0,0,.4);opacity:1}}.md-search__scrollwrap{height:100%;overflow-y:auto;background-color:var(--md-default-bg-color);-webkit-backface-visibility:hidden;backface-visibility:hidden;-webkit-scroll-snap-type:y mandatory;-ms-scroll-snap-type:y mandatory;scroll-snap-type:y mandatory;touch-action:pan-y}@media(-webkit-max-device-pixel-ratio: 1), (max-resolution: 1dppx){.md-search__scrollwrap{transform:translateZ(0)}}@media screen and (min-width: 60em)and (max-width: 76.1875em){.md-search__scrollwrap{width:23.4rem}}@media screen and (min-width: 76.25em){.md-search__scrollwrap{width:34.4rem}}@media screen and (min-width: 60em){.md-search__scrollwrap{max-height:0;scrollbar-width:thin;scrollbar-color:var(--md-default-fg-color--lighter) transparent}[data-md-toggle=search]:checked~.md-header .md-search__scrollwrap{max-height:75vh}.md-search__scrollwrap:hover{scrollbar-color:var(--md-accent-fg-color) transparent}.md-search__scrollwrap::-webkit-scrollbar{width:.2rem;height:.2rem}.md-search__scrollwrap::-webkit-scrollbar-thumb{background-color:var(--md-default-fg-color--lighter)}.md-search__scrollwrap::-webkit-scrollbar-thumb:hover{background-color:var(--md-accent-fg-color)}}.md-search-result{color:var(--md-default-fg-color);word-break:break-word}.md-search-result__meta{padding:0 .8rem;color:var(--md-default-fg-color--light);font-size:.64rem;line-height:1.8rem;background-color:var(--md-default-fg-color--lightest);scroll-snap-align:start}@media screen and (min-width: 60em){.md-search-result__meta{padding-left:2.2rem}[dir=rtl] .md-search-result__meta{padding-right:2.2rem;padding-left:initial}}.md-search-result__list{margin:0;padding:0;list-style:none}.md-search-result__item{box-shadow:0 -0.05rem 0 var(--md-default-fg-color--lightest)}.md-search-result__item:first-child{box-shadow:none}.md-search-result__link{display:block;outline:none;transition:background-color 250ms;scroll-snap-align:start}.md-search-result__link:focus,.md-search-result__link:hover{background-color:var(--md-accent-fg-color--transparent)}.md-search-result__link:focus .md-search-result__article::before,.md-search-result__link:hover .md-search-result__article::before{opacity:.7}.md-search-result__link:last-child p:last-child{margin-bottom:.6rem}.md-search-result__more summary{display:block;padding:.75em .8rem;color:var(--md-typeset-a-color);font-size:.64rem;outline:0;cursor:pointer;transition:color 250ms,background-color 250ms;scroll-snap-align:start}.md-search-result__more summary:focus,.md-search-result__more summary:hover{color:var(--md-accent-fg-color);background-color:var(--md-accent-fg-color--transparent)}@media screen and (min-width: 60em){.md-search-result__more summary{padding-left:2.2rem}[dir=rtl] .md-search-result__more summary{padding-right:2.2rem;padding-left:.8rem}}.md-search-result__more summary::-webkit-details-marker{display:none}.md-search-result__more summary~*>*{opacity:.65}.md-search-result__article{position:relative;padding:0 .8rem;overflow:hidden}@media screen and (min-width: 60em){.md-search-result__article{padding-left:2.2rem}[dir=rtl] .md-search-result__article{padding-right:2.2rem;padding-left:.8rem}}.md-search-result__article--document .md-search-result__title{margin:.55rem 0;font-weight:400;font-size:.8rem;line-height:1.4}.md-search-result__icon{position:absolute;left:0;width:1.2rem;height:1.2rem;margin:.5rem;color:var(--md-default-fg-color--light)}.md-search-result__icon::after{display:inline-block;width:100%;height:100%;background-color:currentColor;-webkit-mask-image:var(--md-search-result-icon);mask-image:var(--md-search-result-icon);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;content:""}[dir=rtl] .md-search-result__icon{right:0;left:initial}[dir=rtl] .md-search-result__icon::after{transform:scaleX(-1)}@media screen and (max-width: 59.9375em){.md-search-result__icon{display:none}}.md-search-result__title{margin:.5em 0;font-weight:700;font-size:.64rem;line-height:1.6}.md-search-result__teaser{display:-webkit-box;max-height:2rem;margin:.5em 0;overflow:hidden;color:var(--md-default-fg-color--light);font-size:.64rem;line-height:1.6;text-overflow:ellipsis;-webkit-box-orient:vertical;-webkit-line-clamp:2}@media screen and (max-width: 44.9375em){.md-search-result__teaser{max-height:3rem;-webkit-line-clamp:3}}@media screen and (min-width: 60em)and (max-width: 76.1875em){.md-search-result__teaser{max-height:3rem;-webkit-line-clamp:3}}.md-search-result__teaser mark{text-decoration:underline;background-color:transparent}.md-search-result__terms{margin:.5em 0;font-size:.64rem;font-style:italic}.md-search-result mark{color:var(--md-accent-fg-color);background-color:transparent}@-webkit-keyframes md-sidebar__scrollwrap--hack{0%,99%{-webkit-scroll-snap-type:none;scroll-snap-type:none}100%{-webkit-scroll-snap-type:y mandatory;scroll-snap-type:y mandatory}}@keyframes md-sidebar__scrollwrap--hack{0%,99%{-webkit-scroll-snap-type:none;-ms-scroll-snap-type:none;scroll-snap-type:none}100%{-webkit-scroll-snap-type:y mandatory;-ms-scroll-snap-type:y mandatory;scroll-snap-type:y mandatory}}.md-sidebar{position:-webkit-sticky;position:sticky;top:2.4rem;flex-shrink:0;align-self:flex-start;width:12.1rem;padding:1.2rem 0;overflow:hidden}@media print{.md-sidebar{display:none}}@media screen and (max-width: 76.1875em){.md-sidebar--primary{position:fixed;top:0;left:-12.1rem;z-index:3;width:12.1rem;height:100%;background-color:var(--md-default-bg-color);transform:translateX(0);transition:transform 250ms cubic-bezier(0.4, 0, 0.2, 1),box-shadow 250ms}[dir=rtl] .md-sidebar--primary{right:-12.1rem;left:initial}[data-md-toggle=drawer]:checked~.md-container .md-sidebar--primary{box-shadow:0 8px 10px 1px rgba(0,0,0,.14),0 3px 14px 2px rgba(0,0,0,.12),0 5px 5px -3px rgba(0,0,0,.4);transform:translateX(12.1rem)}[dir=rtl] [data-md-toggle=drawer]:checked~.md-container .md-sidebar--primary{transform:translateX(-12.1rem)}.md-sidebar--primary .md-sidebar__scrollwrap{overflow:hidden}}.md-sidebar--secondary{display:none;order:2}@media screen and (min-width: 60em){.md-sidebar--secondary{display:block}.md-sidebar--secondary .md-sidebar__scrollwrap{touch-action:pan-y}}.md-sidebar__scrollwrap{max-height:100%;margin:0 .2rem;overflow-y:auto;-webkit-backface-visibility:hidden;backface-visibility:hidden;scrollbar-width:thin;scrollbar-color:var(--md-default-fg-color--lighter) transparent}.js .md-sidebar__scrollwrap{-webkit-animation:md-sidebar__scrollwrap--hack 400ms forwards;animation:md-sidebar__scrollwrap--hack 400ms forwards}@media screen and (max-width: 76.1875em){.md-sidebar--primary .md-sidebar__scrollwrap{position:absolute;top:0;right:0;bottom:0;left:0;margin:0;-webkit-scroll-snap-type:none;-ms-scroll-snap-type:none;scroll-snap-type:none}}.md-sidebar__scrollwrap:hover{scrollbar-color:var(--md-accent-fg-color) transparent}.md-sidebar__scrollwrap::-webkit-scrollbar{width:.2rem;height:.2rem}.md-sidebar__scrollwrap::-webkit-scrollbar-thumb{background-color:var(--md-default-fg-color--lighter)}.md-sidebar__scrollwrap::-webkit-scrollbar-thumb:hover{background-color:var(--md-accent-fg-color)}@-webkit-keyframes md-source__facts--done{0%{height:0}100%{height:.65rem}}@keyframes md-source__facts--done{0%{height:0}100%{height:.65rem}}@-webkit-keyframes md-source__fact--done{0%{transform:translateY(100%);opacity:0}50%{opacity:0}100%{transform:translateY(0%);opacity:1}}@keyframes md-source__fact--done{0%{transform:translateY(100%);opacity:0}50%{opacity:0}100%{transform:translateY(0%);opacity:1}}.md-source{display:block;font-size:.65rem;line-height:1.2;white-space:nowrap;-webkit-backface-visibility:hidden;backface-visibility:hidden;transition:opacity 250ms}.md-source:hover{opacity:.7}.md-source__icon{display:inline-block;width:2.4rem;height:2.4rem;vertical-align:middle}.md-source__icon svg{margin-top:.6rem;margin-left:.6rem}[dir=rtl] .md-source__icon svg{margin-right:.6rem;margin-left:initial}.md-source__icon+.md-source__repository{margin-left:-2rem;padding-left:2rem}[dir=rtl] .md-source__icon+.md-source__repository{margin-right:-2rem;margin-left:initial;padding-right:2rem;padding-left:initial}.md-source__repository{display:inline-block;max-width:calc(100% - 1.2rem);margin-left:.6rem;overflow:hidden;font-weight:700;text-overflow:ellipsis;vertical-align:middle}.md-source__facts{margin:0;padding:0;overflow:hidden;font-weight:700;font-size:.55rem;list-style-type:none;opacity:.75}[data-md-state=done] .md-source__facts{-webkit-animation:md-source__facts--done 250ms ease-in;animation:md-source__facts--done 250ms ease-in}.md-source__fact{float:left}[dir=rtl] .md-source__fact{float:right}[data-md-state=done] .md-source__fact{-webkit-animation:md-source__fact--done 400ms ease-out;animation:md-source__fact--done 400ms ease-out}.md-source__fact::before{margin:0 .1rem;content:"·"}.md-source__fact:first-child::before{display:none}.md-tabs{width:100%;overflow:auto;color:var(--md-primary-bg-color);background-color:var(--md-primary-fg-color);transition:background-color 250ms}.no-js .md-tabs{transition:none}@media screen and (max-width: 76.1875em){.md-tabs{display:none}}@media print{.md-tabs{display:none}}.md-tabs__list{margin:0;margin-left:.2rem;padding:0;white-space:nowrap;list-style:none;contain:content}[dir=rtl] .md-tabs__list{margin-right:.2rem;margin-left:initial}.md-tabs__item{display:inline-block;height:2.4rem;padding-right:.6rem;padding-left:.6rem}.md-tabs__link{display:block;margin-top:.8rem;font-size:.7rem;opacity:.7;transition:transform 400ms cubic-bezier(0.1, 0.7, 0.1, 1),opacity 250ms}.no-js .md-tabs__link{transition:none}.md-tabs__link--active,.md-tabs__link:hover{color:inherit;opacity:1}.md-tabs__item:nth-child(2) .md-tabs__link{transition-delay:20ms}.md-tabs__item:nth-child(3) .md-tabs__link{transition-delay:40ms}.md-tabs__item:nth-child(4) .md-tabs__link{transition-delay:60ms}.md-tabs__item:nth-child(5) .md-tabs__link{transition-delay:80ms}.md-tabs__item:nth-child(6) .md-tabs__link{transition-delay:100ms}.md-tabs__item:nth-child(7) .md-tabs__link{transition-delay:120ms}.md-tabs__item:nth-child(8) .md-tabs__link{transition-delay:140ms}.md-tabs__item:nth-child(9) .md-tabs__link{transition-delay:160ms}.md-tabs__item:nth-child(10) .md-tabs__link{transition-delay:180ms}.md-tabs__item:nth-child(11) .md-tabs__link{transition-delay:200ms}.md-tabs__item:nth-child(12) .md-tabs__link{transition-delay:220ms}.md-tabs__item:nth-child(13) .md-tabs__link{transition-delay:240ms}.md-tabs__item:nth-child(14) .md-tabs__link{transition-delay:260ms}.md-tabs__item:nth-child(15) .md-tabs__link{transition-delay:280ms}.md-tabs__item:nth-child(16) .md-tabs__link{transition-delay:300ms}.md-tabs[data-md-state=hidden]{pointer-events:none}.md-tabs[data-md-state=hidden] .md-tabs__link{transform:translateY(50%);opacity:0;transition:color 250ms,transform 0ms 400ms,opacity 100ms}@media screen and (min-width: 76.25em){.md-tabs~.md-main .md-nav--primary>.md-nav__list>.md-nav__item--nested{display:none}.md-tabs--active~.md-main .md-nav--primary .md-nav__title{display:block;padding:0 .6rem;pointer-events:none;scroll-snap-align:start}.md-tabs--active~.md-main .md-nav--primary .md-nav__title[for=__drawer]{display:none}.md-tabs--active~.md-main .md-nav--primary>.md-nav__list>.md-nav__item{display:none}.md-tabs--active~.md-main .md-nav--primary>.md-nav__list>.md-nav__item--active{display:block;padding:0}.md-tabs--active~.md-main .md-nav--primary>.md-nav__list>.md-nav__item--active>.md-nav__link{display:none}.md-tabs--active~.md-main .md-nav[data-md-level="1"]{display:block}.md-tabs--active~.md-main .md-nav[data-md-level="1"]>.md-nav__list>.md-nav__item{padding:0 .6rem}.md-tabs--active~.md-main .md-nav[data-md-level="1"]>.md-nav__list>.md-nav__item:last-child{padding-bottom:.6rem}.md-tabs--active~.md-main .md-nav[data-md-level="1"]>.md-nav__list>.md-nav__item:last-child .md-nav__item{padding-bottom:0}.md-tabs--active~.md-main .md-nav[data-md-level="1"] .md-nav .md-nav__title{display:none}}:root{--md-version-icon: url( 'data:image/svg+xml;charset=utf-8,' )}.md-version{flex-shrink:0;height:2.4rem;font-size:.8rem}.md-version__current{position:relative;top:.05rem;margin-right:.4rem;margin-left:1.4rem}.md-version__current::after{display:inline-block;width:.4rem;height:.6rem;margin-left:.4rem;background-color:currentColor;-webkit-mask-image:var(--md-version-icon);mask-image:var(--md-version-icon);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;content:""}.md-version__list{position:absolute;top:.05rem;max-height:2rem;margin:.2rem .8rem .2rem;padding:0;overflow:scroll;color:var(--md-default-fg-color);list-style-type:none;background-color:var(--md-default-bg-color);border-radius:.1rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.1),0 0 .05rem rgba(0,0,0,.25);opacity:0;transition:opacity 250ms 250ms,max-height 0ms 500ms;-webkit-scroll-snap-type:y mandatory;-ms-scroll-snap-type:y mandatory;scroll-snap-type:y mandatory}.md-version__list:focus-within,.md-version__list:hover{max-height:10rem;opacity:1;transition:opacity 250ms,max-height 250ms}.md-version__item{line-height:2rem}.md-version__link{display:block;width:100%;padding-right:1.2rem;padding-left:.6rem;cursor:pointer;transition:background-color 250ms,color 250ms;scroll-snap-align:start}.md-version__link:focus,.md-version__link:hover{background-color:var(--md-default-fg-color--lightest)}:root{--md-admonition-icon--note: url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--abstract: url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--info: url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--tip: url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--success: url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--question: url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--warning: url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--failure: url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--danger: url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--bug: url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--example: url('data:image/svg+xml;charset=utf-8,');--md-admonition-icon--quote: url('data:image/svg+xml;charset=utf-8,')}.md-typeset .admonition,.md-typeset details{margin:1.5625em 0;padding:0 .6rem;overflow:hidden;color:var(--md-admonition-fg-color);font-size:.64rem;page-break-inside:avoid;background-color:var(--md-admonition-bg-color);border-left:.2rem solid #448aff;border-radius:.1rem;box-shadow:0 .2rem .5rem rgba(0,0,0,.05),0 0 .05rem rgba(0,0,0,.1)}[dir=rtl] .md-typeset .admonition,[dir=rtl] .md-typeset details{border-right:.2rem solid #448aff;border-left:none}@media print{.md-typeset .admonition,.md-typeset details{box-shadow:none}}html .md-typeset .admonition>:last-child,html .md-typeset details>:last-child{margin-bottom:.6rem}.md-typeset .admonition .admonition,.md-typeset details .admonition,.md-typeset .admonition details,.md-typeset details details{margin:1em 0}.md-typeset .admonition .md-typeset__scrollwrap,.md-typeset details .md-typeset__scrollwrap{margin:1em -0.6rem}.md-typeset .admonition .md-typeset__table,.md-typeset details .md-typeset__table{padding:0 .6rem}.md-typeset .admonition>.tabbed-set:only-child,.md-typeset details>.tabbed-set:only-child{margin-top:0}.md-typeset .admonition-title,.md-typeset summary{position:relative;margin:0 -0.6rem 0 -0.8rem;padding:.4rem .6rem .4rem 2rem;font-weight:700;background-color:rgba(68,138,255,.1);border-left:.2rem solid #448aff}[dir=rtl] .md-typeset .admonition-title,[dir=rtl] .md-typeset summary{margin:0 -0.8rem 0 -0.6rem;padding:.4rem 2rem .4rem .6rem}html .md-typeset .admonition-title:last-child,html .md-typeset summary:last-child{margin-bottom:0}.md-typeset .admonition-title::before,.md-typeset summary::before{position:absolute;left:.6rem;width:1rem;height:1rem;background-color:#448aff;-webkit-mask-image:var(--md-admonition-icon--note);mask-image:var(--md-admonition-icon--note);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;content:""}[dir=rtl] .md-typeset .admonition-title::before,[dir=rtl] .md-typeset summary::before{right:.8rem;left:initial}.md-typeset .admonition-title code,.md-typeset summary code{margin:initial;padding:initial;color:currentColor;background-color:transparent;border-radius:initial;box-shadow:none}.md-typeset .admonition-title+.tabbed-set:last-child,.md-typeset summary+.tabbed-set:last-child{margin-top:0}.md-typeset .admonition.note,.md-typeset details.note{border-color:#448aff}.md-typeset .note>.admonition-title,.md-typeset .note>summary{background-color:rgba(68,138,255,.1);border-color:#448aff}.md-typeset .note>.admonition-title::before,.md-typeset .note>summary::before{background-color:#448aff;-webkit-mask-image:var(--md-admonition-icon--note);mask-image:var(--md-admonition-icon--note);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.md-typeset .admonition.abstract,.md-typeset details.abstract,.md-typeset .admonition.tldr,.md-typeset details.tldr,.md-typeset .admonition.summary,.md-typeset details.summary{border-color:#00b0ff}.md-typeset .abstract>.admonition-title,.md-typeset .abstract>summary,.md-typeset .tldr>.admonition-title,.md-typeset .tldr>summary,.md-typeset .summary>.admonition-title,.md-typeset .summary>summary{background-color:rgba(0,176,255,.1);border-color:#00b0ff}.md-typeset .abstract>.admonition-title::before,.md-typeset .abstract>summary::before,.md-typeset .tldr>.admonition-title::before,.md-typeset .tldr>summary::before,.md-typeset .summary>.admonition-title::before,.md-typeset .summary>summary::before{background-color:#00b0ff;-webkit-mask-image:var(--md-admonition-icon--abstract);mask-image:var(--md-admonition-icon--abstract);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.md-typeset .admonition.info,.md-typeset details.info,.md-typeset .admonition.todo,.md-typeset details.todo{border-color:#00b8d4}.md-typeset .info>.admonition-title,.md-typeset .info>summary,.md-typeset .todo>.admonition-title,.md-typeset .todo>summary{background-color:rgba(0,184,212,.1);border-color:#00b8d4}.md-typeset .info>.admonition-title::before,.md-typeset .info>summary::before,.md-typeset .todo>.admonition-title::before,.md-typeset .todo>summary::before{background-color:#00b8d4;-webkit-mask-image:var(--md-admonition-icon--info);mask-image:var(--md-admonition-icon--info);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.md-typeset .admonition.tip,.md-typeset details.tip,.md-typeset .admonition.important,.md-typeset details.important,.md-typeset .admonition.hint,.md-typeset details.hint{border-color:#00bfa5}.md-typeset .tip>.admonition-title,.md-typeset .tip>summary,.md-typeset .important>.admonition-title,.md-typeset .important>summary,.md-typeset .hint>.admonition-title,.md-typeset .hint>summary{background-color:rgba(0,191,165,.1);border-color:#00bfa5}.md-typeset .tip>.admonition-title::before,.md-typeset .tip>summary::before,.md-typeset .important>.admonition-title::before,.md-typeset .important>summary::before,.md-typeset .hint>.admonition-title::before,.md-typeset .hint>summary::before{background-color:#00bfa5;-webkit-mask-image:var(--md-admonition-icon--tip);mask-image:var(--md-admonition-icon--tip);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.md-typeset .admonition.success,.md-typeset details.success,.md-typeset .admonition.done,.md-typeset details.done,.md-typeset .admonition.check,.md-typeset details.check{border-color:#00c853}.md-typeset .success>.admonition-title,.md-typeset .success>summary,.md-typeset .done>.admonition-title,.md-typeset .done>summary,.md-typeset .check>.admonition-title,.md-typeset .check>summary{background-color:rgba(0,200,83,.1);border-color:#00c853}.md-typeset .success>.admonition-title::before,.md-typeset .success>summary::before,.md-typeset .done>.admonition-title::before,.md-typeset .done>summary::before,.md-typeset .check>.admonition-title::before,.md-typeset .check>summary::before{background-color:#00c853;-webkit-mask-image:var(--md-admonition-icon--success);mask-image:var(--md-admonition-icon--success);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.md-typeset .admonition.question,.md-typeset details.question,.md-typeset .admonition.faq,.md-typeset details.faq,.md-typeset .admonition.help,.md-typeset details.help{border-color:#64dd17}.md-typeset .question>.admonition-title,.md-typeset .question>summary,.md-typeset .faq>.admonition-title,.md-typeset .faq>summary,.md-typeset .help>.admonition-title,.md-typeset .help>summary{background-color:rgba(100,221,23,.1);border-color:#64dd17}.md-typeset .question>.admonition-title::before,.md-typeset .question>summary::before,.md-typeset .faq>.admonition-title::before,.md-typeset .faq>summary::before,.md-typeset .help>.admonition-title::before,.md-typeset .help>summary::before{background-color:#64dd17;-webkit-mask-image:var(--md-admonition-icon--question);mask-image:var(--md-admonition-icon--question);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.md-typeset .admonition.warning,.md-typeset details.warning,.md-typeset .admonition.attention,.md-typeset details.attention,.md-typeset .admonition.caution,.md-typeset details.caution{border-color:#ff9100}.md-typeset .warning>.admonition-title,.md-typeset .warning>summary,.md-typeset .attention>.admonition-title,.md-typeset .attention>summary,.md-typeset .caution>.admonition-title,.md-typeset .caution>summary{background-color:rgba(255,145,0,.1);border-color:#ff9100}.md-typeset .warning>.admonition-title::before,.md-typeset .warning>summary::before,.md-typeset .attention>.admonition-title::before,.md-typeset .attention>summary::before,.md-typeset .caution>.admonition-title::before,.md-typeset .caution>summary::before{background-color:#ff9100;-webkit-mask-image:var(--md-admonition-icon--warning);mask-image:var(--md-admonition-icon--warning);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.md-typeset .admonition.failure,.md-typeset details.failure,.md-typeset .admonition.missing,.md-typeset details.missing,.md-typeset .admonition.fail,.md-typeset details.fail{border-color:#ff5252}.md-typeset .failure>.admonition-title,.md-typeset .failure>summary,.md-typeset .missing>.admonition-title,.md-typeset .missing>summary,.md-typeset .fail>.admonition-title,.md-typeset .fail>summary{background-color:rgba(255,82,82,.1);border-color:#ff5252}.md-typeset .failure>.admonition-title::before,.md-typeset .failure>summary::before,.md-typeset .missing>.admonition-title::before,.md-typeset .missing>summary::before,.md-typeset .fail>.admonition-title::before,.md-typeset .fail>summary::before{background-color:#ff5252;-webkit-mask-image:var(--md-admonition-icon--failure);mask-image:var(--md-admonition-icon--failure);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.md-typeset .admonition.danger,.md-typeset details.danger,.md-typeset .admonition.error,.md-typeset details.error{border-color:#ff1744}.md-typeset .danger>.admonition-title,.md-typeset .danger>summary,.md-typeset .error>.admonition-title,.md-typeset .error>summary{background-color:rgba(255,23,68,.1);border-color:#ff1744}.md-typeset .danger>.admonition-title::before,.md-typeset .danger>summary::before,.md-typeset .error>.admonition-title::before,.md-typeset .error>summary::before{background-color:#ff1744;-webkit-mask-image:var(--md-admonition-icon--danger);mask-image:var(--md-admonition-icon--danger);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.md-typeset .admonition.bug,.md-typeset details.bug{border-color:#f50057}.md-typeset .bug>.admonition-title,.md-typeset .bug>summary{background-color:rgba(245,0,87,.1);border-color:#f50057}.md-typeset .bug>.admonition-title::before,.md-typeset .bug>summary::before{background-color:#f50057;-webkit-mask-image:var(--md-admonition-icon--bug);mask-image:var(--md-admonition-icon--bug);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.md-typeset .admonition.example,.md-typeset details.example{border-color:#651fff}.md-typeset .example>.admonition-title,.md-typeset .example>summary{background-color:rgba(101,31,255,.1);border-color:#651fff}.md-typeset .example>.admonition-title::before,.md-typeset .example>summary::before{background-color:#651fff;-webkit-mask-image:var(--md-admonition-icon--example);mask-image:var(--md-admonition-icon--example);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.md-typeset .admonition.quote,.md-typeset details.quote,.md-typeset .admonition.cite,.md-typeset details.cite{border-color:#9e9e9e}.md-typeset .quote>.admonition-title,.md-typeset .quote>summary,.md-typeset .cite>.admonition-title,.md-typeset .cite>summary{background-color:rgba(158,158,158,.1);border-color:#9e9e9e}.md-typeset .quote>.admonition-title::before,.md-typeset .quote>summary::before,.md-typeset .cite>.admonition-title::before,.md-typeset .cite>summary::before{background-color:#9e9e9e;-webkit-mask-image:var(--md-admonition-icon--quote);mask-image:var(--md-admonition-icon--quote);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat}.codehilite .o,.highlight .o,.codehilite .ow,.highlight .ow{color:var(--md-code-hl-operator-color)}.codehilite .p,.highlight .p{color:var(--md-code-hl-punctuation-color)}.codehilite .cpf,.highlight .cpf,.codehilite .l,.highlight .l,.codehilite .s,.highlight .s,.codehilite .sb,.highlight .sb,.codehilite .sc,.highlight .sc,.codehilite .s2,.highlight .s2,.codehilite .si,.highlight .si,.codehilite .s1,.highlight .s1,.codehilite .ss,.highlight .ss{color:var(--md-code-hl-string-color)}.codehilite .cp,.highlight .cp,.codehilite .se,.highlight .se,.codehilite .sh,.highlight .sh,.codehilite .sr,.highlight .sr,.codehilite .sx,.highlight .sx{color:var(--md-code-hl-special-color)}.codehilite .m,.highlight .m,.codehilite .mf,.highlight .mf,.codehilite .mh,.highlight .mh,.codehilite .mi,.highlight .mi,.codehilite .il,.highlight .il,.codehilite .mo,.highlight .mo{color:var(--md-code-hl-number-color)}.codehilite .k,.highlight .k,.codehilite .kd,.highlight .kd,.codehilite .kn,.highlight .kn,.codehilite .kp,.highlight .kp,.codehilite .kr,.highlight .kr,.codehilite .kt,.highlight .kt{color:var(--md-code-hl-keyword-color)}.codehilite .kc,.highlight .kc,.codehilite .n,.highlight .n{color:var(--md-code-hl-name-color)}.codehilite .no,.highlight .no,.codehilite .nb,.highlight .nb,.codehilite .bp,.highlight .bp{color:var(--md-code-hl-constant-color)}.codehilite .nc,.highlight .nc,.codehilite .ne,.highlight .ne,.codehilite .nf,.highlight .nf,.codehilite .nn,.highlight .nn{color:var(--md-code-hl-function-color)}.codehilite .nd,.highlight .nd,.codehilite .ni,.highlight .ni,.codehilite .nl,.highlight .nl,.codehilite .nt,.highlight .nt{color:var(--md-code-hl-keyword-color)}.codehilite .c,.highlight .c,.codehilite .cm,.highlight .cm,.codehilite .c1,.highlight .c1,.codehilite .ch,.highlight .ch,.codehilite .cs,.highlight .cs,.codehilite .sd,.highlight .sd{color:var(--md-code-hl-comment-color)}.codehilite .na,.highlight .na,.codehilite .nv,.highlight .nv,.codehilite .vc,.highlight .vc,.codehilite .vg,.highlight .vg,.codehilite .vi,.highlight .vi{color:var(--md-code-hl-variable-color)}.codehilite .ge,.highlight .ge,.codehilite .gr,.highlight .gr,.codehilite .gh,.highlight .gh,.codehilite .go,.highlight .go,.codehilite .gp,.highlight .gp,.codehilite .gs,.highlight .gs,.codehilite .gu,.highlight .gu,.codehilite .gt,.highlight .gt{color:var(--md-code-hl-generic-color)}.codehilite .gd,.highlight .gd,.codehilite .gi,.highlight .gi{margin:0 -0.125em;padding:0 .125em;border-radius:.1rem}.codehilite .gd,.highlight .gd{background-color:var(--md-typeset-del-color)}.codehilite .gi,.highlight .gi{background-color:var(--md-typeset-ins-color)}.codehilite .hll,.highlight .hll{display:block;margin:0 -1.1764705882em;padding:0 1.1764705882em;background-color:var(--md-code-hl-color)}.codehilitetable,.highlighttable{display:block;overflow:hidden}.codehilitetable tbody,.highlighttable tbody,.codehilitetable td,.highlighttable td{display:block;padding:0}.codehilitetable tr,.highlighttable tr{display:flex}.codehilitetable pre,.highlighttable pre{margin:0}.codehilitetable .linenos,.highlighttable .linenos{padding:.525rem 1.1764705882em;padding-right:0;font-size:.85em;background-color:var(--md-code-bg-color);-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.codehilitetable .linenodiv,.highlighttable .linenodiv{padding-right:.5882352941em;box-shadow:-0.05rem 0 var(--md-default-fg-color--lighter) inset}.codehilitetable .linenodiv pre,.highlighttable .linenodiv pre{color:var(--md-default-fg-color--light);text-align:right}.codehilitetable .code,.highlighttable .code{flex:1;overflow:hidden}.md-typeset .codehilitetable,.md-typeset .highlighttable{margin:1em 0;direction:ltr;border-radius:.1rem}.md-typeset .codehilitetable code,.md-typeset .highlighttable code{border-radius:0}@media screen and (max-width: 44.9375em){.md-typeset>.codehilite,.md-typeset>.highlight{margin:1em -0.8rem}.md-typeset>.codehilite .hll,.md-typeset>.highlight .hll{margin:0 -0.8rem;padding:0 .8rem}.md-typeset>.codehilite code,.md-typeset>.highlight code{border-radius:0}.md-typeset>.codehilitetable,.md-typeset>.highlighttable{margin:1em -0.8rem;border-radius:0}.md-typeset>.codehilitetable .hll,.md-typeset>.highlighttable .hll{margin:0 -0.8rem;padding:0 .8rem}}:root{--md-footnotes-icon: url('data:image/svg+xml;charset=utf-8,')}.md-typeset [id^="fnref:"]{display:inline-block}.md-typeset .footnote{color:var(--md-default-fg-color--light);font-size:.64rem}.md-typeset .footnote ol{margin-left:0}.md-typeset .footnote li{transition:color 125ms}.md-typeset .footnote li:target{color:var(--md-default-fg-color)}.md-typeset .footnote li :first-child{margin-top:0}.md-typeset .footnote li:hover .footnote-backref,.md-typeset .footnote li:target .footnote-backref{transform:translateX(0);opacity:1}.md-typeset .footnote li:hover .footnote-backref:hover{color:var(--md-accent-fg-color)}.md-typeset .footnote-ref{display:inline-block;pointer-events:initial}.md-typeset .footnote-backref{display:inline-block;color:var(--md-typeset-a-color);font-size:0;vertical-align:text-bottom;transform:translateX(0.25rem);opacity:0;transition:color 250ms,transform 250ms 250ms,opacity 125ms 250ms}[dir=rtl] .md-typeset .footnote-backref{transform:translateX(-0.25rem)}.md-typeset .footnote-backref::before{display:inline-block;width:.8rem;height:.8rem;background-color:currentColor;-webkit-mask-image:var(--md-footnotes-icon);mask-image:var(--md-footnotes-icon);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;content:""}[dir=rtl] .md-typeset .footnote-backref::before svg{transform:scaleX(-1)}@media print{.md-typeset .footnote-backref{color:var(--md-typeset-a-color);transform:translateX(0);opacity:1}}.md-typeset .headerlink{display:inline-block;margin-left:.5rem;visibility:hidden;opacity:0;transition:color 250ms,visibility 0ms 500ms,opacity 125ms}[dir=rtl] .md-typeset .headerlink{margin-right:.5rem;margin-left:initial}html body .md-typeset .headerlink{color:var(--md-default-fg-color--lighter)}@media print{.md-typeset .headerlink{display:none}}.md-typeset :hover>.headerlink,.md-typeset :target>.headerlink,.md-typeset .headerlink:focus{visibility:visible;opacity:1;transition:color 250ms,visibility 0ms,opacity 125ms}.md-typeset :target>.headerlink,.md-typeset .headerlink:focus,.md-typeset .headerlink:hover{color:var(--md-accent-fg-color)}.md-typeset :target{scroll-margin-top:3.6rem}.md-typeset h3:target,.md-typeset h2:target,.md-typeset h1:target{scroll-margin-top:3.4rem}.md-typeset h4:target{scroll-margin-top:3.45rem}.md-typeset div.arithmatex{overflow-x:scroll}@media screen and (max-width: 44.9375em){.md-typeset div.arithmatex{margin:0 -0.8rem}}.md-typeset div.arithmatex>*{width:-webkit-min-content;width:-moz-min-content;width:min-content;margin:1em auto !important;padding:0 .8rem;overflow:auto;touch-action:auto}.md-typeset del.critic,.md-typeset ins.critic,.md-typeset .critic.comment{-webkit-box-decoration-break:clone;box-decoration-break:clone}.md-typeset del.critic{background-color:var(--md-typeset-del-color)}.md-typeset ins.critic{background-color:var(--md-typeset-ins-color)}.md-typeset .critic.comment{color:var(--md-code-hl-comment-color)}.md-typeset .critic.comment::before{content:"/* "}.md-typeset .critic.comment::after{content:" */"}.md-typeset .critic.block{display:block;margin:1em 0;padding-right:.8rem;padding-left:.8rem;overflow:auto;box-shadow:none}.md-typeset .critic.block :first-child{margin-top:.5em}.md-typeset .critic.block :last-child{margin-bottom:.5em}:root{--md-details-icon: url('data:image/svg+xml;charset=utf-8,')}.md-typeset details{display:block;padding-top:0;overflow:visible}.md-typeset details[open]>summary::after{transform:rotate(90deg)}.md-typeset details:not([open]){padding-bottom:0}.md-typeset details:not([open])>summary{border-radius:.1rem}.md-typeset details::after{display:table;content:""}.md-typeset summary{display:block;min-height:1rem;padding:.4rem 1.8rem .4rem 2rem;border-top-left-radius:.1rem;border-top-right-radius:.1rem;cursor:pointer}.md-typeset summary:not(.focus-visible){outline:none;-webkit-tap-highlight-color:transparent}[dir=rtl] .md-typeset summary{padding:.4rem 2.2rem .4rem 1.8rem}.md-typeset summary::-webkit-details-marker{display:none}.md-typeset summary::after{position:absolute;top:.4rem;right:.4rem;width:1rem;height:1rem;background-color:currentColor;-webkit-mask-image:var(--md-details-icon);mask-image:var(--md-details-icon);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;transform:rotate(0deg);transition:transform 250ms;content:""}[dir=rtl] .md-typeset summary::after{right:initial;left:.4rem;transform:rotate(180deg)}.md-typeset img.emojione,.md-typeset img.twemoji,.md-typeset img.gemoji{width:1.125em;max-height:100%;vertical-align:-15%}.md-typeset span.twemoji{display:inline-block;height:1.125em;vertical-align:text-top}.md-typeset span.twemoji svg{width:1.125em;max-height:100%;fill:currentColor}.highlight [data-linenos]::before{position:-webkit-sticky;position:sticky;left:-1.1764705882em;float:left;margin-right:1.1764705882em;margin-left:-1.1764705882em;padding-left:1.1764705882em;color:var(--md-default-fg-color--light);background-color:var(--md-code-bg-color);box-shadow:-0.05rem 0 var(--md-default-fg-color--lighter) inset;content:attr(data-linenos);-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.md-typeset .keys kbd::before,.md-typeset .keys kbd::after{position:relative;margin:0;color:inherit;-moz-osx-font-smoothing:initial;-webkit-font-smoothing:initial}.md-typeset .keys span{padding:0 .2em;color:var(--md-default-fg-color--light)}.md-typeset .keys .key-alt::before{padding-right:.4em;content:"⎇"}.md-typeset .keys .key-left-alt::before{padding-right:.4em;content:"⎇"}.md-typeset .keys .key-right-alt::before{padding-right:.4em;content:"⎇"}.md-typeset .keys .key-command::before{padding-right:.4em;content:"⌘"}.md-typeset .keys .key-left-command::before{padding-right:.4em;content:"⌘"}.md-typeset .keys .key-right-command::before{padding-right:.4em;content:"⌘"}.md-typeset .keys .key-control::before{padding-right:.4em;content:"⌃"}.md-typeset .keys .key-left-control::before{padding-right:.4em;content:"⌃"}.md-typeset .keys .key-right-control::before{padding-right:.4em;content:"⌃"}.md-typeset .keys .key-meta::before{padding-right:.4em;content:"◆"}.md-typeset .keys .key-left-meta::before{padding-right:.4em;content:"◆"}.md-typeset .keys .key-right-meta::before{padding-right:.4em;content:"◆"}.md-typeset .keys .key-option::before{padding-right:.4em;content:"⌥"}.md-typeset .keys .key-left-option::before{padding-right:.4em;content:"⌥"}.md-typeset .keys .key-right-option::before{padding-right:.4em;content:"⌥"}.md-typeset .keys .key-shift::before{padding-right:.4em;content:"⇧"}.md-typeset .keys .key-left-shift::before{padding-right:.4em;content:"⇧"}.md-typeset .keys .key-right-shift::before{padding-right:.4em;content:"⇧"}.md-typeset .keys .key-super::before{padding-right:.4em;content:"❖"}.md-typeset .keys .key-left-super::before{padding-right:.4em;content:"❖"}.md-typeset .keys .key-right-super::before{padding-right:.4em;content:"❖"}.md-typeset .keys .key-windows::before{padding-right:.4em;content:"⊞"}.md-typeset .keys .key-left-windows::before{padding-right:.4em;content:"⊞"}.md-typeset .keys .key-right-windows::before{padding-right:.4em;content:"⊞"}.md-typeset .keys .key-arrow-down::before{padding-right:.4em;content:"↓"}.md-typeset .keys .key-arrow-left::before{padding-right:.4em;content:"←"}.md-typeset .keys .key-arrow-right::before{padding-right:.4em;content:"→"}.md-typeset .keys .key-arrow-up::before{padding-right:.4em;content:"↑"}.md-typeset .keys .key-backspace::before{padding-right:.4em;content:"⌫"}.md-typeset .keys .key-backtab::before{padding-right:.4em;content:"⇤"}.md-typeset .keys .key-caps-lock::before{padding-right:.4em;content:"⇪"}.md-typeset .keys .key-clear::before{padding-right:.4em;content:"⌧"}.md-typeset .keys .key-context-menu::before{padding-right:.4em;content:"☰"}.md-typeset .keys .key-delete::before{padding-right:.4em;content:"⌦"}.md-typeset .keys .key-eject::before{padding-right:.4em;content:"⏏"}.md-typeset .keys .key-end::before{padding-right:.4em;content:"⤓"}.md-typeset .keys .key-escape::before{padding-right:.4em;content:"⎋"}.md-typeset .keys .key-home::before{padding-right:.4em;content:"⤒"}.md-typeset .keys .key-insert::before{padding-right:.4em;content:"⎀"}.md-typeset .keys .key-page-down::before{padding-right:.4em;content:"⇟"}.md-typeset .keys .key-page-up::before{padding-right:.4em;content:"⇞"}.md-typeset .keys .key-print-screen::before{padding-right:.4em;content:"⎙"}.md-typeset .keys .key-tab::after{padding-left:.4em;content:"⇥"}.md-typeset .keys .key-num-enter::after{padding-left:.4em;content:"⌤"}.md-typeset .keys .key-enter::after{padding-left:.4em;content:"⏎"}.md-typeset .tabbed-content{display:none;order:99;width:100%;box-shadow:0 -0.05rem var(--md-default-fg-color--lightest)}@media print{.md-typeset .tabbed-content{display:block;order:initial}}.md-typeset .tabbed-content>pre:only-child,.md-typeset .tabbed-content>.codehilite:only-child pre,.md-typeset .tabbed-content>.codehilitetable:only-child,.md-typeset .tabbed-content>.highlight:only-child pre,.md-typeset .tabbed-content>.highlighttable:only-child{margin:0}.md-typeset .tabbed-content>pre:only-child>code,.md-typeset .tabbed-content>.codehilite:only-child pre>code,.md-typeset .tabbed-content>.codehilitetable:only-child>code,.md-typeset .tabbed-content>.highlight:only-child pre>code,.md-typeset .tabbed-content>.highlighttable:only-child>code{border-top-left-radius:0;border-top-right-radius:0}.md-typeset .tabbed-content>.tabbed-set{margin:0}.md-typeset .tabbed-set{position:relative;display:flex;flex-wrap:wrap;margin:1em 0;border-radius:.1rem}.md-typeset .tabbed-set>input{position:absolute;width:0;height:0;opacity:0}.md-typeset .tabbed-set>input:checked+label{color:var(--md-accent-fg-color);border-color:var(--md-accent-fg-color)}.md-typeset .tabbed-set>input:checked+label+.tabbed-content{display:block}.md-typeset .tabbed-set>input:focus+label{outline-style:auto}.md-typeset .tabbed-set>input:not(.focus-visible)+label{outline:none;-webkit-tap-highlight-color:transparent}.md-typeset .tabbed-set>label{z-index:1;width:auto;padding:.9375em 1.25em .78125em;color:var(--md-default-fg-color--light);font-weight:700;font-size:.64rem;border-bottom:.1rem solid transparent;cursor:pointer;transition:color 250ms}html .md-typeset .tabbed-set>label:hover{color:var(--md-accent-fg-color)}:root{--md-tasklist-icon: url( 'data:image/svg+xml;charset=utf-8,' );--md-tasklist-icon--checked: url( 'data:image/svg+xml;charset=utf-8,' )}.md-typeset .task-list-item{position:relative;list-style-type:none}.md-typeset .task-list-item [type=checkbox]{position:absolute;top:.45em;left:-2em}[dir=rtl] .md-typeset .task-list-item [type=checkbox]{right:-2em;left:initial}.md-typeset .task-list-control .task-list-indicator::before{position:absolute;top:.15em;left:-1.5em;width:1.25em;height:1.25em;background-color:var(--md-default-fg-color--lightest);-webkit-mask-image:var(--md-tasklist-icon);mask-image:var(--md-tasklist-icon);-webkit-mask-repeat:no-repeat;mask-repeat:no-repeat;content:""}[dir=rtl] .md-typeset .task-list-control .task-list-indicator::before{right:-1.5em;left:initial}.md-typeset .task-list-control [type=checkbox]:checked+.task-list-indicator::before{background-color:#00e676;-webkit-mask-image:var(--md-tasklist-icon--checked);mask-image:var(--md-tasklist-icon--checked)}.md-typeset .task-list-control [type=checkbox]{z-index:-1;opacity:0} diff --git a/v4.0.1/assets/stylesheets/palette.ec60dfa4.min.css b/v4.0.1/assets/stylesheets/palette.ec60dfa4.min.css new file mode 100644 index 0000000000..0e4ca128a5 --- /dev/null +++ b/v4.0.1/assets/stylesheets/palette.ec60dfa4.min.css @@ -0,0 +1 @@ +[data-md-color-accent=red]{--md-accent-fg-color: hsla(348, 100%, 55%, 1);--md-accent-fg-color--transparent: hsla(348, 100%, 55%, 0.1);--md-accent-bg-color: hsla(0, 0%, 100%, 1);--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-accent=pink]{--md-accent-fg-color: hsla(339, 100%, 48%, 1);--md-accent-fg-color--transparent: hsla(339, 100%, 48%, 0.1);--md-accent-bg-color: hsla(0, 0%, 100%, 1);--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-accent=purple]{--md-accent-fg-color: hsla(291, 96%, 62%, 1);--md-accent-fg-color--transparent: hsla(291, 96%, 62%, 0.1);--md-accent-bg-color: hsla(0, 0%, 100%, 1);--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-accent=deep-purple]{--md-accent-fg-color: hsla(256, 100%, 65%, 1);--md-accent-fg-color--transparent: hsla(256, 100%, 65%, 0.1);--md-accent-bg-color: hsla(0, 0%, 100%, 1);--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-accent=indigo]{--md-accent-fg-color: hsla(231, 99%, 66%, 1);--md-accent-fg-color--transparent: hsla(231, 99%, 66%, 0.1);--md-accent-bg-color: hsla(0, 0%, 100%, 1);--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-accent=blue]{--md-accent-fg-color: hsla(218, 100%, 63%, 1);--md-accent-fg-color--transparent: hsla(218, 100%, 63%, 0.1);--md-accent-bg-color: hsla(0, 0%, 100%, 1);--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-accent=light-blue]{--md-accent-fg-color: hsla(203, 100%, 46%, 1);--md-accent-fg-color--transparent: hsla(203, 100%, 46%, 0.1);--md-accent-bg-color: hsla(0, 0%, 100%, 1);--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-accent=cyan]{--md-accent-fg-color: hsla(188, 100%, 42%, 1);--md-accent-fg-color--transparent: hsla(188, 100%, 42%, 0.1);--md-accent-bg-color: hsla(0, 0%, 100%, 1);--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-accent=teal]{--md-accent-fg-color: hsla(172, 100%, 37%, 1);--md-accent-fg-color--transparent: hsla(172, 100%, 37%, 0.1);--md-accent-bg-color: hsla(0, 0%, 100%, 1);--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-accent=green]{--md-accent-fg-color: hsla(145, 100%, 39%, 1);--md-accent-fg-color--transparent: hsla(145, 100%, 39%, 0.1);--md-accent-bg-color: hsla(0, 0%, 100%, 1);--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-accent=light-green]{--md-accent-fg-color: hsla(97, 81%, 48%, 1);--md-accent-fg-color--transparent: hsla(97, 81%, 48%, 0.1);--md-accent-bg-color: hsla(0, 0%, 100%, 1);--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-accent=lime]{--md-accent-fg-color: hsla(75, 100%, 46%, 1);--md-accent-fg-color--transparent: hsla(75, 100%, 46%, 0.1);--md-accent-bg-color: hsla(0, 0%, 0%, 0.87);--md-accent-bg-color--light: hsla(0, 0%, 0%, 0.54)}[data-md-color-accent=yellow]{--md-accent-fg-color: hsla(50, 100%, 50%, 1);--md-accent-fg-color--transparent: hsla(50, 100%, 50%, 0.1);--md-accent-bg-color: hsla(0, 0%, 0%, 0.87);--md-accent-bg-color--light: hsla(0, 0%, 0%, 0.54)}[data-md-color-accent=amber]{--md-accent-fg-color: hsla(40, 100%, 50%, 1);--md-accent-fg-color--transparent: hsla(40, 100%, 50%, 0.1);--md-accent-bg-color: hsla(0, 0%, 0%, 0.87);--md-accent-bg-color--light: hsla(0, 0%, 0%, 0.54)}[data-md-color-accent=orange]{--md-accent-fg-color: hsla(34, 100%, 50%, 1);--md-accent-fg-color--transparent: hsla(34, 100%, 50%, 0.1);--md-accent-bg-color: hsla(0, 0%, 0%, 0.87);--md-accent-bg-color--light: hsla(0, 0%, 0%, 0.54)}[data-md-color-accent=deep-orange]{--md-accent-fg-color: hsla(14, 100%, 63%, 1);--md-accent-fg-color--transparent: hsla(14, 100%, 63%, 0.1);--md-accent-bg-color: hsla(0, 0%, 100%, 1);--md-accent-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-primary=red]{--md-primary-fg-color: hsla(1, 83%, 63%, 1);--md-primary-fg-color--light: hsla(0, 69%, 67%, 1);--md-primary-fg-color--dark: hsla(1, 77%, 55%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-primary=pink]{--md-primary-fg-color: hsla(340, 82%, 52%, 1);--md-primary-fg-color--light: hsla(340, 82%, 59%, 1);--md-primary-fg-color--dark: hsla(336, 78%, 43%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-primary=purple]{--md-primary-fg-color: hsla(291, 47%, 51%, 1);--md-primary-fg-color--light: hsla(291, 47%, 60%, 1);--md-primary-fg-color--dark: hsla(287, 65%, 40%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-primary=deep-purple]{--md-primary-fg-color: hsla(262, 47%, 55%, 1);--md-primary-fg-color--light: hsla(262, 47%, 63%, 1);--md-primary-fg-color--dark: hsla(262, 52%, 47%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-primary=indigo]{--md-primary-fg-color: hsla(231, 48%, 48%, 1);--md-primary-fg-color--light: hsla(231, 44%, 56%, 1);--md-primary-fg-color--dark: hsla(232, 54%, 41%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-primary=blue]{--md-primary-fg-color: hsla(207, 90%, 54%, 1);--md-primary-fg-color--light: hsla(207, 90%, 61%, 1);--md-primary-fg-color--dark: hsla(210, 79%, 46%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-primary=light-blue]{--md-primary-fg-color: hsla(199, 98%, 48%, 1);--md-primary-fg-color--light: hsla(199, 92%, 56%, 1);--md-primary-fg-color--dark: hsla(201, 98%, 41%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-primary=cyan]{--md-primary-fg-color: hsla(187, 100%, 42%, 1);--md-primary-fg-color--light: hsla(187, 71%, 50%, 1);--md-primary-fg-color--dark: hsla(186, 100%, 33%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-primary=teal]{--md-primary-fg-color: hsla(174, 100%, 29%, 1);--md-primary-fg-color--light: hsla(174, 63%, 40%, 1);--md-primary-fg-color--dark: hsla(173, 100%, 24%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-primary=green]{--md-primary-fg-color: hsla(122, 39%, 49%, 1);--md-primary-fg-color--light: hsla(123, 38%, 57%, 1);--md-primary-fg-color--dark: hsla(123, 43%, 39%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-primary=light-green]{--md-primary-fg-color: hsla(88, 50%, 53%, 1);--md-primary-fg-color--light: hsla(88, 50%, 60%, 1);--md-primary-fg-color--dark: hsla(92, 48%, 42%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-primary=lime]{--md-primary-fg-color: hsla(66, 70%, 54%, 1);--md-primary-fg-color--light: hsla(66, 70%, 61%, 1);--md-primary-fg-color--dark: hsla(62, 61%, 44%, 1);--md-primary-bg-color: hsla(0, 0%, 0%, 0.87);--md-primary-bg-color--light: hsla(0, 0%, 0%, 0.54)}[data-md-color-primary=yellow]{--md-primary-fg-color: hsla(54, 100%, 62%, 1);--md-primary-fg-color--light: hsla(54, 100%, 67%, 1);--md-primary-fg-color--dark: hsla(43, 96%, 58%, 1);--md-primary-bg-color: hsla(0, 0%, 0%, 0.87);--md-primary-bg-color--light: hsla(0, 0%, 0%, 0.54)}[data-md-color-primary=amber]{--md-primary-fg-color: hsla(45, 100%, 51%, 1);--md-primary-fg-color--light: hsla(45, 100%, 58%, 1);--md-primary-fg-color--dark: hsla(38, 100%, 50%, 1);--md-primary-bg-color: hsla(0, 0%, 0%, 0.87);--md-primary-bg-color--light: hsla(0, 0%, 0%, 0.54)}[data-md-color-primary=orange]{--md-primary-fg-color: hsla(36, 100%, 57%, 1);--md-primary-fg-color--light: hsla(36, 100%, 57%, 1);--md-primary-fg-color--dark: hsla(33, 100%, 49%, 1);--md-primary-bg-color: hsla(0, 0%, 0%, 0.87);--md-primary-bg-color--light: hsla(0, 0%, 0%, 0.54)}[data-md-color-primary=deep-orange]{--md-primary-fg-color: hsla(14, 100%, 63%, 1);--md-primary-fg-color--light: hsla(14, 100%, 70%, 1);--md-primary-fg-color--dark: hsla(14, 91%, 54%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-primary=brown]{--md-primary-fg-color: hsla(16, 25%, 38%, 1);--md-primary-fg-color--light: hsla(16, 18%, 47%, 1);--md-primary-fg-color--dark: hsla(14, 26%, 29%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-primary=grey]{--md-primary-fg-color: hsla(0, 0%, 46%, 1);--md-primary-fg-color--light: hsla(0, 0%, 62%, 1);--md-primary-fg-color--dark: hsla(0, 0%, 38%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-primary=blue-grey]{--md-primary-fg-color: hsla(199, 18%, 40%, 1);--md-primary-fg-color--light: hsla(200, 18%, 46%, 1);--md-primary-fg-color--dark: hsla(199, 18%, 33%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7)}[data-md-color-primary=white]{--md-primary-fg-color: hsla(0, 0%, 100%, 1);--md-primary-fg-color--light: hsla(0, 0%, 100%, 0.7);--md-primary-fg-color--dark: hsla(0, 0%, 0%, 0.07);--md-primary-bg-color: hsla(0, 0%, 0%, 0.87);--md-primary-bg-color--light: hsla(0, 0%, 0%, 0.54);--md-typeset-a-color: hsla(231, 48%, 48%, 1)}@media screen and (min-width: 60em){[data-md-color-primary=white] .md-search__input{background-color:rgba(0,0,0,.07)}[data-md-color-primary=white] .md-search__input+.md-search__icon{color:rgba(0,0,0,.87)}[data-md-color-primary=white] .md-search__input::-webkit-input-placeholder{color:rgba(0,0,0,.54)}[data-md-color-primary=white] .md-search__input::-moz-placeholder{color:rgba(0,0,0,.54)}[data-md-color-primary=white] .md-search__input::-ms-input-placeholder{color:rgba(0,0,0,.54)}[data-md-color-primary=white] .md-search__input::placeholder{color:rgba(0,0,0,.54)}[data-md-color-primary=white] .md-search__input:hover{background-color:rgba(0,0,0,.32)}}@media screen and (min-width: 76.25em){[data-md-color-primary=white] .md-tabs{border-bottom:.05rem solid rgba(0,0,0,.07)}}[data-md-color-primary=black]{--md-primary-fg-color: hsla(0, 0%, 0%, 1);--md-primary-fg-color--light: hsla(0, 0%, 0%, 0.54);--md-primary-fg-color--dark: hsla(0, 0%, 0%, 1);--md-primary-bg-color: hsla(0, 0%, 100%, 1);--md-primary-bg-color--light: hsla(0, 0%, 100%, 0.7);--md-typeset-a-color: hsla(231, 48%, 48%, 1)}[data-md-color-primary=black] .md-header{background-color:#000}@media screen and (max-width: 59.9375em){[data-md-color-primary=black] .md-nav__source{background-color:rgba(0,0,0,.87)}}@media screen and (min-width: 60em){[data-md-color-primary=black] .md-search__input{background-color:rgba(255,255,255,.12)}[data-md-color-primary=black] .md-search__input:hover{background-color:rgba(255,255,255,.3)}}@media screen and (max-width: 76.1875em){html [data-md-color-primary=black] .md-nav--primary .md-nav__title[for=__drawer]{background-color:#000}}@media screen and (min-width: 76.25em){[data-md-color-primary=black] .md-tabs{background-color:#000}}@media screen{[data-md-color-scheme=slate]{--md-hue: 232;--md-default-fg-color: hsla(var(--md-hue), 75%, 95%, 1);--md-default-fg-color--light: hsla(var(--md-hue), 75%, 90%, 0.62);--md-default-fg-color--lighter: hsla(var(--md-hue), 75%, 90%, 0.32);--md-default-fg-color--lightest: hsla(var(--md-hue), 75%, 90%, 0.12);--md-default-bg-color: hsla(var(--md-hue), 15%, 21%, 1);--md-default-bg-color--light: hsla(var(--md-hue), 15%, 21%, 0.54);--md-default-bg-color--lighter: hsla(var(--md-hue), 15%, 21%, 0.26);--md-default-bg-color--lightest: hsla(var(--md-hue), 15%, 21%, 0.07);--md-code-fg-color: hsla(var(--md-hue), 18%, 86%, 1);--md-code-bg-color: hsla(var(--md-hue), 15%, 15%, 1);--md-code-hl-color: hsla(218, 100%, 63%, 0.15);--md-code-hl-number-color: hsla(6, 74%, 63%, 1);--md-code-hl-special-color: hsla(340, 83%, 66%, 1);--md-code-hl-function-color: hsla(291, 57%, 65%, 1);--md-code-hl-constant-color: hsla(250, 62%, 70%, 1);--md-code-hl-keyword-color: hsla(219, 66%, 64%, 1);--md-code-hl-string-color: hsla(150, 58%, 44%, 1);--md-typeset-a-color: var(--md-primary-fg-color--light);--md-typeset-mark-color: hsla(218, 100%, 63%, 0.3);--md-typeset-kbd-color: hsla(var(--md-hue), 15%, 94%, 0.12);--md-typeset-kbd-accent-color: hsla(var(--md-hue), 15%, 94%, 0.2);--md-typeset-kbd-border-color: hsla(var(--md-hue), 15%, 14%, 1);--md-admonition-bg-color: hsla(var(--md-hue), 0%, 100%, 0.025);--md-footer-bg-color: hsla(var(--md-hue), 15%, 12%, 0.87);--md-footer-bg-color--dark: hsla(var(--md-hue), 15%, 10%, 1)}} diff --git a/v4.0.1/clusters/adding-clusters/index.html b/v4.0.1/clusters/adding-clusters/index.html new file mode 100644 index 0000000000..1e8f08442b --- /dev/null +++ b/v4.0.1/clusters/adding-clusters/index.html @@ -0,0 +1,1002 @@ + + + + + + + + + + + + + + + + + + + + + + Adding Clusters - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Adding Clusters#

    +

    Add clusters by clicking the Add Cluster button in the left-side menu.

    +
      +
    1. Click the Add Cluster button (indicated with a '+' icon).
      2. +
    2. 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.
      3. +
    +

    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.

    +

    Add Cluster

    +

    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.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/clusters/images/add-cluster.png b/v4.0.1/clusters/images/add-cluster.png new file mode 100644 index 0000000000..fa7b632026 Binary files /dev/null and b/v4.0.1/clusters/images/add-cluster.png differ diff --git a/v4.0.1/clusters/images/cluster-context-menu.png b/v4.0.1/clusters/images/cluster-context-menu.png new file mode 100644 index 0000000000..d733840df3 Binary files /dev/null and b/v4.0.1/clusters/images/cluster-context-menu.png differ diff --git a/v4.0.1/clusters/images/cluster-settings-features.png b/v4.0.1/clusters/images/cluster-settings-features.png new file mode 100644 index 0000000000..3a8066309d Binary files /dev/null and b/v4.0.1/clusters/images/cluster-settings-features.png differ diff --git a/v4.0.1/clusters/images/cluster-settings-general.png b/v4.0.1/clusters/images/cluster-settings-general.png new file mode 100644 index 0000000000..d7de0a1a35 Binary files /dev/null and b/v4.0.1/clusters/images/cluster-settings-general.png differ diff --git a/v4.0.1/clusters/images/cluster-settings-removal.png b/v4.0.1/clusters/images/cluster-settings-removal.png new file mode 100644 index 0000000000..badcbcc6e0 Binary files /dev/null and b/v4.0.1/clusters/images/cluster-settings-removal.png differ diff --git a/v4.0.1/clusters/images/cluster-settings-status.png b/v4.0.1/clusters/images/cluster-settings-status.png new file mode 100644 index 0000000000..af8e939e35 Binary files /dev/null and b/v4.0.1/clusters/images/cluster-settings-status.png differ diff --git a/v4.0.1/clusters/images/cluster-settings.png b/v4.0.1/clusters/images/cluster-settings.png new file mode 100644 index 0000000000..27a4a72ff9 Binary files /dev/null and b/v4.0.1/clusters/images/cluster-settings.png differ diff --git a/v4.0.1/clusters/images/remove-cluster.png b/v4.0.1/clusters/images/remove-cluster.png new file mode 100644 index 0000000000..bcaa69c44a Binary files /dev/null and b/v4.0.1/clusters/images/remove-cluster.png differ diff --git a/v4.0.1/clusters/removing-clusters/index.html b/v4.0.1/clusters/removing-clusters/index.html new file mode 100644 index 0000000000..c0d691684d --- /dev/null +++ b/v4.0.1/clusters/removing-clusters/index.html @@ -0,0 +1,938 @@ + + + + + + + + + + + + + + + + + + + + + + Removing Clusters - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + +
    +
    + + + +

    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:

    +
      +
    1. Right-click the name of the cluster in the left-side menu that you want to remove.
      2. +
    2. Click Remove.
      3. +
    +

    NOTE: This will only remove the cluster from your Lens cluster list. It will not affect your actual Kubernetes cluster or its configuration.

    +

    Remove Cluster

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/clusters/settings/index.html b/v4.0.1/clusters/settings/index.html new file mode 100644 index 0000000000..3d59a74edb --- /dev/null +++ b/v4.0.1/clusters/settings/index.html @@ -0,0 +1,1236 @@ + + + + + + + + + + + + + + + + + + + + + + Settings - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Settings#

    +

    It is easy to configure Lens Clusters to your liking through its various settings.

    +
      +
    1. Right-click the name of the cluster in the left-side menu that you want to open the settings for.
      2. +
    2. Click Settings.
      3. +
    +

    Cluster settings

    +

    Status#

    +

    Overview of the cluster status

    +

    Cluster Status#

    +

    Cluster status information including the detected distribution, kernel version, API endpoint, and online status

    +

    Cluster settings 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.

    +

    Cluster settings general

    +

    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.

    +

    Cluster settings features

    +

    Removal#

    +

    Use this setting to remove the current cluster.

    +

    Cluster settings removal

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/contributing/development/index.html b/v4.0.1/contributing/development/index.html new file mode 100644 index 0000000000..71017bab76 --- /dev/null +++ b/v4.0.1/contributing/development/index.html @@ -0,0 +1,1078 @@ + + + + + + + + + + + + + + + + + + + + + + Development - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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.

    + + +

    Local Development Environment#

    +
    +

    Prerequisites: Nodejs v12, make, yarn

    +
    +
      +
    • make dev - builds and starts the app
      • +
    • make clean - cleanup local environment build artifacts
      • +
    +

    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:

    + +

    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:

    + +

    License#

    +

    By contributing, you agree that your contributions will be licensed as described in LICENSE.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/contributing/documentation/index.html b/v4.0.1/contributing/documentation/index.html new file mode 100644 index 0000000000..4a637d9da6 --- /dev/null +++ b/v4.0.1/contributing/documentation/index.html @@ -0,0 +1,1044 @@ + + + + + + + + + + + + + + + + + + + + + + Documentation - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:

    +
      +
    1. Express your interest to start working on an issue via comments.
      2. +
    2. One of the maintainers will assign the issue for you.
      3. +
    3. You can start working on the issue. When you're done, simply submit a pull request.
      4. +
    +

    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.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/contributing/github_workflow/index.html b/v4.0.1/contributing/github_workflow/index.html new file mode 100644 index 0000000000..e3c29c1e4b --- /dev/null +++ b/v4.0.1/contributing/github_workflow/index.html @@ -0,0 +1,1078 @@ + + + + + + + + + + + + + + + + + + + + + + Github Workflow - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Github Workflow#

    + + + +

    This guide assumes you have already cloned the upstream repo to your system via git clone.

    +

    Fork The Project#

    +
      +
    1. Go to http://github.com/lensapp/lens
      2. +
    2. On the top, right-hand side, click on "fork" and select your username for the fork destination.
      3. +
    +

    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:

    +
    ➜ 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 <commit> = use commit
+# r, reword <commit> = use commit, but edit the commit message
+# e, edit <commit> = use commit, but stop for amending
+# s, squash <commit> = use commit, but meld into previous commit
+# f, fixup <commit> = like "squash", but discard this commit's log message
+# x, exec <command> = run command (the rest of the line) using shell
+# b, break = stop here (continue rebase later with 'git rebase --continue')
+# d, drop <commit> = remove commit
+# l, label <label> = label current HEAD with a name
+# t, reset <label> = reset HEAD to a label
+# m, merge [-C <commit> | -c <commit>] <label> [# <oneline>]
+# .       create a merge commit using the original merge commit's
+# .       message (or the oneline, if no original merge commit was
+# .       specified). Use -c <commit> to reword the commit message.
+#
+# These lines can be re-ordered; they are executed from top to bottom.
+#
+# However, if you remove everything, the rebase will be aborted.
+#
+# Note that empty commits are commented out
+
    +Use a command line text editor to change the word pick to fixup for the commits you want to squash, then save your changes and continue the rebase:

    +

    Per the output above, you can see that: +

    fixup <commit> = like "squash", but discard this commit's log message
+
    +Which means that when rebased, the commit message "fixed some typos" will be removed, and squashed with the parent commit.

    +

    Push Your Final Changes#

    +

    Once done, you can push the final commits to your branch: +

    git push --force
+
    +You can run multiple iteration of rebase/push -f, if needed.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/contributing/index.html b/v4.0.1/contributing/index.html new file mode 100644 index 0000000000..cac92ab8c8 --- /dev/null +++ b/v4.0.1/contributing/index.html @@ -0,0 +1,1001 @@ + + + + + + + + + + + + + + + + + + + + + + Overview - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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!

    + +

    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.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/contributing/maintainers/index.html b/v4.0.1/contributing/maintainers/index.html new file mode 100644 index 0000000000..00bc6a52a7 --- /dev/null +++ b/v4.0.1/contributing/maintainers/index.html @@ -0,0 +1,1017 @@ + + + + + + + + + + + + + + + + + + + + + + Maintainers - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Maintainers#

    +

    We are looking for community maintainers for the Lens project. Maintainers will be added to a special team with write permissions. These permissions consist of opening, closing, tagging, and editing issues and pull requests, as well as creating and deleting non-protected branches.

    +

    The responsibilities of a community maintainer are listed below.

    +

    Issues Triage#

    +
      +
    • Labeling Issues: Label issues accordingly.
      • +
    • Finding Duplicates: Finding and closing duplicate issues.
      • +
    • Doing First Level Contact: Getting more information on the issues (like version number or asking for clarification) if needed.
      • +
    • Closing Irrelevant Issues: Closing issues that are determined irrelevant, no longer needed, not relevant to the project and/or don't follow the issues guidelines.
      • +
    +

    Help with Contributions#

    +
      +
    • Help Manage Pull Requests: Help the author of the pull request with any problems.
      • +
    • Contributing: Create pull requests to help maintain and drive the project forward.
      • +
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/contributing/promotion/index.html b/v4.0.1/contributing/promotion/index.html new file mode 100644 index 0000000000..8c9aa1495e --- /dev/null +++ b/v4.0.1/contributing/promotion/index.html @@ -0,0 +1,1025 @@ + + + + + + + + + + + + + + + + + + + + + + Promotion - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Promotion#

    +

    Help promote Lens! If you are not a developer (or even if you are), you can still contribute to the project – a lot – by helping us to promote it. As we are a free and open source project, the community is our most important asset. Here are some ways that you can help the project continue to grow.

    +

    Follow, Like, Recommend, Favorite, Vote and Star Us#

    +

    There are many sites where you can vote, recommend, favorite, and star us.

    +
      +
    • Twitter - Like, comment and retweet our posts, and follow us on Twitter.
      • +
    • Medium - Give claps to our articles and follow us on Medium.
      • +
    • GitHub - Become a stargazer on GitHub.
      • +
    • StackShare - Indicate you are using Lens and follow us on StackShare.
      • +
    • Reddit - Upvote and be a Lens ambassador by participating in relevant discussions on Reddit.
      • +
    • Hacker News - Upvote and be a Lens ambassador by participating in relevant discussions on Hacker News.
      • +
    +

    Write Blogs or Make Videos About Us#

    +

    Here are some nice blog posts and videos about our project for you to get some inspiration:

    + +

    Psst... If you have created some content around Lens, let us know!

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/contributing/testing/index.html b/v4.0.1/contributing/testing/index.html new file mode 100644 index 0000000000..b75e3aa0c4 --- /dev/null +++ b/v4.0.1/contributing/testing/index.html @@ -0,0 +1,961 @@ + + + + + + + + + + + + + + + + + + + + + + Testing - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Testing

    + +

    Testing Your Code#

    +

    Lens uses github actions to run automated tests on any PR, before merging. +However, a PR will not be reviewed before all tests are green, so to save time and prevent your PR from going stale, it is best to test it before submitting the PR.

    +

    Run Local Verifications#

    +

    Please run the following style and formatting commands and fix/check-in any changes:

    +

    1. Linting

    +

    We use ESLing for style verification. +In the repository's root directory, simply run:

    +
    make lint
+
    +

    3. Pre-submit Flight Checks

    +

    In the repository root directory, make sure that:

    +
      +
    • make build runs successfully.
      • +
    • make test runs successfully.
      • +
    • make integration runs successfully (some tests require minikube running).
      • +
    +

    Please note that this last test is prone to "flakiness", so it might fail on occasion. If it fails constantly, take a deeper look at your code to find the source of the problem.

    +

    If you find that all tests passed, you may open a pull request upstream.

    +

    Opening A Pull Request#

    +

    Draft Mode

    +

    You may open a pull request in draft mode. +All automated tests will still run against the PR, but the PR will not be assigned for review. +Once a PR is ready for review, transition it from Draft mode, and code owners will be notified.

    +

    Pre-Requisites for PR Merge

    +

    In order for a PR to be merged, the following conditions should exist: +1. The PR has passed all the automated tests (style, build & conformance tests). +2. PR commits have been signed with the --signoff option. +3. PR was reviewed and approved by a code owner. +4. PR is rebased against upstream's master branch.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/custom_theme/img/favicon.ico b/v4.0.1/custom_theme/img/favicon.ico new file mode 100644 index 0000000000..19b2de71d1 Binary files /dev/null and b/v4.0.1/custom_theme/img/favicon.ico differ diff --git a/v4.0.1/custom_theme/main.html b/v4.0.1/custom_theme/main.html new file mode 100644 index 0000000000..b6ad2467dd --- /dev/null +++ b/v4.0.1/custom_theme/main.html @@ -0,0 +1,12 @@ +{% extends "base.html" %} + +{% block analytics %} + + + +{% endblock %} \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html b/v4.0.1/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html new file mode 100644 index 0000000000..c4e341a632 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_core_api_cluster_feature_.clusterfeature/index.html @@ -0,0 +1,1275 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ClusterFeature - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ClusterFeature#

    +

    Hierarchy#

    +
      +
    • ClusterFeature
      • +
    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Object literals#

    + +

    Properties#

    +

    templateContext#

    +

    • templateContext: any

    +

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

    +

    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

    +

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

    +

    Parameters:

    +
    + + + + + + + + + + + + + + + + + + + +
    NameTypeDescription
    clusterClusterthe cluster that the resources are to be applied to
    resourceSpecstring | string[]as a string type this is a folder path that is searched for files specifying kubernetes resources. The files are read and if any of the resource files are templated, the template parameters are filled using the templateContext field (See renderTemplate() method). Finally the resources are applied to the cluster. As a string[] type resourceSpec is treated as an array of fully formed (not templated) kubernetes resources that are applied to the cluster
    +

    Returns: Promise‹void›

    +
    +

    Abstract install#

    +

    ▸ install(cluster: Cluster): Promise‹void›

    +

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

    +

    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:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    clusterClusterthe cluster that the feature is to be installed on
    +

    Returns: Promise‹void›

    +
    +

    Protected renderTemplates#

    +

    ▸ renderTemplates(folderPath: string): string[]

    +

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

    +

    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:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    folderPathstringthis is a folder path that is searched for files defining kubernetes resources.
    +

    Returns: string[]

    +

    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

    +

    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:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    clusterClusterthe cluster that the feature is to be uninstalled from
    +

    Returns: Promise‹void›

    +
    +

    Abstract updateStatus#

    +

    ▸ updateStatus(cluster: Cluster): Promise‹ClusterFeatureStatus›

    +

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

    +

    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 +can be upgraded so the implementation should set the canUpgrade field according to specific rules for the feature, if relevant.

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    clusterClusterthe cluster that the feature may be installed on
    +

    Returns: Promise‹ClusterFeatureStatus›

    +

    a promise, resolved with the updated ClusterFeatureStatus

    +
    +

    Abstract upgrade#

    +

    ▸ upgrade(cluster: Cluster): Promise‹void›

    +

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

    +

    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:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    clusterClusterthe cluster that the feature is to be upgraded on
    +

    Returns: Promise‹void›

    +

    Object literals#

    +

    status#

    +

    ▪ status: object#

    +

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

    +

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

    +

    canUpgrade#

    +

    • canUpgrade: false = false

    +

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

    +

    currentVersion#

    +

    • currentVersion: null = null

    +

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

    +

    installed#

    +

    • installed: false = false

    +

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

    +

    latestVersion#

    +

    • latestVersion: null = null

    +

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

    + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_core_api_stores_.cluster/index.html b/v4.0.1/extensions/api/classes/_core_api_stores_.cluster/index.html new file mode 100644 index 0000000000..7954926846 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_core_api_stores_.cluster/index.html @@ -0,0 +1,2097 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Cluster - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Cluster#

    +

    Cluster

    +

    beta

    +

    Hierarchy#

    +
      +
    • Cluster
      • +
    +

    Implements#

    + +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Cluster(model: ClusterModel): Cluster

    +

    Defined in src/main/cluster.ts:239

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    modelClusterModel
    +

    Returns: Cluster

    +

    Properties#

    +

    accessible#

    +

    • accessible: boolean = false

    +

    Defined in src/main/cluster.ts:139

    +

    Can user access cluster resources

    +

    observable

    +
    +

    accessibleNamespaces#

    +

    • accessibleNamespaces: string[] = []

    +

    Implementation of ClusterModel.accessibleNamespaces

    +

    Defined in src/main/cluster.ts:200

    +

    List of accessible namespaces

    +

    observable

    +
    +

    Protected activated#

    +

    • activated: boolean = false

    +

    Defined in src/main/cluster.ts:80

    +
    +

    allowedNamespaces#

    +

    • allowedNamespaces: string[] = []

    +

    Defined in src/main/cluster.ts:187

    +

    List of allowed namespaces

    +

    observable

    +
    +

    allowedResources#

    +

    • allowedResources: string[] = []

    +

    Defined in src/main/cluster.ts:194

    +

    List of allowed resources

    +

    observable

    +

    internal

    +
    +

    apiUrl#

    +

    • apiUrl: string

    +

    Defined in src/main/cluster.ts:114

    +

    Kubernetes API server URL

    +

    observable

    +
    +

    contextHandler#

    +

    • contextHandler: ContextHandler

    +

    Defined in src/main/cluster.ts:71

    +

    Context handler

    +

    internal

    +
    +

    contextName#

    +

    • contextName: string

    +

    Implementation of ClusterModel.contextName

    +

    Defined in src/main/cluster.ts:96

    +

    Kubeconfig context name

    +

    observable

    +
    +

    disconnected#

    +

    • disconnected: boolean = true

    +

    Defined in src/main/cluster.ts:157

    +

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

    +

    observable

    +
    +

    enabled#

    +

    • enabled: boolean = false

    +

    Defined in src/main/cluster.ts:127

    +

    Is cluster instance enabled (disabled clusters are currently hidden)

    +

    observable

    +
    +

    Protected eventDisposers#

    +

    • eventDisposers: Function[] = []

    +

    Defined in src/main/cluster.ts:79

    +
    +

    failureReason#

    +

    • failureReason: string

    +

    Defined in src/main/cluster.ts:163

    +

    Connection failure reason

    +

    observable

    +
    +

    id#

    +

    • id: ClusterId

    +

    Implementation of ClusterModel.id

    +

    Defined in src/main/cluster.ts:59

    +

    Unique id for a cluster

    +
    +

    initialized#

    +

    • initialized: boolean = false

    +

    Defined in src/main/cluster.ts:90

    +

    Is cluster object initialized

    +

    observable

    +
    +

    isAdmin#

    +

    • isAdmin: boolean = false

    +

    Defined in src/main/cluster.ts:169

    +

    Does user have admin like access

    +

    observable

    +
    +

    kubeConfigPath#

    +

    • kubeConfigPath: string

    +

    Implementation of ClusterModel.kubeConfigPath

    +

    Defined in src/main/cluster.ts:108

    +

    Path to kubeconfig

    +

    observable

    +
    +

    kubeCtl#

    +

    • kubeCtl: Kubectl

    +

    Defined in src/main/cluster.ts:65

    +

    Kubectl

    +

    internal

    +
    +

    kubeProxyUrl#

    +

    • kubeProxyUrl: string

    +

    Defined in src/main/cluster.ts:121

    +

    Internal authentication proxy URL

    +

    observable

    +

    internal

    +
    +

    Protected kubeconfigManager#

    +

    • kubeconfigManager: KubeconfigManager

    +

    Defined in src/main/cluster.ts:78

    +
    +

    metadata#

    +

    • metadata: ClusterMetadata

    +

    Implementation of ClusterModel.metadata

    +

    Defined in src/main/cluster.ts:181

    +

    Metadata

    +

    observable

    +
    +

    online#

    +

    • online: boolean = false

    +

    Defined in src/main/cluster.ts:133

    +

    Is cluster online

    +

    observable

    +
    +

    ownerRef#

    +

    • ownerRef: string

    +

    Implementation of ClusterModel.ownerRef

    +

    Defined in src/main/cluster.ts:77

    +

    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:175

    +

    Preferences

    +

    observable

    +
    +

    ready#

    +

    • ready: boolean = false

    +

    Defined in src/main/cluster.ts:145

    +

    Is cluster instance in usable state

    +

    observable

    +
    +

    reconnecting#

    +

    • reconnecting: boolean = false

    +

    Defined in src/main/cluster.ts:151

    +

    Is cluster currently reconnecting

    +

    observable

    +
    +

    whenInitialized#

    +

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

    +

    Defined in src/main/cluster.ts:82

    +
    +

    whenReady#

    +

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

    +

    Defined in src/main/cluster.ts:83

    +
    +

    workspace#

    +

    • workspace: WorkspaceId

    +

    Implementation of ClusterModel.workspace

    +

    Defined in src/main/cluster.ts:102

    +

    Workspace id

    +

    observable

    +

    Accessors#

    +

    available#

    +

    • get available(): boolean

    +

    Defined in src/main/cluster.ts:207

    +

    Is cluster available

    +

    computed

    +

    Returns: boolean

    +
    +

    isManaged#

    +

    • get isManaged(): boolean

    +

    Defined in src/main/cluster.ts:253

    +

    Is cluster managed by an extension

    +

    Returns: boolean

    +
    +

    name#

    +

    • get name(): string

    +

    Defined in src/main/cluster.ts:216

    +

    Cluster name

    +

    computed

    +

    Returns: string

    +
    +

    prometheusPreferences#

    +

    • get prometheusPreferences(): ClusterPrometheusPreferences

    +

    Defined in src/main/cluster.ts:226

    +

    Prometheus preferences

    +

    computed

    +

    internal

    +

    Returns: ClusterPrometheusPreferences

    +
    +

    version#

    +

    • get version(): string

    +

    Defined in src/main/cluster.ts:237

    +

    Kubernetes version

    +

    Returns: string

    +

    Methods#

    +

    activate#

    +

    ▸ activate(force: boolean): Promise‹void›

    +

    Defined in src/main/cluster.ts:324

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameTypeDefaultDescription
    forcebooleanfalseforce activation
    +

    Returns: Promise‹void›

    +
    +

    Protected bindEvents#

    +

    ▸ bindEvents(): void

    +

    Defined in src/main/cluster.ts:294

    +

    internal

    +

    Returns: void

    +
    +

    canI#

    +

    ▸ canI(resourceAttributes: V1ResourceAttributes): Promise‹boolean›

    +

    Defined in src/main/cluster.ts:522

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    resourceAttributesV1ResourceAttributesresource attributes
    +

    Returns: Promise‹boolean›

    +
    +

    disconnect#

    +

    ▸ disconnect(): void

    +

    Defined in src/main/cluster.ts:373

    +

    internal

    +

    Returns: void

    +
    +

    Protected ensureKubectl#

    +

    ▸ ensureKubectl(): Promise‹boolean›

    +

    Defined in src/main/cluster.ts:354

    +

    internal

    +

    Returns: Promise‹boolean›

    +
    +

    Protected getAllowedNamespaces#

    +

    ▸ getAllowedNamespaces(): Promise‹string[]›

    +

    Defined in src/main/cluster.ts:621

    +

    Returns: Promise‹string[]›

    +
    +

    Protected getAllowedResources#

    +

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

    +

    Defined in src/main/cluster.ts:641

    +

    Returns: Promise‹("namespaces" | "nodes" | "events" | "resourcequotas" | "services" | "secrets" | "configmaps" | "ingresses" | "networkpolicies" | "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:480

    +

    Returns: Promise‹ClusterStatus›

    +
    +

    Protected getKubeconfig#

    +

    ▸ getKubeconfig(): KubeConfig

    +

    Defined in src/main/cluster.ts:435

    +

    Returns: KubeConfig

    +
    +

    getMeta#

    +

    ▸ getMeta(): object

    +

    Defined in src/main/cluster.ts:609

    +

    Returns: object

    +
      +
    • +

      accessible: boolean = this.accessible

      +
      • +
    • +

      disconnected: boolean = this.disconnected

      +
      • +
    • +

      id: string = this.id

      +
      • +
    • +

      initialized: boolean = this.initialized

      +
      • +
    • +

      name: string = this.contextName

      +
      • +
    • +

      online: boolean = this.online

      +
      • +
    • +

      ready: boolean = this.ready

      +
      • +
    +
    +

    getMetrics#

    +

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

    +

    Defined in src/main/cluster.ts:468

    +

    internal

    +

    Parameters:

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

    Returns: Promise‹any›

    +
    +

    getProxyKubeconfig#

    +

    ▸ getProxyKubeconfig(): KubeConfig

    +

    Defined in src/main/cluster.ts:442

    +

    internal

    +

    Returns: KubeConfig

    +
    +

    getProxyKubeconfigPath#

    +

    ▸ getProxyKubeconfigPath(): string

    +

    Defined in src/main/cluster.ts:449

    +

    internal

    +

    Returns: string

    +
    +

    getState#

    +

    ▸ getState(): ClusterState

    +

    Defined in src/main/cluster.ts:571

    +

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

    +

    Returns: ClusterState

    +
    +

    init#

    +

    ▸ init(port: number): Promise‹void›

    +

    Defined in src/main/cluster.ts:272

    +

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

    +

    internal

    +

    Parameters:

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

    Returns: Promise‹void›

    +
    +

    isClusterAdmin#

    +

    ▸ isClusterAdmin(): Promise‹boolean›

    +

    Defined in src/main/cluster.ts:543

    +

    internal

    +

    Returns: Promise‹boolean›

    +
    +

    Protected k8sRequest#

    +

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

    +

    Defined in src/main/cluster.ts:453

    +

    Type parameters:

    +

    ▪ T

    +

    Parameters:

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

    Returns: Promise‹T›

    +
    +

    pushState#

    +

    ▸ pushState(state: ClusterState): void

    +

    Defined in src/main/cluster.ts:603

    +

    internal

    +

    Parameters:

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

    Returns: void

    +
    +

    reconnect#

    +

    ▸ reconnect(): Promise‹void›

    +

    Defined in src/main/cluster.ts:363

    +

    internal

    +

    Returns: Promise‹void›

    +
    +

    refresh#

    +

    ▸ refresh(opts: ClusterRefreshOptions): Promise‹void›

    +

    Defined in src/main/cluster.ts:389

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameTypeDefaultDescription
    optsClusterRefreshOptions{}refresh options
    +

    Returns: Promise‹void›

    +
    +

    refreshAllowedResources#

    +

    ▸ refreshAllowedResources(): Promise‹void›

    +

    Defined in src/main/cluster.ts:430

    +

    internal

    +

    Returns: Promise‹void›

    +
    +

    refreshConnectionStatus#

    +

    ▸ refreshConnectionStatus(): Promise‹void›

    +

    Defined in src/main/cluster.ts:420

    +

    internal

    +

    Returns: Promise‹void›

    +
    +

    refreshMetadata#

    +

    ▸ refreshMetadata(): Promise‹void›

    +

    Defined in src/main/cluster.ts:409

    +

    internal

    +

    Returns: Promise‹void›

    +
    +

    setState#

    +

    ▸ setState(state: ClusterState): void

    +

    Defined in src/main/cluster.ts:595

    +

    internal

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    stateClusterStatecluster state
    +

    Returns: void

    +
    +

    toJSON#

    +

    ▸ toJSON(): ClusterModel

    +

    Defined in src/main/cluster.ts:551

    +

    Returns: ClusterModel

    +
    +

    Protected unbindEvents#

    +

    ▸ unbindEvents(): void

    +

    Defined in src/main/cluster.ts:314

    +

    internal

    +

    Returns: void

    +
    +

    updateModel#

    +

    ▸ updateModel(model: ClusterModel): void

    +

    Defined in src/main/cluster.ts:262

    +

    Update cluster data model

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    modelClusterModel
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_core_api_stores_.clusterstore/index.html b/v4.0.1/extensions/api/classes/_core_api_stores_.clusterstore/index.html new file mode 100644 index 0000000000..93f4c9e8c8 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_core_api_stores_.clusterstore/index.html @@ -0,0 +1,1346 @@ + + + + + + + + + + + + + + + + + + + + + + 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

    +

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

    +

    Get active cluster (a cluster which is currently visible)

    +

    Returns: Cluster

    +
    +

    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:52

    +

    Array of all clusters

    +

    Returns: Cluster[]

    +
    +

    connectedClustersList#

    +

    • get connectedClustersList(): Cluster[]

    +

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

    +

    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:59

    +

    Array of all enabled clusters

    +

    Returns: Cluster[]

    +

    Methods#

    +

    addCluster#

    +

    ▸ addCluster(model: ClusterModel | Cluster): Cluster

    +

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

    +

    Add a cluster to store

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    modelClusterModel | Clustercluster
    +

    Returns: Cluster

    +
    +

    addClusters#

    +

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

    +

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

    +

    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:74

    +

    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:82

    +

    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:114

    +

    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:122

    +

    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:106

    +

    Remove a cluster from store

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    modelClusterModelcluster
    +

    Returns: Promise‹void›

    +
    +

    Static getInstance#

    +

    ▸ getInstance‹T›(...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/v4.0.1/extensions/api/classes/_core_api_stores_.extensionstore/index.html b/v4.0.1/extensions/api/classes/_core_api_stores_.extensionstore/index.html new file mode 100644 index 0000000000..109150cd41 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_core_api_stores_.extensionstore/index.html @@ -0,0 +1,1537 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ExtensionStore ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ExtensionStore ‹T›#

    +

    Type parameters#

    +

    ▪ T

    +

    Hierarchy#

    +
      +
    • BaseStore‹T›
      • +
    +

    ↳ ExtensionStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    Protected constructor#

    +

    + new ExtensionStore(params: BaseStoreParams): ExtensionStore

    +

    Inherited from ExtensionStore.constructor

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    paramsBaseStoreParams
    +

    Returns: ExtensionStore

    +

    Properties#

    +

    Protected extension#

    +

    • extension: LensExtension

    +

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

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from ExtensionStore.isLoaded

    +

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

    +
    +

    Protected params#

    +

    • params: BaseStoreParams

    +

    Inherited from ExtensionStore.params

    +

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

    +
    +

    Protected storeConfig#

    +

    • storeConfig: Config‹T›

    +

    Inherited from ExtensionStore.storeConfig

    +

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

    +
    +

    Protected syncDisposers#

    +

    • syncDisposers: Function[] = []

    +

    Inherited from ExtensionStore.syncDisposers

    +

    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

    +

    Accessors#

    +

    name#

    +

    • get name(): string

    +

    Inherited from ExtensionStore.name

    +

    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

    +

    Returns: string

    +
    +

    Protected syncMainChannel#

    +

    • get syncMainChannel(): string

    +

    Inherited from ExtensionStore.syncMainChannel

    +

    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

    +

    Returns: string

    +

    Methods#

    +

    Protected applyWithoutSync#

    +

    ▸ applyWithoutSync(callback: function): void

    +

    Inherited from ExtensionStore.applyWithoutSync

    +

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

    +

    Parameters:

    +

    ▪ callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Protected cwd#

    +

    ▸ cwd(): string

    +

    Overrides void

    +

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

    +

    Returns: string

    +
    +

    disableSync#

    +

    ▸ disableSync(): void

    +

    Inherited from ExtensionStore.disableSync

    +

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

    +

    Returns: void

    +
    +

    enableSync#

    +

    ▸ enableSync(): void

    +

    Inherited from ExtensionStore.enableSync

    +

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

    +

    Returns: void

    +
    +

    Protected Abstract fromStore#

    +

    ▸ fromStore(data: T): void

    +

    Inherited from ExtensionStore.fromStore

    +

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

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    dataTthe parsed information read from the stored JSON file
    +

    Returns: void

    +
    +

    Protected init#

    +

    ▸ init(): Promise‹void›

    +

    Inherited from ExtensionStore.init

    +

    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

    +

    Returns: Promise‹void›

    +
    +

    loadExtension#

    +

    ▸ loadExtension(extension: LensExtension): Promise‹void›

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    extensionLensExtension
    +

    Returns: Promise‹void›

    +
    +

    Protected onModelChange#

    +

    ▸ onModelChange(model: T): Promise‹void›

    +

    Inherited from ExtensionStore.onModelChange

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    modelT
    +

    Returns: Promise‹void›

    +
    +

    Protected onSync#

    +

    ▸ onSync(model: T): void

    +

    Inherited from ExtensionStore.onSync

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    modelT
    +

    Returns: void

    +
    +

    Protected onSyncFromMain#

    +

    ▸ onSyncFromMain(model: T): void

    +

    Inherited from ExtensionStore.onSyncFromMain

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    modelT
    +

    Returns: void

    +
    +

    Protected saveToFile#

    +

    ▸ saveToFile(model: T): Promise‹void›

    +

    Inherited from ExtensionStore.saveToFile

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    modelT
    +

    Returns: Promise‹void›

    +
    +

    Abstract toJSON#

    +

    ▸ toJSON(): T

    +

    Inherited from ExtensionStore.toJSON

    +

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

    +

    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 +this.fromStore(this.toJSON()) shouldn't change the state.

    +

    Returns: T

    +
    +

    unregisterIpcListener#

    +

    ▸ unregisterIpcListener(): void

    +

    Inherited from ExtensionStore.unregisterIpcListener

    +

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

    +

    Returns: void

    +
    +

    Static getInstance#

    +

    ▸ getInstance‹T›(...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/v4.0.1/extensions/api/classes/_core_api_stores_.workspace/index.html b/v4.0.1/extensions/api/classes/_core_api_stores_.workspace/index.html new file mode 100644 index 0000000000..5d438d0be0 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_core_api_stores_.workspace/index.html @@ -0,0 +1,1262 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Workspace - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Workspace#

    +

    Workspace

    +

    beta

    +

    Hierarchy#

    +
      +
    • Workspace
      • +
    +

    Implements#

    + +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Workspace(data: WorkspaceModel): Workspace

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataWorkspaceModel
    +

    Returns: Workspace

    +

    Properties#

    +

    Optional description#

    +

    • description? : string

    +

    Implementation of WorkspaceModel.description

    +

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

    +

    Workspace description

    +

    observable

    +
    +

    enabled#

    +

    • enabled: boolean

    +

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

    +

    Is workspace enabled

    +

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

    +

    observable

    +
    +

    id#

    +

    • id: WorkspaceId

    +

    Implementation of WorkspaceModel.id

    +

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

    +

    Unique id for workspace

    +

    observable

    +
    +

    Optional lastActiveClusterId#

    +

    • lastActiveClusterId? : ClusterId

    +

    Implementation of WorkspaceModel.lastActiveClusterId

    +

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

    +

    Last active cluster id

    +

    observable

    +
    +

    name#

    +

    • name: string

    +

    Implementation of WorkspaceModel.name

    +

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

    +

    Workspace name

    +

    observable

    +
    +

    Optional ownerRef#

    +

    • ownerRef? : string

    +

    Implementation of WorkspaceModel.ownerRef

    +

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

    +

    Workspace owner reference

    +

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

    +

    observable

    +

    Accessors#

    +

    isManaged#

    +

    • get isManaged(): boolean

    +

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

    +

    Is workspace managed by an extension

    +

    Returns: boolean

    +

    Methods#

    +

    getState#

    +

    ▸ getState(): WorkspaceState

    +

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

    +

    Get workspace state

    +

    Returns: WorkspaceState

    +
    +

    pushState#

    +

    ▸ pushState(state: WorkspaceState): void

    +

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

    +

    Push state

    +

    interal

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameTypeDefaultDescription
    stateWorkspaceStatethis.getState()workspace state
    +

    Returns: void

    +
    +

    setState#

    +

    ▸ setState(state: WorkspaceState): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    stateWorkspaceStateworkspace state
    +

    Returns: void

    +
    +

    toJSON#

    +

    ▸ toJSON(): WorkspaceModel

    +

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

    +

    Returns: WorkspaceModel

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_core_api_stores_.workspacestore/index.html b/v4.0.1/extensions/api/classes/_core_api_stores_.workspacestore/index.html new file mode 100644 index 0000000000..db935a1f7e --- /dev/null +++ b/v4.0.1/extensions/api/classes/_core_api_stores_.workspacestore/index.html @@ -0,0 +1,1370 @@ + + + + + + + + + + + + + + + + + + + + + + Class: WorkspaceStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: WorkspaceStore#

    +

    Stores all workspaces

    +

    beta

    +

    Hierarchy#

    + +

    ↳ WorkspaceStore

    +

    Index#

    +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Properties#

    +

    Static defaultId#

    +

    ▪ defaultId: WorkspaceId = InternalWorkspaceStore.defaultId

    +

    Defined in src/extensions/stores/workspace-store.ts:17

    +

    Default workspace id, this workspace is always present

    +

    Accessors#

    +

    currentWorkspace#

    +

    • get currentWorkspace(): Workspace

    +

    Defined in src/extensions/stores/workspace-store.ts:43

    +

    Currently active workspace

    +

    Returns: Workspace

    +
    +

    currentWorkspaceId#

    +

    • get currentWorkspaceId(): string

    +

    Defined in src/extensions/stores/workspace-store.ts:22

    +

    Currently active workspace id

    +

    Returns: string

    +

    • set currentWorkspaceId(id: string): void

    +

    Defined in src/extensions/stores/workspace-store.ts:29

    +

    Set active workspace id

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idstring
    +

    Returns: void

    +
    +

    enabledWorkspacesList#

    +

    • get enabledWorkspacesList(): Workspace[]

    +

    Defined in src/extensions/stores/workspace-store.ts:57

    +

    Array of all enabled (visible) workspaces

    +

    Returns: Workspace[]

    +
    +

    workspaces#

    +

    • get workspaces(): ObservableMap‹string, Workspace›

    +

    Defined in src/extensions/stores/workspace-store.ts:36

    +

    Map of all workspaces

    +

    Returns: ObservableMap‹string, Workspace›

    +
    +

    workspacesList#

    +

    • get workspacesList(): Workspace[]

    +

    Defined in src/extensions/stores/workspace-store.ts:50

    +

    Array of all workspaces

    +

    Returns: Workspace[]

    +

    Methods#

    +

    addWorkspace#

    +

    ▸ addWorkspace(workspace: Workspace): Workspace‹›

    +

    Defined in src/extensions/stores/workspace-store.ts:89

    +

    Add a workspace to store

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    workspaceWorkspaceworkspace
    +

    Returns: Workspace‹›

    +
    +

    getById#

    +

    ▸ getById(id: WorkspaceId): Workspace

    +

    Defined in src/extensions/stores/workspace-store.ts:65

    +

    Get workspace by id

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    idWorkspaceIdworkspace id
    +

    Returns: Workspace

    +
    +

    getByName#

    +

    ▸ getByName(name: string): Workspace

    +

    Defined in src/extensions/stores/workspace-store.ts:73

    +

    Get workspace by name

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    namestringworkspace name
    +

    Returns: Workspace

    +
    +

    removeWorkspace#

    +

    ▸ removeWorkspace(workspace: Workspace): void

    +

    Defined in src/extensions/stores/workspace-store.ts:105

    +

    Remove workspace from store

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    workspaceWorkspaceworkspace
    +

    Returns: void

    +
    +

    removeWorkspaceById#

    +

    ▸ removeWorkspaceById(id: WorkspaceId): void

    +

    Defined in src/extensions/stores/workspace-store.ts:113

    +

    Remove workspace by id

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    idWorkspaceIdworkspace
    +

    Returns: void

    +
    +

    setActive#

    +

    ▸ setActive(id: string): void

    +

    Defined in src/extensions/stores/workspace-store.ts:81

    +

    Set active workspace

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameTypeDefaultDescription
    idstringWorkspaceStore.defaultIdworkspace id
    +

    Returns: void

    +
    +

    updateWorkspace#

    +

    ▸ updateWorkspace(workspace: Workspace): void

    +

    Defined in src/extensions/stores/workspace-store.ts:97

    +

    Update a workspace in store

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDescription
    workspaceWorkspaceworkspace
    +

    Returns: void

    +
    +

    Static getInstance#

    +

    ▸ getInstance‹T›(...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/v4.0.1/extensions/api/classes/_core_api_utils_.singleton/index.html b/v4.0.1/extensions/api/classes/_core_api_utils_.singleton/index.html new file mode 100644 index 0000000000..52ccee6494 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_core_api_utils_.singleton/index.html @@ -0,0 +1,1000 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Singleton - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Singleton#

    +

    Hierarchy#

    +
      +
    • Singleton
      • +
    +

    ↳ ClusterStore

    +

    ↳ WorkspaceStore

    +

    Index#

    +

    Methods#

    + +

    Methods#

    +

    Static getInstance#

    +

    ▸ getInstance‹T›(...args: ConstructorParameters‹Constructor‹T››): T

    +

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

    +

    Type parameters:

    +

    ▪ T

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ...argsConstructorParameters‹Constructor‹T››
    +

    Returns: T

    +
    +

    Static resetInstance#

    +

    ▸ resetInstance(): void

    +

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

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.badge/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.badge/index.html new file mode 100644 index 0000000000..036e4cd9ed --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.badge/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Badge ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Badge ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ Badge

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Badge(props: Readonly‹BadgeProps›): Badge

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹BadgeProps›
    +

    Returns: Badge

    +

    + new Badge(props: BadgeProps, context?: any): Badge

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsBadgeProps
    context?any
    +

    Returns: Badge

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹BadgeProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹BadgeProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹BadgeProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹BadgeProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹BadgeProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹BadgeProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹BadgeProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹BadgeProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹BadgeProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹BadgeProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹BadgeProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹BadgeProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹BadgeProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

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

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹BadgeProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹BadgeProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.button/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.button/index.html new file mode 100644 index 0000000000..a5ffe6c123 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.button/index.html @@ -0,0 +1,1381 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Button ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Button ‹SS›#

    +

    Type parameters#

    +

    ▪ SS

    +

    Hierarchy#

    + +

    ↳ Button

    +

    Index#

    +

    Methods#

    + +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹ButtonProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ButtonProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹ButtonProps›, nextState: Readonly‹object›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ButtonProps›
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹ButtonProps›, prevState: Readonly‹object›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹ButtonProps›
    prevStateReadonly‹object›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹ButtonProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ButtonProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹ButtonProps›, nextState: Readonly‹object›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ButtonProps›
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹ButtonProps›, prevState: Readonly‹object›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹ButtonProps›
    prevStateReadonly‹object›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

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

    +

    Returns: Element‹›

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹ButtonProps›, nextState: Readonly‹object›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ButtonProps›
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.checkbox/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.checkbox/index.html new file mode 100644 index 0000000000..f0086470f3 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.checkbox/index.html @@ -0,0 +1,1423 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Checkbox ‹**S, SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Checkbox ‹S, SS›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    Hierarchy#

    + +

    ↳ Checkbox

    +

    Index#

    +

    Methods#

    + +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹CheckboxProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CheckboxProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹CheckboxProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CheckboxProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹CheckboxProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹CheckboxProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹CheckboxProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CheckboxProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹CheckboxProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CheckboxProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹CheckboxProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹CheckboxProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    getValue#

    +

    ▸ getValue(): boolean

    +

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

    +

    Returns: boolean

    +
    +

    onChange#

    +

    ▸ onChange(evt: ChangeEvent‹HTMLInputElement›): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtChangeEvent‹HTMLInputElement›
    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

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

    +

    Returns: Element‹›

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹CheckboxProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CheckboxProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html new file mode 100644 index 0000000000..99e9301dc2 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.confirmdialog/index.html @@ -0,0 +1,1850 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ConfirmDialog ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ConfirmDialog ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ ConfirmDialog

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new ConfirmDialog(props: Readonly‹ConfirmDialogProps›): ConfirmDialog

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹ConfirmDialogProps›
    +

    Returns: ConfirmDialog

    +

    + new ConfirmDialog(props: ConfirmDialogProps, context?: any): ConfirmDialog

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsConfirmDialogProps
    context?any
    +

    Returns: ConfirmDialog

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    isSaving#

    +

    • isSaving: boolean = false

    +

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

    +
    +

    props#

    +

    • props: Readonly‹ConfirmDialogProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +
    +

    Static isOpen#

    +

    ▪ isOpen: boolean = false

    +

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

    +
    +

    Static params#

    +

    ▪ params: ConfirmDialogParams

    +

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

    +

    Accessors#

    +

    params#

    +

    • get params(): ConfirmDialogParams

    +

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

    +

    Returns: ConfirmDialogParams

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹ConfirmDialogProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ConfirmDialogProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹ConfirmDialogProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ConfirmDialogProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    close#

    +

    ▸ close(): void

    +

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

    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹ConfirmDialogProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹ConfirmDialogProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹ConfirmDialogProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ConfirmDialogProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹ConfirmDialogProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ConfirmDialogProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹ConfirmDialogProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹ConfirmDialogProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    ok#

    +

    ▸ ok(): Promise‹void›

    +

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

    +

    Returns: Promise‹void›

    +
    +

    onClose#

    +

    ▸ onClose(): void

    +

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

    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

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

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹ConfirmDialogProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹ConfirmDialogProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +
    +

    Static close#

    +

    ▸ close(): void

    +

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

    +

    Returns: void

    +
    +

    Static open#

    +

    ▸ open(params: ConfirmDialogParams): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    paramsConfirmDialogParams
    +

    Returns: void

    +

    Object literals#

    +

    defaultParams#

    +

    ▪ defaultParams: object#

    +

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

    +

    icon#

    +

    • icon: Element‹› =

    +

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

    +

    labelCancel#

    +

    • labelCancel: Element‹› = Cancel

    +

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

    +

    labelOk#

    +

    • labelOk: Element‹› = Ok

    +

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

    +

    ok#

    +

    • ok: any = noop

    +

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

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.cubespinner/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.cubespinner/index.html new file mode 100644 index 0000000000..ea9bed1a07 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.cubespinner/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CubeSpinner ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: CubeSpinner ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ CubeSpinner

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new CubeSpinner(props: Readonly‹CubeSpinnerProps›): CubeSpinner

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹CubeSpinnerProps›
    +

    Returns: CubeSpinner

    +

    + new CubeSpinner(props: CubeSpinnerProps, context?: any): CubeSpinner

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsCubeSpinnerProps
    context?any
    +

    Returns: CubeSpinner

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹CubeSpinnerProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹CubeSpinnerProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CubeSpinnerProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹CubeSpinnerProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CubeSpinnerProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹CubeSpinnerProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹CubeSpinnerProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹CubeSpinnerProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CubeSpinnerProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹CubeSpinnerProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CubeSpinnerProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹CubeSpinnerProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹CubeSpinnerProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

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

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹CubeSpinnerProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹CubeSpinnerProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.dialog/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.dialog/index.html new file mode 100644 index 0000000000..88a3d40157 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.dialog/index.html @@ -0,0 +1,1739 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Dialog ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Dialog ‹SS›#

    +

    Type parameters#

    +

    ▪ SS

    +

    Hierarchy#

    + +

    ↳ Dialog

    +

    Index#

    +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Object literals#

    + +

    Properties#

    +

    closeOnNavigate#

    +

    • closeOnNavigate: IReactionDisposer = reaction(() => navigation.getPath(), () => this.close())

    +

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

    +

    Accessors#

    +

    elem#

    +

    • get elem(): HTMLElement

    +

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

    +

    Returns: HTMLElement

    +
    +

    isOpen#

    +

    • get isOpen(): boolean

    +

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

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹DialogProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DialogProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹DialogProps›, nextState: Readonly‹DialogState›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DialogProps›
    nextStateReadonly‹DialogState›
    nextContextany
    +

    Returns: void

    +
    +

    close#

    +

    ▸ close(): void

    +

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

    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

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

    +

    Returns: void

    +
    +

    componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: DialogProps): void

    +

    Overrides PageLayout.componentDidUpdate

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    prevPropsDialogProps
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹DialogProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DialogProps›
    nextContextany
    +

    Returns: void

    +
    +

    componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Overrides WizardLayout.componentWillUnmount

    +

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

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹DialogProps›, nextState: Readonly‹DialogState›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DialogProps›
    nextStateReadonly‹DialogState›
    nextContextany
    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹DialogProps›, prevState: Readonly‹DialogState›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DialogProps›
    prevStateReadonly‹DialogState›
    +

    Returns: SS | null

    +
    +

    onClickOutside#

    +

    ▸ onClickOutside(evt: MouseEvent): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent
    +

    Returns: void

    +
    +

    onClose#

    +

    ▸ onClose(): void

    +

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

    +

    Returns: void

    +
    +

    onEscapeKey#

    +

    ▸ onEscapeKey(evt: KeyboardEvent): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent
    +

    Returns: void

    +
    +

    onOpen#

    +

    ▸ onOpen(): void

    +

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

    +

    Returns: void

    +
    +

    open#

    +

    ▸ open(): void

    +

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

    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): ReactPortal‹›

    +

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

    +

    Returns: ReactPortal‹›

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹DialogProps›, nextState: Readonly‹DialogState›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DialogProps›
    nextStateReadonly‹DialogState›
    nextContextany
    +

    Returns: boolean

    +
    +

    toggle#

    +

    ▸ toggle(isOpen: boolean): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    isOpenboolean
    +

    Returns: void

    +

    Object literals#

    +

    state#

    +

    ▪ state: object#

    +

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

    +

    isOpen#

    +

    • isOpen: boolean = this.props.isOpen

    +

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

    +
    +

    Static defaultProps#

    +

    ▪ defaultProps: object#

    +

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

    +

    animated#

    +

    • animated: true = true

    +

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

    +

    close#

    +

    • close: any = noop

    +

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

    +

    isOpen#

    +

    • isOpen: false = false

    +

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

    + +

    • modal: true = true

    +

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

    +

    onClose#

    +

    • onClose: any = noop

    +

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

    +

    onOpen#

    +

    • onOpen: any = noop

    +

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

    +

    open#

    +

    • open: any = noop

    +

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

    +

    pinned#

    +

    • pinned: false = false

    +

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

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.drawer/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.drawer/index.html new file mode 100644 index 0000000000..64d981bc7a --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.drawer/index.html @@ -0,0 +1,1748 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Drawer ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Drawer ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ Drawer

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Drawer(props: Readonly‹DrawerProps›): Drawer

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹DrawerProps›
    +

    Returns: Drawer

    +

    + new Drawer(props: DrawerProps, context?: any): Drawer

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsDrawerProps
    context?any
    +

    Returns: Drawer

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹DrawerProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +
    +

    Static defaultProps#

    +

    ▪ defaultProps: object = defaultProps as object

    +

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

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹DrawerProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹DrawerProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    close#

    +

    ▸ close(): void

    +

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

    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

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

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹DrawerProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DrawerProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹DrawerProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerProps›
    nextContextany
    +

    Returns: void

    +
    +

    componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Overrides WizardLayout.componentWillUnmount

    +

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

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹DrawerProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹DrawerProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DrawerProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    onClickOutside#

    +

    ▸ onClickOutside(evt: MouseEvent): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent
    +

    Returns: void

    +
    +

    onEscapeKey#

    +

    ▸ onEscapeKey(evt: KeyboardEvent): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent
    +

    Returns: void

    +
    +

    onMouseDown#

    +

    ▸ onMouseDown(evt: MouseEvent): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent
    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

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

    +

    Returns: Element‹›

    +
    +

    restoreScrollPos#

    +

    ▸ restoreScrollPos(): void

    +

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

    +

    Returns: void

    +
    +

    saveScrollPos#

    +

    ▸ saveScrollPos(): void

    +

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

    +

    Returns: void

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹DrawerProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.draweritem/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.draweritem/index.html new file mode 100644 index 0000000000..36eb0c0684 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.draweritem/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DrawerItem ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: DrawerItem ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ DrawerItem

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DrawerItem(props: Readonly‹DrawerItemProps›): DrawerItem

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹DrawerItemProps›
    +

    Returns: DrawerItem

    +

    + new DrawerItem(props: DrawerItemProps, context?: any): DrawerItem

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsDrawerItemProps
    context?any
    +

    Returns: DrawerItem

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹DrawerItemProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹DrawerItemProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerItemProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹DrawerItemProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerItemProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹DrawerItemProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DrawerItemProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹DrawerItemProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerItemProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹DrawerItemProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerItemProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹DrawerItemProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DrawerItemProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

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

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹DrawerItemProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerItemProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html new file mode 100644 index 0000000000..10667e2cdf --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.drawerparamtoggler/index.html @@ -0,0 +1,1627 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DrawerParamToggler ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: DrawerParamToggler ‹SS›#

    +

    Type parameters#

    +

    ▪ SS

    +

    Hierarchy#

    + +

    ↳ DrawerParamToggler

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DrawerParamToggler(props: Readonly‹DrawerParamTogglerProps›): DrawerParamToggler

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹DrawerParamTogglerProps›
    +

    Returns: DrawerParamToggler

    +

    + new DrawerParamToggler(props: DrawerParamTogglerProps, context?: any): DrawerParamToggler

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsDrawerParamTogglerProps
    context?any
    +

    Returns: DrawerParamToggler

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹DrawerParamTogglerProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: State

    +

    Overrides PageLayout.state

    +

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

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹DrawerParamTogglerProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerParamTogglerProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹DrawerParamTogglerProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerParamTogglerProps›
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹DrawerParamTogglerProps›, prevState: Readonly‹State›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DrawerParamTogglerProps›
    prevStateReadonly‹State›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹DrawerParamTogglerProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerParamTogglerProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹DrawerParamTogglerProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerParamTogglerProps›
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹DrawerParamTogglerProps›, prevState: Readonly‹State›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DrawerParamTogglerProps›
    prevStateReadonly‹State›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

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

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof State

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹DrawerParamTogglerProps›, nextState: Readonly‹State›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerParamTogglerProps›
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: boolean

    +
    +

    toggle#

    +

    ▸ toggle(): void

    +

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

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.drawertitle/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.drawertitle/index.html new file mode 100644 index 0000000000..a56f5e05a4 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.drawertitle/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DrawerTitle ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: DrawerTitle ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ DrawerTitle

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DrawerTitle(props: Readonly‹DrawerTitleProps›): DrawerTitle

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹DrawerTitleProps›
    +

    Returns: DrawerTitle

    +

    + new DrawerTitle(props: DrawerTitleProps, context?: any): DrawerTitle

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsDrawerTitleProps
    context?any
    +

    Returns: DrawerTitle

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹DrawerTitleProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹DrawerTitleProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerTitleProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹DrawerTitleProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerTitleProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹DrawerTitleProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DrawerTitleProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹DrawerTitleProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerTitleProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹DrawerTitleProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerTitleProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹DrawerTitleProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹DrawerTitleProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

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

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹DrawerTitleProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹DrawerTitleProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.icon/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.icon/index.html new file mode 100644 index 0000000000..980eb0b679 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.icon/index.html @@ -0,0 +1,1526 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Icon ‹**S, SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Icon ‹S, SS›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    Hierarchy#

    + +

    ↳ Icon

    +

    Index#

    +

    Accessors#

    + +

    Methods#

    + +

    Object literals#

    + +

    Accessors#

    +

    isInteractive#

    +

    • get isInteractive(): boolean

    +

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

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹IconProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹IconProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹IconProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹IconProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹IconProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹IconProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹IconProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹IconProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹IconProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹IconProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹IconProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹IconProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    onClick#

    +

    ▸ onClick(evt: MouseEvent): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent
    +

    Returns: void

    +
    +

    onKeyDown#

    +

    ▸ onKeyDown(evt: KeyboardEvent‹any›): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent‹any›
    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

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

    +

    Returns: Element‹›

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹IconProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹IconProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +

    Object literals#

    +

    Static defaultProps#

    +

    ▪ defaultProps: object#

    +

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

    +

    focusable#

    +

    • focusable: true = true

    +

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

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.input/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.input/index.html new file mode 100644 index 0000000000..79131d82af --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.input/index.html @@ -0,0 +1,2069 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Input ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Input ‹SS›#

    +

    Type parameters#

    +

    ▪ SS

    +

    Hierarchy#

    + +

    ↳ Input

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new Input(props: Readonly‹InputProps›): Input

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹InputProps›
    +

    Returns: Input

    +

    + new Input(props: InputProps, context?: any): Input

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsInputProps
    context?any
    +

    Returns: Input

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    input#

    +

    • input: InputElement

    +

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

    +
    +

    props#

    +

    • props: Readonly‹InputProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    validators#

    +

    • validators: InputValidator[] = []

    +

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

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +
    +

    Static defaultProps#

    +

    ▪ defaultProps: object = defaultProps as object

    +

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

    +

    Accessors#

    +

    isUncontrolled#

    +

    • get isUncontrolled(): boolean

    +

    Defined in src/renderer/components/input/input.tsx:258

    +

    Returns: boolean

    +
    +

    showMaxLenIndicator#

    +

    • get showMaxLenIndicator(): boolean

    +

    Defined in src/renderer/components/input/input.tsx:252

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹InputProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹InputProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹InputProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹InputProps›
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: void

    +
    +

    bindRef#

    +

    ▸ bindRef(elem: InputElement): void

    +

    Defined in src/renderer/components/input/input.tsx:285

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    elemInputElement
    +

    Returns: void

    +
    +

    blur#

    +

    ▸ blur(): void

    +

    Defined in src/renderer/components/input/input.tsx:95

    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/input/input.tsx:262

    +

    Returns: void

    +
    +

    componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: InputProps): void

    +

    Overrides PageLayout.componentDidUpdate

    +

    Defined in src/renderer/components/input/input.tsx:267

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    prevPropsInputProps
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹InputProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹InputProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹InputProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹InputProps›
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: void

    +
    +

    focus#

    +

    ▸ focus(): void

    +

    Defined in src/renderer/components/input/input.tsx:91

    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹InputProps›, prevState: Readonly‹State›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹InputProps›
    prevStateReadonly‹State›
    +

    Returns: SS | null

    +
    +

    getValue#

    +

    ▸ getValue(): string

    +

    Defined in src/renderer/components/input/input.tsx:82

    +

    Returns: string

    +
    +

    isValid#

    +

    ▸ isValid(): boolean

    +

    Defined in src/renderer/components/input/input.tsx:67

    +

    Returns: boolean

    +
    +

    onBlur#

    +

    ▸ onBlur(evt: FocusEvent‹InputElement›): void

    +

    Defined in src/renderer/components/input/input.tsx:208

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtFocusEvent‹InputElement›
    +

    Returns: void

    +
    +

    onChange#

    +

    ▸ onChange(evt: ChangeEvent‹any›): void

    +

    Defined in src/renderer/components/input/input.tsx:217

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtChangeEvent‹any›
    +

    Returns: void

    +
    +

    onFocus#

    +

    ▸ onFocus(evt: FocusEvent‹InputElement›): void

    +

    Defined in src/renderer/components/input/input.tsx:199

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtFocusEvent‹InputElement›
    +

    Returns: void

    +
    +

    onKeyDown#

    +

    ▸ onKeyDown(evt: KeyboardEvent‹any›): void

    +

    Defined in src/renderer/components/input/input.tsx:236

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent‹any›
    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/input/input.tsx:289

    +

    Returns: Element‹›

    +
    +

    select#

    +

    ▸ select(): void

    +

    Defined in src/renderer/components/input/input.tsx:99

    +

    Returns: void

    +
    +

    setDirty#

    +

    ▸ setDirty(dirty: boolean): void

    +

    Defined in src/renderer/components/input/input.tsx:193

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    dirtybooleantrue
    +

    Returns: void

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof State

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    setValidation#

    +

    ▸ setValidation(errors: React.ReactNode[]): void

    +

    Defined in src/renderer/components/input/input.tsx:163

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    errorsReact.ReactNode[]
    +

    Returns: void

    +
    +

    setValue#

    +

    ▸ setValue(value: string): void

    +

    Defined in src/renderer/components/input/input.tsx:71

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    valuestring
    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹InputProps›, nextState: Readonly‹State›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹InputProps›
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: boolean

    +
    +

    validate#

    +

    ▸ validate(value: string): Promise‹void›

    +

    Defined in src/renderer/components/input/input.tsx:119

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    valuestringthis.getValue()
    +

    Returns: Promise‹void›

    +

    Object literals#

    +

    state#

    +

    ▪ state: object#

    +

    Overrides PageLayout.state

    +

    Defined in src/renderer/components/input/input.tsx:61

    +

    dirty#

    +

    • dirty: boolean = !!this.props.dirty

    +

    Defined in src/renderer/components/input/input.tsx:62

    +

    errors#

    +

    • errors: undefined[] = []

    +

    Defined in src/renderer/components/input/input.tsx:64

    +

    valid#

    +

    • valid: true = true

    +

    Defined in src/renderer/components/input/input.tsx:63

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html new file mode 100644 index 0000000000..9f7de08927 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.kubeeventdetails/index.html @@ -0,0 +1,1615 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeEventDetails ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: KubeEventDetails ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ KubeEventDetails

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeEventDetails(props: Readonly‹KubeEventDetailsProps›): KubeEventDetails

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹KubeEventDetailsProps›
    +

    Returns: KubeEventDetails

    +

    + new KubeEventDetails(props: KubeEventDetailsProps, context?: any): KubeEventDetails

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsKubeEventDetailsProps
    context?any
    +

    Returns: KubeEventDetails

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹KubeEventDetailsProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹KubeEventDetailsProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeEventDetailsProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹KubeEventDetailsProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeEventDetailsProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    ▸ componentDidMount(): Promise‹void›

    +

    Overrides WizardLayout.componentDidMount

    +

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

    +

    Returns: Promise‹void›

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹KubeEventDetailsProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹KubeEventDetailsProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹KubeEventDetailsProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeEventDetailsProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹KubeEventDetailsProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeEventDetailsProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹KubeEventDetailsProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹KubeEventDetailsProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

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

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹KubeEventDetailsProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeEventDetailsProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html new file mode 100644 index 0000000000..0fe49a8c5e --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.kubeobjectdetails/index.html @@ -0,0 +1,1739 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectDetails ‹**P, S, SS, P, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: KubeObjectDetails ‹P, S, SS, P, S›#

    +

    Type parameters#

    +

    ▪ P

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ P

    +

    ▪ S

    +

    Hierarchy#

    +
      +
    • Component
      • +
    +

    ↳ KubeObjectDetails

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeObjectDetails(props: Readonly‹P›): KubeObjectDetails

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹P›
    +

    Returns: KubeObjectDetails

    +

    + new KubeObjectDetails(props: P, context?: any): KubeObjectDetails

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsP
    context?any
    +

    Returns: KubeObjectDetails

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

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

    +
    +

    loader#

    +

    • loader: IReactionDisposer = reaction(() => [ + this.path, + this.object, // resource might be updated via watch-event or from already opened details + crdStore.items.length, // crd stores initialized after loading + ], async () => { + this.loadingError = ""; + const { path, object } = this;

    +
    if (!object) {
+  const store = apiManager.getStore(path);
+
+  if (store) {
+    this.isLoading = true;
+
+    try {
+      await store.loadFromPath(path);
+    } catch (err) {
+      this.loadingError = <Trans>Resource loading has failed: <b>{err.toString()}</b></Trans>;
+    } finally {
+      this.isLoading = false;
+    }
+  }
+}
+
    +

    })

    +

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

    +
    +

    loadingError#

    +

    • loadingError: React.ReactNode

    +

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

    +
    +

    props#

    +

    • props: Readonly‹P› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Accessors#

    +

    isCrdInstance#

    +

    • get isCrdInstance(): boolean

    +

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

    +

    Returns: boolean

    +
    +

    object#

    +

    • get object(): any

    +

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

    +

    Returns: any

    +
    +

    path#

    +

    • get path(): string

    +

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

    +

    Returns: string

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹P›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹P›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹P›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹P›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹P›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹P›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹P›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹P›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

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

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹P›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html new file mode 100644 index 0000000000..55f24dc7a7 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.kubeobjectlistlayout/index.html @@ -0,0 +1,1680 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectListLayout ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: KubeObjectListLayout ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ KubeObjectListLayout

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeObjectListLayout(props: Readonly‹KubeObjectListLayoutProps›): KubeObjectListLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹KubeObjectListLayoutProps›
    +

    Returns: KubeObjectListLayout

    +

    + new KubeObjectListLayout(props: KubeObjectListLayoutProps, context?: any): KubeObjectListLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsKubeObjectListLayoutProps
    context?any
    +

    Returns: KubeObjectListLayout

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹KubeObjectListLayoutProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Accessors#

    +

    selectedItem#

    +

    • get selectedItem(): any

    +

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

    +

    Returns: any

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹KubeObjectListLayoutProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectListLayoutProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹KubeObjectListLayoutProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectListLayoutProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹KubeObjectListLayoutProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹KubeObjectListLayoutProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹KubeObjectListLayoutProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectListLayoutProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹KubeObjectListLayoutProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectListLayoutProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹KubeObjectListLayoutProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹KubeObjectListLayoutProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    onDetails#

    +

    ▸ onDetails(item: KubeObject): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeObject
    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

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

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹KubeObjectListLayoutProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectListLayoutProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html new file mode 100644 index 0000000000..02e9fd15f8 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.kubeobjectmenu/index.html @@ -0,0 +1,1717 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectMenu ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: KubeObjectMenu ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ KubeObjectMenu

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeObjectMenu(props: Readonly‹KubeObjectMenuProps›): KubeObjectMenu

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹KubeObjectMenuProps›
    +

    Returns: KubeObjectMenu

    +

    + new KubeObjectMenu(props: KubeObjectMenuProps, context?: any): KubeObjectMenu

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsKubeObjectMenuProps
    context?any
    +

    Returns: KubeObjectMenu

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹KubeObjectMenuProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Accessors#

    +

    isEditable#

    +

    • get isEditable(): boolean

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:26

    +

    Returns: boolean

    +
    +

    isRemovable#

    +

    • get isRemovable(): boolean

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:32

    +

    Returns: boolean

    +
    +

    store#

    +

    • get store(): KubeObjectStore‹any›

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:18

    +

    Returns: KubeObjectStore‹any›

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹KubeObjectMenuProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMenuProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹KubeObjectMenuProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMenuProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹KubeObjectMenuProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹KubeObjectMenuProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹KubeObjectMenuProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMenuProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹KubeObjectMenuProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMenuProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹KubeObjectMenuProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹KubeObjectMenuProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    remove#

    +

    ▸ remove(): Promise‹void›

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:45

    +

    Returns: Promise‹void›

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

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

    +

    Returns: Element‹›

    +
    +

    renderRemoveMessage#

    +

    ▸ renderRemoveMessage(): Element‹›

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:54

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹KubeObjectMenuProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMenuProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +
    +

    update#

    +

    ▸ update(): Promise‹void›

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:39

    +

    Returns: Promise‹void›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html new file mode 100644 index 0000000000..06134b61cf --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.kubeobjectmeta/index.html @@ -0,0 +1,1658 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectMeta ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: KubeObjectMeta ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ KubeObjectMeta

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeObjectMeta(props: Readonly‹KubeObjectMetaProps›): KubeObjectMeta

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹KubeObjectMetaProps›
    +

    Returns: KubeObjectMeta

    +

    + new KubeObjectMeta(props: KubeObjectMetaProps, context?: any): KubeObjectMeta

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsKubeObjectMetaProps
    context?any
    +

    Returns: KubeObjectMeta

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹KubeObjectMetaProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +
    +

    Static defaultHiddenFields#

    +

    ▪ defaultHiddenFields: IKubeMetaField[] = [ + "uid", "resourceVersion", "selfLink" + ]

    +

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:16

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹KubeObjectMetaProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMetaProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹KubeObjectMetaProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMetaProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹KubeObjectMetaProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹KubeObjectMetaProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹KubeObjectMetaProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMetaProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹KubeObjectMetaProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMetaProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹KubeObjectMetaProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹KubeObjectMetaProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    isHidden#

    +

    ▸ isHidden(field: IKubeMetaField): boolean

    +

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:20

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    fieldIKubeMetaField
    +

    Returns: boolean

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/kube-object/kube-object-meta.tsx:26

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹KubeObjectMetaProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹KubeObjectMetaProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.lineprogress/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.lineprogress/index.html new file mode 100644 index 0000000000..06408409f5 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.lineprogress/index.html @@ -0,0 +1,1464 @@ + + + + + + + + + + + + + + + + + + + + + + Class: LineProgress ‹**S, SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: LineProgress ‹S, SS›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    Hierarchy#

    + +

    ↳ LineProgress

    +

    Index#

    +

    Methods#

    + +

    Object literals#

    + +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹LineProgressProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹LineProgressProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹LineProgressProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹LineProgressProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹LineProgressProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹LineProgressProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹LineProgressProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹LineProgressProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹LineProgressProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹LineProgressProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹LineProgressProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹LineProgressProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:23

    +

    Returns: Element‹›

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹LineProgressProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹LineProgressProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +

    Object literals#

    +

    Static defaultProps#

    +

    ▪ defaultProps: object#

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:16

    +

    max#

    +

    • max: number = 100

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:19

    +

    min#

    +

    • min: number = 0

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:18

    +

    precise#

    +

    • precise: number = 2

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:20

    +

    value#

    +

    • value: number = 0

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:17

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.menu/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.menu/index.html new file mode 100644 index 0000000000..5d9e6f085d --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.menu/index.html @@ -0,0 +1,1998 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Menu ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Menu ‹SS›#

    +

    Type parameters#

    +

    ▪ SS

    +

    Hierarchy#

    + +

    ↳ Menu

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Menu(props: Readonly‹MenuProps›): Menu

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹MenuProps›
    +

    Returns: Menu

    +

    + new Menu(props: MenuProps, context?: any): Menu

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsMenuProps
    context?any
    +

    Returns: Menu

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    elem#

    +

    • elem: HTMLUListElement

    +

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

    +
    +

    Protected items#

    +

    • items: object

    +

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

    +

    Type declaration:

    + +
    +

    opener#

    +

    • opener: HTMLElement

    +

    Defined in src/renderer/components/menu/menu.tsx:53

    +
    +

    props#

    +

    • props: Readonly‹MenuProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refreshPosition#

    +

    • refreshPosition: (Anonymous function) & Cancelable = debounce(() => { + if (!this.props.usePortal || !this.opener) return; + const { width, height } = this.opener.getBoundingClientRect(); + let { left, top, bottom, right } = this.opener.getBoundingClientRect(); + const withScroll = window.getComputedStyle(this.elem).position !== "fixed";

    +
    // window global scroll corrections
+if (withScroll) {
+  left += window.pageXOffset;
+  top += window.pageYOffset;
+  right = left + width;
+  bottom = top + height;
+}
+
+// setup initial position
+const position: MenuPosition = { left: true, bottom: true };
+
+this.elem.style.left = `${left}px`;
+this.elem.style.top = `${bottom}px`;
+
+// correct position if menu doesn't fit to viewport
+const menuPos = this.elem.getBoundingClientRect();
+
+if (menuPos.right > window.innerWidth) {
+  this.elem.style.left = `${right - this.elem.offsetWidth}px`;
+  position.right = true;
+  delete position.left;
+}
+
+if (menuPos.bottom > window.innerHeight) {
+  this.elem.style.top = `${top - this.elem.offsetHeight}px`;
+  position.top = true;
+  delete position.bottom;
+}
+this.setState({ position });
+
    +

    }, Animate.VISIBILITY_DELAY_MS)

    +

    Defined in src/renderer/components/menu/menu.tsx:121

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: State

    +

    Overrides PageLayout.state

    +

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

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +
    +

    Static defaultProps#

    +

    ▪ defaultProps: object = defaultPropsMenu as object

    +

    Defined in src/renderer/components/menu/menu.tsx:51

    +

    Accessors#

    +

    Protected focusableItems#

    +

    • get focusableItems(): MenuItem‹›[]

    +

    Defined in src/renderer/components/menu/menu.tsx:95

    +

    Returns: MenuItem‹›[]

    +
    +

    Protected focusedItem#

    +

    • get focusedItem(): MenuItem‹›

    +

    Defined in src/renderer/components/menu/menu.tsx:99

    +

    Returns: MenuItem‹›

    +
    +

    isOpen#

    +

    • get isOpen(): boolean

    +

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

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹MenuProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹MenuProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuProps›
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: void

    +
    +

    Protected bindItemRef#

    +

    ▸ bindItemRef(item: MenuItem, index: number): void

    +

    Defined in src/renderer/components/menu/menu.tsx:232

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemMenuItem
    indexnumber
    +

    Returns: void

    +
    +

    Protected bindRef#

    +

    ▸ bindRef(elem: HTMLUListElement): void

    +

    Defined in src/renderer/components/menu/menu.tsx:228

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    elemHTMLUListElement
    +

    Returns: void

    +
    +

    close#

    +

    ▸ close(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:165

    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/menu/menu.tsx:63

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹MenuProps›, prevState: Readonly‹State›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹MenuProps›
    prevStateReadonly‹State›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹MenuProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuProps›
    nextContextany
    +

    Returns: void

    +
    +

    componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Overrides WizardLayout.componentWillUnmount

    +

    Defined in src/renderer/components/menu/menu.tsx:84

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹MenuProps›, nextState: Readonly‹State›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuProps›
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: void

    +
    +

    Protected focusNextItem#

    +

    ▸ focusNextItem(reverse: boolean): void

    +

    Defined in src/renderer/components/menu/menu.tsx:103

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    reversebooleanfalse
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹MenuProps›, prevState: Readonly‹State›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹MenuProps›
    prevStateReadonly‹State›
    +

    Returns: SS | null

    +
    +

    onClickOutside#

    +

    ▸ onClickOutside(evt: MouseEvent): void

    +

    Defined in src/renderer/components/menu/menu.tsx:216

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent
    +

    Returns: void

    +
    +

    onKeyDown#

    +

    ▸ onKeyDown(evt: KeyboardEvent): void

    +

    Defined in src/renderer/components/menu/menu.tsx:174

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent
    +

    Returns: void

    +
    +

    onScrollOutside#

    +

    ▸ onScrollOutside(evt: UIEvent): void

    +

    Defined in src/renderer/components/menu/menu.tsx:206

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtUIEvent
    +

    Returns: void

    +
    +

    onWindowResize#

    +

    ▸ onWindowResize(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:201

    +

    Returns: void

    +
    +

    open#

    +

    ▸ open(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:158

    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/menu/menu.tsx:236

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof State

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹MenuProps›, nextState: Readonly‹State›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuProps›
    nextStateReadonly‹State›
    nextContextany
    +

    Returns: boolean

    +
    +

    toggle#

    +

    ▸ toggle(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:170

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.menuactions/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.menuactions/index.html new file mode 100644 index 0000000000..75fdaba315 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.menuactions/index.html @@ -0,0 +1,1731 @@ + + + + + + + + + + + + + + + + + + + + + + Class: MenuActions ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: MenuActions ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ MenuActions

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new MenuActions(props: Readonly‹MenuActionsProps›): MenuActions

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹MenuActionsProps›
    +

    Returns: MenuActions

    +

    + new MenuActions(props: MenuActionsProps, context?: any): MenuActions

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsMenuActionsProps
    context?any
    +

    Returns: MenuActions

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    id#

    +

    • id: string = uniqueId("menu_actions_")

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:32

    +
    +

    isOpen#

    +

    • isOpen: boolean = !!this.props.toolbar

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:34

    +
    +

    props#

    +

    • props: Readonly‹MenuActionsProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹MenuActionsProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuActionsProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹MenuActionsProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuActionsProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹MenuActionsProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹MenuActionsProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹MenuActionsProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuActionsProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹MenuActionsProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuActionsProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹MenuActionsProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹MenuActionsProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    remove#

    +

    ▸ remove(): void

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:42

    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:83

    +

    Returns: Element‹›

    +
    +

    renderTriggerIcon#

    +

    ▸ renderTriggerIcon(): Element‹›

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:56

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹MenuActionsProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuActionsProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +
    +

    toggle#

    +

    ▸ toggle(): void

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:36

    +

    Returns: void

    +

    Object literals#

    +

    Static defaultProps#

    +

    ▪ defaultProps: object#

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:26

    +

    removeConfirmationMessage#

    +

    • removeConfirmationMessage:

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:27

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.menuitem/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.menuitem/index.html new file mode 100644 index 0000000000..763c8314f3 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.menuitem/index.html @@ -0,0 +1,1721 @@ + + + + + + + + + + + + + + + + + + + + + + Class: MenuItem ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: MenuItem ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ MenuItem

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new MenuItem(props: Readonly‹MenuItemProps›): MenuItem

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹MenuItemProps›
    +

    Returns: MenuItem

    +

    + new MenuItem(props: MenuItemProps, context?: any): MenuItem

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsMenuItemProps
    context?any
    +

    Returns: MenuItem

    +

    Properties#

    +

    context#

    +

    • context: MenuContextValue

    +

    Overrides PageLayout.context

    +

    Defined in src/renderer/components/menu/menu.tsx:307

    +
    +

    elem#

    +

    • elem: HTMLElement

    +

    Defined in src/renderer/components/menu/menu.tsx:308

    +
    +

    props#

    +

    • props: Readonly‹MenuItemProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static contextType#

    +

    ▪ contextType: Context‹Menu‹›› = MenuContext

    +

    Overrides PageLayout.contextType

    +

    Defined in src/renderer/components/menu/menu.tsx:305

    +
    +

    Static defaultProps#

    +

    ▪ defaultProps: object = defaultPropsMenuItem as object

    +

    Defined in src/renderer/components/menu/menu.tsx:304

    +

    Accessors#

    +

    isFocusable#

    +

    • get isFocusable(): boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:310

    +

    Returns: boolean

    +
    + +

    • get isLink(): boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:316

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹MenuItemProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuItemProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹MenuItemProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuItemProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Protected bindRef#

    +

    ▸ bindRef(elem: HTMLElement): void

    +

    Defined in src/renderer/components/menu/menu.tsx:332

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    elemHTMLElement
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹MenuItemProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹MenuItemProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹MenuItemProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuItemProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹MenuItemProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuItemProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹MenuItemProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹MenuItemProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    onClick#

    +

    ▸ onClick(evt: MouseEvent): void

    +

    Defined in src/renderer/components/menu/menu.tsx:320

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent
    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/menu/menu.tsx:336

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹MenuItemProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹MenuItemProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.notifications/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.notifications/index.html new file mode 100644 index 0000000000..20ea4effde --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.notifications/index.html @@ -0,0 +1,1762 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Notifications ‹**P, S, SS, P, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Notifications ‹P, S, SS, P, S›#

    +

    Type parameters#

    +

    ▪ P

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ P

    +

    ▪ S

    +

    Hierarchy#

    +
      +
    • Component
      • +
    +

    ↳ Notifications

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Notifications(props: Readonly‹P›): Notifications

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹P›
    +

    Returns: Notifications

    +

    + new Notifications(props: P, context?: any): Notifications

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsP
    context?any
    +

    Returns: Notifications

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    elem#

    +

    • elem: HTMLElement

    +

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

    +
    +

    props#

    +

    • props: Readonly‹P› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹P›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹P›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

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

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹P›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹P›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹P›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹P›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    getMessage#

    +

    ▸ getMessage(notification: Notification): (string | number | object | ReactElement‹any, string | function | object› | ReactNodeArray‹› | ReactPortal‹›)[]

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    notificationNotification
    +

    Returns: (string | number | object | ReactElement‹any, string | function | object› | ReactNodeArray‹› | ReactPortal‹›)[]

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹P›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹P›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/notifications/notifications.tsx:69

    +

    Returns: Element‹›

    +
    +

    scrollToLastNotification#

    +

    ▸ scrollToLastNotification(): void

    +

    Defined in src/renderer/components/notifications/notifications.tsx:49

    +

    Returns: void

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹P›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹P›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +
    +

    Static error#

    +

    ▸ error(message: NotificationMessage): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    messageNotificationMessage
    +

    Returns: void

    +
    +

    Static info#

    +

    ▸ info(message: NotificationMessage, customOpts: Partial‹Notification›): function

    +

    Defined in src/renderer/components/notifications/notifications.tsx:32

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    messageNotificationMessage-
    customOptsPartial‹Notification›{}
    +

    Returns: function

    +

    ▸ (): void

    +
    +

    Static ok#

    +

    ▸ ok(message: NotificationMessage): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    messageNotificationMessage
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html new file mode 100644 index 0000000000..c984cd9f26 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.notificationsstore/index.html @@ -0,0 +1,1143 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NotificationsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: NotificationsStore#

    +

    Hierarchy#

    +
      +
    • NotificationsStore
      • +
    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Protected autoHideTimers#

    +

    • autoHideTimers: Map‹string | number, number› = new Map()

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:27

    +
    +

    notifications#

    +

    • notifications: IObservableArray‹Notification› = observable.array([], { deep: false })

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:25

    +

    Methods#

    +

    add#

    +

    ▸ add(notification: Notification): function

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    notificationNotification
    +

    Returns: function

    +

    ▸ (): void

    +
    +

    addAutoHideTimer#

    +

    ▸ addAutoHideTimer(id: NotificationId): void

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idNotificationId
    +

    Returns: void

    +
    +

    getById#

    +

    ▸ getById(id: NotificationId): Notification | null

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:29

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idNotificationId
    +

    Returns: Notification | null

    +
    +

    remove#

    +

    ▸ remove(id: NotificationId): void

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:71

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idNotificationId
    +

    Returns: void

    +
    +

    removeAutoHideTimer#

    +

    ▸ removeAutoHideTimer(id: NotificationId): void

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:46

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    idNotificationId
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.pagelayout/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.pagelayout/index.html new file mode 100644 index 0000000000..9fecc045d1 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.pagelayout/index.html @@ -0,0 +1,1681 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PageLayout ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PageLayout ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ PageLayout

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PageLayout(props: Readonly‹PageLayoutProps›): PageLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹PageLayoutProps›
    +

    Returns: PageLayout

    +

    + new PageLayout(props: PageLayoutProps, context?: any): PageLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsPageLayoutProps
    context?any
    +

    Returns: PageLayout

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹PageLayoutProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +
    +

    Static defaultProps#

    +

    ▪ defaultProps: object = defaultProps as object

    +

    Defined in src/renderer/components/layout/page-layout.tsx:27

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹PageLayoutProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹PageLayoutProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹PageLayoutProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹PageLayoutProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    back#

    +

    ▸ back(evt?: MouseEvent | KeyboardEvent): void

    +

    Defined in src/renderer/components/layout/page-layout.tsx:30

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evt?MouseEvent | KeyboardEvent
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    ▸ componentDidMount(): Promise‹void›

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/layout/page-layout.tsx:38

    +

    Returns: Promise‹void›

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹PageLayoutProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹PageLayoutProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹PageLayoutProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹PageLayoutProps›
    nextContextany
    +

    Returns: void

    +
    +

    componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Overrides WizardLayout.componentWillUnmount

    +

    Defined in src/renderer/components/layout/page-layout.tsx:42

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹PageLayoutProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹PageLayoutProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹PageLayoutProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹PageLayoutProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    onEscapeKey#

    +

    ▸ onEscapeKey(evt: KeyboardEvent): void

    +

    Defined in src/renderer/components/layout/page-layout.tsx:46

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent
    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/layout/page-layout.tsx:57

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹PageLayoutProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹PageLayoutProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.radio/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.radio/index.html new file mode 100644 index 0000000000..c6ad7874b1 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.radio/index.html @@ -0,0 +1,1657 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Radio ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Radio ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ Radio

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Radio(props: Readonly‹RadioProps›): Radio

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹RadioProps›
    +

    Returns: Radio

    +

    + new Radio(props: RadioProps, context?: any): Radio

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsRadioProps
    context?any
    +

    Returns: Radio

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹RadioProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹RadioProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹RadioProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹RadioProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹RadioProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹RadioProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹RadioProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹RadioProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹RadioProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    onChange#

    +

    ▸ onChange(): void

    +

    Defined in src/renderer/components/radio/radio.tsx:52

    +

    Returns: void

    +
    +

    onKeyDown#

    +

    ▸ onKeyDown(e: KeyboardEvent‹any›): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eKeyboardEvent‹any›
    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/radio/radio.tsx:70

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹RadioProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.radiogroup/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.radiogroup/index.html new file mode 100644 index 0000000000..2f9f795231 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.radiogroup/index.html @@ -0,0 +1,1614 @@ + + + + + + + + + + + + + + + + + + + + + + Class: RadioGroup ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: RadioGroup ‹SS›#

    +

    Type parameters#

    +

    ▪ SS

    +

    Hierarchy#

    + +

    ↳ RadioGroup

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new RadioGroup(props: Readonly‹RadioGroupProps›): RadioGroup

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹RadioGroupProps›
    +

    Returns: RadioGroup

    +

    + new RadioGroup(props: RadioGroupProps, context?: any): RadioGroup

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsRadioGroupProps
    context?any
    +

    Returns: RadioGroup

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹RadioGroupProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹object›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹RadioGroupProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioGroupProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹RadioGroupProps›, nextState: Readonly‹object›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioGroupProps›
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹RadioGroupProps›, prevState: Readonly‹object›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹RadioGroupProps›
    prevStateReadonly‹object›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹RadioGroupProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioGroupProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹RadioGroupProps›, nextState: Readonly‹object›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioGroupProps›
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹RadioGroupProps›, prevState: Readonly‹object›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹RadioGroupProps›
    prevStateReadonly‹object›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

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

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof object

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹RadioGroupProps›, nextState: Readonly‹object›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹RadioGroupProps›
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.select/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.select/index.html new file mode 100644 index 0000000000..eaaa39a43f --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.select/index.html @@ -0,0 +1,1838 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Select ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Select ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ Select

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new Select(props: Readonly‹SelectProps›): Select

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹SelectProps›
    +

    Returns: Select

    +

    + new Select(props: SelectProps, context?: any): Select

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsSelectProps
    context?any
    +

    Returns: Select

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹SelectProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Accessors#

    +

    options#

    +

    • get options(): SelectOption[]

    +

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

    +

    Returns: SelectOption[]

    +
    +

    selectedOption#

    +

    • get selectedOption(): SelectOption‹any› | SelectOption‹any›[]

    +

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

    +

    Returns: SelectOption‹any› | SelectOption‹any›[]

    +
    +

    theme#

    +

    • get theme(): "dark" | "light" | "outlined"

    +

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

    +

    Returns: "dark" | "light" | "outlined"

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹SelectProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SelectProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹SelectProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SelectProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹SelectProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹SelectProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹SelectProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SelectProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹SelectProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SelectProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹SelectProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹SelectProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    Protected isValidOption#

    +

    ▸ isValidOption(opt: SelectOption | any): boolean

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optSelectOption | any
    +

    Returns: boolean

    +
    +

    onChange#

    +

    ▸ onChange(value: SelectOption, meta: ActionMeta‹any›): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    valueSelectOption
    metaActionMeta‹any›
    +

    Returns: void

    +
    +

    onKeyDown#

    +

    ▸ onKeyDown(evt: KeyboardEvent‹HTMLElement›): void

    +

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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent‹HTMLElement›
    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

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

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹SelectProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SelectProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +

    Object literals#

    +

    Static defaultProps#

    +

    ▪ defaultProps: object#

    +

    Defined in src/renderer/components/select/select.tsx:36

    +

    autoConvertOptions#

    +

    • autoConvertOptions: true = true

    +

    Defined in src/renderer/components/select/select.tsx:37

    + +

    • menuPlacement: "auto" = "auto"

    +

    Defined in src/renderer/components/select/select.tsx:39

    + +

    • menuPortalTarget: HTMLElement = document.body

    +

    Defined in src/renderer/components/select/select.tsx:38

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.slider/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.slider/index.html new file mode 100644 index 0000000000..1cc01dc03b --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.slider/index.html @@ -0,0 +1,1628 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Slider ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Slider ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ Slider

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Slider(props: Readonly‹SliderProps›): Slider

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹SliderProps›
    +

    Returns: Slider

    +

    + new Slider(props: SliderProps, context?: any): Slider

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsSliderProps
    context?any
    +

    Returns: Slider

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹SliderProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +
    +

    Static defaultProps#

    +

    ▪ defaultProps: object = defaultProps as object

    +

    Defined in src/renderer/components/slider/slider.tsx:21

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹SliderProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SliderProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹SliderProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SliderProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹SliderProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹SliderProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹SliderProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SliderProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹SliderProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SliderProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹SliderProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹SliderProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/slider/slider.tsx:30

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹SliderProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SliderProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.spinner/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.spinner/index.html new file mode 100644 index 0000000000..2d3c2bb534 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.spinner/index.html @@ -0,0 +1,1676 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Spinner ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Spinner ‹SS›#

    +

    Type parameters#

    +

    ▪ SS

    +

    Hierarchy#

    + +

    ↳ Spinner

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new Spinner(props: Readonly‹SpinnerProps›): Spinner

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹SpinnerProps›
    +

    Returns: Spinner

    +

    + new Spinner(props: SpinnerProps, context?: any): Spinner

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsSpinnerProps
    context?any
    +

    Returns: Spinner

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹SpinnerProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹object›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹SpinnerProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SpinnerProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹SpinnerProps›, nextState: Readonly‹object›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SpinnerProps›
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹SpinnerProps›, prevState: Readonly‹object›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹SpinnerProps›
    prevStateReadonly‹object›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹SpinnerProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SpinnerProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹SpinnerProps›, nextState: Readonly‹object›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SpinnerProps›
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹SpinnerProps›, prevState: Readonly‹object›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹SpinnerProps›
    prevStateReadonly‹object›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/spinner/spinner.tsx:18

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof object

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹SpinnerProps›, nextState: Readonly‹object›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹SpinnerProps›
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: boolean

    +

    Object literals#

    +

    Static defaultProps#

    +

    ▪ defaultProps: object#

    +

    Defined in src/renderer/components/spinner/spinner.tsx:13

    +

    center#

    +

    • center: boolean = false

    +

    Defined in src/renderer/components/spinner/spinner.tsx:15

    +

    singleColor#

    +

    • singleColor: boolean = true

    +

    Defined in src/renderer/components/spinner/spinner.tsx:14

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.statusbrick/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.statusbrick/index.html new file mode 100644 index 0000000000..b17499d0a9 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.statusbrick/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: StatusBrick ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: StatusBrick ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ StatusBrick

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new StatusBrick(props: Readonly‹StatusBrickProps›): StatusBrick

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹StatusBrickProps›
    +

    Returns: StatusBrick

    +

    + new StatusBrick(props: StatusBrickProps, context?: any): StatusBrick

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsStatusBrickProps
    context?any
    +

    Returns: StatusBrick

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹StatusBrickProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹StatusBrickProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StatusBrickProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹StatusBrickProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StatusBrickProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹StatusBrickProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹StatusBrickProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹StatusBrickProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StatusBrickProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹StatusBrickProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StatusBrickProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹StatusBrickProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹StatusBrickProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/status-brick/status-brick.tsx:12

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹StatusBrickProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StatusBrickProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.stepper/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.stepper/index.html new file mode 100644 index 0000000000..c22bc54049 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.stepper/index.html @@ -0,0 +1,1614 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Stepper ‹**SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Stepper ‹SS›#

    +

    Type parameters#

    +

    ▪ SS

    +

    Hierarchy#

    + +

    ↳ Stepper

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Stepper(props: Readonly‹StepperProps›): Stepper

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹StepperProps›
    +

    Returns: Stepper

    +

    + new Stepper(props: StepperProps, context?: any): Stepper

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsStepperProps
    context?any
    +

    Returns: Stepper

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹StepperProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹object›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹StepperProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StepperProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹StepperProps›, nextState: Readonly‹object›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StepperProps›
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹StepperProps›, prevState: Readonly‹object›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹StepperProps›
    prevStateReadonly‹object›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹StepperProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StepperProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹StepperProps›, nextState: Readonly‹object›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StepperProps›
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹StepperProps›, prevState: Readonly‹object›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹StepperProps›
    prevStateReadonly‹object›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/stepper/stepper.tsx:15

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof object

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹StepperProps›, nextState: Readonly‹object›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹StepperProps›
    nextStateReadonly‹object›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.tab/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.tab/index.html new file mode 100644 index 0000000000..ed52c65c2c --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.tab/index.html @@ -0,0 +1,1614 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Tab ‹**S, SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Tab ‹S, SS›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    Hierarchy#

    + +

    ↳ Tab

    +

    Index#

    +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Properties#

    +

    context#

    +

    • context: TabsContextValue

    +

    Defined in src/renderer/components/tabs/tabs.tsx:64

    +
    +

    elem#

    +

    • elem: HTMLElement

    +

    Defined in src/renderer/components/tabs/tabs.tsx:65

    +
    +

    Static contextType#

    +

    ▪ contextType: Context‹TabsContextValue‹any›› = TabsContext

    +

    Defined in src/renderer/components/tabs/tabs.tsx:63

    +

    Accessors#

    +

    isActive#

    +

    • get isActive(): boolean

    +

    Defined in src/renderer/components/tabs/tabs.tsx:67

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TabProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹TabProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Protected bindRef#

    +

    ▸ bindRef(elem: HTMLElement): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    elemHTMLElement
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/tabs/tabs.tsx:113

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹TabProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TabProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹TabProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹TabProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    focus#

    +

    ▸ focus(): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:73

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹TabProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TabProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    onClick#

    +

    ▸ onClick(evt: MouseEvent‹HTMLElement›): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent‹HTMLElement›
    +

    Returns: void

    +
    +

    onFocus#

    +

    ▸ onFocus(evt: FocusEvent‹HTMLElement›): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:95

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtFocusEvent‹HTMLElement›
    +

    Returns: void

    +
    +

    onKeyDown#

    +

    ▸ onKeyDown(evt: KeyboardEvent‹HTMLElement›): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:103

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtKeyboardEvent‹HTMLElement›
    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Defined in src/renderer/components/tabs/tabs.tsx:124

    +

    Returns: Element‹›

    +
    +

    scrollIntoView#

    +

    ▸ scrollIntoView(): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:77

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹TabProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.table/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.table/index.html new file mode 100644 index 0000000000..0923cd8bd1 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.table/index.html @@ -0,0 +1,1867 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Table ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Table ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ Table

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new Table(props: Readonly‹TableProps›): Table

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹TableProps›
    +

    Returns: Table

    +

    + new Table(props: TableProps, context?: any): Table

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsTableProps
    context?any
    +

    Returns: Table

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹TableProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    sortParamsLocal#

    +

    • sortParamsLocal: object = this.props.sortByDefault

    +

    Defined in src/renderer/components/table/table.tsx:56

    +

    Type declaration:

    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Accessors#

    +

    sortParams#

    +

    • get sortParams(): Partial‹TableSortParams›

    +

    Defined in src/renderer/components/table/table.tsx:58

    +

    Returns: Partial‹TableSortParams›

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TableProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹TableProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹TableProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TableProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹TableProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹TableProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹TableProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TableProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    getSorted#

    +

    ▸ getSorted(items: any[]): any[]

    +

    Defined in src/renderer/components/table/table.tsx:103

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsany[]
    +

    Returns: any[]

    +
    +

    Protected onSort#

    +

    ▸ onSort(params: TableSortParams): void

    +

    Defined in src/renderer/components/table/table.tsx:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    paramsTableSortParams
    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/table/table.tsx:188

    +

    Returns: Element‹›

    +
    +

    renderHead#

    +

    ▸ renderHead(): ReactElement‹TableHeadProps‹›, string | function | object›

    +

    Defined in src/renderer/components/table/table.tsx:69

    +

    Returns: ReactElement‹TableHeadProps‹›, string | function | object›

    +
    +

    renderRows#

    +

    ▸ renderRows(): object

    +

    Defined in src/renderer/components/table/table.tsx:143

    +

    Returns: object

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹TableProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +
    +

    sort#

    +

    ▸ sort(colName: TableSortBy): void

    +

    Defined in src/renderer/components/table/table.tsx:131

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    colNameTableSortBy
    +

    Returns: void

    +

    Object literals#

    +

    Static defaultProps#

    +

    ▪ defaultProps: object#

    +

    Defined in src/renderer/components/table/table.tsx:48

    +

    autoSize#

    +

    • autoSize: true = true

    +

    Defined in src/renderer/components/table/table.tsx:50

    +

    rowLineHeight#

    +

    • rowLineHeight: string = "17px"

    +

    Defined in src/renderer/components/table/table.tsx:52

    +

    rowPadding#

    +

    • rowPadding: string = "8px"

    +

    Defined in src/renderer/components/table/table.tsx:51

    +

    scrollable#

    +

    • scrollable: true = true

    +

    Defined in src/renderer/components/table/table.tsx:49

    +

    sortSyncWithUrl#

    +

    • sortSyncWithUrl: true = true

    +

    Defined in src/renderer/components/table/table.tsx:53

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.tablecell/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.tablecell/index.html new file mode 100644 index 0000000000..e4eb8d2640 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.tablecell/index.html @@ -0,0 +1,1706 @@ + + + + + + + + + + + + + + + + + + + + + + Class: TableCell ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: TableCell ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ TableCell

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new TableCell(props: Readonly‹TableCellProps›): TableCell

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹TableCellProps›
    +

    Returns: TableCell

    +

    + new TableCell(props: TableCellProps, context?: any): TableCell

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsTableCellProps
    context?any
    +

    Returns: TableCell

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹TableCellProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Accessors#

    +

    isSortable#

    +

    • get isSortable(): boolean

    +

    Defined in src/renderer/components/table/table-cell.tsx:35

    +

    Returns: boolean

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TableCellProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableCellProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹TableCellProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableCellProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹TableCellProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TableCellProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹TableCellProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableCellProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹TableCellProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableCellProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹TableCellProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TableCellProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    onClick#

    +

    ▸ onClick(evt: MouseEvent‹HTMLDivElement›): void

    +

    Defined in src/renderer/components/table/table-cell.tsx:25

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent‹HTMLDivElement›
    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/table/table-cell.tsx:65

    +

    Returns: Element‹›

    +
    +

    renderCheckbox#

    +

    ▸ renderCheckbox(): Element‹›

    +

    Defined in src/renderer/components/table/table-cell.tsx:56

    +

    Returns: Element‹›

    +
    +

    renderSortIcon#

    +

    ▸ renderSortIcon(): Element‹›

    +

    Defined in src/renderer/components/table/table-cell.tsx:41

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹TableCellProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableCellProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.tablehead/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.tablehead/index.html new file mode 100644 index 0000000000..6443e6ce8f --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.tablehead/index.html @@ -0,0 +1,1668 @@ + + + + + + + + + + + + + + + + + + + + + + Class: TableHead ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: TableHead ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ TableHead

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Object literals#

    + +

    Constructors#

    +

    constructor#

    +

    + new TableHead(props: Readonly‹TableHeadProps›): TableHead

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹TableHeadProps›
    +

    Returns: TableHead

    +

    + new TableHead(props: TableHeadProps, context?: any): TableHead

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsTableHeadProps
    context?any
    +

    Returns: TableHead

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹TableHeadProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TableHeadProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableHeadProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹TableHeadProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableHeadProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹TableHeadProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TableHeadProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹TableHeadProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableHeadProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹TableHeadProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableHeadProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹TableHeadProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TableHeadProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/table/table-head.tsx:20

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹TableHeadProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableHeadProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    +

    Object literals#

    +

    Static defaultProps#

    +

    ▪ defaultProps: object#

    +

    Defined in src/renderer/components/table/table-head.tsx:16

    +

    sticky#

    +

    • sticky: true = true

    +

    Defined in src/renderer/components/table/table-head.tsx:17

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.tablerow/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.tablerow/index.html new file mode 100644 index 0000000000..fee9cc4f35 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.tablerow/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: TableRow ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: TableRow ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ TableRow

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new TableRow(props: Readonly‹TableRowProps›): TableRow

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹TableRowProps›
    +

    Returns: TableRow

    +

    + new TableRow(props: TableRowProps, context?: any): TableRow

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsTableRowProps
    context?any
    +

    Returns: TableRow

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹TableRowProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TableRowProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableRowProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹TableRowProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableRowProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹TableRowProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TableRowProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹TableRowProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableRowProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹TableRowProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableRowProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹TableRowProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TableRowProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/table/table-row.tsx:20

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹TableRowProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TableRowProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.tabs/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.tabs/index.html new file mode 100644 index 0000000000..60a51086b0 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.tabs/index.html @@ -0,0 +1,1445 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Tabs ‹**S, SS**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Tabs ‹S, SS›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    Hierarchy#

    + +

    ↳ Tabs

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    elem#

    +

    • elem: HTMLElement

    +

    Defined in src/renderer/components/tabs/tabs.tsx:25

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TabsProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabsProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹TabsProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabsProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Protected bindRef#

    +

    ▸ bindRef(elem: HTMLElement): void

    +

    Defined in src/renderer/components/tabs/tabs.tsx:28

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    elemHTMLElement
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹TabsProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TabsProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹TabsProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabsProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹TabsProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabsProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹TabsProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TabsProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Defined in src/renderer/components/tabs/tabs.tsx:32

    +

    Returns: Element‹›

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹TabsProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TabsProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.tooltip/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.tooltip/index.html new file mode 100644 index 0000000000..ea5da958ef --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.tooltip/index.html @@ -0,0 +1,1860 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Tooltip ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Tooltip ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ Tooltip

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Tooltip(props: Readonly‹TooltipProps›): Tooltip

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹TooltipProps›
    +

    Returns: Tooltip

    +

    + new Tooltip(props: TooltipProps, context?: any): Tooltip

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsTooltipProps
    context?any
    +

    Returns: Tooltip

    +

    Properties#

    +

    activePosition#

    +

    • activePosition: TooltipPosition

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:51

    +
    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    elem#

    +

    • elem: HTMLElement

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:50

    +
    +

    isVisible#

    +

    • isVisible: boolean = !!this.props.visible

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:52

    +
    +

    props#

    +

    • props: Readonly‹TooltipProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +
    +

    Static defaultProps#

    +

    ▪ defaultProps: object = defaultProps as object

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:48

    +

    Accessors#

    +

    hoverTarget#

    +

    • get hoverTarget(): HTMLElement

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:58

    +

    Returns: HTMLElement

    +
    +

    targetElem#

    +

    • get targetElem(): HTMLElement

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:54

    +

    Returns: HTMLElement

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹TooltipProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TooltipProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹TooltipProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TooltipProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    bindRef#

    +

    ▸ bindRef(elem: HTMLElement): void

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:198

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    elemHTMLElement
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Overrides WizardLayout.componentDidMount

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:66

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹TooltipProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TooltipProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹TooltipProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TooltipProps›
    nextContextany
    +

    Returns: void

    +
    +

    componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Overrides WizardLayout.componentWillUnmount

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:71

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹TooltipProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TooltipProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Protected getPosition#

    +

    ▸ getPosition(position: TooltipPosition, tooltipBounds: DOMRect, targetBounds: DOMRect): object

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:145

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    positionTooltipPosition
    tooltipBoundsDOMRect
    targetBoundsDOMRect
    +

    Returns: object

    +
      +
    • +

      bottom: number = top + tooltipBounds.height

      +
      • +
    • +

      left: number

      +
      • +
    • +

      right: number = left + tooltipBounds.width

      +
      • +
    • +

      top: number

      +
      • +
    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹TooltipProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹TooltipProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    Protected onEnterTarget#

    +

    ▸ onEnterTarget(): void

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:77

    +

    Returns: void

    +
    +

    Protected onLeaveTarget#

    +

    ▸ onLeaveTarget(): void

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:83

    +

    Returns: void

    +
    +

    refreshPosition#

    +

    ▸ refreshPosition(): void

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:88

    +

    Returns: void

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:202

    +

    Returns: Element‹›

    +
    +

    Protected setPosition#

    +

    ▸ setPosition(pos: object): void

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:138

    +

    Parameters:

    +

    ▪ pos: object

    + + + + + + + + + + + + + + + + + +
    NameType
    leftnumber
    topnumber
    +

    Returns: void

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹TooltipProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹TooltipProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html b/v4.0.1/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html new file mode 100644 index 0000000000..e70446b89f --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_components_.wizardlayout/index.html @@ -0,0 +1,1616 @@ + + + + + + + + + + + + + + + + + + + + + + Class: WizardLayout ‹**S, SS, S**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: WizardLayout ‹S, SS, S›#

    +

    Type parameters#

    +

    ▪ S

    +

    ▪ SS

    +

    ▪ S

    +

    Hierarchy#

    + +

    ↳ WizardLayout

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new WizardLayout(props: Readonly‹WizardLayoutProps›): WizardLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsReadonly‹WizardLayoutProps›
    +

    Returns: WizardLayout

    +

    + new WizardLayout(props: WizardLayoutProps, context?: any): WizardLayout

    +

    Inherited from PageLayout.constructor

    +

    Defined in node_modules/@types/react/index.d.ts:488

    +

    deprecated

    +

    see https://reactjs.org/docs/legacy-context.html

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    propsWizardLayoutProps
    context?any
    +

    Returns: WizardLayout

    +

    Properties#

    +

    context#

    +

    • context: any

    +

    Inherited from PageLayout.context

    +

    Defined in node_modules/@types/react/index.d.ts:486

    +

    If using the new style context, re-declare this in your class to be the +React.ContextType of your static contextType. +Should be used with type annotation or static contextType.

    +
    static contextType = MyContext
+// For TS pre-3.7:
+context!: React.ContextType<typeof MyContext>
+// For TS 3.7 and above:
+declare context: React.ContextType<typeof MyContext>
+
    +

    see https://reactjs.org/docs/context.html

    +
    +

    props#

    +

    • props: Readonly‹WizardLayoutProps› & Readonly‹object›

    +

    Inherited from PageLayout.props

    +

    Defined in node_modules/@types/react/index.d.ts:511

    +
    +

    refs#

    +

    • refs: object

    +

    Inherited from PageLayout.refs

    +

    Defined in node_modules/@types/react/index.d.ts:517

    +

    deprecated +https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

    +

    Type declaration:

    +
      +
    • [ key: string]: ReactInstance
      • +
    +
    +

    state#

    +

    • state: Readonly‹S›

    +

    Inherited from PageLayout.state

    +

    Defined in node_modules/@types/react/index.d.ts:512

    +
    +

    Static Optional contextType#

    +

    ▪ contextType? : Context‹any›

    +

    Inherited from PageLayout.contextType

    +

    Defined in node_modules/@types/react/index.d.ts:468

    +

    If set, this.context will be set at runtime to the current value of the given Context.

    +

    Usage:

    +
    type MyContext = number
+const Ctx = React.createContext<MyContext>(0)
+
+class Foo extends React.Component {
+  static contextType = Ctx
+  context!: React.ContextType<typeof Ctx>
+  render () {
+    return <>My context's value: {this.context}</>;
+  }
+}
+
    +

    see https://reactjs.org/docs/context.html#classcontexttype

    +

    Methods#

    +

    Optional UNSAFE_componentWillMount#

    +

    ▸ UNSAFE_componentWillMount(): void

    +

    Inherited from PageLayout.UNSAFE_componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:712

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillReceiveProps#

    +

    ▸ UNSAFE_componentWillReceiveProps(nextProps: Readonly‹WizardLayoutProps›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:744

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardLayoutProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional UNSAFE_componentWillUpdate#

    +

    ▸ UNSAFE_componentWillUpdate(nextProps: Readonly‹WizardLayoutProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.UNSAFE_componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:772

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    This method will not stop working in React 17.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardLayoutProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentDidCatch#

    +

    ▸ componentDidCatch(error: Error, errorInfo: ErrorInfo): void

    +

    Inherited from PageLayout.componentDidCatch

    +

    Defined in node_modules/@types/react/index.d.ts:641

    +

    Catches exceptions generated in descendant components. Unhandled exceptions will cause +the entire component tree to unmount.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    errorError
    errorInfoErrorInfo
    +

    Returns: void

    +
    +

    Optional componentDidMount#

    +

    ▸ componentDidMount(): void

    +

    Inherited from WizardLayout.componentDidMount

    +

    Defined in node_modules/@types/react/index.d.ts:620

    +

    Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    +

    Returns: void

    +
    +

    Optional componentDidUpdate#

    +

    ▸ componentDidUpdate(prevProps: Readonly‹WizardLayoutProps›, prevState: Readonly‹S›, snapshot?: SS): void

    +

    Inherited from PageLayout.componentDidUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:683

    +

    Called immediately after updating occurs. Not called for the initial render.

    +

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹WizardLayoutProps›
    prevStateReadonly‹S›
    snapshot?SS
    +

    Returns: void

    +
    +

    Optional componentWillMount#

    +

    ▸ componentWillMount(): void

    +

    Inherited from PageLayout.componentWillMount

    +

    Defined in node_modules/@types/react/index.d.ts:698

    +

    Called immediately before mounting occurs, and before Component#render. +Avoid introducing any side-effects or subscriptions in this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use componentDidMount or the constructor instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Returns: void

    +
    +

    Optional componentWillReceiveProps#

    +

    ▸ componentWillReceiveProps(nextProps: Readonly‹WizardLayoutProps›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillReceiveProps

    +

    Defined in node_modules/@types/react/index.d.ts:727

    +

    Called when the component may be receiving new props. +React may call this even if props have not changed, so be sure to compare new and existing +props if you only want to handle changes.

    +

    Calling Component#setState generally does not trigger this method.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use static getDerivedStateFromProps instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardLayoutProps›
    nextContextany
    +

    Returns: void

    +
    +

    Optional componentWillUnmount#

    +

    ▸ componentWillUnmount(): void

    +

    Inherited from WizardLayout.componentWillUnmount

    +

    Defined in node_modules/@types/react/index.d.ts:636

    +

    Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as +cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    +

    Returns: void

    +
    +

    Optional componentWillUpdate#

    +

    ▸ componentWillUpdate(nextProps: Readonly‹WizardLayoutProps›, nextState: Readonly‹S›, nextContext: any): void

    +

    Inherited from PageLayout.componentWillUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:757

    +

    Called immediately before rendering when new props or state is received. Not called for the initial render.

    +

    Note: You cannot call Component#setState here.

    +

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps +prevents this from being invoked.

    +

    deprecated 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update

    +

    see https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardLayoutProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: void

    +
    +

    forceUpdate#

    +

    ▸ forceUpdate(callback?: function): void

    +

    Inherited from PageLayout.forceUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:503

    +

    Parameters:

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional getSnapshotBeforeUpdate#

    +

    ▸ getSnapshotBeforeUpdate(prevProps: Readonly‹WizardLayoutProps›, prevState: Readonly‹S›): SS | null

    +

    Inherited from PageLayout.getSnapshotBeforeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:677

    +

    Runs before React applies the result of render to the document, and +returns an object to be given to componentDidUpdate. Useful for saving +things such as scroll position before render causes changes to it.

    +

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated +lifecycle events from running.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    prevPropsReadonly‹WizardLayoutProps›
    prevStateReadonly‹S›
    +

    Returns: SS | null

    +
    +

    render#

    +

    ▸ render(): Element‹›

    +

    Overrides void

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:18

    +

    Returns: Element‹›

    +
    +

    setState#

    +

    ▸ setState‹K›(state: function | S | object, callback?: function): void

    +

    Inherited from PageLayout.setState

    +

    Defined in node_modules/@types/react/index.d.ts:498

    +

    Type parameters:

    +

    ▪ K: keyof S

    +

    Parameters:

    +

    ▪ state: function | S | object

    +

    ▪Optional callback: function

    +

    ▸ (): void

    +

    Returns: void

    +
    +

    Optional shouldComponentUpdate#

    +

    ▸ shouldComponentUpdate(nextProps: Readonly‹WizardLayoutProps›, nextState: Readonly‹S›, nextContext: any): boolean

    +

    Inherited from PageLayout.shouldComponentUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:631

    +

    Called to determine whether the change in props and state should trigger a re-render.

    +

    Component always returns true. +PureComponent implements a shallow comparison on props and state and returns true if any +props or states have changed.

    +

    If false is returned, Component#render, componentWillUpdate +and componentDidUpdate will not be called.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    nextPropsReadonly‹WizardLayoutProps›
    nextStateReadonly‹S›
    nextContextany
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html new file mode 100644 index 0000000000..bf38738ffd --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.clusterrole/index.html @@ -0,0 +1,1598 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ClusterRole - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ClusterRole#

    +

    Hierarchy#

    +

    ↳ Role

    +

    ↳ ClusterRole

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ClusterRole(data: KubeJsonApiData): ClusterRole

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: ClusterRole

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    rules#

    +

    • rules: object[]

    +

    Inherited from Role.rules

    +

    Defined in src/renderer/api/endpoints/role.api.ts:9

    +
    +

    Optional status#

    +

    • status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:79

    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/apis/rbac.authorization.k8s.io/v1/clusterroles"

    +

    Overrides Role.apiBase

    +

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:9

    +
    +

    Static kind#

    +

    ▪ kind: string = "ClusterRole"

    +

    Overrides Role.kind

    +

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:7

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = false

    +

    Overrides Role.namespaced

    +

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:8

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getRules#

    +

    ▸ getRules(): object[]

    +

    Inherited from Role.getRules

    +

    Defined in src/renderer/api/endpoints/role.api.ts:16

    +

    Returns: object[]

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html new file mode 100644 index 0000000000..af5a651cbb --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.clusterrolebinding/index.html @@ -0,0 +1,1637 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ClusterRoleBinding - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ClusterRoleBinding#

    +

    Hierarchy#

    +

    ↳ RoleBinding

    +

    ↳ ClusterRoleBinding

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ClusterRoleBinding(data: KubeJsonApiData): ClusterRoleBinding

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: ClusterRoleBinding

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    roleRef#

    +

    • roleRef: object

    +

    Inherited from RoleBinding.roleRef

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:19

    +

    Type declaration:

    +
      +
    • +

      apiGroup? : string

      +
      • +
    • +

      kind: string

      +
      • +
    • +

      name: string

      +
      • +
    +
    +

    Optional status#

    +

    • status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:79

    +
    +

    Optional subjects#

    +

    • subjects? : IRoleBindingSubject[]

    +

    Inherited from RoleBinding.subjects

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:18

    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/apis/rbac.authorization.k8s.io/v1/clusterrolebindings"

    +

    Overrides RoleBinding.apiBase

    +

    Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:7

    +
    +

    Static kind#

    +

    ▪ kind: string = "ClusterRoleBinding"

    +

    Overrides RoleBinding.kind

    +

    Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:5

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = false

    +

    Overrides RoleBinding.namespaced

    +

    Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:6

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getSubjectNames#

    +

    ▸ getSubjectNames(): string

    +

    Inherited from RoleBinding.getSubjectNames

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:29

    +

    Returns: string

    +
    +

    getSubjects#

    +

    ▸ getSubjects(): IRoleBindingSubject[]

    +

    Inherited from RoleBinding.getSubjects

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:25

    +

    Returns: IRoleBindingSubject[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html new file mode 100644 index 0000000000..4386cfd397 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.configmap/index.html @@ -0,0 +1,1601 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ConfigMap - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ConfigMap#

    +

    Hierarchy#

    + +

    ↳ ConfigMap

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ConfigMap(data: KubeJsonApiData): ConfigMap

    +

    Overrides KubeObject.constructor

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:10

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: ConfigMap

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    data#

    +

    • data: object

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:17

    +

    Type declaration:

    +
      +
    • [ param: string]: string
      • +
    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    Optional status#

    +

    • status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:79

    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/api/v1/configmaps"

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:10

    +
    +

    Static kind#

    +

    ▪ kind: string = "ConfigMap"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:8

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:9

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getKeys#

    +

    ▸ getKeys(): string[]

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:21

    +

    Returns: string[]

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html new file mode 100644 index 0000000000..b2bc84cf8a --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.configmapsstore/index.html @@ -0,0 +1,2078 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ConfigMapsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ConfigMapsStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹ConfigMap›

    +

    ↳ ConfigMapsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ConfigMapsStore(): ConfigMapsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: ConfigMapsStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹ConfigMap‹›› = configMapApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+config-maps/config-maps.store.ts:8

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): ConfigMap[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: ConfigMap[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹ConfigMap›): Promise‹ConfigMap›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹ConfigMap›

    +

    Returns: Promise‹ConfigMap›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹ConfigMap›): Promise‹ConfigMap›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹ConfigMap›

    +

    Returns: Promise‹ConfigMap›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: ConfigMap): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: ConfigMap[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsConfigMap[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): ConfigMap[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: ConfigMap[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): ConfigMap[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: ConfigMap[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): ConfigMap

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: ConfigMap

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): ConfigMap

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: ConfigMap

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: ConfigMap[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsConfigMap[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: ConfigMap): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: ConfigMap[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsConfigMap[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹ConfigMap›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ConfigMap›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹ConfigMap›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ConfigMap›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹ConfigMap[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹ConfigMap[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: ConfigMap): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: ConfigMap, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: ConfigMap

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: ConfigMap): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: ConfigMap[], sorting?: function[], order?: "asc" | "desc"): ConfigMap[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsConfigMap[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: ConfigMap[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: ConfigMap): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: ConfigMap[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsConfigMap[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: ConfigMap): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: ConfigMap, data: Partial‹ConfigMap›): Promise‹ConfigMap›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemConfigMap
    dataPartial‹ConfigMap›
    +

    Returns: Promise‹ConfigMap›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: ConfigMap, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: ConfigMap

    +

    ▪ request: function

    +

    ▸ (): Promise‹ConfigMap›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html new file mode 100644 index 0000000000..6663be7a75 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.crdresourcestore/index.html @@ -0,0 +1,2102 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CRDResourceStore ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: CRDResourceStore ‹T›#

    +

    Type parameters#

    +

    ▪ T: KubeObject

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹T›

    +

    ↳ CRDResourceStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new CRDResourceStore(api: KubeApi‹T›): CRDResourceStore

    +

    Overrides KubeObjectStore.constructor

    +

    Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    apiKubeApi‹T›
    +

    Returns: CRDResourceStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+custom-resources/crd-resource.store.ts:8

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): T[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: T[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹T›

    +

    Returns: Promise‹T›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹T›

    +

    Returns: Promise‹T›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: T): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: T[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsT[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): T[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: T[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): T[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: T[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): T

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: T

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): T

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: T

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: T[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsT[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: T): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: T[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsT[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹T›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹T›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹T›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹T[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹T[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: T): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: T, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: T

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: T): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: T[], sorting?: function[], order?: "asc" | "desc"): T[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsT[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: T[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: T): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: T[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsT[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: T): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: T, data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemT
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: T, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: T

    +

    ▪ request: function

    +

    ▸ (): Promise‹T›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html new file mode 100644 index 0000000000..052aa1708d --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.crdstore/index.html @@ -0,0 +1,2139 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CRDStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: CRDStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹CustomResourceDefinition›

    +

    ↳ CRDStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new CRDStore(): CRDStore

    +

    Overrides KubeObjectStore.constructor

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:23

    +

    Returns: CRDStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹CustomResourceDefinition‹›› = crdApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:23

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    groups#

    +

    • get groups(): object

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:39

    +

    Returns: object

    +
    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): CustomResourceDefinition[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: CustomResourceDefinition[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹CustomResourceDefinition›

    +

    Returns: Promise‹CustomResourceDefinition›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹CustomResourceDefinition›

    +

    Returns: Promise‹CustomResourceDefinition›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: CustomResourceDefinition): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: CustomResourceDefinition[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsCustomResourceDefinition[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): CustomResourceDefinition[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: CustomResourceDefinition[]

    +
    +

    getByGroup#

    +

    ▸ getByGroup(group: string, pluralName: string): CustomResourceDefinition‹›

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:52

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    groupstring
    pluralNamestring
    +

    Returns: CustomResourceDefinition‹›

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): CustomResourceDefinition[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: CustomResourceDefinition[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): CustomResourceDefinition

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: CustomResourceDefinition

    +
    +

    getByObject#

    +

    ▸ getByObject(obj: KubeObject): CustomResourceDefinition‹›

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:60

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objKubeObject
    +

    Returns: CustomResourceDefinition‹›

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): CustomResourceDefinition

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: CustomResourceDefinition

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: CustomResourceDefinition[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsCustomResourceDefinition[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: CustomResourceDefinition): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: CustomResourceDefinition[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsCustomResourceDefinition[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹CustomResourceDefinition›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹CustomResourceDefinition›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹CustomResourceDefinition›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹CustomResourceDefinition›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹CustomResourceDefinition[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹CustomResourceDefinition[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: CustomResourceDefinition): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: CustomResourceDefinition, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: CustomResourceDefinition

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: CustomResourceDefinition): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: CustomResourceDefinition[]): CustomResourceDefinition‹›[]

    +

    Overrides KubeObjectStore.sortItems

    +

    Defined in src/renderer/components/+custom-resources/crd.store.ts:32

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsCustomResourceDefinition[]
    +

    Returns: CustomResourceDefinition‹›[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: CustomResourceDefinition): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: CustomResourceDefinition[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsCustomResourceDefinition[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: CustomResourceDefinition): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: CustomResourceDefinition, data: Partial‹CustomResourceDefinition›): Promise‹CustomResourceDefinition›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemCustomResourceDefinition
    dataPartial‹CustomResourceDefinition›
    +

    Returns: Promise‹CustomResourceDefinition›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: CustomResourceDefinition, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: CustomResourceDefinition

    +

    ▪ request: function

    +

    ▸ (): Promise‹CustomResourceDefinition›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html new file mode 100644 index 0000000000..965f32c191 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.cronjob/index.html @@ -0,0 +1,1739 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CronJob - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: CronJob#

    +

    Hierarchy#

    + +

    ↳ CronJob

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new CronJob(data: KubeJsonApiData): CronJob

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: CronJob

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Overrides KubeObject.apiVersion

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:15

    +
    +

    kind#

    +

    • kind: string

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:14

    +
    +

    metadata#

    +

    • metadata: object

    +

    Overrides KubeObject.metadata

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:16

    +

    Type declaration:

    +
      +
    • +

      annotations(): object

      +
      • +
    • +

      creationTimestamp: string

      +
      • +
    • +

      labels(): object

      +
      • +
    • +

      name: string

      +
      • +
    • +

      namespace: string

      +
      • +
    • +

      resourceVersion: string

      +
      • +
    • +

      selfLink: string

      +
      • +
    • +

      uid: string

      +
      • +
    +
    +

    spec#

    +

    • spec: object

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:30

    +

    Type declaration:

    +
      +
    • +

      concurrencyPolicy: string

      +
      • +
    • +

      failedJobsHistoryLimit: number

      +
      • +
    • +

      jobTemplate(): object

      +
      • +
    • +

      metadata(): object

      +
        +
      • +

        annotations(): object

        +
        • +
      • +

        creationTimestamp? : string

        +
        • +
      • +

        labels(): object

        +
        • +
      +
      • +
    • +

      spec(): object

      +
        +
      • +

        template(): object

        +
        • +
      • +

        metadata(): object

        +
          +
        • creationTimestamp? : string
          • +
        +
        • +
      • +

        spec(): object

        +
          +
        • +

          containers: IPodContainer[]

          +
          • +
        • +

          dnsPolicy: string

          +
          • +
        • +

          hostPID: boolean

          +
          • +
        • +

          restartPolicy: string

          +
          • +
        • +

          schedulerName: string

          +
          • +
        • +

          terminationGracePeriodSeconds: number

          +
          • +
        +
        • +
      +
      • +
    • +

      schedule: string

      +
      • +
    • +

      successfulJobsHistoryLimit: number

      +
      • +
    • +

      suspend: boolean

      +
      • +
    +
    +

    status#

    +

    • status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:63

    +

    Type declaration:

    +
      +
    • lastScheduleTime? : string
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/apis/batch/v1beta1/cronjobs"

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:12

    +
    +

    Static kind#

    +

    ▪ kind: string = "CronJob"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:10

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:11

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getLastScheduleTime#

    +

    ▸ getLastScheduleTime(): string

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:71

    +

    Returns: string

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSchedule#

    +

    ▸ getSchedule(): string

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:78

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getSuspendFlag#

    +

    ▸ getSuspendFlag(): string

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:67

    +

    Returns: string

    +
    +

    isNeverRun#

    +

    ▸ isNeverRun(): boolean

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:82

    +

    Returns: boolean

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html new file mode 100644 index 0000000000..3c4d1200cb --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.cronjobstore/index.html @@ -0,0 +1,2114 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CronJobStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: CronJobStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹CronJob›

    +

    ↳ CronJobStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new CronJobStore(): CronJobStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: CronJobStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹CronJob‹›› = cronJobApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:9

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): CronJob[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: CronJob[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹CronJob›): Promise‹CronJob›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹CronJob›

    +

    Returns: Promise‹CronJob›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹CronJob›): Promise‹CronJob›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹CronJob›

    +

    Returns: Promise‹CronJob›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: CronJob): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCronJob
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: CronJob[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsCronJob[]
    +

    Returns: T[]

    +
    +

    getActiveJobsNum#

    +

    ▸ getActiveJobsNum(cronJob: CronJob): number

    +

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:26

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    cronJobCronJob
    +

    Returns: number

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): CronJob[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: CronJob[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): CronJob[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: CronJob[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): CronJob

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: CronJob

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): CronJob

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: CronJob

    +
    +

    getStatuses#

    +

    ▸ getStatuses(cronJobs?: CronJob[]): object

    +

    Overrides KubeObjectStore.getStatuses

    +

    Defined in src/renderer/components/+workloads-cronjobs/cronjob.store.ts:11

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    cronJobs?CronJob[]
    +

    Returns: object

    +
      +
    • +

      scheduled: number = 0

      +
      • +
    • +

      suspended: number = 0

      +
      • +
    +
    +

    isSelected#

    +

    ▸ isSelected(item: CronJob): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCronJob
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: CronJob[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsCronJob[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹CronJob›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹CronJob›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹CronJob›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹CronJob›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹CronJob[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹CronJob[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: CronJob): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCronJob
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: CronJob, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: CronJob

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: CronJob): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCronJob
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: CronJob[], sorting?: function[], order?: "asc" | "desc"): CronJob[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsCronJob[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: CronJob[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: CronJob): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCronJob
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: CronJob[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsCronJob[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: CronJob): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemCronJob
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: CronJob, data: Partial‹CronJob›): Promise‹CronJob›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemCronJob
    dataPartial‹CronJob›
    +

    Returns: Promise‹CronJob›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: CronJob, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: CronJob

    +

    ▪ request: function

    +

    ▸ (): Promise‹CronJob›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html new file mode 100644 index 0000000000..c6af421e17 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.customresourcedefinition/index.html @@ -0,0 +1,1882 @@ + + + + + + + + + + + + + + + + + + + + + + Class: CustomResourceDefinition - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: CustomResourceDefinition#

    +

    Hierarchy#

    + +

    ↳ CustomResourceDefinition

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new CustomResourceDefinition(data: KubeJsonApiData): CustomResourceDefinition

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: CustomResourceDefinition

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    spec#

    +

    • spec: object

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:25

    +

    Type declaration:

    +
      +
    • +

      additionalPrinterColumns? : AdditionalPrinterColumnsV1Beta[]

      +
      • +
    • +

      conversion(): object

      +
      • +
    • +

      strategy? : string

      +
      • +
    • +

      webhook? : any

      +
      • +
    • +

      group: string

      +
      • +
    • +

      names(): object

      +
      • +
    • +

      kind: string

      +
      • +
    • +

      listKind: string

      +
      • +
    • +

      plural: string

      +
      • +
    • +

      singular: string

      +
      • +
    • +

      scope: "Namespaced" | "Cluster" | string

      +
      • +
    • +

      validation? : any

      +
      • +
    • +

      version? : string

      +
      • +
    • +

      versions: object[]

      +
      • +
    +
    +

    status#

    +

    • status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:49

    +

    Type declaration:

    +
      +
    • +

      acceptedNames(): object

      +
      • +
    • +

      kind: string

      +
      • +
    • +

      listKind: string

      +
      • +
    • +

      plural: string

      +
      • +
    • +

      shortNames: string[]

      +
      • +
    • +

      singular: string

      +
      • +
    • +

      conditions: object[]

      +
      • +
    • +

      storedVersions: string[]

      +
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/apis/apiextensions.k8s.io/v1/customresourcedefinitions"

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:23

    +
    +

    Static kind#

    +

    ▪ kind: string = "CustomResourceDefinition"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:21

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = false

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:22

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getConditions#

    +

    ▸ getConditions(): object[]

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:139

    +

    Returns: object[]

    +
    +

    getConversion#

    +

    ▸ getConversion(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:121

    +

    Returns: string

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getGroup#

    +

    ▸ getGroup(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:96

    +

    Returns: string

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNames#

    +

    ▸ getNames(): object

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:117

    +

    Returns: object

    +
      +
    • +

      kind: string

      +
      • +
    • +

      listKind: string

      +
      • +
    • +

      plural: string

      +
      • +
    • +

      singular: string

      +
      • +
    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getPluralName#

    +

    ▸ getPluralName(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:82

    +

    Returns: string

    +
    +

    getPrinterColumns#

    +

    ▸ getPrinterColumns(ignorePriority: boolean): AdditionalPrinterColumnsV1[]

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    ignorePrioritybooleantrue
    +

    Returns: AdditionalPrinterColumnsV1[]

    +
    +

    getResourceApiBase#

    +

    ▸ getResourceApiBase(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:76

    +

    Returns: string

    +
    +

    getResourceKind#

    +

    ▸ getResourceKind(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:86

    +

    Returns: string

    +
    +

    getResourceTitle#

    +

    ▸ getResourceTitle(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:90

    +

    Returns: string

    +
    +

    getResourceUrl#

    +

    ▸ getResourceUrl(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:67

    +

    Returns: string

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getScope#

    +

    ▸ getScope(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:100

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getStoredVersions#

    +

    ▸ getStoredVersions(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:113

    +

    Returns: string

    +
    +

    getValidation#

    +

    ▸ getValidation(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:135

    +

    Returns: string

    +
    +

    getVersion#

    +

    ▸ getVersion(): string

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:104

    +

    Returns: string

    +
    +

    isNamespaced#

    +

    ▸ isNamespaced(): boolean

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:109

    +

    Returns: boolean

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html new file mode 100644 index 0000000000..7d280aee1b --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.daemonset/index.html @@ -0,0 +1,1788 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DaemonSet - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: DaemonSet#

    +

    Hierarchy#

    +
      +
    • WorkloadKubeObject
      • +
    +

    ↳ DaemonSet

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DaemonSet(data: KubeJsonApiData): DaemonSet

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: DaemonSet

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    spec#

    +

    • spec: object

    +

    Overrides void

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:13

    +

    Type declaration:

    +
      +
    • +

      revisionHistoryLimit: number

      +
      • +
    • +

      selector(): object

      +
      • +
    • +

      matchLabels(): object

      +
      • +
    • +

      template(): object

      +
      • +
    • +

      metadata(): object

      +
        +
      • +

        creationTimestamp? : string

        +
        • +
      • +

        labels(): object

        +
        • +
      • +

        name: string

        +
        • +
      +
      • +
    • +

      spec(): object

      +
        +
      • +

        affinity? : IAffinity

        +
        • +
      • +

        containers: IPodContainer[]

        +
        • +
      • +

        dnsPolicy: string

        +
        • +
      • +

        hostPID: boolean

        +
        • +
      • +

        initContainers? : IPodContainer[]

        +
        • +
      • +

        nodeSelector(): object

        +
        • +
      • +

        restartPolicy: string

        +
        • +
      • +

        schedulerName: string

        +
        • +
      • +

        securityContext(): object

        +
        • +
      • +

        terminationGracePeriodSeconds: number

        +
        • +
      • +

        tolerations: object[]

        +
        • +
      +
      • +
    • +

      updateStrategy(): object

      +
      • +
    • +

      rollingUpdate(): object

      +
        +
      • maxUnavailable: number
        • +
      +
      • +
    • +

      type: string

      +
      • +
    +
    +

    status#

    +

    • status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:55

    +

    Type declaration:

    +
      +
    • +

      currentNumberScheduled: number

      +
      • +
    • +

      desiredNumberScheduled: number

      +
      • +
    • +

      numberAvailable: number

      +
      • +
    • +

      numberMisscheduled: number

      +
      • +
    • +

      numberReady: number

      +
      • +
    • +

      numberUnavailable: number

      +
      • +
    • +

      observedGeneration: number

      +
      • +
    • +

      updatedNumberScheduled: number

      +
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/apis/apps/v1/daemonsets"

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:11

    +
    +

    Static kind#

    +

    ▪ kind: string = "DaemonSet"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:9

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:10

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAffinity#

    +

    ▸ getAffinity(): IAffinity

    +

    Inherited from Deployment.getAffinity

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Returns: IAffinity

    +
    +

    getAffinityNumber#

    +

    ▸ getAffinityNumber(): number

    +

    Inherited from Pod.getAffinityNumber

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Returns: number

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getImages#

    +

    ▸ getImages(): string[]

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:66

    +

    Returns: string[]

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNodeSelectors#

    +

    ▸ getNodeSelectors(): string[]

    +

    Inherited from Deployment.getNodeSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Returns: string[]

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getSelectors#

    +

    ▸ getSelectors(): string[]

    +

    Inherited from Pod.getSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Returns: string[]

    +
    +

    getTemplateLabels#

    +

    ▸ getTemplateLabels(): string[]

    +

    Inherited from Pod.getTemplateLabels

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Returns: string[]

    +
    +

    getTolerations#

    +

    ▸ getTolerations(): IToleration[]

    +

    Inherited from Deployment.getTolerations

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Returns: IToleration[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html new file mode 100644 index 0000000000..a89be73029 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.daemonsetstore/index.html @@ -0,0 +1,2157 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DaemonSetStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: DaemonSetStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹DaemonSet›

    +

    ↳ DaemonSetStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DaemonSetStore(): DaemonSetStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: DaemonSetStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹DaemonSet‹›› = daemonSetApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:10

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    metrics#

    +

    • metrics: IPodMetrics = null

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:12

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): DaemonSet[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: DaemonSet[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹DaemonSet›): Promise‹DaemonSet›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹DaemonSet›

    +

    Returns: Promise‹DaemonSet›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹DaemonSet›): Promise‹DaemonSet›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹DaemonSet›

    +

    Returns: Promise‹DaemonSet›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: DaemonSet): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: DaemonSet[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsDaemonSet[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): DaemonSet[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: DaemonSet[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): DaemonSet[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: DaemonSet[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): DaemonSet

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: DaemonSet

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): DaemonSet

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: DaemonSet

    +
    +

    getChildPods#

    +

    ▸ getChildPods(daemonSet: DaemonSet): Pod[]

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:20

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    daemonSetDaemonSet
    +

    Returns: Pod[]

    +
    +

    getStatuses#

    +

    ▸ getStatuses(daemonSets?: DaemonSet[]): object

    +

    Overrides KubeObjectStore.getStatuses

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:24

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    daemonSets?DaemonSet[]
    +

    Returns: object

    +
      +
    • +

      failed: number = 0

      +
      • +
    • +

      pending: number = 0

      +
      • +
    • +

      running: number = 0

      +
      • +
    +
    +

    isSelected#

    +

    ▸ isSelected(item: DaemonSet): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: DaemonSet[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsDaemonSet[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹DaemonSet›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹DaemonSet›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹DaemonSet›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹DaemonSet›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹DaemonSet[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹DaemonSet[]›

    +
    +

    loadMetrics#

    +

    ▸ loadMetrics(daemonSet: DaemonSet): Promise‹void›

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    daemonSetDaemonSet
    +

    Returns: Promise‹void›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: DaemonSet): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: DaemonSet, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: DaemonSet

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+workloads-daemonsets/daemonsets.store.ts:44

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: DaemonSet): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: DaemonSet[], sorting?: function[], order?: "asc" | "desc"): DaemonSet[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsDaemonSet[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: DaemonSet[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: DaemonSet): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: DaemonSet[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsDaemonSet[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: DaemonSet): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: DaemonSet, data: Partial‹DaemonSet›): Promise‹DaemonSet›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemDaemonSet
    dataPartial‹DaemonSet›
    +

    Returns: Promise‹DaemonSet›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: DaemonSet, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: DaemonSet

    +

    ▪ request: function

    +

    ▸ (): Promise‹DaemonSet›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html new file mode 100644 index 0000000000..6373f5a0f1 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.deployment/index.html @@ -0,0 +1,1853 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Deployment - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Deployment#

    +

    Hierarchy#

    +
      +
    • WorkloadKubeObject
      • +
    +

    ↳ Deployment

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Deployment(data: KubeJsonApiData): Deployment

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Deployment

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    spec#

    +

    • spec: object

    +

    Overrides void

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:55

    +

    Type declaration:

    +
      +
    • +

      replicas: number

      +
      • +
    • +

      selector(): object

      +
      • +
    • +

      matchLabels(): object

      +
      • +
    • +

      strategy(): object

      +
      • +
    • +

      rollingUpdate(): object

      +
        +
      • +

        maxSurge: number

        +
        • +
      • +

        maxUnavailable: number

        +
        • +
      +
      • +
    • +

      type: string

      +
      • +
    • +

      template(): object

      +
      • +
    • +

      metadata(): object

      +
        +
      • +

        annotations(): object

        +
        • +
      • +

        creationTimestamp? : string

        +
        • +
      • +

        labels(): object

        +
        • +
      +
      • +
    • +

      spec(): object

      +
        +
      • +

        affinity? : IAffinity

        +
        • +
      • +

        containers: object[]

        +
        • +
      • +

        dnsPolicy: string

        +
        • +
      • +

        nodeSelector(): object

        +
        • +
      • +

        restartPolicy: string

        +
        • +
      • +

        schedulerName: string

        +
        • +
      • +

        securityContext(): object

        +
        • +
      • +

        serviceAccount: string

        +
        • +
      • +

        serviceAccountName: string

        +
        • +
      • +

        terminationGracePeriodSeconds: number

        +
        • +
      • +

        tolerations? : object[]

        +
        • +
      • +

        volumes? : object[]

        +
        • +
      +
      • +
    +
    +

    status#

    +

    • status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:155

    +

    Type declaration:

    +
      +
    • +

      availableReplicas? : number

      +
      • +
    • +

      conditions: object[]

      +
      • +
    • +

      observedGeneration: number

      +
      • +
    • +

      readyReplicas: number

      +
      • +
    • +

      replicas: number

      +
      • +
    • +

      unavailableReplicas? : number

      +
      • +
    • +

      updatedReplicas: number

      +
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/apis/apps/v1/deployments"

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:53

    +
    +

    Static kind#

    +

    ▪ kind: string = "Deployment"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:51

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:52

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAffinity#

    +

    ▸ getAffinity(): IAffinity

    +

    Inherited from Deployment.getAffinity

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Returns: IAffinity

    +
    +

    getAffinityNumber#

    +

    ▸ getAffinityNumber(): number

    +

    Inherited from Pod.getAffinityNumber

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Returns: number

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getConditions#

    +

    ▸ getConditions(activeOnly: boolean): object[]

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:172

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    activeOnlybooleanfalse
    +

    Returns: object[]

    +
    +

    getConditionsText#

    +

    ▸ getConditionsText(activeOnly: boolean): string

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    activeOnlybooleantrue
    +

    Returns: string

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNodeSelectors#

    +

    ▸ getNodeSelectors(): string[]

    +

    Inherited from Deployment.getNodeSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Returns: string[]

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getReplicas#

    +

    ▸ getReplicas(): number

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:188

    +

    Returns: number

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getSelectors#

    +

    ▸ getSelectors(): string[]

    +

    Inherited from Pod.getSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Returns: string[]

    +
    +

    getTemplateLabels#

    +

    ▸ getTemplateLabels(): string[]

    +

    Inherited from Pod.getTemplateLabels

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Returns: string[]

    +
    +

    getTolerations#

    +

    ▸ getTolerations(): IToleration[]

    +

    Inherited from Deployment.getTolerations

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Returns: IToleration[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html new file mode 100644 index 0000000000..7f1238bac5 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.deploymentapi/index.html @@ -0,0 +1,1847 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DeploymentApi - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: DeploymentApi#

    +

    Hierarchy#

    + +

    ↳ DeploymentApi

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DeploymentApi(options: IKubeApiOptions‹Deployment›): DeploymentApi

    +

    Inherited from KubeApi.constructor

    +

    Defined in src/renderer/api/kube-api.ts:102

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹Deployment›
    +

    Returns: DeploymentApi

    +

    Properties#

    +

    apiBase#

    +

    • apiBase: string

    +

    Inherited from KubeApi.apiBase

    +

    Defined in src/renderer/api/kube-api.ts:92

    +
    +

    apiGroup#

    +

    • apiGroup: string

    +

    Inherited from KubeApi.apiGroup

    +

    Defined in src/renderer/api/kube-api.ts:94

    +
    +

    apiPrefix#

    +

    • apiPrefix: string

    +

    Inherited from KubeApi.apiPrefix

    +

    Defined in src/renderer/api/kube-api.ts:93

    +
    +

    apiResource#

    +

    • apiResource: string

    +

    Inherited from KubeApi.apiResource

    +

    Defined in src/renderer/api/kube-api.ts:97

    +
    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeApi.apiVersion

    +

    Defined in src/renderer/api/kube-api.ts:95

    +
    +

    Optional apiVersionPreferred#

    +

    • apiVersionPreferred? : string

    +

    Inherited from KubeApi.apiVersionPreferred

    +

    Defined in src/renderer/api/kube-api.ts:96

    +
    +

    isNamespaced#

    +

    • isNamespaced: boolean

    +

    Inherited from KubeApi.isNamespaced

    +

    Defined in src/renderer/api/kube-api.ts:98

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeApi.kind

    +

    Defined in src/renderer/api/kube-api.ts:91

    +
    +

    objectConstructor#

    +

    • objectConstructor: IKubeObjectConstructor‹Deployment›

    +

    Inherited from KubeApi.objectConstructor

    +

    Defined in src/renderer/api/kube-api.ts:100

    +
    +

    Protected options#

    +

    • options: IKubeApiOptions‹Deployment›

    +

    Inherited from KubeApi.options

    +

    Defined in src/renderer/api/kube-api.ts:104

    +
    +

    Protected request#

    +

    • request: KubeJsonApi

    +

    Inherited from KubeApi.request

    +

    Defined in src/renderer/api/kube-api.ts:101

    +
    +

    Protected resourceVersions#

    +

    • resourceVersions: Map‹string, string› = new Map()

    +

    Inherited from KubeApi.resourceVersions

    +

    Defined in src/renderer/api/kube-api.ts:102

    +
    +

    Static parseApi#

    +

    ▪ parseApi: parseKubeApi = parseKubeApi

    +

    Inherited from KubeApi.parseApi

    +

    Defined in src/renderer/api/kube-api.ts:83

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    • get apiVersionWithGroup(): string

    +

    Inherited from KubeApi.apiVersionWithGroup

    +

    Defined in src/renderer/api/kube-api.ts:132

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    ▸ checkPreferredVersion(): Promise‹void›

    +

    Inherited from KubeApi.checkPreferredVersion

    +

    Defined in src/renderer/api/kube-api.ts:194

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    ▸ create(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment›

    +

    Inherited from KubeApi.create

    +

    Defined in src/renderer/api/kube-api.ts:304

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional data: Partial‹Deployment›

    +

    Returns: Promise‹Deployment›

    +
    +

    delete#

    +

    ▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

    +

    Inherited from KubeApi.delete

    +

    Defined in src/renderer/api/kube-api.ts:331

    +

    Parameters:

    +

    ▪ __namedParameters: object

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Returns: Promise‹KubeJsonApiData›

    +
    +

    get#

    +

    ▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Deployment›

    +

    Inherited from KubeApi.get

    +

    Defined in src/renderer/api/kube-api.ts:296

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Deployment›

    +
    +

    getReplicas#

    +

    ▸ getReplicas(params: object): Promise‹number›

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:12

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespacestring
    +

    Returns: Promise‹number›

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(namespace: string): string

    +

    Inherited from KubeApi.getResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:227

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Returns: string

    +
    +

    Protected getScaleApiUrl#

    +

    ▸ getScaleApiUrl(params: object): string

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:8

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespacestring
    +

    Returns: string

    +
    +

    getUrl#

    +

    ▸ getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    +

    Inherited from KubeApi.getUrl

    +

    Defined in src/renderer/api/kube-api.ts:235

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring""
    +

    ▪Optional query: Partial‹IKubeApiQueryParams›

    +

    Returns: string

    +
    +

    getWatchUrl#

    +

    ▸ getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    +

    Inherited from KubeApi.getWatchUrl

    +

    Defined in src/renderer/api/kube-api.ts:338

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    queryIKubeApiQueryParams{}
    +

    Returns: string

    +
    +

    list#

    +

    ▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Deployment[]›

    +

    Inherited from KubeApi.list

    +

    Defined in src/renderer/api/kube-api.ts:288

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    ▪Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Deployment[]›

    +
    +

    Protected normalizeQuery#

    +

    ▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Inherited from KubeApi.normalizeQuery

    +

    Defined in src/renderer/api/kube-api.ts:247

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    queryPartial‹IKubeApiQueryParams›{}
    +

    Returns: object

    +
    +

    Protected parseResponse#

    +

    ▸ parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    +

    Inherited from KubeApi.parseResponse

    +

    Defined in src/renderer/api/kube-api.ts:259

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList
    namespace?string
    +

    Returns: any

    +
    +

    refreshResourceVersion#

    +

    ▸ refreshResourceVersion(params?: object): Promise‹T[]›

    +

    Inherited from KubeApi.refreshResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:231

    +

    Parameters:

    +

    ▪Optional params: object

    + + + + + + + + + + + + + +
    NameType
    namespacestring
    +

    Returns: Promise‹T[]›

    +
    +

    restart#

    +

    ▸ restart(params: object): CancelablePromise‹KubeJsonApiData›

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:29

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespacestring
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    scale#

    +

    ▸ scale(params: object, replicas: number): CancelablePromise‹KubeJsonApiData›

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:18

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespacestring
    +

    ▪ replicas: number

    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    setResourceVersion#

    +

    ▸ setResourceVersion(namespace: string, newVersion: string): void

    +

    Inherited from KubeApi.setResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:223

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    newVersionstring-
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(__namedParameters: object, data?: Partial‹Deployment›): Promise‹Deployment›

    +

    Inherited from KubeApi.update

    +

    Defined in src/renderer/api/kube-api.ts:322

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional data: Partial‹Deployment›

    +

    Returns: Promise‹Deployment›

    +
    +

    watch#

    +

    ▸ watch(): function

    +

    Inherited from KubeApi.watch

    +

    Defined in src/renderer/api/kube-api.ts:346

    +

    Returns: function

    +

    ▸ (): void

    +
    +

    Static watchAll#

    +

    ▸ watchAll(...apis: KubeApi[]): (Anonymous function)

    +

    Inherited from KubeApi.watchAll

    +

    Defined in src/renderer/api/kube-api.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ...apisKubeApi[]
    +

    Returns: (Anonymous function)

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html new file mode 100644 index 0000000000..4b900f1c6b --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.deploymentstore/index.html @@ -0,0 +1,2145 @@ + + + + + + + + + + + + + + + + + + + + + + Class: DeploymentStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: DeploymentStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹Deployment›

    +

    ↳ DeploymentStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new DeploymentStore(): DeploymentStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: DeploymentStore

    +

    Properties#

    +

    api#

    +

    • api: DeploymentApi‹› = deploymentApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:10

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    metrics#

    +

    • metrics: IPodMetrics = null

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:11

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): Deployment[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Deployment[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹Deployment›): Promise‹Deployment›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Deployment›

    +

    Returns: Promise‹Deployment›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹Deployment›): Promise‹Deployment›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Deployment›

    +

    Returns: Promise‹Deployment›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: Deployment): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDeployment
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: Deployment[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsDeployment[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Deployment[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Deployment[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): Deployment[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Deployment[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): Deployment

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Deployment

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): Deployment

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Deployment

    +
    +

    getChildPods#

    +

    ▸ getChildPods(deployment: Deployment): Pod‹›[]

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    deploymentDeployment
    +

    Returns: Pod‹›[]

    +
    +

    getStatuses#

    +

    ▸ getStatuses(deployments?: Deployment[]): object

    +

    Overrides KubeObjectStore.getStatuses

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:25

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    deployments?Deployment[]
    +

    Returns: object

    +
      +
    • +

      failed: number = 0

      +
      • +
    • +

      pending: number = 0

      +
      • +
    • +

      running: number = 0

      +
      • +
    +
    +

    isSelected#

    +

    ▸ isSelected(item: Deployment): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDeployment
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: Deployment[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsDeployment[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹Deployment›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Deployment›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹Deployment›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Deployment›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹Deployment[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹Deployment[]›

    +
    +

    loadMetrics#

    +

    ▸ loadMetrics(deployment: Deployment): Promise‹void›

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:19

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    deploymentDeployment
    +

    Returns: Promise‹void›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: Deployment): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDeployment
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: Deployment, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: Deployment

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:51

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: Deployment): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDeployment
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: Deployment[]): Deployment‹›[]

    +

    Overrides KubeObjectStore.sortItems

    +

    Defined in src/renderer/components/+workloads-deployments/deployments.store.ts:13

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsDeployment[]
    +

    Returns: Deployment‹›[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: Deployment): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDeployment
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: Deployment[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsDeployment[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: Deployment): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemDeployment
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: Deployment, data: Partial‹Deployment›): Promise‹Deployment›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemDeployment
    dataPartial‹Deployment›
    +

    Returns: Promise‹Deployment›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: Deployment, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: Deployment

    +

    ▪ request: function

    +

    ▸ (): Promise‹Deployment›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html new file mode 100644 index 0000000000..2bbe275cfd --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.endpoint/index.html @@ -0,0 +1,1610 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Endpoint - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Endpoint#

    +

    Hierarchy#

    + +

    ↳ Endpoint

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Endpoint(data: KubeJsonApiData): Endpoint

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Endpoint

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    Optional status#

    +

    • status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:79

    +
    +

    subsets#

    +

    • subsets: IEndpointSubset[]

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:109

    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/api/v1/endpoints"

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:107

    +
    +

    Static kind#

    +

    ▪ kind: string = "Endpoints"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:105

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:106

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getEndpointSubsets#

    +

    ▸ getEndpointSubsets(): EndpointSubset[]

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:111

    +

    Returns: EndpointSubset[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    toString#

    +

    ▸ toString(): string

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:117

    +

    Returns: string

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html new file mode 100644 index 0000000000..429f8ee167 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.endpointstore/index.html @@ -0,0 +1,2078 @@ + + + + + + + + + + + + + + + + + + + + + + Class: EndpointStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: EndpointStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹Endpoint›

    +

    ↳ EndpointStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new EndpointStore(): EndpointStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: EndpointStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹Endpoint‹›› = endpointApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+network-endpoints/endpoints.store.ts:8

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): Endpoint[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Endpoint[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹Endpoint›): Promise‹Endpoint›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Endpoint›

    +

    Returns: Promise‹Endpoint›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹Endpoint›): Promise‹Endpoint›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Endpoint›

    +

    Returns: Promise‹Endpoint›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: Endpoint): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: Endpoint[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsEndpoint[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Endpoint[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Endpoint[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): Endpoint[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Endpoint[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): Endpoint

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Endpoint

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): Endpoint

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Endpoint

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: Endpoint[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsEndpoint[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: Endpoint): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: Endpoint[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsEndpoint[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹Endpoint›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Endpoint›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹Endpoint›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Endpoint›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹Endpoint[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹Endpoint[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: Endpoint): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: Endpoint, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: Endpoint

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: Endpoint): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: Endpoint[], sorting?: function[], order?: "asc" | "desc"): Endpoint[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsEndpoint[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Endpoint[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: Endpoint): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: Endpoint[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsEndpoint[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: Endpoint): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: Endpoint, data: Partial‹Endpoint›): Promise‹Endpoint›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemEndpoint
    dataPartial‹Endpoint›
    +

    Returns: Promise‹Endpoint›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: Endpoint, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: Endpoint

    +

    ▪ request: function

    +

    ▸ (): Promise‹Endpoint›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html new file mode 100644 index 0000000000..f3f34f6085 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.eventstore/index.html @@ -0,0 +1,2102 @@ + + + + + + + + + + + + + + + + + + + + + + Class: EventStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: EventStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹KubeEvent›

    +

    ↳ EventStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new EventStore(): EventStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: EventStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹KubeEvent‹›› = eventApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+events/event.store.ts:13

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    limit#

    +

    • limit: number = 1000

    +

    Overrides KubeObjectStore.limit

    +

    Defined in src/renderer/components/+events/event.store.ts:14

    +
    +

    saveLimit#

    +

    • saveLimit: number = 50000

    +

    Defined in src/renderer/components/+events/event.store.ts:15

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): KubeEvent[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: KubeEvent[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(): IReactionDisposer

    +

    Overrides KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/components/+events/event.store.ts:17

    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹KubeEvent›): Promise‹KubeEvent›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹KubeEvent›

    +

    Returns: Promise‹KubeEvent›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹KubeEvent›): Promise‹KubeEvent›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹KubeEvent›

    +

    Returns: Promise‹KubeEvent›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: KubeEvent): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: KubeEvent[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsKubeEvent[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): KubeEvent[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: KubeEvent[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): KubeEvent[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: KubeEvent[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): KubeEvent

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: KubeEvent

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): KubeEvent

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: KubeEvent

    +
    +

    getEventsByObject#

    +

    ▸ getEventsByObject(obj: KubeObject): KubeEvent[]

    +

    Defined in src/renderer/components/+events/event.store.ts:27

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objKubeObject
    +

    Returns: KubeEvent[]

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: KubeEvent[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsKubeEvent[]
    +

    Returns: Record‹string, number›

    +
    +

    getWarnings#

    +

    ▸ getWarnings(): KubeEvent‹›[]

    +

    Defined in src/renderer/components/+events/event.store.ts:37

    +

    Returns: KubeEvent‹›[]

    +
    +

    isSelected#

    +

    ▸ isSelected(item: KubeEvent): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: KubeEvent[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsKubeEvent[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹KubeEvent›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹KubeEvent›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹KubeEvent›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹KubeEvent›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹KubeEvent[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹KubeEvent[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: KubeEvent): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: KubeEvent, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: KubeEvent

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: KubeEvent): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: KubeEvent[]): KubeEvent‹›[]

    +

    Overrides KubeObjectStore.sortItems

    +

    Defined in src/renderer/components/+events/event.store.ts:21

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsKubeEvent[]
    +

    Returns: KubeEvent‹›[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: KubeEvent): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: KubeEvent[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsKubeEvent[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: KubeEvent): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: KubeEvent, data: Partial‹KubeEvent›): Promise‹KubeEvent›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemKubeEvent
    dataPartial‹KubeEvent›
    +

    Returns: Promise‹KubeEvent›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: KubeEvent, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: KubeEvent

    +

    ▪ request: function

    +

    ▸ (): Promise‹KubeEvent›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html new file mode 100644 index 0000000000..fc652cbdec --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.horizontalpodautoscaler/index.html @@ -0,0 +1,1757 @@ + + + + + + + + + + + + + + + + + + + + + + Class: HorizontalPodAutoscaler - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: HorizontalPodAutoscaler#

    +

    Hierarchy#

    + +

    ↳ HorizontalPodAutoscaler

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new HorizontalPodAutoscaler(data: KubeJsonApiData): HorizontalPodAutoscaler

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: HorizontalPodAutoscaler

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    spec#

    +

    • spec: object

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:46

    +

    Type declaration:

    +
      +
    • +

      maxReplicas: number

      +
      • +
    • +

      metrics: IHpaMetric[]

      +
      • +
    • +

      minReplicas: number

      +
      • +
    • +

      scaleTargetRef(): object

      +
      • +
    • +

      apiVersion: string

      +
      • +
    • +

      kind: string

      +
      • +
    • +

      name: string

      +
      • +
    +
    +

    status#

    +

    • status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:56

    +

    Type declaration:

    +
      +
    • +

      conditions: object[]

      +
      • +
    • +

      currentMetrics: IHpaMetric[]

      +
      • +
    • +

      currentReplicas: number

      +
      • +
    • +

      desiredReplicas: number

      +
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/apis/autoscaling/v2beta1/horizontalpodautoscalers"

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:44

    +
    +

    Static kind#

    +

    ▪ kind: string = "HorizontalPodAutoscaler"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:42

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:43

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getConditions#

    +

    ▸ getConditions(): object[]

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:81

    +

    Returns: object[]

    +
    +

    getCurrentMetrics#

    +

    ▸ getCurrentMetrics(): IHpaMetric[]

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:99

    +

    Returns: IHpaMetric[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getMaxPods#

    +

    ▸ getMaxPods(): number

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:69

    +

    Returns: number

    +
    +

    Protected getMetricName#

    +

    ▸ getMetricName(metric: IHpaMetric): string

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    metricIHpaMetric
    +

    Returns: string

    +
    +

    getMetricValues#

    +

    ▸ getMetricValues(metric: IHpaMetric): string

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:119

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    metricIHpaMetric
    +

    Returns: string

    +
    +

    getMetrics#

    +

    ▸ getMetrics(): IHpaMetric[]

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:95

    +

    Returns: IHpaMetric[]

    +
    +

    getMinPods#

    +

    ▸ getMinPods(): number

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:73

    +

    Returns: number

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getReplicas#

    +

    ▸ getReplicas(): number

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:77

    +

    Returns: number

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html new file mode 100644 index 0000000000..a37b953440 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.hpastore/index.html @@ -0,0 +1,2078 @@ + + + + + + + + + + + + + + + + + + + + + + Class: HPAStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: HPAStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹HorizontalPodAutoscaler›

    +

    ↳ HPAStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new HPAStore(): HPAStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: HPAStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹HorizontalPodAutoscaler‹›› = hpaApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+config-autoscalers/hpa.store.ts:8

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): HorizontalPodAutoscaler[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: HorizontalPodAutoscaler[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹HorizontalPodAutoscaler›): Promise‹HorizontalPodAutoscaler›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹HorizontalPodAutoscaler›

    +

    Returns: Promise‹HorizontalPodAutoscaler›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹HorizontalPodAutoscaler›): Promise‹HorizontalPodAutoscaler›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹HorizontalPodAutoscaler›

    +

    Returns: Promise‹HorizontalPodAutoscaler›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: HorizontalPodAutoscaler): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: HorizontalPodAutoscaler[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsHorizontalPodAutoscaler[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): HorizontalPodAutoscaler[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: HorizontalPodAutoscaler[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): HorizontalPodAutoscaler[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: HorizontalPodAutoscaler[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): HorizontalPodAutoscaler

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: HorizontalPodAutoscaler

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): HorizontalPodAutoscaler

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: HorizontalPodAutoscaler

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: HorizontalPodAutoscaler[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsHorizontalPodAutoscaler[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: HorizontalPodAutoscaler): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: HorizontalPodAutoscaler[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsHorizontalPodAutoscaler[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹HorizontalPodAutoscaler›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹HorizontalPodAutoscaler›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹HorizontalPodAutoscaler›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹HorizontalPodAutoscaler›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹HorizontalPodAutoscaler[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹HorizontalPodAutoscaler[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: HorizontalPodAutoscaler): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: HorizontalPodAutoscaler, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: HorizontalPodAutoscaler

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: HorizontalPodAutoscaler): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: HorizontalPodAutoscaler[], sorting?: function[], order?: "asc" | "desc"): HorizontalPodAutoscaler[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsHorizontalPodAutoscaler[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: HorizontalPodAutoscaler[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: HorizontalPodAutoscaler): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: HorizontalPodAutoscaler[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsHorizontalPodAutoscaler[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: HorizontalPodAutoscaler): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: HorizontalPodAutoscaler, data: Partial‹HorizontalPodAutoscaler›): Promise‹HorizontalPodAutoscaler›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemHorizontalPodAutoscaler
    dataPartial‹HorizontalPodAutoscaler›
    +

    Returns: Promise‹HorizontalPodAutoscaler›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: HorizontalPodAutoscaler, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: HorizontalPodAutoscaler

    +

    ▪ request: function

    +

    ▸ (): Promise‹HorizontalPodAutoscaler›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html new file mode 100644 index 0000000000..64d27fd28c --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.ingress/index.html @@ -0,0 +1,1681 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Ingress - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Ingress#

    +

    Hierarchy#

    + +

    ↳ Ingress

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Ingress(data: KubeJsonApiData): Ingress

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Ingress

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    spec#

    +

    • spec: object

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:70

    +

    Type declaration:

    +
      +
    • +

      backend? : IExtensionsBackend

      +
      • +
    • +

      defaultBackend? : INetworkingBackend & object

      +
      • +
    • +

      rules? : object[]

      +
      • +
    • +

      tls: object[]

      +
      • +
    +
    +

    status#

    +

    • status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:94

    +

    Type declaration:

    +
      +
    • +

      loadBalancer(): object

      +
      • +
    • +

      ingress: ILoadBalancerIngress[]

      +
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/apis/networking.k8s.io/v1/ingresses"

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:68

    +
    +

    Static kind#

    +

    ▪ kind: string = "Ingress"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:66

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:67

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getHosts#

    +

    ▸ getHosts(): string[]

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:137

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getLoadBalancers#

    +

    ▸ getLoadBalancers(): string[]

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:168

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getPorts#

    +

    ▸ getPorts(): string

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:145

    +

    Returns: string

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getRoutes#

    +

    ▸ getRoutes(): string[]

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:100

    +

    Returns: string[]

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getServiceNamePort#

    +

    ▸ getServiceNamePort(): object

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:126

    +

    Returns: object

    +
      +
    • +

      serviceName: string

      +
      • +
    • +

      servicePort: string | number

      +
      • +
    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html new file mode 100644 index 0000000000..85170f3832 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.ingressapi/index.html @@ -0,0 +1,1746 @@ + + + + + + + + + + + + + + + + + + + + + + Class: IngressApi - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: IngressApi#

    +

    Hierarchy#

    + +

    ↳ IngressApi

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new IngressApi(options: IKubeApiOptions‹Ingress›): IngressApi

    +

    Inherited from KubeApi.constructor

    +

    Defined in src/renderer/api/kube-api.ts:102

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹Ingress›
    +

    Returns: IngressApi

    +

    Properties#

    +

    apiBase#

    +

    • apiBase: string

    +

    Inherited from KubeApi.apiBase

    +

    Defined in src/renderer/api/kube-api.ts:92

    +
    +

    apiGroup#

    +

    • apiGroup: string

    +

    Inherited from KubeApi.apiGroup

    +

    Defined in src/renderer/api/kube-api.ts:94

    +
    +

    apiPrefix#

    +

    • apiPrefix: string

    +

    Inherited from KubeApi.apiPrefix

    +

    Defined in src/renderer/api/kube-api.ts:93

    +
    +

    apiResource#

    +

    • apiResource: string

    +

    Inherited from KubeApi.apiResource

    +

    Defined in src/renderer/api/kube-api.ts:97

    +
    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeApi.apiVersion

    +

    Defined in src/renderer/api/kube-api.ts:95

    +
    +

    Optional apiVersionPreferred#

    +

    • apiVersionPreferred? : string

    +

    Inherited from KubeApi.apiVersionPreferred

    +

    Defined in src/renderer/api/kube-api.ts:96

    +
    +

    isNamespaced#

    +

    • isNamespaced: boolean

    +

    Inherited from KubeApi.isNamespaced

    +

    Defined in src/renderer/api/kube-api.ts:98

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeApi.kind

    +

    Defined in src/renderer/api/kube-api.ts:91

    +
    +

    objectConstructor#

    +

    • objectConstructor: IKubeObjectConstructor‹Ingress›

    +

    Inherited from KubeApi.objectConstructor

    +

    Defined in src/renderer/api/kube-api.ts:100

    +
    +

    Protected options#

    +

    • options: IKubeApiOptions‹Ingress›

    +

    Inherited from KubeApi.options

    +

    Defined in src/renderer/api/kube-api.ts:104

    +
    +

    Protected request#

    +

    • request: KubeJsonApi

    +

    Inherited from KubeApi.request

    +

    Defined in src/renderer/api/kube-api.ts:101

    +
    +

    Protected resourceVersions#

    +

    • resourceVersions: Map‹string, string› = new Map()

    +

    Inherited from KubeApi.resourceVersions

    +

    Defined in src/renderer/api/kube-api.ts:102

    +
    +

    Static parseApi#

    +

    ▪ parseApi: parseKubeApi = parseKubeApi

    +

    Inherited from KubeApi.parseApi

    +

    Defined in src/renderer/api/kube-api.ts:83

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    • get apiVersionWithGroup(): string

    +

    Inherited from KubeApi.apiVersionWithGroup

    +

    Defined in src/renderer/api/kube-api.ts:132

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    ▸ checkPreferredVersion(): Promise‹void›

    +

    Inherited from KubeApi.checkPreferredVersion

    +

    Defined in src/renderer/api/kube-api.ts:194

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    ▸ create(__namedParameters: object, data?: Partial‹Ingress›): Promise‹Ingress›

    +

    Inherited from KubeApi.create

    +

    Defined in src/renderer/api/kube-api.ts:304

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional data: Partial‹Ingress›

    +

    Returns: Promise‹Ingress›

    +
    +

    delete#

    +

    ▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

    +

    Inherited from KubeApi.delete

    +

    Defined in src/renderer/api/kube-api.ts:331

    +

    Parameters:

    +

    ▪ __namedParameters: object

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Returns: Promise‹KubeJsonApiData›

    +
    +

    get#

    +

    ▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Ingress›

    +

    Inherited from KubeApi.get

    +

    Defined in src/renderer/api/kube-api.ts:296

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Ingress›

    +
    +

    getMetrics#

    +

    ▸ getMetrics(ingress: string, namespace: string): Promise‹IIngressMetrics›

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:7

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    ingressstring
    namespacestring
    +

    Returns: Promise‹IIngressMetrics›

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(namespace: string): string

    +

    Inherited from KubeApi.getResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:227

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Returns: string

    +
    +

    getUrl#

    +

    ▸ getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    +

    Inherited from KubeApi.getUrl

    +

    Defined in src/renderer/api/kube-api.ts:235

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring""
    +

    ▪Optional query: Partial‹IKubeApiQueryParams›

    +

    Returns: string

    +
    +

    getWatchUrl#

    +

    ▸ getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    +

    Inherited from KubeApi.getWatchUrl

    +

    Defined in src/renderer/api/kube-api.ts:338

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    queryIKubeApiQueryParams{}
    +

    Returns: string

    +
    +

    list#

    +

    ▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Ingress[]›

    +

    Inherited from KubeApi.list

    +

    Defined in src/renderer/api/kube-api.ts:288

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    ▪Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Ingress[]›

    +
    +

    Protected normalizeQuery#

    +

    ▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Inherited from KubeApi.normalizeQuery

    +

    Defined in src/renderer/api/kube-api.ts:247

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    queryPartial‹IKubeApiQueryParams›{}
    +

    Returns: object

    +
    +

    Protected parseResponse#

    +

    ▸ parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    +

    Inherited from KubeApi.parseResponse

    +

    Defined in src/renderer/api/kube-api.ts:259

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList
    namespace?string
    +

    Returns: any

    +
    +

    refreshResourceVersion#

    +

    ▸ refreshResourceVersion(params?: object): Promise‹T[]›

    +

    Inherited from KubeApi.refreshResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:231

    +

    Parameters:

    +

    ▪Optional params: object

    + + + + + + + + + + + + + +
    NameType
    namespacestring
    +

    Returns: Promise‹T[]›

    +
    +

    setResourceVersion#

    +

    ▸ setResourceVersion(namespace: string, newVersion: string): void

    +

    Inherited from KubeApi.setResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:223

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    newVersionstring-
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(__namedParameters: object, data?: Partial‹Ingress›): Promise‹Ingress›

    +

    Inherited from KubeApi.update

    +

    Defined in src/renderer/api/kube-api.ts:322

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional data: Partial‹Ingress›

    +

    Returns: Promise‹Ingress›

    +
    +

    watch#

    +

    ▸ watch(): function

    +

    Inherited from KubeApi.watch

    +

    Defined in src/renderer/api/kube-api.ts:346

    +

    Returns: function

    +

    ▸ (): void

    +
    +

    Static watchAll#

    +

    ▸ watchAll(...apis: KubeApi[]): (Anonymous function)

    +

    Inherited from KubeApi.watchAll

    +

    Defined in src/renderer/api/kube-api.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ...apisKubeApi[]
    +

    Returns: (Anonymous function)

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html new file mode 100644 index 0000000000..99bff4d4c3 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.ingressstore/index.html @@ -0,0 +1,2118 @@ + + + + + + + + + + + + + + + + + + + + + + Class: IngressStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: IngressStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹Ingress›

    +

    ↳ IngressStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new IngressStore(): IngressStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: IngressStore

    +

    Properties#

    +

    api#

    +

    • api: IngressApi‹› = ingressApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:9

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    metrics#

    +

    • metrics: IIngressMetrics = null

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:10

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): Ingress[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Ingress[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹Ingress›): Promise‹Ingress›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Ingress›

    +

    Returns: Promise‹Ingress›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹Ingress›): Promise‹Ingress›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Ingress›

    +

    Returns: Promise‹Ingress›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: Ingress): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemIngress
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: Ingress[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsIngress[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Ingress[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Ingress[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): Ingress[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Ingress[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): Ingress

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Ingress

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): Ingress

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Ingress

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: Ingress[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsIngress[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: Ingress): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemIngress
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: Ingress[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsIngress[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹Ingress›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Ingress›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹Ingress›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Ingress›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹Ingress[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹Ingress[]›

    +
    +

    loadMetrics#

    +

    ▸ loadMetrics(ingress: Ingress): Promise‹void›

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:12

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ingressIngress
    +

    Returns: Promise‹void›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: Ingress): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemIngress
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: Ingress, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: Ingress

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+network-ingresses/ingress.store.ts:16

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: Ingress): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemIngress
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: Ingress[], sorting?: function[], order?: "asc" | "desc"): Ingress[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsIngress[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Ingress[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: Ingress): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemIngress
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: Ingress[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsIngress[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: Ingress): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemIngress
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: Ingress, data: Partial‹Ingress›): Promise‹Ingress›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemIngress
    dataPartial‹Ingress›
    +

    Returns: Promise‹Ingress›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: Ingress, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: Ingress

    +

    ▪ request: function

    +

    ▸ (): Promise‹Ingress›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.job/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.job/index.html new file mode 100644 index 0000000000..63656858f7 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.job/index.html @@ -0,0 +1,1839 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Job - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Job#

    +

    Hierarchy#

    +
      +
    • WorkloadKubeObject
      • +
    +

    ↳ Job

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Job(data: KubeJsonApiData): Job

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Job

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    spec#

    +

    • spec: object

    +

    Overrides void

    +

    Defined in src/renderer/api/endpoints/job.api.ts:14

    +

    Type declaration:

    +
      +
    • +

      backoffLimit? : number

      +
      • +
    • +

      completions? : number

      +
      • +
    • +

      containers? : IPodContainer[]

      +
      • +
    • +

      dnsPolicy? : string

      +
      • +
    • +

      parallelism? : number

      +
      • +
    • +

      restartPolicy? : string

      +
      • +
    • +

      schedulerName? : string

      +
      • +
    • +

      selector(): object

      +
      • +
    • +

      matchLabels(): object

      +
      • +
    • +

      serviceAccount? : string

      +
      • +
    • +

      serviceAccountName? : string

      +
      • +
    • +

      template(): object

      +
      • +
    • +

      metadata(): object

      +
        +
      • +

        annotations(): object

        +
        • +
      • +

        creationTimestamp? : string

        +
        • +
      • +

        labels(): object

        +
        • +
      +
      • +
    • +

      spec(): object

      +
        +
      • +

        affinity? : IAffinity

        +
        • +
      • +

        containers: IPodContainer[]

        +
        • +
      • +

        dnsPolicy: string

        +
        • +
      • +

        hostPID: boolean

        +
        • +
      • +

        nodeSelector(): object

        +
        • +
      • +

        restartPolicy: string

        +
        • +
      • +

        schedulerName: string

        +
        • +
      • +

        terminationGracePeriodSeconds: number

        +
        • +
      • +

        tolerations? : object[]

        +
        • +
      +
      • +
    • +

      terminationGracePeriodSeconds? : number

      +
      • +
    +
    +

    status#

    +

    • status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/job.api.ts:60

    +

    Type declaration:

    +
      +
    • +

      completionTime: string

      +
      • +
    • +

      conditions: object[]

      +
      • +
    • +

      startTime: string

      +
      • +
    • +

      succeeded: number

      +
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/apis/batch/v1/jobs"

    +

    Defined in src/renderer/api/endpoints/job.api.ts:12

    +
    +

    Static kind#

    +

    ▪ kind: string = "Job"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/job.api.ts:10

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/job.api.ts:11

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(): CancelablePromise‹KubeJsonApiData›

    +

    Overrides KubeObject.delete

    +

    Defined in src/renderer/api/endpoints/job.api.ts:101

    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAffinity#

    +

    ▸ getAffinity(): IAffinity

    +

    Inherited from Deployment.getAffinity

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Returns: IAffinity

    +
    +

    getAffinityNumber#

    +

    ▸ getAffinityNumber(): number

    +

    Inherited from Pod.getAffinityNumber

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Returns: number

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getCompletions#

    +

    ▸ getCompletions(): number

    +

    Defined in src/renderer/api/endpoints/job.api.ts:77

    +

    Returns: number

    +
    +

    getCondition#

    +

    ▸ getCondition(): object

    +

    Defined in src/renderer/api/endpoints/job.api.ts:85

    +

    Returns: object

    +
      +
    • +

      lastProbeTime: string

      +
      • +
    • +

      lastTransitionTime: string

      +
      • +
    • +

      message? : string

      +
      • +
    • +

      status: string

      +
      • +
    • +

      type: string

      +
      • +
    +
    +

    getDesiredCompletions#

    +

    ▸ getDesiredCompletions(): number

    +

    Defined in src/renderer/api/endpoints/job.api.ts:73

    +

    Returns: number

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getImages#

    +

    ▸ getImages(): string[]

    +

    Defined in src/renderer/api/endpoints/job.api.ts:95

    +

    Returns: string[]

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNodeSelectors#

    +

    ▸ getNodeSelectors(): string[]

    +

    Inherited from Deployment.getNodeSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Returns: string[]

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getParallelism#

    +

    ▸ getParallelism(): number

    +

    Defined in src/renderer/api/endpoints/job.api.ts:81

    +

    Returns: number

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getSelectors#

    +

    ▸ getSelectors(): string[]

    +

    Inherited from Pod.getSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Returns: string[]

    +
    +

    getTemplateLabels#

    +

    ▸ getTemplateLabels(): string[]

    +

    Inherited from Pod.getTemplateLabels

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Returns: string[]

    +
    +

    getTolerations#

    +

    ▸ getTolerations(): IToleration[]

    +

    Inherited from Deployment.getTolerations

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Returns: IToleration[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html new file mode 100644 index 0000000000..2e366f5851 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.jobstore/index.html @@ -0,0 +1,2148 @@ + + + + + + + + + + + + + + + + + + + + + + Class: JobStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: JobStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹Job›

    +

    ↳ JobStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new JobStore(): JobStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: JobStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹Job‹›› = jobApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:10

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): Job[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Job[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹Job›): Promise‹Job›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Job›

    +

    Returns: Promise‹Job›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹Job›): Promise‹Job›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Job›

    +

    Returns: Promise‹Job›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: Job): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemJob
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: Job[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsJob[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Job[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Job[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): Job[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Job[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): Job

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Job

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): Job

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Job

    +
    +

    getChildPods#

    +

    ▸ getChildPods(job: Job): Pod[]

    +

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:12

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    jobJob
    +

    Returns: Pod[]

    +
    +

    getJobsByOwner#

    +

    ▸ getJobsByOwner(cronJob: CronJob): Job‹›[]

    +

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:16

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    cronJobCronJob
    +

    Returns: Job‹›[]

    +
    +

    getStatuses#

    +

    ▸ getStatuses(jobs?: Job[]): object

    +

    Overrides KubeObjectStore.getStatuses

    +

    Defined in src/renderer/components/+workloads-jobs/job.store.ts:23

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    jobs?Job[]
    +

    Returns: object

    +
      +
    • +

      failed: number = 0

      +
      • +
    • +

      pending: number = 0

      +
      • +
    • +

      running: number = 0

      +
      • +
    • +

      succeeded: number = 0

      +
      • +
    +
    +

    isSelected#

    +

    ▸ isSelected(item: Job): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemJob
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: Job[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsJob[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹Job›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Job›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹Job›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Job›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹Job[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹Job[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: Job): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemJob
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: Job, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: Job

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: Job): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemJob
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: Job[], sorting?: function[], order?: "asc" | "desc"): Job[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsJob[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Job[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: Job): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemJob
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: Job[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsJob[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: Job): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemJob
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: Job, data: Partial‹Job›): Promise‹Job›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemJob
    dataPartial‹Job›
    +

    Returns: Promise‹Job›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: Job, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: Job

    +

    ▪ request: function

    +

    ▸ (): Promise‹Job›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html new file mode 100644 index 0000000000..7cbc3f4a18 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.kubeapi/index.html @@ -0,0 +1,1697 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeApi ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: KubeApi ‹T›#

    +

    Type parameters#

    +

    ▪ T: KubeObject

    +

    Hierarchy#

    +
      +
    • KubeApi
      • +
    +

    ↳ PodsApi

    +

    ↳ NodesApi

    +

    ↳ DeploymentApi

    +

    ↳ IngressApi

    +

    ↳ PersistentVolumeClaimsApi

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeApi(options: IKubeApiOptions‹T›): KubeApi

    +

    Defined in src/renderer/api/kube-api.ts:102

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹T›
    +

    Returns: KubeApi

    +

    Properties#

    +

    apiBase#

    +

    • apiBase: string

    +

    Defined in src/renderer/api/kube-api.ts:92

    +
    +

    apiGroup#

    +

    • apiGroup: string

    +

    Defined in src/renderer/api/kube-api.ts:94

    +
    +

    apiPrefix#

    +

    • apiPrefix: string

    +

    Defined in src/renderer/api/kube-api.ts:93

    +
    +

    apiResource#

    +

    • apiResource: string

    +

    Defined in src/renderer/api/kube-api.ts:97

    +
    +

    apiVersion#

    +

    • apiVersion: string

    +

    Defined in src/renderer/api/kube-api.ts:95

    +
    +

    Optional apiVersionPreferred#

    +

    • apiVersionPreferred? : string

    +

    Defined in src/renderer/api/kube-api.ts:96

    +
    +

    isNamespaced#

    +

    • isNamespaced: boolean

    +

    Defined in src/renderer/api/kube-api.ts:98

    +
    +

    kind#

    +

    • kind: string

    +

    Defined in src/renderer/api/kube-api.ts:91

    +
    +

    objectConstructor#

    +

    • objectConstructor: IKubeObjectConstructor‹T›

    +

    Defined in src/renderer/api/kube-api.ts:100

    +
    +

    Protected options#

    +

    • options: IKubeApiOptions‹T›

    +

    Defined in src/renderer/api/kube-api.ts:104

    +
    +

    Protected request#

    +

    • request: KubeJsonApi

    +

    Defined in src/renderer/api/kube-api.ts:101

    +
    +

    Protected resourceVersions#

    +

    • resourceVersions: Map‹string, string› = new Map()

    +

    Defined in src/renderer/api/kube-api.ts:102

    +
    +

    Static parseApi#

    +

    ▪ parseApi: parseKubeApi = parseKubeApi

    +

    Defined in src/renderer/api/kube-api.ts:83

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    • get apiVersionWithGroup(): string

    +

    Defined in src/renderer/api/kube-api.ts:132

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    ▸ checkPreferredVersion(): Promise‹void›

    +

    Defined in src/renderer/api/kube-api.ts:194

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    ▸ create(__namedParameters: object, data?: Partial‹T›): Promise‹T›

    +

    Defined in src/renderer/api/kube-api.ts:304

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional data: Partial‹T›

    +

    Returns: Promise‹T›

    +
    +

    delete#

    +

    ▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

    +

    Defined in src/renderer/api/kube-api.ts:331

    +

    Parameters:

    +

    ▪ __namedParameters: object

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Returns: Promise‹KubeJsonApiData›

    +
    +

    get#

    +

    ▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹T›

    +

    Defined in src/renderer/api/kube-api.ts:296

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹T›

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(namespace: string): string

    +

    Defined in src/renderer/api/kube-api.ts:227

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Returns: string

    +
    +

    getUrl#

    +

    ▸ getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    +

    Defined in src/renderer/api/kube-api.ts:235

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring""
    +

    ▪Optional query: Partial‹IKubeApiQueryParams›

    +

    Returns: string

    +
    +

    getWatchUrl#

    +

    ▸ getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    +

    Defined in src/renderer/api/kube-api.ts:338

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    queryIKubeApiQueryParams{}
    +

    Returns: string

    +
    +

    list#

    +

    ▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹T[]›

    +

    Defined in src/renderer/api/kube-api.ts:288

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    ▪Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹T[]›

    +
    +

    Protected normalizeQuery#

    +

    ▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Defined in src/renderer/api/kube-api.ts:247

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    queryPartial‹IKubeApiQueryParams›{}
    +

    Returns: object

    +
    +

    Protected parseResponse#

    +

    ▸ parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    +

    Defined in src/renderer/api/kube-api.ts:259

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList
    namespace?string
    +

    Returns: any

    +
    +

    refreshResourceVersion#

    +

    ▸ refreshResourceVersion(params?: object): Promise‹T[]›

    +

    Defined in src/renderer/api/kube-api.ts:231

    +

    Parameters:

    +

    ▪Optional params: object

    + + + + + + + + + + + + + +
    NameType
    namespacestring
    +

    Returns: Promise‹T[]›

    +
    +

    setResourceVersion#

    +

    ▸ setResourceVersion(namespace: string, newVersion: string): void

    +

    Defined in src/renderer/api/kube-api.ts:223

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    newVersionstring-
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(__namedParameters: object, data?: Partial‹T›): Promise‹T›

    +

    Defined in src/renderer/api/kube-api.ts:322

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional data: Partial‹T›

    +

    Returns: Promise‹T›

    +
    +

    watch#

    +

    ▸ watch(): function

    +

    Defined in src/renderer/api/kube-api.ts:346

    +

    Returns: function

    +

    ▸ (): void

    +
    +

    Static watchAll#

    +

    ▸ watchAll(...apis: KubeApi[]): (Anonymous function)

    +

    Defined in src/renderer/api/kube-api.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ...apisKubeApi[]
    +

    Returns: (Anonymous function)

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html new file mode 100644 index 0000000000..410691bc5c --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.kubeevent/index.html @@ -0,0 +1,1789 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeEvent - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: KubeEvent#

    +

    Hierarchy#

    + +

    ↳ KubeEvent

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeEvent(data: KubeJsonApiData): KubeEvent

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: KubeEvent

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    count#

    +

    • count: number

    +

    Defined in src/renderer/api/endpoints/events.api.ts:30

    +
    +

    eventTime#

    +

    • eventTime: null

    +

    Defined in src/renderer/api/endpoints/events.api.ts:32

    +
    +

    firstTimestamp#

    +

    • firstTimestamp: string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:28

    +
    +

    involvedObject#

    +

    • involvedObject: object

    +

    Defined in src/renderer/api/endpoints/events.api.ts:13

    +

    Type declaration:

    +
      +
    • +

      apiVersion: string

      +
      • +
    • +

      fieldPath: string

      +
      • +
    • +

      kind: string

      +
      • +
    • +

      name: string

      +
      • +
    • +

      namespace: string

      +
      • +
    • +

      resourceVersion: string

      +
      • +
    • +

      uid: string

      +
      • +
    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    lastTimestamp#

    +

    • lastTimestamp: string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:29

    +
    +

    message#

    +

    • message: string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:23

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    reason#

    +

    • reason: string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:22

    +
    +

    reportingComponent#

    +

    • reportingComponent: string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:33

    +
    +

    reportingInstance#

    +

    • reportingInstance: string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:34

    +
    +

    source#

    +

    • source: object

    +

    Defined in src/renderer/api/endpoints/events.api.ts:24

    +

    Type declaration:

    +
      +
    • +

      component: string

      +
      • +
    • +

      host: string

      +
      • +
    +
    +

    Optional status#

    +

    • status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:79

    +
    +

    type#

    +

    • type: string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:31

    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/api/v1/events"

    +

    Defined in src/renderer/api/endpoints/events.api.ts:11

    +
    +

    Static kind#

    +

    ▪ kind: string = "Event"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/events.api.ts:9

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/events.api.ts:10

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getFirstSeenTime#

    +

    ▸ getFirstSeenTime(): string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:46

    +

    Returns: string

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getLastSeenTime#

    +

    ▸ getLastSeenTime(): string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:52

    +

    Returns: string

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getSource#

    +

    ▸ getSource(): string

    +

    Defined in src/renderer/api/endpoints/events.api.ts:40

    +

    Returns: string

    +
    +

    isWarning#

    +

    ▸ isWarning(): boolean

    +

    Defined in src/renderer/api/endpoints/events.api.ts:36

    +

    Returns: boolean

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html new file mode 100644 index 0000000000..603b578c74 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.kubeobject/index.html @@ -0,0 +1,1553 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObject - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: KubeObject#

    +

    Hierarchy#

    +
      +
    • KubeObject
      • +
    +

    ↳ Node

    +

    ↳ CronJob

    +

    ↳ ConfigMap

    +

    ↳ Secret

    +

    ↳ ResourceQuota

    +

    ↳ HorizontalPodAutoscaler

    +

    ↳ PodDisruptionBudget

    +

    ↳ Service

    +

    ↳ Endpoint

    +

    ↳ Ingress

    +

    ↳ NetworkPolicy

    +

    ↳ PersistentVolume

    +

    ↳ PersistentVolumeClaim

    +

    ↳ StorageClass

    +

    ↳ Namespace

    +

    ↳ KubeEvent

    +

    ↳ ServiceAccount

    +

    ↳ Role

    +

    ↳ RoleBinding

    +

    ↳ CustomResourceDefinition

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeObject(data: KubeJsonApiData): KubeObject

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: KubeObject

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    Optional status#

    +

    • status? : any

    +

    Defined in src/renderer/api/kube-object.ts:79

    +
    +

    Static kind#

    +

    ▪ kind: string

    +

    Defined in src/renderer/api/kube-object.ts:47

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean

    +

    Defined in src/renderer/api/kube-object.ts:48

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html new file mode 100644 index 0000000000..946d292170 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.kubeobjectstore/index.html @@ -0,0 +1,2090 @@ + + + + + + + + + + + + + + + + + + + + + + Class: KubeObjectStore ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: KubeObjectStore ‹T›#

    +

    Type parameters#

    +

    ▪ T: KubeObject

    +

    Hierarchy#

    +
      +
    • ItemStore‹T›
      • +
    +

    ↳ KubeObjectStore

    +

    ↳ EventStore

    +

    ↳ PodsStore

    +

    ↳ NodesStore

    +

    ↳ DeploymentStore

    +

    ↳ DaemonSetStore

    +

    ↳ StatefulSetStore

    +

    ↳ JobStore

    +

    ↳ CronJobStore

    +

    ↳ ConfigMapsStore

    +

    ↳ SecretsStore

    +

    ↳ ReplicaSetStore

    +

    ↳ ResourceQuotasStore

    +

    ↳ HPAStore

    +

    ↳ PodDisruptionBudgetsStore

    +

    ↳ ServiceStore

    +

    ↳ EndpointStore

    +

    ↳ IngressStore

    +

    ↳ NetworkPolicyStore

    +

    ↳ PersistentVolumesStore

    +

    ↳ VolumeClaimStore

    +

    ↳ StorageClassStore

    +

    ↳ NamespaceStore

    +

    ↳ ServiceAccountsStore

    +

    ↳ RolesStore

    +

    ↳ RoleBindingsStore

    +

    ↳ CRDStore

    +

    ↳ CRDResourceStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new KubeObjectStore(): KubeObjectStore

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: KubeObjectStore

    +

    Properties#

    +

    Abstract api#

    +

    • api: KubeApi‹T›

    +

    Defined in src/renderer/kube-object.store.ts:13

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): T[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: T[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹T›): Promise‹T›

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹T›

    +

    Returns: Promise‹T›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹T›): Promise‹T›

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹T›

    +

    Returns: Promise‹T›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: T): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: T[]): T[]

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsT[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): T[]

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: T[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): T[]

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: T[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): T

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: T

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): T

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: T

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: T[]): Record‹string, number›

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsT[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: T): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: T[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsT[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹T›

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹T›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹T›

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹T[]›

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹T[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: T): Promise‹void›

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: T, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: T

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: T): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: T[], sorting?: function[], order?: "asc" | "desc"): T[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsT[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: T[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: T): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: T[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsT[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: T): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: T, data: Partial‹T›): Promise‹T›

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemT
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: T, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: T

    +

    ▪ request: function

    +

    ▸ (): Promise‹T›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html new file mode 100644 index 0000000000..7364fc5e0c --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.namespace/index.html @@ -0,0 +1,1589 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Namespace - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Namespace#

    +

    Hierarchy#

    + +

    ↳ Namespace

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Namespace(data: KubeJsonApiData): Namespace

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Namespace

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    Optional status#

    +

    • status? : object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:16

    +

    Type declaration:

    +
      +
    • phase: string
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/api/v1/namespaces"

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:14

    +
    +

    Static kind#

    +

    ▪ kind: string = "Namespace"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:12

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = false

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:13

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getStatus#

    +

    ▸ getStatus(): string

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:20

    +

    Returns: string

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html new file mode 100644 index 0000000000..0361b8db5a --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.namespacestore/index.html @@ -0,0 +1,2266 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NamespaceStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: NamespaceStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹Namespace›

    +

    ↳ NamespaceStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new NamespaceStore(): NamespaceStore

    +

    Overrides KubeObjectStore.constructor

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:21

    +

    Returns: NamespaceStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹Namespace‹›› = namespacesApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:12

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    contextNs#

    +

    • contextNs: IObservableArray‹string› = observable.array()

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:13

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +
    +

    Protected storage#

    +

    • storage: StorageHelper‹string[]› = createStorage("context_ns", this.contextNs)

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:15

    +

    Accessors#

    +

    initNamespaces#

    +

    • get initNamespaces(): string[]

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:17

    +

    Returns: string[]

    +
    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): Namespace[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Namespace[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹Namespace›): Promise‹Namespace›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Namespace›

    +

    Returns: Promise‹Namespace›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹Namespace›): Promise‹Namespace›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Namespace›

    +

    Returns: Promise‹Namespace›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: Namespace): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNamespace
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: Namespace[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsNamespace[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Namespace[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Namespace[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): Namespace[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Namespace[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): Namespace

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Namespace

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): Namespace

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Namespace

    +
    +

    getContextParams#

    +

    ▸ getContextParams(): Partial‹IQueryParams›

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:39

    +

    Returns: Partial‹IQueryParams›

    +
    +

    Protected getDummyNamespace#

    +

    ▸ getDummyNamespace(name: string): Namespace‹›

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    namestring
    +

    Returns: Namespace‹›

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: Namespace[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsNamespace[]
    +

    Returns: Record‹string, number›

    +
    +

    hasContext#

    +

    ▸ hasContext(namespace: string | string[]): boolean

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:91

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    namespacestring | string[]
    +

    Returns: boolean

    +
    +

    isSelected#

    +

    ▸ isSelected(item: Namespace): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNamespace
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: Namespace[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsNamespace[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹Namespace›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Namespace›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹Namespace›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Namespace›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(namespaces?: string[]): Promise‹Namespace‹›[]›

    +

    Overrides KubeObjectStore.loadItems

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:60

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    namespaces?string[]
    +

    Returns: Promise‹Namespace‹›[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: Namespace): Promise‹void›

    +

    Overrides KubeObjectStore.remove

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:108

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNamespace
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: Namespace, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: Namespace

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:103

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: Namespace): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNamespace
    +

    Returns: void

    +
    +

    setContext#

    +

    ▸ setContext(namespaces: string[]): void

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:87

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    namespacesstring[]
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: Namespace[], sorting?: function[], order?: "asc" | "desc"): Namespace[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsNamespace[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Namespace[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹Namespace‹››[]): (Anonymous function)

    +

    Overrides KubeObjectStore.subscribe

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹Namespace‹››[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleContext#

    +

    ▸ toggleContext(namespace: string): void

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:97

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    namespacestring
    +

    Returns: void

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: Namespace): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNamespace
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: Namespace[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsNamespace[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: Namespace): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNamespace
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: Namespace, data: Partial‹Namespace›): Promise‹Namespace›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemNamespace
    dataPartial‹Namespace›
    +

    Returns: Promise‹Namespace›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: Namespace, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: Namespace

    +

    ▪ request: function

    +

    ▸ (): Promise‹Namespace›

    +

    Returns: Promise‹T›

    +
    +

    Protected updateUrl#

    +

    ▸ updateUrl(namespaces: string[]): void

    +

    Defined in src/renderer/components/+namespaces/namespace.store.ts:56

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    namespacesstring[]
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html new file mode 100644 index 0000000000..15ed9cc619 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.networkpolicy/index.html @@ -0,0 +1,1631 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NetworkPolicy - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: NetworkPolicy#

    +

    Hierarchy#

    + +

    ↳ NetworkPolicy

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new NetworkPolicy(data: KubeJsonApiData): NetworkPolicy

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: NetworkPolicy

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    spec#

    +

    • spec: object

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:44

    +

    Type declaration:

    +
      +
    • +

      egress: IPolicyEgress[]

      +
      • +
    • +

      ingress: IPolicyIngress[]

      +
      • +
    • +

      podSelector(): object

      +
      • +
    • +

      matchLabels(): object

      +
        +
      • role: string
        • +
      +
      • +
    • +

      policyTypes: string[]

      +
      • +
    +
    +

    Optional status#

    +

    • status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:79

    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/apis/networking.k8s.io/v1/networkpolicies"

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:42

    +
    +

    Static kind#

    +

    ▪ kind: string = "NetworkPolicy"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:40

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:41

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getMatchLabels#

    +

    ▸ getMatchLabels(): string[]

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:56

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getTypes#

    +

    ▸ getTypes(): string[]

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:64

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html new file mode 100644 index 0000000000..c1796893b9 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.networkpolicystore/index.html @@ -0,0 +1,2078 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NetworkPolicyStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: NetworkPolicyStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹NetworkPolicy›

    +

    ↳ NetworkPolicyStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new NetworkPolicyStore(): NetworkPolicyStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: NetworkPolicyStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹NetworkPolicy‹›› = networkPolicyApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+network-policies/network-policy.store.ts:8

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: NetworkPolicy[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹NetworkPolicy›): Promise‹NetworkPolicy›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹NetworkPolicy›

    +

    Returns: Promise‹NetworkPolicy›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹NetworkPolicy›): Promise‹NetworkPolicy›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹NetworkPolicy›

    +

    Returns: Promise‹NetworkPolicy›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: NetworkPolicy): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: NetworkPolicy[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsNetworkPolicy[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: NetworkPolicy[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: NetworkPolicy[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): NetworkPolicy

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: NetworkPolicy

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): NetworkPolicy

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: NetworkPolicy

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: NetworkPolicy[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsNetworkPolicy[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: NetworkPolicy): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: NetworkPolicy[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsNetworkPolicy[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹NetworkPolicy›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹NetworkPolicy›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹NetworkPolicy›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹NetworkPolicy›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹NetworkPolicy[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹NetworkPolicy[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: NetworkPolicy): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: NetworkPolicy, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: NetworkPolicy

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: NetworkPolicy): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: NetworkPolicy[], sorting?: function[], order?: "asc" | "desc"): NetworkPolicy[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsNetworkPolicy[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: NetworkPolicy[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: NetworkPolicy): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: NetworkPolicy[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsNetworkPolicy[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: NetworkPolicy): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: NetworkPolicy, data: Partial‹NetworkPolicy›): Promise‹NetworkPolicy›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemNetworkPolicy
    dataPartial‹NetworkPolicy›
    +

    Returns: Promise‹NetworkPolicy›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: NetworkPolicy, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: NetworkPolicy

    +

    ▪ request: function

    +

    ▸ (): Promise‹NetworkPolicy›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.node/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.node/index.html new file mode 100644 index 0000000000..0d78bf80f0 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.node/index.html @@ -0,0 +1,1811 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Node - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Node#

    +

    Hierarchy#

    + +

    ↳ Node

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Node(data: KubeJsonApiData): Node

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Node

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    spec#

    +

    • spec: object

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:37

    +

    Type declaration:

    +
      +
    • +

      externalID: string

      +
      • +
    • +

      podCIDR: string

      +
      • +
    • +

      taints? : object[]

      +
      • +
    • +

      unschedulable? : boolean

      +
      • +
    +
    +

    status#

    +

    • status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:47

    +

    Type declaration:

    +
      +
    • +

      addresses: object[]

      +
      • +
    • +

      allocatable(): object

      +
      • +
    • +

      cpu: string

      +
      • +
    • +

      memory: string

      +
      • +
    • +

      pods: string

      +
      • +
    • +

      capacity(): object

      +
      • +
    • +

      cpu: string

      +
      • +
    • +

      memory: string

      +
      • +
    • +

      pods: string

      +
      • +
    • +

      conditions: object[]

      +
      • +
    • +

      images: object[]

      +
      • +
    • +

      nodeInfo(): object

      +
      • +
    • +

      architecture: string

      +
      • +
    • +

      bootID: string

      +
      • +
    • +

      containerRuntimeVersion: string

      +
      • +
    • +

      kernelVersion: string

      +
      • +
    • +

      kubeProxyVersion: string

      +
      • +
    • +

      kubeletVersion: string

      +
      • +
    • +

      machineID: string

      +
      • +
    • +

      operatingSystem: string

      +
      • +
    • +

      osImage: string

      +
      • +
    • +

      systemUUID: string

      +
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/api/v1/nodes"

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:35

    +
    +

    Static kind#

    +

    ▪ kind: string = "Node"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:33

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = false

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:34

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getActiveConditions#

    +

    ▸ getActiveConditions(): object[]

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:138

    +

    Returns: object[]

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getConditions#

    +

    ▸ getConditions(): object[]

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:128

    +

    Returns: object[]

    +
    +

    getCpuCapacity#

    +

    ▸ getCpuCapacity(): number

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:116

    +

    Returns: number

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getKubeletVersion#

    +

    ▸ getKubeletVersion(): string

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:150

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getMemoryCapacity#

    +

    ▸ getMemoryCapacity(): number

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:122

    +

    Returns: number

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNodeConditionText#

    +

    ▸ getNodeConditionText(): string

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:88

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOperatingSystem#

    +

    ▸ getOperatingSystem(): string

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:154

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getRoleLabels#

    +

    ▸ getRoleLabels(): string

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:104

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getTaints#

    +

    ▸ getTaints(): object[]

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:100

    +

    Returns: object[]

    +
    +

    getWarningConditions#

    +

    ▸ getWarningConditions(): object[]

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:142

    +

    Returns: object[]

    +
    +

    isUnschedulable#

    +

    ▸ isUnschedulable(): boolean

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:164

    +

    Returns: boolean

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html new file mode 100644 index 0000000000..f81b29188a --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.nodesapi/index.html @@ -0,0 +1,1727 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NodesApi - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: NodesApi#

    +

    Hierarchy#

    + +

    ↳ NodesApi

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new NodesApi(options: IKubeApiOptions‹Node›): NodesApi

    +

    Inherited from KubeApi.constructor

    +

    Defined in src/renderer/api/kube-api.ts:102

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹Node›
    +

    Returns: NodesApi

    +

    Properties#

    +

    apiBase#

    +

    • apiBase: string

    +

    Inherited from KubeApi.apiBase

    +

    Defined in src/renderer/api/kube-api.ts:92

    +
    +

    apiGroup#

    +

    • apiGroup: string

    +

    Inherited from KubeApi.apiGroup

    +

    Defined in src/renderer/api/kube-api.ts:94

    +
    +

    apiPrefix#

    +

    • apiPrefix: string

    +

    Inherited from KubeApi.apiPrefix

    +

    Defined in src/renderer/api/kube-api.ts:93

    +
    +

    apiResource#

    +

    • apiResource: string

    +

    Inherited from KubeApi.apiResource

    +

    Defined in src/renderer/api/kube-api.ts:97

    +
    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeApi.apiVersion

    +

    Defined in src/renderer/api/kube-api.ts:95

    +
    +

    Optional apiVersionPreferred#

    +

    • apiVersionPreferred? : string

    +

    Inherited from KubeApi.apiVersionPreferred

    +

    Defined in src/renderer/api/kube-api.ts:96

    +
    +

    isNamespaced#

    +

    • isNamespaced: boolean

    +

    Inherited from KubeApi.isNamespaced

    +

    Defined in src/renderer/api/kube-api.ts:98

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeApi.kind

    +

    Defined in src/renderer/api/kube-api.ts:91

    +
    +

    objectConstructor#

    +

    • objectConstructor: IKubeObjectConstructor‹Node›

    +

    Inherited from KubeApi.objectConstructor

    +

    Defined in src/renderer/api/kube-api.ts:100

    +
    +

    Protected options#

    +

    • options: IKubeApiOptions‹Node›

    +

    Inherited from KubeApi.options

    +

    Defined in src/renderer/api/kube-api.ts:104

    +
    +

    Protected request#

    +

    • request: KubeJsonApi

    +

    Inherited from KubeApi.request

    +

    Defined in src/renderer/api/kube-api.ts:101

    +
    +

    Protected resourceVersions#

    +

    • resourceVersions: Map‹string, string› = new Map()

    +

    Inherited from KubeApi.resourceVersions

    +

    Defined in src/renderer/api/kube-api.ts:102

    +
    +

    Static parseApi#

    +

    ▪ parseApi: parseKubeApi = parseKubeApi

    +

    Inherited from KubeApi.parseApi

    +

    Defined in src/renderer/api/kube-api.ts:83

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    • get apiVersionWithGroup(): string

    +

    Inherited from KubeApi.apiVersionWithGroup

    +

    Defined in src/renderer/api/kube-api.ts:132

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    ▸ checkPreferredVersion(): Promise‹void›

    +

    Inherited from KubeApi.checkPreferredVersion

    +

    Defined in src/renderer/api/kube-api.ts:194

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    ▸ create(__namedParameters: object, data?: Partial‹Node›): Promise‹Node›

    +

    Inherited from KubeApi.create

    +

    Defined in src/renderer/api/kube-api.ts:304

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional data: Partial‹Node›

    +

    Returns: Promise‹Node›

    +
    +

    delete#

    +

    ▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

    +

    Inherited from KubeApi.delete

    +

    Defined in src/renderer/api/kube-api.ts:331

    +

    Parameters:

    +

    ▪ __namedParameters: object

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Returns: Promise‹KubeJsonApiData›

    +
    +

    get#

    +

    ▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Node›

    +

    Inherited from KubeApi.get

    +

    Defined in src/renderer/api/kube-api.ts:296

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Node›

    +
    +

    getMetrics#

    +

    ▸ getMetrics(): Promise‹INodeMetrics›

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:7

    +

    Returns: Promise‹INodeMetrics›

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(namespace: string): string

    +

    Inherited from KubeApi.getResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:227

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Returns: string

    +
    +

    getUrl#

    +

    ▸ getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    +

    Inherited from KubeApi.getUrl

    +

    Defined in src/renderer/api/kube-api.ts:235

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring""
    +

    ▪Optional query: Partial‹IKubeApiQueryParams›

    +

    Returns: string

    +
    +

    getWatchUrl#

    +

    ▸ getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    +

    Inherited from KubeApi.getWatchUrl

    +

    Defined in src/renderer/api/kube-api.ts:338

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    queryIKubeApiQueryParams{}
    +

    Returns: string

    +
    +

    list#

    +

    ▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Node[]›

    +

    Inherited from KubeApi.list

    +

    Defined in src/renderer/api/kube-api.ts:288

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    ▪Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Node[]›

    +
    +

    Protected normalizeQuery#

    +

    ▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Inherited from KubeApi.normalizeQuery

    +

    Defined in src/renderer/api/kube-api.ts:247

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    queryPartial‹IKubeApiQueryParams›{}
    +

    Returns: object

    +
    +

    Protected parseResponse#

    +

    ▸ parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    +

    Inherited from KubeApi.parseResponse

    +

    Defined in src/renderer/api/kube-api.ts:259

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList
    namespace?string
    +

    Returns: any

    +
    +

    refreshResourceVersion#

    +

    ▸ refreshResourceVersion(params?: object): Promise‹T[]›

    +

    Inherited from KubeApi.refreshResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:231

    +

    Parameters:

    +

    ▪Optional params: object

    + + + + + + + + + + + + + +
    NameType
    namespacestring
    +

    Returns: Promise‹T[]›

    +
    +

    setResourceVersion#

    +

    ▸ setResourceVersion(namespace: string, newVersion: string): void

    +

    Inherited from KubeApi.setResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:223

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    newVersionstring-
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(__namedParameters: object, data?: Partial‹Node›): Promise‹Node›

    +

    Inherited from KubeApi.update

    +

    Defined in src/renderer/api/kube-api.ts:322

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional data: Partial‹Node›

    +

    Returns: Promise‹Node›

    +
    +

    watch#

    +

    ▸ watch(): function

    +

    Inherited from KubeApi.watch

    +

    Defined in src/renderer/api/kube-api.ts:346

    +

    Returns: function

    +

    ▸ (): void

    +
    +

    Static watchAll#

    +

    ▸ watchAll(...apis: KubeApi[]): (Anonymous function)

    +

    Inherited from KubeApi.watchAll

    +

    Defined in src/renderer/api/kube-api.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ...apisKubeApi[]
    +

    Returns: (Anonymous function)

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html new file mode 100644 index 0000000000..f5644b566e --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.nodesstore/index.html @@ -0,0 +1,2225 @@ + + + + + + + + + + + + + + + + + + + + + + Class: NodesStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: NodesStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹Node›

    +

    ↳ NodesStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new NodesStore(): NodesStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: NodesStore

    +

    Properties#

    +

    api#

    +

    • api: NodesApi‹› = nodesApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:9

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    metrics#

    +

    • metrics: Partial‹INodeMetrics›

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:11

    +
    +

    metricsLoaded#

    +

    • metricsLoaded: boolean = false

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:14

    +
    +

    metricsLoading#

    +

    • metricsLoading: boolean = false

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:13

    +
    +

    nodeMetrics#

    +

    • nodeMetrics: Partial‹IClusterMetrics› = null

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:12

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    masterNodes#

    +

    • get masterNodes(): Node‹›[]

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:33

    +

    Returns: Node‹›[]

    +
    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): Node[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Node[]

    +
    +

    workerNodes#

    +

    • get workerNodes(): Node‹›[]

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:37

    +

    Returns: Node‹›[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹Node›): Promise‹Node›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Node›

    +

    Returns: Promise‹Node›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹Node›): Promise‹Node›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Node›

    +

    Returns: Promise‹Node›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: Node): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNode
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: Node[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsNode[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Node[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Node[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): Node[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Node[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): Node

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Node

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): Node

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Node

    +
    +

    getLastMetricValues#

    +

    ▸ getLastMetricValues(node: Node, metricNames: string[]): number[]

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:41

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    nodeNode
    metricNamesstring[]
    +

    Returns: number[]

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: Node[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsNode[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: Node): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNode
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: Node[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsNode[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹Node›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Node›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹Node›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Node›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹Node[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹Node[]›

    +
    +

    loadMetrics#

    +

    ▸ loadMetrics(nodeName: string): Promise‹void›

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:29

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    nodeNamestring
    +

    Returns: Promise‹void›

    +
    +

    loadUsageMetrics#

    +

    ▸ loadUsageMetrics(): Promise‹void›

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:17

    +

    Returns: Promise‹void›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: Node): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNode
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: Node, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: Node

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+nodes/nodes.store.ts:65

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: Node): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNode
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: Node[], sorting?: function[], order?: "asc" | "desc"): Node[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsNode[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Node[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: Node): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNode
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: Node[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsNode[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: Node): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemNode
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: Node, data: Partial‹Node›): Promise‹Node›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemNode
    dataPartial‹Node›
    +

    Returns: Promise‹Node›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: Node, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: Node

    +

    ▪ request: function

    +

    ▸ (): Promise‹Node›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html new file mode 100644 index 0000000000..6271613c3a --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolume/index.html @@ -0,0 +1,1723 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolume - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PersistentVolume#

    +

    Hierarchy#

    + +

    ↳ PersistentVolume

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PersistentVolume(data: KubeJsonApiData): PersistentVolume

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: PersistentVolume

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    spec#

    +

    • spec: object

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:12

    +

    Type declaration:

    +
      +
    • +

      accessModes: string[]

      +
      • +
    • +

      capacity(): object

      +
      • +
    • +

      storage: string

      +
      • +
    • +

      claimRef(): object

      +
      • +
    • +

      apiVersion: string

      +
      • +
    • +

      kind: string

      +
      • +
    • +

      name: string

      +
      • +
    • +

      namespace: string

      +
      • +
    • +

      resourceVersion: string

      +
      • +
    • +

      uid: string

      +
      • +
    • +

      flexVolume(): object

      +
      • +
    • +

      driver: string

      +
      • +
    • +

      options(): object

      +
        +
      • +

        clusterNamespace: string

        +
        • +
      • +

        image: string

        +
        • +
      • +

        pool: string

        +
        • +
      • +

        storageClass: string

        +
        • +
      +
      • +
    • +

      mountOptions? : string[]

      +
      • +
    • +

      nfs(): object

      +
      • +
    • +

      path: string

      +
      • +
    • +

      server: string

      +
      • +
    • +

      persistentVolumeReclaimPolicy: string

      +
      • +
    • +

      storageClassName: string

      +
      • +
    +
    +

    status#

    +

    • status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:43

    +

    Type declaration:

    +
      +
    • +

      phase: string

      +
      • +
    • +

      reason? : string

      +
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/api/v1/persistentvolumes"

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:10

    +
    +

    Static kind#

    +

    ▪ kind: string = "PersistentVolume"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:8

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = false

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:9

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getCapacity#

    +

    ▸ getCapacity(inBytes: boolean): string | number

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:48

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    inBytesbooleanfalse
    +

    Returns: string | number

    +
    +

    getClaimRefName#

    +

    ▸ getClaimRefName(): string

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:66

    +

    Returns: string

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getStatus#

    +

    ▸ getStatus(): string

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:60

    +

    Returns: string

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html new file mode 100644 index 0000000000..4a05be951e --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaim/index.html @@ -0,0 +1,1698 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolumeClaim - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PersistentVolumeClaim#

    +

    Hierarchy#

    + +

    ↳ PersistentVolumeClaim

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PersistentVolumeClaim(data: KubeJsonApiData): PersistentVolumeClaim

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: PersistentVolumeClaim

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    spec#

    +

    • spec: object

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:30

    +

    Type declaration:

    +
      +
    • +

      accessModes: string[]

      +
      • +
    • +

      resources(): object

      +
      • +
    • +

      requests(): object

      +
        +
      • storage: string
        • +
      +
      • +
    • +

      selector(): object

      +
      • +
    • +

      matchExpressions: object[]

      +
      • +
    • +

      matchLabels(): object

      +
        +
      • release: string
        • +
      +
      • +
    • +

      storageClassName: string

      +
      • +
    +
    +

    status#

    +

    • status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:49

    +

    Type declaration:

    +
      +
    • phase: string
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/api/v1/persistentvolumeclaims"

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:28

    +
    +

    Static kind#

    +

    ▪ kind: string = "PersistentVolumeClaim"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:26

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:27

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getMatchExpressions#

    +

    ▸ getMatchExpressions(): object[]

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:77

    +

    Returns: object[]

    +
    +

    getMatchLabels#

    +

    ▸ getMatchLabels(): string[]

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:70

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getPods#

    +

    ▸ getPods(allPods: Pod[]): Pod[]

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allPodsPod[]
    +

    Returns: Pod[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getStatus#

    +

    ▸ getStatus(): string

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:83

    +

    Returns: string

    +
    +

    getStorage#

    +

    ▸ getStorage(): string

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:64

    +

    Returns: string

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html new file mode 100644 index 0000000000..c88acde22e --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumeclaimsapi/index.html @@ -0,0 +1,1746 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolumeClaimsApi - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PersistentVolumeClaimsApi#

    +

    Hierarchy#

    + +

    ↳ PersistentVolumeClaimsApi

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PersistentVolumeClaimsApi(options: IKubeApiOptions‹PersistentVolumeClaim›): PersistentVolumeClaimsApi

    +

    Inherited from KubeApi.constructor

    +

    Defined in src/renderer/api/kube-api.ts:102

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹PersistentVolumeClaim›
    +

    Returns: PersistentVolumeClaimsApi

    +

    Properties#

    +

    apiBase#

    +

    • apiBase: string

    +

    Inherited from KubeApi.apiBase

    +

    Defined in src/renderer/api/kube-api.ts:92

    +
    +

    apiGroup#

    +

    • apiGroup: string

    +

    Inherited from KubeApi.apiGroup

    +

    Defined in src/renderer/api/kube-api.ts:94

    +
    +

    apiPrefix#

    +

    • apiPrefix: string

    +

    Inherited from KubeApi.apiPrefix

    +

    Defined in src/renderer/api/kube-api.ts:93

    +
    +

    apiResource#

    +

    • apiResource: string

    +

    Inherited from KubeApi.apiResource

    +

    Defined in src/renderer/api/kube-api.ts:97

    +
    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeApi.apiVersion

    +

    Defined in src/renderer/api/kube-api.ts:95

    +
    +

    Optional apiVersionPreferred#

    +

    • apiVersionPreferred? : string

    +

    Inherited from KubeApi.apiVersionPreferred

    +

    Defined in src/renderer/api/kube-api.ts:96

    +
    +

    isNamespaced#

    +

    • isNamespaced: boolean

    +

    Inherited from KubeApi.isNamespaced

    +

    Defined in src/renderer/api/kube-api.ts:98

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeApi.kind

    +

    Defined in src/renderer/api/kube-api.ts:91

    +
    +

    objectConstructor#

    +

    • objectConstructor: IKubeObjectConstructor‹PersistentVolumeClaim›

    +

    Inherited from KubeApi.objectConstructor

    +

    Defined in src/renderer/api/kube-api.ts:100

    +
    +

    Protected options#

    +

    • options: IKubeApiOptions‹PersistentVolumeClaim›

    +

    Inherited from KubeApi.options

    +

    Defined in src/renderer/api/kube-api.ts:104

    +
    +

    Protected request#

    +

    • request: KubeJsonApi

    +

    Inherited from KubeApi.request

    +

    Defined in src/renderer/api/kube-api.ts:101

    +
    +

    Protected resourceVersions#

    +

    • resourceVersions: Map‹string, string› = new Map()

    +

    Inherited from KubeApi.resourceVersions

    +

    Defined in src/renderer/api/kube-api.ts:102

    +
    +

    Static parseApi#

    +

    ▪ parseApi: parseKubeApi = parseKubeApi

    +

    Inherited from KubeApi.parseApi

    +

    Defined in src/renderer/api/kube-api.ts:83

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    • get apiVersionWithGroup(): string

    +

    Inherited from KubeApi.apiVersionWithGroup

    +

    Defined in src/renderer/api/kube-api.ts:132

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    ▸ checkPreferredVersion(): Promise‹void›

    +

    Inherited from KubeApi.checkPreferredVersion

    +

    Defined in src/renderer/api/kube-api.ts:194

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    ▸ create(__namedParameters: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim›

    +

    Inherited from KubeApi.create

    +

    Defined in src/renderer/api/kube-api.ts:304

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional data: Partial‹PersistentVolumeClaim›

    +

    Returns: Promise‹PersistentVolumeClaim›

    +
    +

    delete#

    +

    ▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

    +

    Inherited from KubeApi.delete

    +

    Defined in src/renderer/api/kube-api.ts:331

    +

    Parameters:

    +

    ▪ __namedParameters: object

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Returns: Promise‹KubeJsonApiData›

    +
    +

    get#

    +

    ▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹PersistentVolumeClaim›

    +

    Inherited from KubeApi.get

    +

    Defined in src/renderer/api/kube-api.ts:296

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹PersistentVolumeClaim›

    +
    +

    getMetrics#

    +

    ▸ getMetrics(pvcName: string, namespace: string): Promise‹IPvcMetrics›

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:8

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    pvcNamestring
    namespacestring
    +

    Returns: Promise‹IPvcMetrics›

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(namespace: string): string

    +

    Inherited from KubeApi.getResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:227

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Returns: string

    +
    +

    getUrl#

    +

    ▸ getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    +

    Inherited from KubeApi.getUrl

    +

    Defined in src/renderer/api/kube-api.ts:235

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring""
    +

    ▪Optional query: Partial‹IKubeApiQueryParams›

    +

    Returns: string

    +
    +

    getWatchUrl#

    +

    ▸ getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    +

    Inherited from KubeApi.getWatchUrl

    +

    Defined in src/renderer/api/kube-api.ts:338

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    queryIKubeApiQueryParams{}
    +

    Returns: string

    +
    +

    list#

    +

    ▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹PersistentVolumeClaim[]›

    +

    Inherited from KubeApi.list

    +

    Defined in src/renderer/api/kube-api.ts:288

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    ▪Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹PersistentVolumeClaim[]›

    +
    +

    Protected normalizeQuery#

    +

    ▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Inherited from KubeApi.normalizeQuery

    +

    Defined in src/renderer/api/kube-api.ts:247

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    queryPartial‹IKubeApiQueryParams›{}
    +

    Returns: object

    +
    +

    Protected parseResponse#

    +

    ▸ parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    +

    Inherited from KubeApi.parseResponse

    +

    Defined in src/renderer/api/kube-api.ts:259

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList
    namespace?string
    +

    Returns: any

    +
    +

    refreshResourceVersion#

    +

    ▸ refreshResourceVersion(params?: object): Promise‹T[]›

    +

    Inherited from KubeApi.refreshResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:231

    +

    Parameters:

    +

    ▪Optional params: object

    + + + + + + + + + + + + + +
    NameType
    namespacestring
    +

    Returns: Promise‹T[]›

    +
    +

    setResourceVersion#

    +

    ▸ setResourceVersion(namespace: string, newVersion: string): void

    +

    Inherited from KubeApi.setResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:223

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    newVersionstring-
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(__namedParameters: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim›

    +

    Inherited from KubeApi.update

    +

    Defined in src/renderer/api/kube-api.ts:322

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional data: Partial‹PersistentVolumeClaim›

    +

    Returns: Promise‹PersistentVolumeClaim›

    +
    +

    watch#

    +

    ▸ watch(): function

    +

    Inherited from KubeApi.watch

    +

    Defined in src/renderer/api/kube-api.ts:346

    +

    Returns: function

    +

    ▸ (): void

    +
    +

    Static watchAll#

    +

    ▸ watchAll(...apis: KubeApi[]): (Anonymous function)

    +

    Inherited from KubeApi.watchAll

    +

    Defined in src/renderer/api/kube-api.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ...apisKubeApi[]
    +

    Returns: (Anonymous function)

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html new file mode 100644 index 0000000000..21176dce22 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.persistentvolumesstore/index.html @@ -0,0 +1,2078 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PersistentVolumesStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PersistentVolumesStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹PersistentVolume›

    +

    ↳ PersistentVolumesStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PersistentVolumesStore(): PersistentVolumesStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: PersistentVolumesStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹PersistentVolume‹›› = persistentVolumeApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+storage-volumes/volumes.store.ts:8

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): PersistentVolume[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: PersistentVolume[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹PersistentVolume›): Promise‹PersistentVolume›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹PersistentVolume›

    +

    Returns: Promise‹PersistentVolume›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹PersistentVolume›): Promise‹PersistentVolume›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹PersistentVolume›

    +

    Returns: Promise‹PersistentVolume›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: PersistentVolume): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: PersistentVolume[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPersistentVolume[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): PersistentVolume[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: PersistentVolume[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): PersistentVolume[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: PersistentVolume[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): PersistentVolume

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: PersistentVolume

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): PersistentVolume

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: PersistentVolume

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: PersistentVolume[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPersistentVolume[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: PersistentVolume): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: PersistentVolume[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPersistentVolume[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹PersistentVolume›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PersistentVolume›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹PersistentVolume›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PersistentVolume›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹PersistentVolume[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹PersistentVolume[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: PersistentVolume): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: PersistentVolume, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: PersistentVolume

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: PersistentVolume): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: PersistentVolume[], sorting?: function[], order?: "asc" | "desc"): PersistentVolume[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsPersistentVolume[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: PersistentVolume[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: PersistentVolume): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: PersistentVolume[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPersistentVolume[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: PersistentVolume): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: PersistentVolume, data: Partial‹PersistentVolume›): Promise‹PersistentVolume›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemPersistentVolume
    dataPartial‹PersistentVolume›
    +

    Returns: Promise‹PersistentVolume›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: PersistentVolume, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: PersistentVolume

    +

    ▪ request: function

    +

    ▸ (): Promise‹PersistentVolume›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html new file mode 100644 index 0000000000..80dec611b5 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.pod/index.html @@ -0,0 +1,2085 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Pod - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Pod#

    +

    Hierarchy#

    +
      +
    • WorkloadKubeObject
      • +
    +

    ↳ Pod

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Pod(data: KubeJsonApiData): Pod

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Pod

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    spec#

    +

    • spec: object

    +

    Overrides void

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:179

    +

    Type declaration:

    +
      +
    • +

      affinity: IAffinity

      +
      • +
    • +

      containers: IPodContainer[]

      +
      • +
    • +

      dnsPolicy: string

      +
      • +
    • +

      initContainers: IPodContainer[]

      +
      • +
    • +

      nodeName: string

      +
      • +
    • +

      nodeSelector(): object

      +
      • +
    • +

      priority: number

      +
      • +
    • +

      priorityClassName: string

      +
      • +
    • +

      restartPolicy: string

      +
      • +
    • +

      schedulerName: string

      +
      • +
    • +

      securityContext(): object

      +
      • +
    • +

      serviceAccount: string

      +
      • +
    • +

      serviceAccountName: string

      +
      • +
    • +

      terminationGracePeriodSeconds: number

      +
      • +
    • +

      tolerations: object[]

      +
      • +
    • +

      volumes? : object[]

      +
      • +
    +
    +

    status#

    +

    • status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:220

    +

    Type declaration:

    +
      +
    • +

      conditions: object[]

      +
      • +
    • +

      containerStatuses? : IPodContainerStatus[]

      +
      • +
    • +

      hostIP: string

      +
      • +
    • +

      initContainerStatuses? : IPodContainerStatus[]

      +
      • +
    • +

      phase: string

      +
      • +
    • +

      podIP: string

      +
      • +
    • +

      qosClass: string

      +
      • +
    • +

      reason? : string

      +
      • +
    • +

      startTime: string

      +
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/api/v1/pods"

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:177

    +
    +

    Static kind#

    +

    ▪ kind: string = "Pod"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:175

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:176

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAffinity#

    +

    ▸ getAffinity(): IAffinity

    +

    Overrides Deployment.getAffinity

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:380

    +

    Returns: IAffinity

    +
    +

    getAffinityNumber#

    +

    ▸ getAffinityNumber(): number

    +

    Inherited from Pod.getAffinityNumber

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Returns: number

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAllContainers#

    +

    ▸ getAllContainers(): IPodContainer[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:245

    +

    Returns: IPodContainer[]

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getConditions#

    +

    ▸ getConditions(): object[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:354

    +

    Returns: object[]

    +
    +

    getContainerStatuses#

    +

    ▸ getContainerStatuses(includeInitContainers: boolean): IPodContainerStatus[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:258

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    includeInitContainersbooleantrue
    +

    Returns: IPodContainerStatus[]

    +
    +

    getContainers#

    +

    ▸ getContainers(): IPodContainer[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:241

    +

    Returns: IPodContainer[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getInitContainers#

    +

    ▸ getInitContainers(): IPodContainer[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:237

    +

    Returns: IPodContainer[]

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getLivenessProbe#

    +

    ▸ getLivenessProbe(container: IPodContainer): string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:401

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    containerIPodContainer
    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNodeName#

    +

    ▸ getNodeName(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:447

    +

    Returns: string

    +
    +

    getNodeSelectors#

    +

    ▸ getNodeSelectors(): string[]

    +

    Overrides Deployment.getNodeSelectors

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:368

    +

    Returns: string[]

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getPriorityClassName#

    +

    ▸ getPriorityClassName(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:289

    +

    Returns: string

    +
    +

    getProbe#

    +

    ▸ getProbe(probeData: IContainerProbe): string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:409

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    probeDataIContainerProbe
    +

    Returns: string[]

    +
    +

    getQosClass#

    +

    ▸ getQosClass(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:281

    +

    Returns: string

    +
    +

    getReadinessProbe#

    +

    ▸ getReadinessProbe(container: IPodContainer): string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:405

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    containerIPodContainer
    +

    Returns: string[]

    +
    +

    getReason#

    +

    ▸ getReason(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:285

    +

    Returns: string

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getRestartsCount#

    +

    ▸ getRestartsCount(): number

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:273

    +

    Returns: number

    +
    +

    getRunningContainers#

    +

    ▸ getRunningContainers(): IPodContainer[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:249

    +

    Returns: IPodContainer[]

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getSecrets#

    +

    ▸ getSecrets(): string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:362

    +

    Returns: string[]

    +
    +

    getSelectedNodeOs#

    +

    ▸ getSelectedNodeOs(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:451

    +

    Returns: string

    +
    +

    getSelectors#

    +

    ▸ getSelectors(): string[]

    +

    Inherited from Pod.getSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Returns: string[]

    +
    +

    getStatus#

    +

    ▸ getStatus(): FAILED | PENDING | RUNNING | SUCCEEDED | EVICTED

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:294

    +

    Returns: FAILED | PENDING | RUNNING | SUCCEEDED | EVICTED

    +
    +

    getStatusMessage#

    +

    ▸ getStatusMessage(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:321

    +

    Returns: string

    +
    +

    getStatusPhase#

    +

    ▸ getStatusPhase(): string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:350

    +

    Returns: string

    +
    +

    getTemplateLabels#

    +

    ▸ getTemplateLabels(): string[]

    +

    Inherited from Pod.getTemplateLabels

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Returns: string[]

    +
    +

    getTolerations#

    +

    ▸ getTolerations(): object[]

    +

    Overrides Deployment.getTolerations

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:376

    +

    Returns: object[]

    +
    +

    getVolumes#

    +

    ▸ getVolumes(): object[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:358

    +

    Returns: object[]

    +
    +

    hasIssues#

    +

    ▸ hasIssues(): boolean

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:384

    +

    Returns: boolean

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html new file mode 100644 index 0000000000..616a666cc5 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudget/index.html @@ -0,0 +1,1679 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PodDisruptionBudget - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PodDisruptionBudget#

    +

    Hierarchy#

    + +

    ↳ PodDisruptionBudget

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PodDisruptionBudget(data: KubeJsonApiData): PodDisruptionBudget

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: PodDisruptionBudget

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    spec#

    +

    • spec: object

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:11

    +

    Type declaration:

    +
      +
    • +

      maxUnavailable: string

      +
      • +
    • +

      minAvailable: string

      +
      • +
    • +

      selector(): object

      +
      • +
    • +

      matchLabels(): object

      +
      • +
    +
    +

    status#

    +

    • status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:16

    +

    Type declaration:

    +
      +
    • +

      currentHealthy: number

      +
      • +
    • +

      desiredHealthy: number

      +
      • +
    • +

      disruptionsAllowed: number

      +
      • +
    • +

      expectedPods: number

      +
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/apis/policy/v1beta1/poddisruptionbudgets"

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:9

    +
    +

    Static kind#

    +

    ▪ kind: string = "PodDisruptionBudget"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:7

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:8

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getCurrentHealthy#

    +

    ▸ getCurrentHealthy(): number

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:37

    +

    Returns: number

    +
    +

    getDesiredHealthy#

    +

    ▸ getDesiredHealthy(): number

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:41

    +

    Returns: number

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getMaxUnavailable#

    +

    ▸ getMaxUnavailable(): string

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:33

    +

    Returns: string

    +
    +

    getMinAvailable#

    +

    ▸ getMinAvailable(): string

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:29

    +

    Returns: string

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getSelectors#

    +

    ▸ getSelectors(): string[]

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:23

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html new file mode 100644 index 0000000000..27da662d29 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.poddisruptionbudgetsstore/index.html @@ -0,0 +1,2078 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PodDisruptionBudgetsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PodDisruptionBudgetsStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹PodDisruptionBudget›

    +

    ↳ PodDisruptionBudgetsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PodDisruptionBudgetsStore(): PodDisruptionBudgetsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: PodDisruptionBudgetsStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹PodDisruptionBudget‹›› = pdbApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+config-pod-disruption-budgets/pod-disruption-budgets.store.ts:8

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): PodDisruptionBudget[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: PodDisruptionBudget[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹PodDisruptionBudget›

    +

    Returns: Promise‹PodDisruptionBudget›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹PodDisruptionBudget›

    +

    Returns: Promise‹PodDisruptionBudget›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: PodDisruptionBudget): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: PodDisruptionBudget[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPodDisruptionBudget[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): PodDisruptionBudget[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: PodDisruptionBudget[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): PodDisruptionBudget[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: PodDisruptionBudget[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): PodDisruptionBudget

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: PodDisruptionBudget

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): PodDisruptionBudget

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: PodDisruptionBudget

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: PodDisruptionBudget[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPodDisruptionBudget[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: PodDisruptionBudget): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: PodDisruptionBudget[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPodDisruptionBudget[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹PodDisruptionBudget›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PodDisruptionBudget›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹PodDisruptionBudget›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PodDisruptionBudget›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹PodDisruptionBudget[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹PodDisruptionBudget[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: PodDisruptionBudget): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: PodDisruptionBudget, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: PodDisruptionBudget

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: PodDisruptionBudget): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: PodDisruptionBudget[], sorting?: function[], order?: "asc" | "desc"): PodDisruptionBudget[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsPodDisruptionBudget[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: PodDisruptionBudget[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: PodDisruptionBudget): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: PodDisruptionBudget[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPodDisruptionBudget[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: PodDisruptionBudget): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: PodDisruptionBudget, data: Partial‹PodDisruptionBudget›): Promise‹PodDisruptionBudget›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemPodDisruptionBudget
    dataPartial‹PodDisruptionBudget›
    +

    Returns: Promise‹PodDisruptionBudget›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: PodDisruptionBudget, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: PodDisruptionBudget

    +

    ▪ request: function

    +

    ▸ (): Promise‹PodDisruptionBudget›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html new file mode 100644 index 0000000000..99c4f1444c --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.podsapi/index.html @@ -0,0 +1,1788 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PodsApi - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PodsApi#

    +

    Hierarchy#

    + +

    ↳ PodsApi

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PodsApi(options: IKubeApiOptions‹Pod›): PodsApi

    +

    Inherited from KubeApi.constructor

    +

    Defined in src/renderer/api/kube-api.ts:102

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    optionsIKubeApiOptions‹Pod›
    +

    Returns: PodsApi

    +

    Properties#

    +

    apiBase#

    +

    • apiBase: string

    +

    Inherited from KubeApi.apiBase

    +

    Defined in src/renderer/api/kube-api.ts:92

    +
    +

    apiGroup#

    +

    • apiGroup: string

    +

    Inherited from KubeApi.apiGroup

    +

    Defined in src/renderer/api/kube-api.ts:94

    +
    +

    apiPrefix#

    +

    • apiPrefix: string

    +

    Inherited from KubeApi.apiPrefix

    +

    Defined in src/renderer/api/kube-api.ts:93

    +
    +

    apiResource#

    +

    • apiResource: string

    +

    Inherited from KubeApi.apiResource

    +

    Defined in src/renderer/api/kube-api.ts:97

    +
    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeApi.apiVersion

    +

    Defined in src/renderer/api/kube-api.ts:95

    +
    +

    Optional apiVersionPreferred#

    +

    • apiVersionPreferred? : string

    +

    Inherited from KubeApi.apiVersionPreferred

    +

    Defined in src/renderer/api/kube-api.ts:96

    +
    +

    isNamespaced#

    +

    • isNamespaced: boolean

    +

    Inherited from KubeApi.isNamespaced

    +

    Defined in src/renderer/api/kube-api.ts:98

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeApi.kind

    +

    Defined in src/renderer/api/kube-api.ts:91

    +
    +

    objectConstructor#

    +

    • objectConstructor: IKubeObjectConstructor‹Pod›

    +

    Inherited from KubeApi.objectConstructor

    +

    Defined in src/renderer/api/kube-api.ts:100

    +
    +

    Protected options#

    +

    • options: IKubeApiOptions‹Pod›

    +

    Inherited from KubeApi.options

    +

    Defined in src/renderer/api/kube-api.ts:104

    +
    +

    Protected request#

    +

    • request: KubeJsonApi

    +

    Inherited from KubeApi.request

    +

    Defined in src/renderer/api/kube-api.ts:101

    +
    +

    Protected resourceVersions#

    +

    • resourceVersions: Map‹string, string› = new Map()

    +

    Inherited from KubeApi.resourceVersions

    +

    Defined in src/renderer/api/kube-api.ts:102

    +
    +

    Static parseApi#

    +

    ▪ parseApi: parseKubeApi = parseKubeApi

    +

    Inherited from KubeApi.parseApi

    +

    Defined in src/renderer/api/kube-api.ts:83

    +

    Accessors#

    +

    apiVersionWithGroup#

    +

    • get apiVersionWithGroup(): string

    +

    Inherited from KubeApi.apiVersionWithGroup

    +

    Defined in src/renderer/api/kube-api.ts:132

    +

    Returns: string

    +

    Methods#

    +

    Protected checkPreferredVersion#

    +

    ▸ checkPreferredVersion(): Promise‹void›

    +

    Inherited from KubeApi.checkPreferredVersion

    +

    Defined in src/renderer/api/kube-api.ts:194

    +

    Returns: Promise‹void›

    +
    +

    create#

    +

    ▸ create(__namedParameters: object, data?: Partial‹Pod›): Promise‹Pod›

    +

    Inherited from KubeApi.create

    +

    Defined in src/renderer/api/kube-api.ts:304

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional data: Partial‹Pod›

    +

    Returns: Promise‹Pod›

    +
    +

    delete#

    +

    ▸ delete(__namedParameters: object): Promise‹KubeJsonApiData›

    +

    Inherited from KubeApi.delete

    +

    Defined in src/renderer/api/kube-api.ts:331

    +

    Parameters:

    +

    ▪ __namedParameters: object

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    Returns: Promise‹KubeJsonApiData›

    +
    +

    get#

    +

    ▸ get(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Pod›

    +

    Inherited from KubeApi.get

    +

    Defined in src/renderer/api/kube-api.ts:296

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Pod›

    +
    +

    getLogs#

    +

    ▸ getLogs(params: object, query?: IPodLogsQuery): Promise‹string›

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:7

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespacestring
    +

    ▪Optional query: IPodLogsQuery

    +

    Returns: Promise‹string›

    +
    +

    getMetrics#

    +

    ▸ getMetrics(pods: Pod[], namespace: string, selector: string): Promise‹IPodMetrics›

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:13

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    podsPod[]-
    namespacestring-
    selectorstring"pod, namespace"
    +

    Returns: Promise‹IPodMetrics›

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(namespace: string): string

    +

    Inherited from KubeApi.getResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:227

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    Returns: string

    +
    +

    getUrl#

    +

    ▸ getUrl(__namedParameters: object, query?: Partial‹IKubeApiQueryParams›): string

    +

    Inherited from KubeApi.getUrl

    +

    Defined in src/renderer/api/kube-api.ts:235

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring""
    +

    ▪Optional query: Partial‹IKubeApiQueryParams›

    +

    Returns: string

    +
    +

    getWatchUrl#

    +

    ▸ getWatchUrl(namespace: string, query: IKubeApiQueryParams): string

    +

    Inherited from KubeApi.getWatchUrl

    +

    Defined in src/renderer/api/kube-api.ts:338

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    queryIKubeApiQueryParams{}
    +

    Returns: string

    +
    +

    list#

    +

    ▸ list(__namedParameters: object, query?: IKubeApiQueryParams): Promise‹Pod[]›

    +

    Inherited from KubeApi.list

    +

    Defined in src/renderer/api/kube-api.ts:288

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    +

    ▪Optional query: IKubeApiQueryParams

    +

    Returns: Promise‹Pod[]›

    +
    +

    Protected normalizeQuery#

    +

    ▸ normalizeQuery(query: Partial‹IKubeApiQueryParams›): object

    +

    Inherited from KubeApi.normalizeQuery

    +

    Defined in src/renderer/api/kube-api.ts:247

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    queryPartial‹IKubeApiQueryParams›{}
    +

    Returns: object

    +
    +

    Protected parseResponse#

    +

    ▸ parseResponse(data: KubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList, namespace?: string): any

    +

    Inherited from KubeApi.parseResponse

    +

    Defined in src/renderer/api/kube-api.ts:259

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData | KubeJsonApiData[] | KubeJsonApiDataList
    namespace?string
    +

    Returns: any

    +
    +

    refreshResourceVersion#

    +

    ▸ refreshResourceVersion(params?: object): Promise‹T[]›

    +

    Inherited from KubeApi.refreshResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:231

    +

    Parameters:

    +

    ▪Optional params: object

    + + + + + + + + + + + + + +
    NameType
    namespacestring
    +

    Returns: Promise‹T[]›

    +
    +

    setResourceVersion#

    +

    ▸ setResourceVersion(namespace: string, newVersion: string): void

    +

    Inherited from KubeApi.setResourceVersion

    +

    Defined in src/renderer/api/kube-api.ts:223

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring""
    newVersionstring-
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(__namedParameters: object, data?: Partial‹Pod›): Promise‹Pod›

    +

    Inherited from KubeApi.update

    +

    Defined in src/renderer/api/kube-api.ts:322

    +

    Parameters:

    +

    ▪Default value __namedParameters: object= {}

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namestring""
    namespacestring"default"
    +

    ▪Optional data: Partial‹Pod›

    +

    Returns: Promise‹Pod›

    +
    +

    watch#

    +

    ▸ watch(): function

    +

    Inherited from KubeApi.watch

    +

    Defined in src/renderer/api/kube-api.ts:346

    +

    Returns: function

    +

    ▸ (): void

    +
    +

    Static watchAll#

    +

    ▸ watchAll(...apis: KubeApi[]): (Anonymous function)

    +

    Inherited from KubeApi.watchAll

    +

    Defined in src/renderer/api/kube-api.ts:85

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ...apisKubeApi[]
    +

    Returns: (Anonymous function)

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html new file mode 100644 index 0000000000..7af2d78e32 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.podsstore/index.html @@ -0,0 +1,2278 @@ + + + + + + + + + + + + + + + + + + + + + + Class: PodsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: PodsStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹Pod›

    +

    ↳ PodsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new PodsStore(): PodsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: PodsStore

    +

    Properties#

    +

    api#

    +

    • api: PodsApi‹› = podsApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:11

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    kubeMetrics#

    +

    • kubeMetrics: IObservableArray‹PodMetrics‹›› = observable.array([])

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:14

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    metrics#

    +

    • metrics: IPodMetrics = null

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:13

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): Pod[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Pod[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹Pod›): Promise‹Pod›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Pod›

    +

    Returns: Promise‹Pod›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹Pod›): Promise‹Pod›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Pod›

    +

    Returns: Promise‹Pod›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: Pod): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPod
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: Pod[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPod[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Pod[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Pod[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): Pod[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Pod[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): Pod

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Pod

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): Pod

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Pod

    +
    +

    getPodKubeMetrics#

    +

    ▸ getPodKubeMetrics(pod: Pod): object

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    podPod
    +

    Returns: object

    +
      +
    • +

      cpu: number = 0

      +
      • +
    • +

      memory: number = 0

      +
      • +
    +
    +

    getPodsByNode#

    +

    ▸ getPodsByNode(node: string): Pod‹›[]

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:43

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    nodestring
    +

    Returns: Pod‹›[]

    +
    +

    getPodsByOwner#

    +

    ▸ getPodsByOwner(workload: WorkloadKubeObject): Pod[]

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    workloadWorkloadKubeObject
    +

    Returns: Pod[]

    +
    +

    getStatuses#

    +

    ▸ getStatuses(pods: Pod[]): Dictionary‹number›

    +

    Overrides KubeObjectStore.getStatuses

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:49

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    podsPod[]
    +

    Returns: Dictionary‹number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: Pod): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPod
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: Pod[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPod[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹Pod›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Pod›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadContainerMetrics#

    +

    ▸ loadContainerMetrics(pod: Pod): Promise‹IPodMetrics‹IMetrics››

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:21

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    podPod
    +

    Returns: Promise‹IPodMetrics‹IMetrics››

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹Pod›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Pod›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹Pod[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹Pod[]›

    +
    +

    loadKubeMetrics#

    +

    ▸ loadKubeMetrics(namespace?: string): Promise‹void›

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:25

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    namespace?string
    +

    Returns: Promise‹void›

    +
    +

    loadMetrics#

    +

    ▸ loadMetrics(pod: Pod): Promise‹void›

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:17

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    podPod
    +

    Returns: Promise‹void›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: Pod): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPod
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: Pod, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: Pod

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+workloads-pods/pods.store.ts:82

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: Pod): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPod
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: Pod[], sorting?: function[], order?: "asc" | "desc"): Pod[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsPod[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Pod[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: Pod): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPod
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: Pod[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPod[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: Pod): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPod
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: Pod, data: Partial‹Pod›): Promise‹Pod›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemPod
    dataPartial‹Pod›
    +

    Returns: Promise‹Pod›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: Pod, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: Pod

    +

    ▪ request: function

    +

    ▸ (): Promise‹Pod›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html new file mode 100644 index 0000000000..f1197d0ff6 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.replicaset/index.html @@ -0,0 +1,1747 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ReplicaSet - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ReplicaSet#

    +

    Hierarchy#

    +
      +
    • WorkloadKubeObject
      • +
    +

    ↳ ReplicaSet

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ReplicaSet(data: KubeJsonApiData): ReplicaSet

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: ReplicaSet

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    spec#

    +

    • spec: object

    +

    Overrides void

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:13

    +

    Type declaration:

    +
      +
    • +

      containers? : IPodContainer[]

      +
      • +
    • +

      dnsPolicy? : string

      +
      • +
    • +

      replicas? : number

      +
      • +
    • +

      restartPolicy? : string

      +
      • +
    • +

      schedulerName? : string

      +
      • +
    • +

      selector(): object

      +
      • +
    • +

      matchLabels(): object

      +
      • +
    • +

      template(): object

      +
      • +
    • +

      spec(): object

      +
        +
      • +

        affinity? : IAffinity

        +
        • +
      • +

        containers: IPodContainer[]

        +
        • +
      • +

        nodeSelector(): object

        +
        • +
      • +

        tolerations: object[]

        +
        • +
      +
      • +
    • +

      terminationGracePeriodSeconds? : number

      +
      • +
    +
    +

    status#

    +

    • status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:41

    +

    Type declaration:

    +
      +
    • +

      availableReplicas: number

      +
      • +
    • +

      fullyLabeledReplicas: number

      +
      • +
    • +

      observedGeneration: number

      +
      • +
    • +

      readyReplicas: number

      +
      • +
    • +

      replicas: number

      +
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/apis/apps/v1/replicasets"

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:11

    +
    +

    Static kind#

    +

    ▪ kind: string = "ReplicaSet"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:9

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:10

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAffinity#

    +

    ▸ getAffinity(): IAffinity

    +

    Inherited from Deployment.getAffinity

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Returns: IAffinity

    +
    +

    getAffinityNumber#

    +

    ▸ getAffinityNumber(): number

    +

    Inherited from Pod.getAffinityNumber

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Returns: number

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getImages#

    +

    ▸ getImages(): string[]

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:49

    +

    Returns: string[]

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNodeSelectors#

    +

    ▸ getNodeSelectors(): string[]

    +

    Inherited from Deployment.getNodeSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Returns: string[]

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getSelectors#

    +

    ▸ getSelectors(): string[]

    +

    Inherited from Pod.getSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Returns: string[]

    +
    +

    getTemplateLabels#

    +

    ▸ getTemplateLabels(): string[]

    +

    Inherited from Pod.getTemplateLabels

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Returns: string[]

    +
    +

    getTolerations#

    +

    ▸ getTolerations(): IToleration[]

    +

    Inherited from Deployment.getTolerations

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Returns: IToleration[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html new file mode 100644 index 0000000000..a96e35ac1c --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.replicasetstore/index.html @@ -0,0 +1,2174 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ReplicaSetStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ReplicaSetStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹ReplicaSet›

    +

    ↳ ReplicaSetStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ReplicaSetStore(): ReplicaSetStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: ReplicaSetStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹ReplicaSet‹›› = replicaSetApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:10

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    metrics#

    +

    • metrics: IPodMetrics = null

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:11

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): ReplicaSet[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: ReplicaSet[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹ReplicaSet›): Promise‹ReplicaSet›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹ReplicaSet›

    +

    Returns: Promise‹ReplicaSet›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹ReplicaSet›): Promise‹ReplicaSet›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹ReplicaSet›

    +

    Returns: Promise‹ReplicaSet›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: ReplicaSet): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: ReplicaSet[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsReplicaSet[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): ReplicaSet[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: ReplicaSet[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): ReplicaSet[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: ReplicaSet[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): ReplicaSet

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: ReplicaSet

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): ReplicaSet

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: ReplicaSet

    +
    +

    getChildPods#

    +

    ▸ getChildPods(replicaSet: ReplicaSet): Pod‹›[]

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:19

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    replicaSetReplicaSet
    +

    Returns: Pod‹›[]

    +
    +

    getReplicaSetsByOwner#

    +

    ▸ getReplicaSetsByOwner(deployment: Deployment): ReplicaSet‹›[]

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:23

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    deploymentDeployment
    +

    Returns: ReplicaSet‹›[]

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: ReplicaSet[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsReplicaSet[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: ReplicaSet): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: ReplicaSet[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsReplicaSet[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹ReplicaSet›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ReplicaSet›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹ReplicaSet›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ReplicaSet›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹ReplicaSet[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹ReplicaSet[]›

    +
    +

    loadMetrics#

    +

    ▸ loadMetrics(replicaSet: ReplicaSet): Promise‹void›

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:13

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    replicaSetReplicaSet
    +

    Returns: Promise‹void›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: ReplicaSet): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: ReplicaSet, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: ReplicaSet

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+workloads-replicasets/replicasets.store.ts:29

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: ReplicaSet): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: ReplicaSet[], sorting?: function[], order?: "asc" | "desc"): ReplicaSet[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsReplicaSet[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: ReplicaSet[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: ReplicaSet): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: ReplicaSet[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsReplicaSet[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: ReplicaSet): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: ReplicaSet, data: Partial‹ReplicaSet›): Promise‹ReplicaSet›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemReplicaSet
    dataPartial‹ReplicaSet›
    +

    Returns: Promise‹ReplicaSet›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: ReplicaSet, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: ReplicaSet

    +

    ▪ request: function

    +

    ▸ (): Promise‹ReplicaSet›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html new file mode 100644 index 0000000000..49c68c1e4e --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.resourcequota/index.html @@ -0,0 +1,1618 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ResourceQuota - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ResourceQuota#

    +

    Hierarchy#

    + +

    ↳ ResourceQuota

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ResourceQuota(data: KubeJsonApiData): ResourceQuota

    +

    Overrides KubeObject.constructor

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:36

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: ResourceQuota

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    spec#

    +

    • spec: object

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:43

    +

    Type declaration:

    +
      +
    • +

      hard: IResourceQuotaValues

      +
      • +
    • +

      scopeSelector(): object

      +
      • +
    • +

      matchExpressions: object[]

      +
      • +
    +
    +

    status#

    +

    • status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:54

    +

    Type declaration:

    +
      +
    • +

      hard: IResourceQuotaValues

      +
      • +
    • +

      used: IResourceQuotaValues

      +
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/api/v1/resourcequotas"

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:36

    +
    +

    Static kind#

    +

    ▪ kind: string = "ResourceQuota"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:34

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:35

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getScopeSelector#

    +

    ▸ getScopeSelector(): object[]

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:59

    +

    Returns: object[]

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html new file mode 100644 index 0000000000..bb88b8d502 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.resourcequotasstore/index.html @@ -0,0 +1,2078 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ResourceQuotasStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ResourceQuotasStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹ResourceQuota›

    +

    ↳ ResourceQuotasStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ResourceQuotasStore(): ResourceQuotasStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: ResourceQuotasStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹ResourceQuota‹›› = resourceQuotaApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+config-resource-quotas/resource-quotas.store.ts:8

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): ResourceQuota[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: ResourceQuota[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹ResourceQuota›): Promise‹ResourceQuota›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹ResourceQuota›

    +

    Returns: Promise‹ResourceQuota›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹ResourceQuota›): Promise‹ResourceQuota›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹ResourceQuota›

    +

    Returns: Promise‹ResourceQuota›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: ResourceQuota): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: ResourceQuota[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsResourceQuota[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): ResourceQuota[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: ResourceQuota[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): ResourceQuota[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: ResourceQuota[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): ResourceQuota

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: ResourceQuota

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): ResourceQuota

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: ResourceQuota

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: ResourceQuota[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsResourceQuota[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: ResourceQuota): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: ResourceQuota[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsResourceQuota[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹ResourceQuota›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ResourceQuota›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹ResourceQuota›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ResourceQuota›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹ResourceQuota[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹ResourceQuota[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: ResourceQuota): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: ResourceQuota, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: ResourceQuota

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: ResourceQuota): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: ResourceQuota[], sorting?: function[], order?: "asc" | "desc"): ResourceQuota[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsResourceQuota[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: ResourceQuota[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: ResourceQuota): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: ResourceQuota[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsResourceQuota[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: ResourceQuota): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: ResourceQuota, data: Partial‹ResourceQuota›): Promise‹ResourceQuota›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemResourceQuota
    dataPartial‹ResourceQuota›
    +

    Returns: Promise‹ResourceQuota›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: ResourceQuota, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: ResourceQuota

    +

    ▪ request: function

    +

    ▸ (): Promise‹ResourceQuota›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.role/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.role/index.html new file mode 100644 index 0000000000..3f7435023f --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.role/index.html @@ -0,0 +1,1598 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Role - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Role#

    +

    Hierarchy#

    + +

    ↳ Role

    +

    ↳ ClusterRole

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Role(data: KubeJsonApiData): Role

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Role

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    rules#

    +

    • rules: object[]

    +

    Defined in src/renderer/api/endpoints/role.api.ts:9

    +
    +

    Optional status#

    +

    • status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:79

    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/apis/rbac.authorization.k8s.io/v1/roles"

    +

    Defined in src/renderer/api/endpoints/role.api.ts:7

    +
    +

    Static kind#

    +

    ▪ kind: string = "Role"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/role.api.ts:5

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/role.api.ts:6

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getRules#

    +

    ▸ getRules(): object[]

    +

    Defined in src/renderer/api/endpoints/role.api.ts:16

    +

    Returns: object[]

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html new file mode 100644 index 0000000000..3e411232d4 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.rolebinding/index.html @@ -0,0 +1,1635 @@ + + + + + + + + + + + + + + + + + + + + + + Class: RoleBinding - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: RoleBinding#

    +

    Hierarchy#

    + +

    ↳ RoleBinding

    +

    ↳ ClusterRoleBinding

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new RoleBinding(data: KubeJsonApiData): RoleBinding

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: RoleBinding

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    roleRef#

    +

    • roleRef: object

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:19

    +

    Type declaration:

    +
      +
    • +

      apiGroup? : string

      +
      • +
    • +

      kind: string

      +
      • +
    • +

      name: string

      +
      • +
    +
    +

    Optional status#

    +

    • status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:79

    +
    +

    Optional subjects#

    +

    • subjects? : IRoleBindingSubject[]

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:18

    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/apis/rbac.authorization.k8s.io/v1/rolebindings"

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:16

    +
    +

    Static kind#

    +

    ▪ kind: string = "RoleBinding"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:14

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:15

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getSubjectNames#

    +

    ▸ getSubjectNames(): string

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:29

    +

    Returns: string

    +
    +

    getSubjects#

    +

    ▸ getSubjects(): IRoleBindingSubject[]

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:25

    +

    Returns: IRoleBindingSubject[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html new file mode 100644 index 0000000000..32a478705f --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.rolebindingsstore/index.html @@ -0,0 +1,2082 @@ + + + + + + + + + + + + + + + + + + + + + + Class: RoleBindingsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: RoleBindingsStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹RoleBinding›

    +

    ↳ RoleBindingsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new RoleBindingsStore(): RoleBindingsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: RoleBindingsStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹ClusterRoleBinding‹›› = clusterRoleBindingApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:10

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): RoleBinding[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: RoleBinding[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹RoleBinding›): Promise‹RoleBinding›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹RoleBinding›

    +

    Returns: Promise‹RoleBinding›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹RoleBinding›): Promise‹RoleBinding‹››

    +

    Overrides KubeObjectStore.createItem

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:40

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹RoleBinding›

    +

    Returns: Promise‹RoleBinding‹››

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: RoleBinding): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: RoleBinding[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsRoleBinding[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): RoleBinding[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: RoleBinding[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): RoleBinding[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: RoleBinding[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): RoleBinding

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: RoleBinding

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): RoleBinding

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: RoleBinding

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: RoleBinding[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsRoleBinding[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: RoleBinding): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: RoleBinding[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsRoleBinding[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹RoleBinding›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹RoleBinding›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹RoleBinding‹››

    +

    Overrides KubeObjectStore.loadItem

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:23

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹RoleBinding‹››

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(namespaces?: string[]): Promise‹RoleBinding‹›[]›

    +

    Overrides KubeObjectStore.loadItems

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:29

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    namespaces?string[]
    +

    Returns: Promise‹RoleBinding‹›[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: RoleBinding): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: RoleBinding, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: RoleBinding

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: RoleBinding): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: RoleBinding[]): RoleBinding‹›[]

    +

    Overrides KubeObjectStore.sortItems

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:16

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsRoleBinding[]
    +

    Returns: RoleBinding‹›[]

    +
    +

    subscribe#

    +

    ▸ subscribe(): (Anonymous function)

    +

    Overrides KubeObjectStore.subscribe

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:12

    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: RoleBinding): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: RoleBinding[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsRoleBinding[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: RoleBinding): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: RoleBinding, data: Partial‹RoleBinding›): Promise‹RoleBinding›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemRoleBinding
    dataPartial‹RoleBinding›
    +

    Returns: Promise‹RoleBinding›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: RoleBinding, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: RoleBinding

    +

    ▪ request: function

    +

    ▸ (): Promise‹RoleBinding›

    +

    Returns: Promise‹T›

    +
    +

    updateSubjects#

    +

    ▸ updateSubjects(params: object): Promise‹RoleBinding‹››

    +

    Defined in src/renderer/components/+user-management-roles-bindings/role-bindings.store.ts:48

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    addSubjects?IRoleBindingSubject[]
    removeSubjects?IRoleBindingSubject[]
    roleBindingRoleBinding
    +

    Returns: Promise‹RoleBinding‹››

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html new file mode 100644 index 0000000000..ec94587287 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.rolesstore/index.html @@ -0,0 +1,2045 @@ + + + + + + + + + + + + + + + + + + + + + + Class: RolesStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: RolesStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹Role›

    +

    ↳ RolesStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new RolesStore(): RolesStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: RolesStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹ClusterRole‹›› = clusterRoleApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:8

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): Role[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Role[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹Role›): Promise‹Role›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Role›

    +

    Returns: Promise‹Role›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹Role›): Promise‹Role‹››

    +

    Overrides KubeObjectStore.createItem

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:38

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Role›

    +

    Returns: Promise‹Role‹››

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: Role): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRole
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: Role[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsRole[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Role[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Role[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): Role[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Role[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): Role

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Role

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): Role

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Role

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: Role[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsRole[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: Role): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRole
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: Role[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsRole[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹Role›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Role›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹Role‹››

    +

    Overrides KubeObjectStore.loadItem

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:21

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Role‹››

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(namespaces?: string[]): Promise‹Role[]›

    +

    Overrides KubeObjectStore.loadItems

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:27

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    namespaces?string[]
    +

    Returns: Promise‹Role[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: Role): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRole
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: Role, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: Role

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: Role): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRole
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: Role[]): Role‹›[]

    +

    Overrides KubeObjectStore.sortItems

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsRole[]
    +

    Returns: Role‹›[]

    +
    +

    subscribe#

    +

    ▸ subscribe(): (Anonymous function)

    +

    Overrides KubeObjectStore.subscribe

    +

    Defined in src/renderer/components/+user-management-roles/roles.store.ts:10

    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: Role): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRole
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: Role[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsRole[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: Role): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemRole
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: Role, data: Partial‹Role›): Promise‹Role›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemRole
    dataPartial‹Role›
    +

    Returns: Promise‹Role›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: Role, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: Role

    +

    ▪ request: function

    +

    ▸ (): Promise‹Role›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html new file mode 100644 index 0000000000..a68a26ecd7 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.secret/index.html @@ -0,0 +1,1631 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Secret - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Secret#

    +

    Hierarchy#

    + +

    ↳ Secret

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Secret(data: KubeJsonApiData): Secret

    +

    Overrides KubeObject.constructor

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:32

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Secret

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    data#

    +

    • data: object

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:29

    +

    Type declaration:

    +
      +
    • +

      [ prop: string]: string

      +
      • +
    • +

      token? : string

      +
      • +
    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    Optional status#

    +

    • status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:79

    +
    +

    type#

    +

    • type: SecretType

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:28

    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/api/v1/secrets"

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:26

    +
    +

    Static kind#

    +

    ▪ kind: string = "Secret"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:24

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:25

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getKeys#

    +

    ▸ getKeys(): string[]

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:39

    +

    Returns: string[]

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getToken#

    +

    ▸ getToken(): string

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:43

    +

    Returns: string

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html new file mode 100644 index 0000000000..1896c6c69e --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.secretsstore/index.html @@ -0,0 +1,2078 @@ + + + + + + + + + + + + + + + + + + + + + + Class: SecretsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: SecretsStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹Secret›

    +

    ↳ SecretsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new SecretsStore(): SecretsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: SecretsStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹Secret‹›› = secretsApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+config-secrets/secrets.store.ts:8

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): Secret[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Secret[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹Secret›): Promise‹Secret›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Secret›

    +

    Returns: Promise‹Secret›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹Secret›): Promise‹Secret›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Secret›

    +

    Returns: Promise‹Secret›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: Secret): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemSecret
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: Secret[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsSecret[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Secret[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Secret[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): Secret[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Secret[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): Secret

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Secret

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): Secret

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Secret

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: Secret[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsSecret[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: Secret): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemSecret
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: Secret[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsSecret[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹Secret›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Secret›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹Secret›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Secret›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹Secret[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹Secret[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: Secret): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemSecret
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: Secret, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: Secret

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: Secret): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemSecret
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: Secret[], sorting?: function[], order?: "asc" | "desc"): Secret[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsSecret[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Secret[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: Secret): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemSecret
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: Secret[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsSecret[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: Secret): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemSecret
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: Secret, data: Partial‹Secret›): Promise‹Secret›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemSecret
    dataPartial‹Secret›
    +

    Returns: Promise‹Secret›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: Secret, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: Secret

    +

    ▪ request: function

    +

    ▸ (): Promise‹Secret›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.service/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.service/index.html new file mode 100644 index 0000000000..f726ea7a51 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.service/index.html @@ -0,0 +1,1727 @@ + + + + + + + + + + + + + + + + + + + + + + Class: Service - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: Service#

    +

    Hierarchy#

    + +

    ↳ Service

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new Service(data: KubeJsonApiData): Service

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: Service

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    spec#

    +

    • spec: object

    +

    Defined in src/renderer/api/endpoints/service.api.ts:38

    +

    Type declaration:

    +
      +
    • +

      clusterIP: string

      +
      • +
    • +

      externalIPs? : string[]

      +
      • +
    • +

      externalTrafficPolicy? : string

      +
      • +
    • +

      loadBalancerIP? : string

      +
      • +
    • +

      ports: ServicePort[]

      +
      • +
    • +

      selector(): object

      +
      • +
    • +

      sessionAffinity: string

      +
      • +
    • +

      type: string

      +
      • +
    +
    +

    status#

    +

    • status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/service.api.ts:49

    +

    Type declaration:

    +
      +
    • +

      loadBalancer(): object

      +
      • +
    • +

      ingress? : object[]

      +
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/api/v1/services"

    +

    Defined in src/renderer/api/endpoints/service.api.ts:36

    +
    +

    Static kind#

    +

    ▪ kind: string = "Service"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/service.api.ts:34

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/service.api.ts:35

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getClusterIp#

    +

    ▸ getClusterIp(): string

    +

    Defined in src/renderer/api/endpoints/service.api.ts:58

    +

    Returns: string

    +
    +

    getExternalIps#

    +

    ▸ getExternalIps(): string[]

    +

    Defined in src/renderer/api/endpoints/service.api.ts:62

    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getLoadBalancer#

    +

    ▸ getLoadBalancer(): object

    +

    Defined in src/renderer/api/endpoints/service.api.ts:88

    +

    Returns: object

    +
      +
    • ingress? : object[]
      • +
    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getPorts#

    +

    ▸ getPorts(): ServicePort[]

    +

    Defined in src/renderer/api/endpoints/service.api.ts:82

    +

    Returns: ServicePort[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getSelector#

    +

    ▸ getSelector(): string[]

    +

    Defined in src/renderer/api/endpoints/service.api.ts:76

    +

    Returns: string[]

    +
    +

    getStatus#

    +

    ▸ getStatus(): "Active" | "Pending"

    +

    Defined in src/renderer/api/endpoints/service.api.ts:96

    +

    Returns: "Active" | "Pending"

    +
    +

    getType#

    +

    ▸ getType(): string

    +

    Defined in src/renderer/api/endpoints/service.api.ts:72

    +

    Returns: string

    +
    +

    isActive#

    +

    ▸ isActive(): boolean

    +

    Defined in src/renderer/api/endpoints/service.api.ts:92

    +

    Returns: boolean

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html new file mode 100644 index 0000000000..040fbb5a5d --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.serviceaccount/index.html @@ -0,0 +1,1622 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ServiceAccount - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ServiceAccount#

    +

    Hierarchy#

    + +

    ↳ ServiceAccount

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ServiceAccount(data: KubeJsonApiData): ServiceAccount

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: ServiceAccount

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    Optional imagePullSecrets#

    +

    • imagePullSecrets? : object[]

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:14

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    Optional secrets#

    +

    • secrets? : object[]

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:11

    +
    +

    Optional status#

    +

    • status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:79

    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/api/v1/serviceaccounts"

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:9

    +
    +

    Static kind#

    +

    ▪ kind: string = "ServiceAccount"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:7

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:8

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getImagePullSecrets#

    +

    ▸ getImagePullSecrets(): object[]

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:22

    +

    Returns: object[]

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getSecrets#

    +

    ▸ getSecrets(): object[]

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:18

    +

    Returns: object[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html new file mode 100644 index 0000000000..a9badc2a2b --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.serviceaccountsstore/index.html @@ -0,0 +1,2076 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ServiceAccountsStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ServiceAccountsStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹ServiceAccount›

    +

    ↳ ServiceAccountsStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ServiceAccountsStore(): ServiceAccountsStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: ServiceAccountsStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹ServiceAccount‹›› = serviceAccountsApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:8

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): ServiceAccount[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: ServiceAccount[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹ServiceAccount›): Promise‹ServiceAccount›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹ServiceAccount›

    +

    Returns: Promise‹ServiceAccount›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object): Promise‹ServiceAccount‹››

    +

    Overrides KubeObjectStore.createItem

    +

    Defined in src/renderer/components/+user-management-service-accounts/service-accounts.store.ts:10

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ServiceAccount‹››

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: ServiceAccount): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: ServiceAccount[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsServiceAccount[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): ServiceAccount[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: ServiceAccount[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): ServiceAccount[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: ServiceAccount[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): ServiceAccount

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: ServiceAccount

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): ServiceAccount

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: ServiceAccount

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: ServiceAccount[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsServiceAccount[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: ServiceAccount): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: ServiceAccount[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsServiceAccount[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹ServiceAccount›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ServiceAccount›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹ServiceAccount›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹ServiceAccount›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹ServiceAccount[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹ServiceAccount[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: ServiceAccount): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: ServiceAccount, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: ServiceAccount

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: ServiceAccount): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: ServiceAccount[], sorting?: function[], order?: "asc" | "desc"): ServiceAccount[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsServiceAccount[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: ServiceAccount[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: ServiceAccount): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: ServiceAccount[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsServiceAccount[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: ServiceAccount): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: ServiceAccount, data: Partial‹ServiceAccount›): Promise‹ServiceAccount›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemServiceAccount
    dataPartial‹ServiceAccount›
    +

    Returns: Promise‹ServiceAccount›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: ServiceAccount, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: ServiceAccount

    +

    ▪ request: function

    +

    ▸ (): Promise‹ServiceAccount›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html new file mode 100644 index 0000000000..0ccde4a91c --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.servicestore/index.html @@ -0,0 +1,2078 @@ + + + + + + + + + + + + + + + + + + + + + + Class: ServiceStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: ServiceStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹Service›

    +

    ↳ ServiceStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new ServiceStore(): ServiceStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: ServiceStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹Service‹›› = serviceApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+network-services/services.store.ts:8

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): Service[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: Service[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹Service›): Promise‹Service›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Service›

    +

    Returns: Promise‹Service›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹Service›): Promise‹Service›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹Service›

    +

    Returns: Promise‹Service›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: Service): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemService
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: Service[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsService[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): Service[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: Service[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): Service[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: Service[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): Service

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Service

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): Service

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: Service

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: Service[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsService[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: Service): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemService
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: Service[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsService[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹Service›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Service›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹Service›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹Service›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹Service[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹Service[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: Service): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemService
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: Service, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: Service

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: Service): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemService
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: Service[], sorting?: function[], order?: "asc" | "desc"): Service[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsService[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: Service[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: Service): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemService
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: Service[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsService[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: Service): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemService
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: Service, data: Partial‹Service›): Promise‹Service›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemService
    dataPartial‹Service›
    +

    Returns: Promise‹Service›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: Service, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: Service

    +

    ▪ request: function

    +

    ▸ (): Promise‹Service›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html new file mode 100644 index 0000000000..07885334f9 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.statefulset/index.html @@ -0,0 +1,1768 @@ + + + + + + + + + + + + + + + + + + + + + + Class: StatefulSet - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: StatefulSet#

    +

    Hierarchy#

    +
      +
    • WorkloadKubeObject
      • +
    +

    ↳ StatefulSet

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new StatefulSet(data: KubeJsonApiData): StatefulSet

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: StatefulSet

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    spec#

    +

    • spec: object

    +

    Overrides void

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:36

    +

    Type declaration:

    +
      +
    • +

      replicas: number

      +
      • +
    • +

      selector(): object

      +
      • +
    • +

      matchLabels(): object

      +
      • +
    • +

      serviceName: string

      +
      • +
    • +

      template(): object

      +
      • +
    • +

      metadata(): object

      +
        +
      • +

        labels(): object

        +
        • +
      • +

        app: string

        +
        • +
      +
      • +
    • +

      spec(): object

      +
        +
      • +

        affinity? : IAffinity

        +
        • +
      • +

        containers: object[]

        +
        • +
      • +

        nodeSelector(): object

        +
        • +
      • +

        tolerations: object[]

        +
        • +
      +
      • +
    • +

      volumeClaimTemplates: object[]

      +
      • +
    +
    +

    status#

    +

    • status: object

    +

    Overrides KubeObject.status

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:89

    +

    Type declaration:

    +
      +
    • +

      collisionCount: number

      +
      • +
    • +

      currentReplicas: number

      +
      • +
    • +

      currentRevision: string

      +
      • +
    • +

      observedGeneration: number

      +
      • +
    • +

      readyReplicas: number

      +
      • +
    • +

      replicas: number

      +
      • +
    • +

      updateRevision: string

      +
      • +
    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/apis/apps/v1/statefulsets"

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:34

    +
    +

    Static kind#

    +

    ▪ kind: string = "StatefulSet"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:32

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = true

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:33

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAffinity#

    +

    ▸ getAffinity(): IAffinity

    +

    Inherited from Deployment.getAffinity

    +

    Defined in src/renderer/api/workload-kube-object.ts:74

    +

    Returns: IAffinity

    +
    +

    getAffinityNumber#

    +

    ▸ getAffinityNumber(): number

    +

    Inherited from Pod.getAffinityNumber

    +

    Defined in src/renderer/api/workload-kube-object.ts:78

    +

    Returns: number

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getImages#

    +

    ▸ getImages(): string[]

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:103

    +

    Returns: string[]

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNodeSelectors#

    +

    ▸ getNodeSelectors(): string[]

    +

    Inherited from Deployment.getNodeSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:58

    +

    Returns: string[]

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getReplicas#

    +

    ▸ getReplicas(): number

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:99

    +

    Returns: number

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getSelectors#

    +

    ▸ getSelectors(): string[]

    +

    Inherited from Pod.getSelectors

    +

    Defined in src/renderer/api/workload-kube-object.ts:52

    +

    Returns: string[]

    +
    +

    getTemplateLabels#

    +

    ▸ getTemplateLabels(): string[]

    +

    Inherited from Pod.getTemplateLabels

    +

    Defined in src/renderer/api/workload-kube-object.ts:64

    +

    Returns: string[]

    +
    +

    getTolerations#

    +

    ▸ getTolerations(): IToleration[]

    +

    Inherited from Deployment.getTolerations

    +

    Defined in src/renderer/api/workload-kube-object.ts:70

    +

    Returns: IToleration[]

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html new file mode 100644 index 0000000000..6defe0057b --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.statefulsetstore/index.html @@ -0,0 +1,2157 @@ + + + + + + + + + + + + + + + + + + + + + + Class: StatefulSetStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: StatefulSetStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹StatefulSet›

    +

    ↳ StatefulSetStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new StatefulSetStore(): StatefulSetStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: StatefulSetStore

    +

    Properties#

    +

    api#

    +

    • api: StatefulSetApi‹› = statefulSetApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:10

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    metrics#

    +

    • metrics: IPodMetrics = null

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:11

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): StatefulSet[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: StatefulSet[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹StatefulSet›): Promise‹StatefulSet›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹StatefulSet›

    +

    Returns: Promise‹StatefulSet›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹StatefulSet›): Promise‹StatefulSet›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹StatefulSet›

    +

    Returns: Promise‹StatefulSet›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: StatefulSet): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: StatefulSet[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsStatefulSet[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): StatefulSet[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: StatefulSet[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): StatefulSet[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: StatefulSet[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): StatefulSet

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: StatefulSet

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): StatefulSet

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: StatefulSet

    +
    +

    getChildPods#

    +

    ▸ getChildPods(statefulSet: StatefulSet): Pod‹›[]

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:19

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    statefulSetStatefulSet
    +

    Returns: Pod‹›[]

    +
    +

    getStatuses#

    +

    ▸ getStatuses(statefulSets: StatefulSet[]): object

    +

    Overrides KubeObjectStore.getStatuses

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:23

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    statefulSetsStatefulSet[]
    +

    Returns: object

    +
      +
    • +

      failed: number = 0

      +
      • +
    • +

      pending: number = 0

      +
      • +
    • +

      running: number = 0

      +
      • +
    +
    +

    isSelected#

    +

    ▸ isSelected(item: StatefulSet): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: StatefulSet[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsStatefulSet[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹StatefulSet›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹StatefulSet›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹StatefulSet›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹StatefulSet›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹StatefulSet[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹StatefulSet[]›

    +
    +

    loadMetrics#

    +

    ▸ loadMetrics(statefulSet: StatefulSet): Promise‹void›

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:13

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    statefulSetStatefulSet
    +

    Returns: Promise‹void›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: StatefulSet): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: StatefulSet, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: StatefulSet

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+workloads-statefulsets/statefulset.store.ts:43

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: StatefulSet): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: StatefulSet[], sorting?: function[], order?: "asc" | "desc"): StatefulSet[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsStatefulSet[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: StatefulSet[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: StatefulSet): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: StatefulSet[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsStatefulSet[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: StatefulSet): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: StatefulSet, data: Partial‹StatefulSet›): Promise‹StatefulSet›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemStatefulSet
    dataPartial‹StatefulSet›
    +

    Returns: Promise‹StatefulSet›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: StatefulSet, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: StatefulSet

    +

    ▪ request: function

    +

    ▸ (): Promise‹StatefulSet›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html new file mode 100644 index 0000000000..49950fbcba --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.storageclass/index.html @@ -0,0 +1,1675 @@ + + + + + + + + + + + + + + + + + + + + + + Class: StorageClass - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: StorageClass#

    +

    Hierarchy#

    + +

    ↳ StorageClass

    +

    Implements#

    +
      +
    • ItemObject
      • +
    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new StorageClass(data: KubeJsonApiData): StorageClass

    +

    Inherited from KubeObject.constructor

    +

    Defined in src/renderer/api/kube-object.ts:70

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataKubeJsonApiData
    +

    Returns: StorageClass

    +

    Properties#

    +

    apiVersion#

    +

    • apiVersion: string

    +

    Inherited from KubeObject.apiVersion

    +

    Defined in src/renderer/api/kube-object.ts:76

    +
    +

    kind#

    +

    • kind: string

    +

    Inherited from KubeObject.kind

    +

    Defined in src/renderer/api/kube-object.ts:77

    +
    +

    metadata#

    +

    • metadata: IKubeObjectMetadata

    +

    Inherited from KubeObject.metadata

    +

    Defined in src/renderer/api/kube-object.ts:78

    +
    +

    Optional mountOptions#

    +

    • mountOptions? : string[]

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:12

    +
    +

    parameters#

    +

    • parameters: object

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:15

    +

    Type declaration:

    +
      +
    • [ param: string]: string
      • +
    +
    +

    provisioner#

    +

    • provisioner: string

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:11

    +
    +

    reclaimPolicy#

    +

    • reclaimPolicy: string

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:14

    +
    +

    Optional status#

    +

    • status? : any

    +

    Inherited from KubeObject.status

    +

    Defined in src/renderer/api/kube-object.ts:79

    +
    +

    volumeBindingMode#

    +

    • volumeBindingMode: string

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:13

    +
    +

    Static apiBase#

    +

    ▪ apiBase: string = "/apis/storage.k8s.io/v1/storageclasses"

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:9

    +
    +

    Static kind#

    +

    ▪ kind: string = "StorageClass"

    +

    Overrides KubeObject.kind

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:7

    +
    +

    Static namespaced#

    +

    ▪ namespaced: boolean = false

    +

    Overrides KubeObject.namespaced

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:8

    +

    Accessors#

    + +

    • get selfLink(): string

    +

    Inherited from KubeObject.selfLink

    +

    Defined in src/renderer/api/kube-object.ts:81

    +

    Returns: string

    +

    Methods#

    +

    delete#

    +

    ▸ delete(params?: JsonApiParams): CancelablePromise‹KubeJsonApiData›

    +

    Inherited from KubeObject.delete

    +

    Defined in src/renderer/api/kube-object.ts:167

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    params?JsonApiParams
    +

    Returns: CancelablePromise‹KubeJsonApiData›

    +
    +

    getAge#

    +

    ▸ getAge(humanize: boolean, compact: boolean, fromNow: boolean): string | number

    +

    Inherited from KubeObject.getAge

    +

    Defined in src/renderer/api/kube-object.ts:103

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    humanizebooleantrue
    compactbooleantrue
    fromNowbooleanfalse
    +

    Returns: string | number

    +
    +

    getAnnotations#

    +

    ▸ getAnnotations(filter: boolean): string[]

    +

    Inherited from KubeObject.getAnnotations

    +

    Defined in src/renderer/api/kube-object.ts:124

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    filterbooleanfalse
    +

    Returns: string[]

    +
    +

    getFinalizers#

    +

    ▸ getFinalizers(): string[]

    +

    Inherited from KubeObject.getFinalizers

    +

    Defined in src/renderer/api/kube-object.ts:116

    +

    Returns: string[]

    +
    +

    getId#

    +

    ▸ getId(): string

    +

    Inherited from KubeObject.getId

    +

    Defined in src/renderer/api/kube-object.ts:85

    +

    Returns: string

    +
    +

    getLabels#

    +

    ▸ getLabels(): string[]

    +

    Inherited from KubeObject.getLabels

    +

    Defined in src/renderer/api/kube-object.ts:120

    +

    Returns: string[]

    +
    +

    getName#

    +

    ▸ getName(): string

    +

    Inherited from KubeObject.getName

    +

    Defined in src/renderer/api/kube-object.ts:93

    +

    Returns: string

    +
    +

    getNs#

    +

    ▸ getNs(): string

    +

    Inherited from KubeObject.getNs

    +

    Defined in src/renderer/api/kube-object.ts:97

    +

    Returns: string

    +
    +

    getOwnerRefs#

    +

    ▸ getOwnerRefs(): object[]

    +

    Inherited from KubeObject.getOwnerRefs

    +

    Defined in src/renderer/api/kube-object.ts:134

    +

    Returns: object[]

    +
    +

    getReclaimPolicy#

    +

    ▸ getReclaimPolicy(): string

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:32

    +

    Returns: string

    +
    +

    getResourceVersion#

    +

    ▸ getResourceVersion(): string

    +

    Inherited from KubeObject.getResourceVersion

    +

    Defined in src/renderer/api/kube-object.ts:89

    +

    Returns: string

    +
    +

    getSearchFields#

    +

    ▸ getSearchFields(): string[]

    +

    Inherited from KubeObject.getSearchFields

    +

    Defined in src/renderer/api/kube-object.ts:143

    +

    Returns: string[]

    +
    +

    getVolumeBindingMode#

    +

    ▸ getVolumeBindingMode(): string

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:28

    +

    Returns: string

    +
    +

    isDefault#

    +

    ▸ isDefault(): boolean

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:19

    +

    Returns: boolean

    +
    +

    toPlainObject#

    +

    ▸ toPlainObject(): object

    +

    Inherited from KubeObject.toPlainObject

    +

    Defined in src/renderer/api/kube-object.ts:155

    +

    Returns: object

    +
    +

    update#

    +

    ▸ update‹T›(data: Partial‹T›): Promise‹T›

    +

    Inherited from KubeObject.update

    +

    Defined in src/renderer/api/kube-object.ts:160

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataPartial‹T›
    +

    Returns: Promise‹T›

    +
    +

    Static create#

    +

    ▸ create(data: any): KubeObject‹›

    +

    Inherited from KubeObject.create

    +

    Defined in src/renderer/api/kube-object.ts:50

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataany
    +

    Returns: KubeObject‹›

    +
    +

    Static isJsonApiData#

    +

    ▸ isJsonApiData(object: any): object is KubeJsonApiData

    +

    Inherited from KubeObject.isJsonApiData

    +

    Defined in src/renderer/api/kube-object.ts:58

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiData

    +
    +

    Static isJsonApiDataList#

    +

    ▸ isJsonApiDataList(object: any): object is KubeJsonApiDataList

    +

    Inherited from KubeObject.isJsonApiDataList

    +

    Defined in src/renderer/api/kube-object.ts:62

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectany
    +

    Returns: object is KubeJsonApiDataList

    +
    +

    Static isNonSystem#

    +

    ▸ isNonSystem(item: KubeJsonApiData | KubeObject): boolean

    +

    Inherited from KubeObject.isNonSystem

    +

    Defined in src/renderer/api/kube-object.ts:54

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemKubeJsonApiData | KubeObject
    +

    Returns: boolean

    +
    +

    Static stringifyLabels#

    +

    ▸ stringifyLabels(labels: object): string[]

    +

    Inherited from KubeObject.stringifyLabels

    +

    Defined in src/renderer/api/kube-object.ts:66

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsobject
    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html new file mode 100644 index 0000000000..60f22da3f0 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.storageclassstore/index.html @@ -0,0 +1,2078 @@ + + + + + + + + + + + + + + + + + + + + + + Class: StorageClassStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: StorageClassStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹StorageClass›

    +

    ↳ StorageClassStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new StorageClassStore(): StorageClassStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: StorageClassStore

    +

    Properties#

    +

    api#

    +

    • api: KubeApi‹StorageClass‹›› = storageClassApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+storage-classes/storage-class.store.ts:8

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): StorageClass[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: StorageClass[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹StorageClass›): Promise‹StorageClass›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹StorageClass›

    +

    Returns: Promise‹StorageClass›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹StorageClass›): Promise‹StorageClass›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹StorageClass›

    +

    Returns: Promise‹StorageClass›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: StorageClass): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: StorageClass[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsStorageClass[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): StorageClass[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: StorageClass[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): StorageClass[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: StorageClass[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): StorageClass

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: StorageClass

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): StorageClass

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: StorageClass

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: StorageClass[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsStorageClass[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: StorageClass): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: StorageClass[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsStorageClass[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹StorageClass›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹StorageClass›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹StorageClass›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹StorageClass›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹StorageClass[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹StorageClass[]›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: StorageClass): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: StorageClass, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: StorageClass

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Inherited from KubeObjectStore.reset

    +

    Defined in src/renderer/item.store.ts:163

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: StorageClass): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: StorageClass[], sorting?: function[], order?: "asc" | "desc"): StorageClass[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsStorageClass[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: StorageClass[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: StorageClass): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: StorageClass[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsStorageClass[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: StorageClass): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: StorageClass, data: Partial‹StorageClass›): Promise‹StorageClass›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemStorageClass
    dataPartial‹StorageClass›
    +

    Returns: Promise‹StorageClass›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: StorageClass, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: StorageClass

    +

    ▪ request: function

    +

    ▸ (): Promise‹StorageClass›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html new file mode 100644 index 0000000000..3f41c2f1d7 --- /dev/null +++ b/v4.0.1/extensions/api/classes/_renderer_api_k8s_api_.volumeclaimstore/index.html @@ -0,0 +1,2118 @@ + + + + + + + + + + + + + + + + + + + + + + Class: VolumeClaimStore - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: VolumeClaimStore#

    +

    Hierarchy#

    +

    ↳ KubeObjectStore‹PersistentVolumeClaim›

    +

    ↳ VolumeClaimStore

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new VolumeClaimStore(): VolumeClaimStore

    +

    Inherited from KubeObjectStore.constructor

    +

    Defined in src/renderer/kube-object.store.ts:15

    +

    Returns: VolumeClaimStore

    +

    Properties#

    +

    api#

    +

    • api: PersistentVolumeClaimsApi‹› = pvcApi

    +

    Overrides KubeObjectStore.api

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:9

    +
    +

    bufferSize#

    +

    • bufferSize: number = 50000

    +

    Inherited from KubeObjectStore.bufferSize

    +

    Defined in src/renderer/kube-object.store.ts:15

    +
    +

    Protected eventsBuffer#

    +

    • eventsBuffer: IObservableArray‹IKubeWatchEvent‹KubeJsonApiData›› = observable>([], { deep: false })

    +

    Inherited from KubeObjectStore.eventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:172

    +
    +

    isLoaded#

    +

    • isLoaded: boolean = false

    +

    Inherited from KubeObjectStore.isLoaded

    +

    Defined in src/renderer/item.store.ts:17

    +
    +

    isLoading#

    +

    • isLoading: boolean = false

    +

    Inherited from KubeObjectStore.isLoading

    +

    Defined in src/renderer/item.store.ts:16

    +
    +

    items#

    +

    • items: IObservableArray‹T› = observable.array([], { deep: false })

    +

    Inherited from KubeObjectStore.items

    +

    Defined in src/renderer/item.store.ts:18

    +
    +

    Optional limit#

    +

    • limit? : number

    +

    Inherited from KubeObjectStore.limit

    +

    Defined in src/renderer/kube-object.store.ts:14

    +
    +

    metrics#

    +

    • metrics: IPvcMetrics = null

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:10

    +
    +

    selectedItemsIds#

    +

    • selectedItemsIds: ObservableMap‹string, boolean› = observable.map()

    +

    Inherited from KubeObjectStore.selectedItemsIds

    +

    Defined in src/renderer/item.store.ts:19

    +

    Accessors#

    +

    query#

    +

    • get query(): IKubeApiQueryParams

    +

    Inherited from KubeObjectStore.query

    +

    Defined in src/renderer/kube-object.store.ts:23

    +

    Returns: IKubeApiQueryParams

    +
    +

    selectedItems#

    +

    • get selectedItems(): PersistentVolumeClaim[]

    +

    Inherited from KubeObjectStore.selectedItems

    +

    Defined in src/renderer/item.store.ts:21

    +

    Returns: PersistentVolumeClaim[]

    +

    Methods#

    +

    [Symbol.iterator]#

    +

    ▸ [Symbol.iterator](): Generator‹T, void, undefined›

    +

    Inherited from KubeObjectStore.[Symbol.iterator]

    +

    Defined in src/renderer/item.store.ts:178

    +

    Returns: Generator‹T, void, undefined›

    +
    +

    Protected bindWatchEventsUpdater#

    +

    ▸ bindWatchEventsUpdater(delay: number): IReactionDisposer

    +

    Inherited from KubeObjectStore.bindWatchEventsUpdater

    +

    Defined in src/renderer/kube-object.store.ts:174

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    delaynumber1000
    +

    Returns: IReactionDisposer

    +
    +

    create#

    +

    ▸ create(params: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim›

    +

    Inherited from KubeObjectStore.create

    +

    Defined in src/renderer/kube-object.store.ts:143

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹PersistentVolumeClaim›

    +

    Returns: Promise‹PersistentVolumeClaim›

    +
    +

    Protected createItem#

    +

    ▸ createItem(params: object, data?: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim›

    +

    Inherited from KubeObjectStore.createItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:139

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    ▪Optional data: Partial‹PersistentVolumeClaim›

    +

    Returns: Promise‹PersistentVolumeClaim›

    +
    +

    Protected defaultSorting#

    +

    ▸ defaultSorting(item: PersistentVolumeClaim): string

    +

    Inherited from KubeObjectStore.defaultSorting

    +

    Defined in src/renderer/item.store.ts:14

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    +

    Returns: string

    +
    +

    Protected filterItemsOnLoad#

    +

    ▸ filterItemsOnLoad(items: PersistentVolumeClaim[]): T[]

    +

    Inherited from KubeObjectStore.filterItemsOnLoad

    +

    Defined in src/renderer/kube-object.store.ts:84

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPersistentVolumeClaim[]
    +

    Returns: T[]

    +
    +

    getAllByNs#

    +

    ▸ getAllByNs(namespace: string | string[], strict: boolean): PersistentVolumeClaim[]

    +

    Inherited from KubeObjectStore.getAllByNs

    +

    Defined in src/renderer/kube-object.store.ts:35

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    namespacestring | string[]-
    strictbooleanfalse
    +

    Returns: PersistentVolumeClaim[]

    +
    +

    getByLabel#

    +

    ▸ getByLabel(labels: string[] | object): PersistentVolumeClaim[]

    +

    Inherited from KubeObjectStore.getByLabel

    +

    Defined in src/renderer/kube-object.store.ts:57

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    labelsstring[] | object
    +

    Returns: PersistentVolumeClaim[]

    +
    +

    getByName#

    +

    ▸ getByName(name: string, namespace?: string): PersistentVolumeClaim

    +

    Inherited from KubeObjectStore.getByName

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:45

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: PersistentVolumeClaim

    +
    +

    getByPath#

    +

    ▸ getByPath(path: string): PersistentVolumeClaim

    +

    Inherited from KubeObjectStore.getByPath

    +

    Defined in src/renderer/kube-object.store.ts:53

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pathstring
    +

    Returns: PersistentVolumeClaim

    +
    +

    Optional getStatuses#

    +

    ▸ getStatuses(items: PersistentVolumeClaim[]): Record‹string, number›

    +

    Inherited from KubeObjectStore.getStatuses

    +

    Defined in src/renderer/kube-object.store.ts:33

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemsPersistentVolumeClaim[]
    +

    Returns: Record‹string, number›

    +
    +

    isSelected#

    +

    ▸ isSelected(item: PersistentVolumeClaim): boolean

    +

    Inherited from KubeObjectStore.isSelected

    +

    Defined in src/renderer/item.store.ts:115

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    +

    Returns: boolean

    +
    +

    isSelectedAll#

    +

    ▸ isSelectedAll(visibleItems: PersistentVolumeClaim[]): boolean

    +

    Inherited from KubeObjectStore.isSelectedAll

    +

    Defined in src/renderer/item.store.ts:151

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPersistentVolumeClaim[]this.items
    +

    Returns: boolean

    +
    +

    load#

    +

    ▸ load(params: object): Promise‹PersistentVolumeClaim›

    +

    Inherited from KubeObjectStore.load

    +

    Defined in src/renderer/kube-object.store.ts:118

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PersistentVolumeClaim›

    +
    +

    loadAll#

    +

    ▸ loadAll(): Promise‹void›

    +

    Inherited from KubeObjectStore.loadAll

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:89

    +

    Returns: Promise‹void›

    +
    +

    loadFromPath#

    +

    ▸ loadFromPath(resourcePath: string): Promise‹T›

    +

    Inherited from KubeObjectStore.loadFromPath

    +

    Defined in src/renderer/kube-object.store.ts:133

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcePathstring
    +

    Returns: Promise‹T›

    +
    +

    Protected loadItem#

    +

    ▸ loadItem(params: object): Promise‹PersistentVolumeClaim›

    +

    Inherited from KubeObjectStore.loadItem

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:113

    +

    Parameters:

    +

    ▪ params: object

    + + + + + + + + + + + + + + + + + +
    NameType
    namestring
    namespace?string
    +

    Returns: Promise‹PersistentVolumeClaim›

    +
    +

    Protected loadItems#

    +

    ▸ loadItems(allowedNamespaces?: string[]): Promise‹PersistentVolumeClaim[]›

    +

    Inherited from KubeObjectStore.loadItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:74

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    allowedNamespaces?string[]
    +

    Returns: Promise‹PersistentVolumeClaim[]›

    +
    +

    loadMetrics#

    +

    ▸ loadMetrics(pvc: PersistentVolumeClaim): Promise‹void›

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:13

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    pvcPersistentVolumeClaim
    +

    Returns: Promise‹void›

    +
    +

    Protected onWatchApiEvent#

    +

    ▸ onWatchApiEvent(evt: IKubeWatchEvent): void

    +

    Inherited from KubeObjectStore.onWatchApiEvent

    +

    Defined in src/renderer/kube-object.store.ts:184

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtIKubeWatchEvent
    +

    Returns: void

    +
    +

    remove#

    +

    ▸ remove(item: PersistentVolumeClaim): Promise‹void›

    +

    Inherited from KubeObjectStore.remove

    +

    Defined in src/renderer/kube-object.store.ts:161

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    +

    Returns: Promise‹void›

    +
    +

    Protected removeItem#

    +

    ▸ removeItem(item: PersistentVolumeClaim, request: function): Promise‹void›

    +

    Inherited from KubeObjectStore.removeItem

    +

    Defined in src/renderer/item.store.ts:109

    +

    Parameters:

    +

    ▪ item: PersistentVolumeClaim

    +

    ▪ request: function

    +

    ▸ (): Promise‹any›

    +

    Returns: Promise‹void›

    +
    +

    removeSelectedItems#

    +

    ▸ removeSelectedItems(): Promise‹void[]›

    +

    Inherited from KubeObjectStore.removeSelectedItems

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:167

    +

    Returns: Promise‹void[]›

    +
    +

    reset#

    +

    ▸ reset(): void

    +

    Overrides KubeObjectStore.reset

    +

    Defined in src/renderer/components/+storage-volume-claims/volume-claim.store.ts:17

    +

    Returns: void

    +
    +

    resetSelection#

    +

    ▸ resetSelection(): void

    +

    Inherited from KubeObjectStore.resetSelection

    +

    Defined in src/renderer/item.store.ts:158

    +

    Returns: void

    +
    +

    select#

    +

    ▸ select(item: PersistentVolumeClaim): void

    +

    Inherited from KubeObjectStore.select

    +

    Defined in src/renderer/item.store.ts:120

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    +

    Returns: void

    +
    +

    Protected sortItems#

    +

    ▸ sortItems(items: PersistentVolumeClaim[], sorting?: function[], order?: "asc" | "desc"): PersistentVolumeClaim[]

    +

    Inherited from KubeObjectStore.sortItems

    +

    Defined in src/renderer/item.store.ts:31

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    itemsPersistentVolumeClaim[]this.items
    sorting?function[]-
    order?"asc" | "desc"-
    +

    Returns: PersistentVolumeClaim[]

    +
    +

    subscribe#

    +

    ▸ subscribe(apis: KubeApi‹T›[]): (Anonymous function)

    +

    Inherited from KubeObjectStore.subscribe

    +

    Overrides void

    +

    Defined in src/renderer/kube-object.store.ts:180

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    apisKubeApi‹T›[][this.api]
    +

    Returns: (Anonymous function)

    +
    +

    toggleSelection#

    +

    ▸ toggleSelection(item: PersistentVolumeClaim): void

    +

    Inherited from KubeObjectStore.toggleSelection

    +

    Defined in src/renderer/item.store.ts:130

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    +

    Returns: void

    +
    +

    toggleSelectionAll#

    +

    ▸ toggleSelectionAll(visibleItems: PersistentVolumeClaim[]): void

    +

    Inherited from KubeObjectStore.toggleSelectionAll

    +

    Defined in src/renderer/item.store.ts:140

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    visibleItemsPersistentVolumeClaim[]this.items
    +

    Returns: void

    +
    +

    unselect#

    +

    ▸ unselect(item: PersistentVolumeClaim): void

    +

    Inherited from KubeObjectStore.unselect

    +

    Defined in src/renderer/item.store.ts:125

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    +

    Returns: void

    +
    +

    update#

    +

    ▸ update(item: PersistentVolumeClaim, data: Partial‹PersistentVolumeClaim›): Promise‹PersistentVolumeClaim›

    +

    Inherited from KubeObjectStore.update

    +

    Defined in src/renderer/kube-object.store.ts:152

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemPersistentVolumeClaim
    dataPartial‹PersistentVolumeClaim›
    +

    Returns: Promise‹PersistentVolumeClaim›

    +
    +

    Protected updateFromEventsBuffer#

    +

    ▸ updateFromEventsBuffer(): void

    +

    Inherited from KubeObjectStore.updateFromEventsBuffer

    +

    Defined in src/renderer/kube-object.store.ts:190

    +

    Returns: void

    +
    +

    Protected updateItem#

    +

    ▸ updateItem(item: PersistentVolumeClaim, request: function): Promise‹T›

    +

    Inherited from KubeObjectStore.updateItem

    +

    Defined in src/renderer/item.store.ts:99

    +

    Parameters:

    +

    ▪ item: PersistentVolumeClaim

    +

    ▪ request: function

    +

    ▸ (): Promise‹PersistentVolumeClaim›

    +

    Returns: Promise‹T›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/lensmainextension/index.html b/v4.0.1/extensions/api/classes/lensmainextension/index.html new file mode 100644 index 0000000000..c29b9f9b56 --- /dev/null +++ b/v4.0.1/extensions/api/classes/lensmainextension/index.html @@ -0,0 +1,1331 @@ + + + + + + + + + + + + + + + + + + + + + + Class: LensMainExtension - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: LensMainExtension#

    +

    Hierarchy#

    +
      +
    • LensExtension
      • +
    +

    ↳ LensMainExtension

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new LensMainExtension(__namedParameters: object): LensMainExtension

    +

    Inherited from LensMainExtension.constructor

    +

    Defined in src/extensions/lens-extension.ts:24

    +

    Parameters:

    +

    ▪ __namedParameters: object

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameType
    idstring
    isBundledboolean
    manifestLensExtensionManifest
    manifestPathstring
    +

    Returns: LensMainExtension

    +

    Properties#

    +

    appMenus#

    +

    • appMenus: MenuRegistration[] = []

    +

    Defined in src/extensions/lens-main-extension.ts:7

    +
    +

    id#

    +

    • id: LensExtensionId

    +

    Inherited from LensMainExtension.id

    +

    Defined in src/extensions/lens-extension.ts:19

    +
    +

    isBundled#

    +

    • isBundled: boolean

    +

    Inherited from LensMainExtension.isBundled

    +

    Defined in src/extensions/lens-extension.ts:22

    +
    +

    manifest#

    +

    • manifest: LensExtensionManifest

    +

    Inherited from LensMainExtension.manifest

    +

    Defined in src/extensions/lens-extension.ts:20

    +
    +

    manifestPath#

    +

    • manifestPath: string

    +

    Inherited from LensMainExtension.manifestPath

    +

    Defined in src/extensions/lens-extension.ts:21

    +

    Accessors#

    +

    description#

    +

    • get description(): string

    +

    Inherited from LensMainExtension.description

    +

    Defined in src/extensions/lens-extension.ts:52

    +

    Returns: string

    +
    +

    name#

    +

    • get name(): string

    +

    Inherited from LensMainExtension.name

    +

    Defined in src/extensions/lens-extension.ts:33

    +

    Returns: string

    +
    +

    version#

    +

    • get version(): string

    +

    Inherited from LensMainExtension.version

    +

    Defined in src/extensions/lens-extension.ts:37

    +

    Returns: string

    +

    Methods#

    +

    disable#

    +

    ▸ disable(): Promise‹void›

    +

    Inherited from LensMainExtension.disable

    +

    Defined in src/extensions/lens-extension.ts:65

    +

    Returns: Promise‹void›

    +
    +

    enable#

    +

    ▸ enable(): Promise‹void›

    +

    Inherited from LensMainExtension.enable

    +

    Defined in src/extensions/lens-extension.ts:57

    +

    Returns: Promise‹void›

    +
    +

    getExtensionFileFolder#

    +

    ▸ getExtensionFileFolder(): Promise‹string›

    +

    Inherited from LensMainExtension.getExtensionFileFolder

    +

    Defined in src/extensions/lens-extension.ts:48

    +

    getExtensionFileFolder returns the path to an already created folder. This +folder is for the sole use of this extension.

    +

    Note: there is no security done on this folder, only obfiscation of the +folder name.

    +

    Returns: Promise‹string›

    +
    + +

    ▸ navigate‹P›(pageId?: string, params?: P, frameId?: number): Promise‹void›

    +

    Defined in src/extensions/lens-main-extension.ts:9

    +

    Type parameters:

    +

    ▪ P: object

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    pageId?string
    params?P
    frameId?number
    +

    Returns: Promise‹void›

    +
    +

    Protected onActivate#

    +

    ▸ onActivate(): void

    +

    Inherited from LensMainExtension.onActivate

    +

    Defined in src/extensions/lens-extension.ts:104

    +

    Returns: void

    +
    +

    Protected onDeactivate#

    +

    ▸ onDeactivate(): void

    +

    Inherited from LensMainExtension.onDeactivate

    +

    Defined in src/extensions/lens-extension.ts:108

    +

    Returns: void

    +
    +

    toggle#

    +

    ▸ toggle(enable?: boolean): void

    +

    Inherited from LensMainExtension.toggle

    +

    Defined in src/extensions/lens-extension.ts:72

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    enable?boolean
    +

    Returns: void

    +
    +

    whenEnabled#

    +

    ▸ whenEnabled(handlers: function): Promise‹(Anonymous function)›

    +

    Inherited from LensMainExtension.whenEnabled

    +

    Defined in src/extensions/lens-extension.ts:80

    +

    Parameters:

    +

    ▪ handlers: function

    +

    ▸ (): Promise‹Function[]›

    +

    Returns: Promise‹(Anonymous function)›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/classes/lensrendererextension/index.html b/v4.0.1/extensions/api/classes/lensrendererextension/index.html new file mode 100644 index 0000000000..cd342416ff --- /dev/null +++ b/v4.0.1/extensions/api/classes/lensrendererextension/index.html @@ -0,0 +1,1464 @@ + + + + + + + + + + + + + + + + + + + + + + Class: LensRendererExtension - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Class: LensRendererExtension#

    +

    Hierarchy#

    +
      +
    • LensExtension
      • +
    +

    ↳ LensRendererExtension

    +

    Index#

    +

    Constructors#

    + +

    Properties#

    + +

    Accessors#

    + +

    Methods#

    + +

    Constructors#

    +

    constructor#

    +

    + new LensRendererExtension(__namedParameters: object): LensRendererExtension

    +

    Inherited from LensMainExtension.constructor

    +

    Defined in src/extensions/lens-extension.ts:24

    +

    Parameters:

    +

    ▪ __namedParameters: object

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameType
    idstring
    isBundledboolean
    manifestLensExtensionManifest
    manifestPathstring
    +

    Returns: LensRendererExtension

    +

    Properties#

    +

    appPreferences#

    +

    • appPreferences: AppPreferenceRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:13

    +
    +

    clusterFeatures#

    +

    • clusterFeatures: ClusterFeatureRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:14

    +
    +

    clusterPageMenus#

    +

    • clusterPageMenus: PageMenuRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:11

    +
    +

    clusterPages#

    +

    • clusterPages: PageRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:9

    +
    +

    globalPageMenus#

    +

    • globalPageMenus: PageMenuRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:10

    +
    +

    globalPages#

    +

    • globalPages: PageRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:8

    +
    +

    id#

    +

    • id: LensExtensionId

    +

    Inherited from LensMainExtension.id

    +

    Defined in src/extensions/lens-extension.ts:19

    +
    +

    isBundled#

    +

    • isBundled: boolean

    +

    Inherited from LensMainExtension.isBundled

    +

    Defined in src/extensions/lens-extension.ts:22

    +
    +

    kubeObjectDetailItems#

    +

    • kubeObjectDetailItems: KubeObjectDetailRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:16

    +
    +

    kubeObjectMenuItems#

    +

    • kubeObjectMenuItems: KubeObjectMenuRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:17

    +
    +

    kubeObjectStatusTexts#

    +

    • kubeObjectStatusTexts: KubeObjectStatusRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:12

    +
    +

    manifest#

    +

    • manifest: LensExtensionManifest

    +

    Inherited from LensMainExtension.manifest

    +

    Defined in src/extensions/lens-extension.ts:20

    +
    +

    manifestPath#

    +

    • manifestPath: string

    +

    Inherited from LensMainExtension.manifestPath

    +

    Defined in src/extensions/lens-extension.ts:21

    +
    +

    statusBarItems#

    +

    • statusBarItems: StatusBarRegistration[] = []

    +

    Defined in src/extensions/lens-renderer-extension.ts:15

    +

    Accessors#

    +

    description#

    +

    • get description(): string

    +

    Inherited from LensMainExtension.description

    +

    Defined in src/extensions/lens-extension.ts:52

    +

    Returns: string

    +
    +

    name#

    +

    • get name(): string

    +

    Inherited from LensMainExtension.name

    +

    Defined in src/extensions/lens-extension.ts:33

    +

    Returns: string

    +
    +

    version#

    +

    • get version(): string

    +

    Inherited from LensMainExtension.version

    +

    Defined in src/extensions/lens-extension.ts:37

    +

    Returns: string

    +

    Methods#

    +

    disable#

    +

    ▸ disable(): Promise‹void›

    +

    Inherited from LensMainExtension.disable

    +

    Defined in src/extensions/lens-extension.ts:65

    +

    Returns: Promise‹void›

    +
    +

    enable#

    +

    ▸ enable(): Promise‹void›

    +

    Inherited from LensMainExtension.enable

    +

    Defined in src/extensions/lens-extension.ts:57

    +

    Returns: Promise‹void›

    +
    +

    getExtensionFileFolder#

    +

    ▸ getExtensionFileFolder(): Promise‹string›

    +

    Inherited from LensMainExtension.getExtensionFileFolder

    +

    Defined in src/extensions/lens-extension.ts:48

    +

    getExtensionFileFolder returns the path to an already created folder. This +folder is for the sole use of this extension.

    +

    Note: there is no security done on this folder, only obfiscation of the +folder name.

    +

    Returns: Promise‹string›

    +
    +

    isEnabledForCluster#

    +

    ▸ isEnabledForCluster(cluster: Cluster): Promise‹Boolean›

    +

    Defined in src/extensions/lens-renderer-extension.ts:34

    +

    Defines if extension is enabled for a given cluster. Defaults to true.

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    clusterCluster
    +

    Returns: Promise‹Boolean›

    +
    + +

    ▸ navigate‹P›(pageId?: string, params?: P): Promise‹void›

    +

    Defined in src/extensions/lens-renderer-extension.ts:19

    +

    Type parameters:

    +

    ▪ P: object

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    pageId?string
    params?P
    +

    Returns: Promise‹void›

    +
    +

    Protected onActivate#

    +

    ▸ onActivate(): void

    +

    Inherited from LensMainExtension.onActivate

    +

    Defined in src/extensions/lens-extension.ts:104

    +

    Returns: void

    +
    +

    Protected onDeactivate#

    +

    ▸ onDeactivate(): void

    +

    Inherited from LensMainExtension.onDeactivate

    +

    Defined in src/extensions/lens-extension.ts:108

    +

    Returns: void

    +
    +

    toggle#

    +

    ▸ toggle(enable?: boolean): void

    +

    Inherited from LensMainExtension.toggle

    +

    Defined in src/extensions/lens-extension.ts:72

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    enable?boolean
    +

    Returns: void

    +
    +

    whenEnabled#

    +

    ▸ whenEnabled(handlers: function): Promise‹(Anonymous function)›

    +

    Inherited from LensMainExtension.whenEnabled

    +

    Defined in src/extensions/lens-extension.ts:80

    +

    Parameters:

    +

    ▪ handlers: function

    +

    ▸ (): Promise‹Function[]›

    +

    Returns: Promise‹(Anonymous function)›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html b/v4.0.1/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html new file mode 100644 index 0000000000..eb4ddc4f8c --- /dev/null +++ b/v4.0.1/extensions/api/enums/_renderer_api_components_.notificationstatus/index.html @@ -0,0 +1,980 @@ + + + + + + + + + + + + + + + + + + + + + + Enumeration: NotificationStatus - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html b/v4.0.1/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html new file mode 100644 index 0000000000..12d334511a --- /dev/null +++ b/v4.0.1/extensions/api/enums/_renderer_api_components_.tooltipposition/index.html @@ -0,0 +1,1040 @@ + + + + + + + + + + + + + + + + + + + + + + Enumeration: TooltipPosition - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Enumeration: TooltipPosition#

    +

    Index#

    +

    Enumeration members#

    + +

    Enumeration members#

    +

    BOTTOM#

    +

    • BOTTOM: = "bottom"

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:11

    +
    +

    BOTTOM_LEFT#

    +

    • BOTTOM_LEFT: = "bottom_left"

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:16

    +
    +

    BOTTOM_RIGHT#

    +

    • BOTTOM_RIGHT: = "bottom_right"

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:17

    +
    +

    LEFT#

    +

    • LEFT: = "left"

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:12

    +
    + +

    • RIGHT: = "right"

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:13

    +
    +

    TOP#

    +

    • TOP: = "top"

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:10

    +
    +

    TOP_LEFT#

    +

    • TOP_LEFT: = "top_left"

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:14

    +
    +

    TOP_RIGHT#

    +

    • TOP_RIGHT: = "top_right"

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:15

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html b/v4.0.1/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html new file mode 100644 index 0000000000..7fb6e2631e --- /dev/null +++ b/v4.0.1/extensions/api/enums/_renderer_api_k8s_api_.kubeobjectstatuslevel/index.html @@ -0,0 +1,980 @@ + + + + + + + + + + + + + + + + + + + + + + Enumeration: KubeObjectStatusLevel - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/globals/index.html b/v4.0.1/extensions/api/globals/index.html new file mode 100644 index 0000000000..9e95e9fe6a --- /dev/null +++ b/v4.0.1/extensions/api/globals/index.html @@ -0,0 +1,953 @@ + + + + + + + + + + + + + + + + + + + + + + @k8slens/extensions - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/index.html b/v4.0.1/extensions/api/index.html new file mode 100644 index 0000000000..8f9d3578f9 --- /dev/null +++ b/v4.0.1/extensions/api/index.html @@ -0,0 +1,947 @@ + + + + + + + + + + + + + + + + + + + + + + API Reference - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html b/v4.0.1/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html new file mode 100644 index 0000000000..064ea4fde8 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_core_api_cluster_feature_.clusterfeaturestatus/index.html @@ -0,0 +1,1007 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterFeatureStatus - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ClusterFeatureStatus#

    +

    Hierarchy#

    +
      +
    • ClusterFeatureStatus
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    canUpgrade#

    +

    • canUpgrade: boolean

    +

    Defined in src/extensions/cluster-feature.ts:20

    +

    whether the feature can be upgraded or not, as set by the implementation

    +
    +

    currentVersion#

    +

    • currentVersion: string

    +

    Defined in src/extensions/cluster-feature.ts:14

    +

    feature's current version, as set by the implementation

    +
    +

    installed#

    +

    • installed: boolean

    +

    Defined in src/extensions/cluster-feature.ts:18

    +

    whether the feature is installed or not, as set by the implementation

    +
    +

    latestVersion#

    +

    • latestVersion: string

    +

    Defined in src/extensions/cluster-feature.ts:16

    +

    feature's latest version, as set by the implementation

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html b/v4.0.1/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html new file mode 100644 index 0000000000..ef0126ca08 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_core_api_stores_.clustermodel/index.html @@ -0,0 +1,1083 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterModel - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ClusterModel#

    +

    Hierarchy#

    +
      +
    • ClusterModel
      • +
    +

    Implemented by#

    + +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional accessibleNamespaces#

    +

    • accessibleNamespaces? : string[]

    +

    Defined in src/common/cluster-store.ts:67

    +

    List of accessible namespaces

    +
    +

    Optional contextName#

    +

    • contextName? : string

    +

    Defined in src/common/cluster-store.ts:53

    +

    User context in kubeconfig

    +
    +

    id#

    +

    • id: ClusterId

    +

    Defined in src/common/cluster-store.ts:44

    +

    Unique id for a cluster

    +
    +

    Optional kubeConfig#

    +

    • kubeConfig? : string

    +

    Defined in src/common/cluster-store.ts:70

    +

    deprecated

    +
    +

    kubeConfigPath#

    +

    • kubeConfigPath: string

    +

    Defined in src/common/cluster-store.ts:47

    +

    Path to cluster kubeconfig

    +
    +

    Optional metadata#

    +

    • metadata? : ClusterMetadata

    +

    Defined in src/common/cluster-store.ts:59

    +

    Metadata

    +
    +

    Optional ownerRef#

    +

    • ownerRef? : string

    +

    Defined in src/common/cluster-store.ts:64

    +

    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:56

    +

    Preferences

    +
    +

    Optional workspace#

    +

    • workspace? : WorkspaceId

    +

    Defined in src/common/cluster-store.ts:50

    +

    Workspace id

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html b/v4.0.1/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html new file mode 100644 index 0000000000..6619166823 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_core_api_stores_.workspacemodel/index.html @@ -0,0 +1,1026 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: WorkspaceModel - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: WorkspaceModel#

    +

    Hierarchy#

    +
      +
    • WorkspaceModel
      • +
    +

    Implemented by#

    + +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional description#

    +

    • description? : string

    +

    Defined in src/common/workspace-store.ts:20

    +
    +

    id#

    +

    • id: WorkspaceId

    +

    Defined in src/common/workspace-store.ts:18

    +
    +

    Optional lastActiveClusterId#

    +

    • lastActiveClusterId? : ClusterId

    +

    Defined in src/common/workspace-store.ts:22

    +
    +

    name#

    +

    • name: string

    +

    Defined in src/common/workspace-store.ts:19

    +
    +

    Optional ownerRef#

    +

    • ownerRef? : string

    +

    Defined in src/common/workspace-store.ts:21

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html b/v4.0.1/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html new file mode 100644 index 0000000000..a42171e7bf --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_interfaces_index_.apppreferencecomponents/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: AppPreferenceComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html b/v4.0.1/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html new file mode 100644 index 0000000000..165dfdc204 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_interfaces_index_.apppreferenceregistration/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: AppPreferenceRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html b/v4.0.1/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html new file mode 100644 index 0000000000..4b99e19c30 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_interfaces_index_.clusterfeaturecomponents/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterFeatureComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html b/v4.0.1/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html new file mode 100644 index 0000000000..8b975f18a4 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_interfaces_index_.clusterfeatureregistration/index.html @@ -0,0 +1,991 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ClusterFeatureRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ClusterFeatureRegistration#

    +

    Hierarchy#

    +
      +
    • ClusterFeatureRegistration
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    components#

    +

    • components: ClusterFeatureComponents

    +

    Defined in src/extensions/registries/cluster-feature-registry.ts:11

    +
    +

    feature#

    +

    • feature: ClusterFeature

    +

    Defined in src/extensions/registries/cluster-feature-registry.ts:12

    +
    +

    title#

    +

    • title: string

    +

    Defined in src/extensions/registries/cluster-feature-registry.ts:10

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html b/v4.0.1/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html new file mode 100644 index 0000000000..0b047e6684 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailcomponents/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectDetailComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html b/v4.0.1/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html new file mode 100644 index 0000000000..8654eac829 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_interfaces_index_.kubeobjectdetailregistration/index.html @@ -0,0 +1,1003 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectDetailRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: KubeObjectDetailRegistration#

    +

    Hierarchy#

    +
      +
    • KubeObjectDetailRegistration
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    apiVersions#

    +

    • apiVersions: string[]

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:10

    +
    +

    components#

    +

    • components: KubeObjectDetailComponents

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:11

    +
    +

    kind#

    +

    • kind: string

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:9

    +
    +

    Optional priority#

    +

    • priority? : number

    +

    Defined in src/extensions/registries/kube-object-detail-registry.ts:12

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html b/v4.0.1/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html new file mode 100644 index 0000000000..d9d364ba04 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_interfaces_index_.kubeobjectmenucomponents/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMenuComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html b/v4.0.1/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html new file mode 100644 index 0000000000..37c223b4bf --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_interfaces_index_.kubeobjectmenuregistration/index.html @@ -0,0 +1,991 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMenuRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: KubeObjectMenuRegistration#

    +

    Hierarchy#

    +
      +
    • KubeObjectMenuRegistration
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    apiVersions#

    +

    • apiVersions: string[]

    +

    Defined in src/extensions/registries/kube-object-menu-registry.ts:10

    +
    +

    components#

    +

    • components: KubeObjectMenuComponents

    +

    Defined in src/extensions/registries/kube-object-menu-registry.ts:11

    +
    +

    kind#

    +

    • kind: string

    +

    Defined in src/extensions/registries/kube-object-menu-registry.ts:9

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html b/v4.0.1/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html new file mode 100644 index 0000000000..2cdb5ea80c --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_interfaces_index_.kubeobjectstatusregistration/index.html @@ -0,0 +1,1008 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectStatusRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: KubeObjectStatusRegistration#

    +

    Hierarchy#

    +
      +
    • KubeObjectStatusRegistration
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    apiVersions#

    +

    • apiVersions: string[]

    +

    Defined in src/extensions/registries/kube-object-status-registry.ts:6

    +
    +

    kind#

    +

    • kind: string

    +

    Defined in src/extensions/registries/kube-object-status-registry.ts:5

    +
    +

    resolve#

    +

    • resolve: function

    +

    Defined in src/extensions/registries/kube-object-status-registry.ts:7

    +

    Type declaration:

    +

    ▸ (object: KubeObject): KubeObjectStatus

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    objectKubeObject
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html b/v4.0.1/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html new file mode 100644 index 0000000000..f65c70d6d5 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_interfaces_index_.pagecomponents/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html b/v4.0.1/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html new file mode 100644 index 0000000000..c12a716793 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_interfaces_index_.pagemenucomponents/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageMenuComponents - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html b/v4.0.1/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html new file mode 100644 index 0000000000..c01721ae97 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_interfaces_index_.pagemenuregistration/index.html @@ -0,0 +1,991 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageMenuRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html b/v4.0.1/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html new file mode 100644 index 0000000000..5dccdea01a --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_interfaces_index_.pageregistration/index.html @@ -0,0 +1,1003 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: PageRegistration#

    +

    Hierarchy#

    +
      +
    • PageRegistration
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    components#

    +

    • components: PageComponents

    +

    Defined in src/extensions/registries/page-registry.ts:31

    +
    +

    Optional exact#

    +

    • exact? : boolean

    +

    Defined in src/extensions/registries/page-registry.ts:30

    +

    Strict route matching to provided page-id, read also: https://reactrouter.com/web/api/NavLink/exact-bool +In case when more than one page registered at same extension "pageId" is required to identify different pages, +It might be useful to provide exact: true in some cases to avoid overlapping routes. +Without {exact:true} second page never matches since first page-id/route already includes partial route.

    +

    example const pages = [ + {id: "/users", exact: true}, + {id: "/users/:userId?"} +] +Pro-tip: registering pages in opposite order will make same effect without "exact".

    +
    +

    Optional id#

    +

    • id? : string

    +

    Defined in src/extensions/registries/page-registry.ts:18

    +

    Page ID or additional route path to indicate uniqueness within current extension registered pages +Might contain special url placeholders, e.g. "/users/:userId?" (? - marks as optional param) +When not provided, first registered page without "id" would be used for page-menus without target.pageId for same extension

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html b/v4.0.1/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html new file mode 100644 index 0000000000..70e5239c30 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_interfaces_index_.statusbarregistration/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: StatusBarRegistration - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html new file mode 100644 index 0000000000..eb5cfc6a58 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.badgeprops/index.html @@ -0,0 +1,4427 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: BadgeProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: BadgeProps#

    +

    Hierarchy#

    + +

    ↳ BadgeProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    • about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1775

    +
    +

    Optional accessKey#

    +

    • accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1751

    +
    +

    Optional aria-activedescendant#

    +

    • aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1558

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    • aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    • aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1565

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    • aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    • aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1572

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    • aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1577

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    • aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1582

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    • aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1587

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    • aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1592

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    • aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    • aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1599

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    • aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1604

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    • aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1609

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    • aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1614

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    • aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1619

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    • aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    • aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1626

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    • aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1631

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    • aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    • aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1638

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    • aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1643

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    • aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    • aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1650

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    • aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1655

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    • aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    • aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    • aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    • aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    • aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    • aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    • aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1673

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    • aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1678

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    • aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1683

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    • aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1688

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    • aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1693

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    • aria-relevant? : "additions" | "additions text" | "all" | "removals" | "text"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1698

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    • aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    • aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    • aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1707

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    • aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1712

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    • aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1717

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    • aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1722

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    • aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1727

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    • aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    • aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    • aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    • aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1738

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    • aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional autoCapitalize#

    +

    • autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1785

    +
    +

    Optional autoCorrect#

    +

    • autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1786

    +
    +

    Optional autoSave#

    +

    • autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    + +

    • checkedLink? : ReactLink‹boolean›

    +

    Inherited from ButtonProps.checkedLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:26

    +
    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional className#

    +

    • className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1752

    +
    +

    Optional color#

    +

    • color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional contentEditable#

    +

    • contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional contextMenu#

    +

    • contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    +

    Optional datatype#

    +

    • datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1776

    +
    +

    Optional defaultChecked#

    +

    • defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1745

    +
    +

    Optional defaultValue#

    +

    • defaultValue? : string | number | string[]

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1746

    +
    +

    Optional dir#

    +

    • dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional draggable#

    +

    • draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional hidden#

    +

    • hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional id#

    +

    • id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional inlist#

    +

    • inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional inputMode#

    +

    • inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1803

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional is#

    +

    • is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1808

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    • itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemProp#

    +

    • itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional itemRef#

    +

    • itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional itemScope#

    +

    • itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional itemType#

    +

    • itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional label#

    +

    • label? : React.ReactNode

    +

    Defined in src/renderer/components/badge/badge.tsx:9

    +
    +

    Optional lang#

    +

    • lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    +
    +

    Optional placeholder#

    +

    • placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional prefix#

    +

    • prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional property#

    +

    • property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional radioGroup#

    +

    • radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1769

    +
    +

    Optional resource#

    +

    • resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional results#

    +

    • results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional role#

    +

    • role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1772

    +
    +

    Optional security#

    +

    • security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional slot#

    +

    • slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional small#

    +

    • small? : boolean

    +

    Defined in src/renderer/components/badge/badge.tsx:8

    +
    +

    Optional spellCheck#

    +

    • spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional style#

    +

    • style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional suppressContentEditableWarning#

    +

    • suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional suppressHydrationWarning#

    +

    • suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional tabIndex#

    +

    • tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional title#

    +

    • title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional tooltip#

    +

    • tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    +

    Inherited from ButtonProps.tooltip

    +

    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

    +

    forces tooltip to detect the target's parent for mouse events. This is +useful for displaying tooltips even when the target is "disabled"

    +
    +

    Optional translate#

    +

    • translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional typeof#

    +

    • typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional unselectable#

    +

    • unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    + +

    • valueLink? : ReactLink‹boolean | string | number›

    +

    Inherited from ButtonProps.valueLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:27

    +
    +

    Optional vocab#

    +

    • vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html new file mode 100644 index 0000000000..96720c5900 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.buttonprops/index.html @@ -0,0 +1,4678 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ButtonProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ButtonProps#

    +

    Hierarchy#

    + +

    ↳ ButtonProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    • about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1775

    +
    +

    Optional accent#

    +

    • accent? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:10

    +
    +

    Optional accessKey#

    +

    • accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1751

    +
    +

    Optional active#

    +

    • active? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:14

    +
    +

    Optional aria-activedescendant#

    +

    • aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1558

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    • aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    • aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1565

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    • aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    • aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1572

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    • aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1577

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    • aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1582

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    • aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1587

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    • aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1592

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    • aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    • aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1599

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    • aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1604

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    • aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1609

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    • aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1614

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    • aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1619

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    • aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    • aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1626

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    • aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1631

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    • aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    • aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1638

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    • aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1643

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    • aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    • aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1650

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    • aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1655

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    • aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    • aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    • aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    • aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    • aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    • aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    • aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1673

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    • aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1678

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    • aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1683

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    • aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1688

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    • aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1693

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    • aria-relevant? : "additions" | "additions text" | "all" | "removals" | "text"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1698

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    • aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    • aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    • aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1707

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    • aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1712

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    • aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1717

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    • aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1722

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    • aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1727

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    • aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    • aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    • aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    • aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1738

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    • aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional autoCapitalize#

    +

    • autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1785

    +
    +

    Optional autoCorrect#

    +

    • autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1786

    +
    +

    Optional autoFocus#

    +

    • autoFocus? : boolean

    +

    Inherited from ButtonProps.autoFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1958

    +
    +

    Optional autoSave#

    +

    • autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional big#

    +

    • big? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:15

    +
    + +

    • checkedLink? : ReactLink‹boolean›

    +

    Inherited from ButtonProps.checkedLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:26

    +
    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional className#

    +

    • className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1752

    +
    +

    Optional color#

    +

    • color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional contentEditable#

    +

    • contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional contextMenu#

    +

    • contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    +

    Optional datatype#

    +

    • datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1776

    +
    +

    Optional defaultChecked#

    +

    • defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1745

    +
    +

    Optional defaultValue#

    +

    • defaultValue? : string | number | string[]

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1746

    +
    +

    Optional dir#

    +

    • dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional disabled#

    +

    • disabled? : boolean

    +

    Inherited from ButtonProps.disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1959

    +
    +

    Optional draggable#

    +

    • draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional form#

    +

    • form? : string

    +

    Inherited from ButtonProps.form

    +

    Defined in node_modules/@types/react/index.d.ts:1960

    +
    +

    Optional formAction#

    +

    • formAction? : string

    +

    Inherited from ButtonProps.formAction

    +

    Defined in node_modules/@types/react/index.d.ts:1961

    +
    +

    Optional formEncType#

    +

    • formEncType? : string

    +

    Inherited from ButtonProps.formEncType

    +

    Defined in node_modules/@types/react/index.d.ts:1962

    +
    +

    Optional formMethod#

    +

    • formMethod? : string

    +

    Inherited from ButtonProps.formMethod

    +

    Defined in node_modules/@types/react/index.d.ts:1963

    +
    +

    Optional formNoValidate#

    +

    • formNoValidate? : boolean

    +

    Inherited from ButtonProps.formNoValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1964

    +
    +

    Optional formTarget#

    +

    • formTarget? : string

    +

    Inherited from ButtonProps.formTarget

    +

    Defined in node_modules/@types/react/index.d.ts:1965

    +
    +

    Optional hidden#

    +

    • hidden? : boolean

    +

    Overrides IconProps.hidden

    +

    Defined in src/renderer/components/button/button.tsx:13

    +
    +

    Optional href#

    +

    • href? : string

    +

    Defined in src/renderer/components/button/button.tsx:17

    +
    +

    Optional id#

    +

    • id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional inlist#

    +

    • inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional inputMode#

    +

    • inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1803

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional is#

    +

    • is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1808

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    • itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemProp#

    +

    • itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional itemRef#

    +

    • itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional itemScope#

    +

    • itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional itemType#

    +

    • itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional label#

    +

    • label? : React.ReactNode

    +

    Defined in src/renderer/components/button/button.tsx:7

    +
    +

    Optional lang#

    +

    • lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional name#

    +

    • name? : string

    +

    Inherited from ButtonProps.name

    +

    Defined in node_modules/@types/react/index.d.ts:1966

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    +
    +

    Optional outlined#

    +

    • outlined? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:12

    +
    +

    Optional placeholder#

    +

    • placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional plain#

    +

    • plain? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:11

    +
    +

    Optional prefix#

    +

    • prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional primary#

    +

    • primary? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:9

    +
    +

    Optional property#

    +

    • property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional radioGroup#

    +

    • radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1769

    +
    +

    Optional resource#

    +

    • resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional results#

    +

    • results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional role#

    +

    • role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1772

    +
    +

    Optional round#

    +

    • round? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:16

    +
    +

    Optional security#

    +

    • security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional slot#

    +

    • slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional spellCheck#

    +

    • spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional style#

    +

    • style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional suppressContentEditableWarning#

    +

    • suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional suppressHydrationWarning#

    +

    • suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional tabIndex#

    +

    • tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional target#

    +

    • target? : "_blank"

    +

    Defined in src/renderer/components/button/button.tsx:18

    +
    +

    Optional title#

    +

    • title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional tooltip#

    +

    • tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    +

    Inherited from ButtonProps.tooltip

    +

    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

    +

    forces tooltip to detect the target's parent for mouse events. This is +useful for displaying tooltips even when the target is "disabled"

    +
    +

    Optional translate#

    +

    • translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional type#

    +

    • type? : "submit" | "reset" | "button"

    +

    Inherited from ButtonProps.type

    +

    Defined in node_modules/@types/react/index.d.ts:1967

    +
    +

    Optional typeof#

    +

    • typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional unselectable#

    +

    • unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional value#

    +

    • value? : string | string[] | number

    +

    Inherited from ButtonProps.value

    +

    Defined in node_modules/@types/react/index.d.ts:1968

    +
    + +

    • valueLink? : ReactLink‹boolean | string | number›

    +

    Inherited from ButtonProps.valueLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:27

    +
    +

    Optional vocab#

    +

    • vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional waiting#

    +

    • waiting? : boolean

    +

    Defined in src/renderer/components/button/button.tsx:8

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html new file mode 100644 index 0000000000..55c3443e41 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.checkboxprops/index.html @@ -0,0 +1,1091 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: CheckboxProps ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: CheckboxProps ‹T›#

    +

    Type parameters#

    +

    ▪ T

    +

    Hierarchy#

    +
      +
    • CheckboxProps
      • +
    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional className#

    +

    • className? : string

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:7

    +
    +

    Optional disabled#

    +

    • disabled? : boolean

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:10

    +
    +

    Optional inline#

    +

    • inline? : boolean

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:9

    +
    +

    Optional label#

    +

    • label? : React.ReactNode

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:8

    +
    +

    Optional theme#

    +

    • theme? : "dark" | "light"

    +

    Defined in src/renderer/components/checkbox/checkbox.tsx:6

    +
    +

    Optional value#

    +

    • value? : T

    +

    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

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    valueT
    evtChangeEvent‹HTMLInputElement›
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html new file mode 100644 index 0000000000..6629f09178 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.confirmdialogparams/index.html @@ -0,0 +1,1041 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ConfirmDialogParams - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ConfirmDialogParams#

    +

    Hierarchy#

    +
      +
    • ConfirmDialogParams
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional cancelButtonProps#

    +

    • cancelButtonProps? : Partial‹ButtonProps›

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:22

    +
    +

    Optional icon#

    +

    • icon? : ReactNode

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:20

    +
    +

    Optional labelCancel#

    +

    • labelCancel? : ReactNode

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:18

    +
    +

    Optional labelOk#

    +

    • labelOk? : ReactNode

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:17

    +
    +

    Optional message#

    +

    • message? : ReactNode

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:19

    +
    +

    Optional ok#

    +

    • ok? : function

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:16

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional okButtonProps#

    +

    • okButtonProps? : Partial‹ButtonProps›

    +

    Defined in src/renderer/components/confirm-dialog/confirm-dialog.tsx:21

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html new file mode 100644 index 0000000000..c5cfb10782 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.confirmdialogprops/index.html @@ -0,0 +1,919 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ConfirmDialogProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: ConfirmDialogProps#

    +

    Hierarchy#

    +
      +
    • object
      • +
    +

    ↳ ConfirmDialogProps

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html new file mode 100644 index 0000000000..c4d1abbd1a --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.cubespinnerprops/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: CubeSpinnerProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html new file mode 100644 index 0000000000..01eeac6fb8 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.dialogprops/index.html @@ -0,0 +1,1071 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DialogProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: DialogProps#

    +

    Hierarchy#

    +
      +
    • DialogProps
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional animated#

    +

    • animated? : boolean

    +

    Defined in src/renderer/components/dialog/dialog.tsx:22

    +
    +

    Optional className#

    +

    • className? : string

    +

    Defined in src/renderer/components/dialog/dialog.tsx:14

    +
    +

    Optional close#

    +

    • close? : function

    +

    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

    +
    +

    Optional modal#

    +

    • modal? : boolean

    +

    Defined in src/renderer/components/dialog/dialog.tsx:20

    +
    +

    Optional onClose#

    +

    • onClose? : function

    +

    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

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional open#

    +

    • open? : function

    +

    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

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html new file mode 100644 index 0000000000..0dd5ae7b55 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.draweritemlabelsprops/index.html @@ -0,0 +1,4422 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerItemLabelsProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: DrawerItemLabelsProps#

    +

    Hierarchy#

    +

    ↳ DrawerItemProps

    +

    ↳ DrawerItemLabelsProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    • about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1775

    +
    +

    Optional accessKey#

    +

    • accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1751

    +
    +

    Optional aria-activedescendant#

    +

    • aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1558

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    • aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    • aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1565

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    • aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    • aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1572

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    • aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1577

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    • aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1582

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    • aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1587

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    • aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1592

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    • aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    • aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1599

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    • aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1604

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    • aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1609

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    • aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1614

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    • aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1619

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    • aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    • aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1626

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    • aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1631

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    • aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    • aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1638

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    • aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1643

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    • aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    • aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1650

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    • aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1655

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    • aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    • aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    • aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    • aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    • aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    • aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    • aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1673

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    • aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1678

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    • aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1683

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    • aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1688

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    • aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1693

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    • aria-relevant? : "additions" | "additions text" | "all" | "removals" | "text"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1698

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    • aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    • aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    • aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1707

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    • aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1712

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    • aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1717

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    • aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1722

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    • aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1727

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    • aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    • aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    • aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    • aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1738

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    • aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional autoCapitalize#

    +

    • autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1785

    +
    +

    Optional autoCorrect#

    +

    • autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1786

    +
    +

    Optional autoSave#

    +

    • autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    + +

    • checkedLink? : ReactLink‹boolean›

    +

    Inherited from ButtonProps.checkedLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:26

    +
    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional className#

    +

    • className? : string

    +

    Inherited from DrawerItemProps.className

    +

    Overrides ButtonProps.className

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:7

    +
    +

    Optional color#

    +

    • color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional contentEditable#

    +

    • contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional contextMenu#

    +

    • contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    +

    Optional datatype#

    +

    • datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1776

    +
    +

    Optional defaultChecked#

    +

    • defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1745

    +
    +

    Optional defaultValue#

    +

    • defaultValue? : string | number | string[]

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1746

    +
    +

    Optional dir#

    +

    • dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional draggable#

    +

    • draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional hidden#

    +

    • hidden? : boolean

    +

    Inherited from DrawerItemProps.hidden

    +

    Overrides IconProps.hidden

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:10

    +
    +

    Optional id#

    +

    • id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional inlist#

    +

    • inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional inputMode#

    +

    • inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1803

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional is#

    +

    • is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1808

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    • itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemProp#

    +

    • itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional itemRef#

    +

    • itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional itemScope#

    +

    • itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional itemType#

    +

    • itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    labels#

    +

    • labels: string[]

    +

    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

    +
    +

    Optional lang#

    +

    • lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    name#

    +

    • name: React.ReactNode

    +

    Inherited from DrawerItemProps.name

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:6

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    +
    +

    Optional placeholder#

    +

    • placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional prefix#

    +

    • prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional property#

    +

    • property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional radioGroup#

    +

    • radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1769

    +
    +

    Optional renderBoolean#

    +

    • renderBoolean? : boolean

    +

    Inherited from DrawerItemProps.renderBoolean

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:11

    +
    +

    Optional resource#

    +

    • resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional results#

    +

    • results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional role#

    +

    • role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1772

    +
    +

    Optional security#

    +

    • security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional slot#

    +

    • slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional spellCheck#

    +

    • spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional style#

    +

    • style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional suppressContentEditableWarning#

    +

    • suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional suppressHydrationWarning#

    +

    • suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional tabIndex#

    +

    • tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional title#

    +

    • title? : string

    +

    Inherited from DrawerItemProps.title

    +

    Overrides ButtonProps.title

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:8

    +
    +

    Optional translate#

    +

    • translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional typeof#

    +

    • typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional unselectable#

    +

    • unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    + +

    • valueLink? : ReactLink‹boolean | string | number›

    +

    Inherited from ButtonProps.valueLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:27

    +
    +

    Optional vocab#

    +

    • vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html new file mode 100644 index 0000000000..b3ab7d8147 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.draweritemprops/index.html @@ -0,0 +1,4407 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerItemProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: DrawerItemProps#

    +

    Hierarchy#

    +
      +
    • HTMLAttributes‹any›
      • +
    +

    ↳ DrawerItemProps

    +

    ↳ DrawerItemLabelsProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    • about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1775

    +
    +

    Optional accessKey#

    +

    • accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1751

    +
    +

    Optional aria-activedescendant#

    +

    • aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1558

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    • aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    • aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1565

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    • aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    • aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1572

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    • aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1577

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    • aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1582

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    • aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1587

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    • aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1592

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    • aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    • aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1599

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    • aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1604

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    • aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1609

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    • aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1614

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    • aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1619

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    • aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    • aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1626

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    • aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1631

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    • aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    • aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1638

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    • aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1643

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    • aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    • aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1650

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    • aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1655

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    • aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    • aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    • aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    • aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    • aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    • aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    • aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1673

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    • aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1678

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    • aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1683

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    • aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1688

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    • aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1693

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    • aria-relevant? : "additions" | "additions text" | "all" | "removals" | "text"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1698

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    • aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    • aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    • aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1707

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    • aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1712

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    • aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1717

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    • aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1722

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    • aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1727

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    • aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    • aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    • aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    • aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1738

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    • aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional autoCapitalize#

    +

    • autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1785

    +
    +

    Optional autoCorrect#

    +

    • autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1786

    +
    +

    Optional autoSave#

    +

    • autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    + +

    • checkedLink? : ReactLink‹boolean›

    +

    Inherited from ButtonProps.checkedLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:26

    +
    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional className#

    +

    • className? : string

    +

    Overrides ButtonProps.className

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:7

    +
    +

    Optional color#

    +

    • color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional contentEditable#

    +

    • contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional contextMenu#

    +

    • contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    +

    Optional datatype#

    +

    • datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1776

    +
    +

    Optional defaultChecked#

    +

    • defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1745

    +
    +

    Optional defaultValue#

    +

    • defaultValue? : string | number | string[]

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1746

    +
    +

    Optional dir#

    +

    • dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional draggable#

    +

    • draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional hidden#

    +

    • hidden? : boolean

    +

    Overrides IconProps.hidden

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:10

    +
    +

    Optional id#

    +

    • id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional inlist#

    +

    • inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional inputMode#

    +

    • inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1803

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional is#

    +

    • is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1808

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    • itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemProp#

    +

    • itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional itemRef#

    +

    • itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional itemScope#

    +

    • itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional itemType#

    +

    • itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional labelsOnly#

    +

    • labelsOnly? : boolean

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:9

    +
    +

    Optional lang#

    +

    • lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    name#

    +

    • name: React.ReactNode

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:6

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    +
    +

    Optional placeholder#

    +

    • placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional prefix#

    +

    • prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional property#

    +

    • property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional radioGroup#

    +

    • radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1769

    +
    +

    Optional renderBoolean#

    +

    • renderBoolean? : boolean

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:11

    +
    +

    Optional resource#

    +

    • resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional results#

    +

    • results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional role#

    +

    • role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1772

    +
    +

    Optional security#

    +

    • security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional slot#

    +

    • slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional spellCheck#

    +

    • spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional style#

    +

    • style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional suppressContentEditableWarning#

    +

    • suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional suppressHydrationWarning#

    +

    • suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional tabIndex#

    +

    • tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional title#

    +

    • title? : string

    +

    Overrides ButtonProps.title

    +

    Defined in src/renderer/components/drawer/drawer-item.tsx:8

    +
    +

    Optional translate#

    +

    • translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional typeof#

    +

    • typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional unselectable#

    +

    • unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    + +

    • valueLink? : ReactLink‹boolean | string | number›

    +

    Inherited from ButtonProps.valueLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:27

    +
    +

    Optional vocab#

    +

    • vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html new file mode 100644 index 0000000000..3a9530c521 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.drawerparamtogglerprops/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerParamTogglerProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html new file mode 100644 index 0000000000..edb87021f9 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.drawerprops/index.html @@ -0,0 +1,1077 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: DrawerProps#

    +

    Hierarchy#

    +
      +
    • DrawerProps
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional animation#

    +

    • animation? : AnimateName

    +

    Defined in src/renderer/components/drawer/drawer.tsx:18

    +
    +

    Optional className#

    +

    • className? : string | object

    +

    Defined in src/renderer/components/drawer/drawer.tsx:15

    +
    +

    Optional contentClass#

    +

    • contentClass? : string | object

    +

    Defined in src/renderer/components/drawer/drawer.tsx:16

    +
    +

    Optional onClose#

    +

    • onClose? : function

    +

    Defined in src/renderer/components/drawer/drawer.tsx:19

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    open#

    +

    • open: boolean

    +

    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

    +
    +

    Optional size#

    +

    • size? : string

    +

    Defined in src/renderer/components/drawer/drawer.tsx:13

    +
    +

    title#

    +

    • title: React.ReactNode

    +

    Defined in src/renderer/components/drawer/drawer.tsx:12

    +
    +

    Optional toolbar#

    +

    • toolbar? : React.ReactNode

    +

    Defined in src/renderer/components/drawer/drawer.tsx:20

    +
    +

    Optional usePortal#

    +

    • usePortal? : boolean

    +

    Defined in src/renderer/components/drawer/drawer.tsx:14

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html new file mode 100644 index 0000000000..325dfde72f --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.drawertitleprops/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: DrawerTitleProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html new file mode 100644 index 0000000000..50fbfe8037 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.groupselectoption/index.html @@ -0,0 +1,988 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: GroupSelectOption ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html new file mode 100644 index 0000000000..43a3d50ad7 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.iconprops/index.html @@ -0,0 +1,4559 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: IconProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: IconProps#

    +

    Hierarchy#

    + +

    ↳ IconProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    • about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1775

    +
    +

    Optional accessKey#

    +

    • accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1751

    +
    +

    Optional active#

    +

    • active? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:20

    +
    +

    Optional aria-activedescendant#

    +

    • aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1558

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    • aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    • aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1565

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    • aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    • aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1572

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    • aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1577

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    • aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1582

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    • aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1587

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    • aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1592

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    • aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    • aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1599

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    • aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1604

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    • aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1609

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    • aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1614

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    • aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1619

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    • aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    • aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1626

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    • aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1631

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    • aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    • aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1638

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    • aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1643

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    • aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    • aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1650

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    • aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1655

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    • aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    • aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    • aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    • aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    • aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    • aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    • aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1673

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    • aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1678

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    • aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1683

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    • aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1688

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    • aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1693

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    • aria-relevant? : "additions" | "additions text" | "all" | "removals" | "text"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1698

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    • aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    • aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    • aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1707

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    • aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1712

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    • aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1717

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    • aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1722

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    • aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1727

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    • aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    • aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    • aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    • aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1738

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    • aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional autoCapitalize#

    +

    • autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1785

    +
    +

    Optional autoCorrect#

    +

    • autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1786

    +
    +

    Optional autoSave#

    +

    • autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional big#

    +

    • big? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:19

    +
    + +

    • checkedLink? : ReactLink‹boolean›

    +

    Inherited from ButtonProps.checkedLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:26

    +
    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional className#

    +

    • className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1752

    +
    +

    Optional color#

    +

    • color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional contentEditable#

    +

    • contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional contextMenu#

    +

    • contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    +

    Optional datatype#

    +

    • datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1776

    +
    +

    Optional defaultChecked#

    +

    • defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1745

    +
    +

    Optional defaultValue#

    +

    • defaultValue? : string | number | string[]

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1746

    +
    +

    Optional dir#

    +

    • dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional disabled#

    +

    • disabled? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:24

    +
    +

    Optional draggable#

    +

    • draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional focusable#

    +

    • focusable? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:22

    +
    +

    Optional hidden#

    +

    • hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional href#

    +

    • href? : string

    +

    Defined in src/renderer/components/icon/icon.tsx:15

    +
    +

    Optional id#

    +

    • id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional inlist#

    +

    • inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional inputMode#

    +

    • inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1803

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional interactive#

    +

    • interactive? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:21

    +
    +

    Optional is#

    +

    • is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1808

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    • itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemProp#

    +

    • itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional itemRef#

    +

    • itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional itemScope#

    +

    • itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional itemType#

    +

    • itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional lang#

    +

    • lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    + +

    • link? : LocationDescriptor

    +

    Defined in src/renderer/components/icon/icon.tsx:14

    +
    +

    Optional material#

    +

    • material? : string

    +

    Defined in src/renderer/components/icon/icon.tsx:12

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    +
    +

    Optional placeholder#

    +

    • placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional prefix#

    +

    • prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional property#

    +

    • property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional radioGroup#

    +

    • radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1769

    +
    +

    Optional resource#

    +

    • resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional results#

    +

    • results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional role#

    +

    • role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1772

    +
    +

    Optional security#

    +

    • security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional size#

    +

    • size? : string | number

    +

    Defined in src/renderer/components/icon/icon.tsx:16

    +
    +

    Optional slot#

    +

    • slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional small#

    +

    • small? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:17

    +
    +

    Optional smallest#

    +

    • smallest? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:18

    +
    +

    Optional spellCheck#

    +

    • spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional sticker#

    +

    • sticker? : boolean

    +

    Defined in src/renderer/components/icon/icon.tsx:23

    +
    +

    Optional style#

    +

    • style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional suppressContentEditableWarning#

    +

    • suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional suppressHydrationWarning#

    +

    • suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional svg#

    +

    • svg? : string

    +

    Defined in src/renderer/components/icon/icon.tsx:13

    +
    +

    Optional tabIndex#

    +

    • tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional title#

    +

    • title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional tooltip#

    +

    • tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    +

    Inherited from ButtonProps.tooltip

    +

    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

    +

    forces tooltip to detect the target's parent for mouse events. This is +useful for displaying tooltips even when the target is "disabled"

    +
    +

    Optional translate#

    +

    • translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional typeof#

    +

    • typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional unselectable#

    +

    • unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    + +

    • valueLink? : ReactLink‹boolean | string | number›

    +

    Inherited from ButtonProps.valueLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:27

    +
    +

    Optional vocab#

    +

    • vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html new file mode 100644 index 0000000000..f6294cfc29 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.inputvalidator/index.html @@ -0,0 +1,1062 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: InputValidator - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: InputValidator#

    +

    Hierarchy#

    +
      +
    • InputValidator
      • +
    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional debounce#

    +

    • debounce? : number

    +

    Defined in src/renderer/components/input/input_validators.ts:8

    +
    +

    Optional message#

    +

    • message? : ReactNode | function

    +

    Defined in src/renderer/components/input/input_validators.ts:10

    +

    Methods#

    +

    Optional condition#

    +

    ▸ condition(props: InputProps): boolean

    +

    Defined in src/renderer/components/input/input_validators.ts:9

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsInputProps
    +

    Returns: boolean

    +
    +

    validate#

    +

    ▸ validate(value: string, props?: InputProps): boolean | Promise‹any›

    +

    Defined in src/renderer/components/input/input_validators.ts:11

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    valuestring
    props?InputProps
    +

    Returns: boolean | Promise‹any›

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html new file mode 100644 index 0000000000..8e95386892 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.kubeeventdetailsprops/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeEventDetailsProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html new file mode 100644 index 0000000000..f4e3646037 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectdetailsprops/index.html @@ -0,0 +1,988 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectDetailsProps ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html new file mode 100644 index 0000000000..37ec3cc278 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectlistlayoutprops/index.html @@ -0,0 +1,1460 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectListLayoutProps ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: KubeObjectListLayoutProps ‹T›#

    +

    Type parameters#

    +

    ▪ T: ItemObject

    +

    Hierarchy#

    +
      +
    • ItemListLayoutProps
      • +
    +

    ↳ KubeObjectListLayoutProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional addRemoveButtons#

    +

    • addRemoveButtons? : Partial‹AddRemoveButtonsProps›

    +

    Inherited from KubeObjectListLayoutProps.addRemoveButtons

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:61

    +
    +

    className#

    +

    • className: IClassName

    +

    Inherited from KubeObjectListLayoutProps.className

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:36

    +
    +

    Optional copyClassNameFromHeadCells#

    +

    • copyClassNameFromHeadCells? : boolean

    +

    Inherited from KubeObjectListLayoutProps.copyClassNameFromHeadCells

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:54

    +
    +

    Optional customizeHeader#

    +

    • customizeHeader? : function

    +

    Inherited from KubeObjectListLayoutProps.customizeHeader

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:48

    +

    Type declaration:

    +

    ▸ (placeholders: IHeaderPlaceholders, content: ReactNode): Partial‹IHeaderPlaceholders› | ReactNode

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    placeholdersIHeaderPlaceholders
    contentReactNode
    +
    +

    Optional customizeRemoveDialog#

    +

    • customizeRemoveDialog? : function

    +

    Inherited from KubeObjectListLayoutProps.customizeRemoveDialog

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:70

    +

    Type declaration:

    +

    ▸ (selectedItems: T[]): Partial‹ConfirmDialogParams›

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    selectedItemsT[]
    +
    +

    Optional customizeTableRowProps#

    +

    • customizeTableRowProps? : function

    +

    Inherited from KubeObjectListLayoutProps.customizeTableRowProps

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:60

    +

    Type declaration:

    +

    ▸ (item: T): Partial‹TableRowProps›

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +
    +

    Optional dependentStores#

    +

    • dependentStores? : ItemStore[]

    +

    Inherited from KubeObjectListLayoutProps.dependentStores

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:38

    +
    +

    Optional detailsItem#

    +

    • detailsItem? : T

    +

    Inherited from KubeObjectListLayoutProps.detailsItem

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:66

    +
    +

    Optional filterItems#

    +

    • filterItems? : ItemsFilter‹T›[]

    +

    Inherited from KubeObjectListLayoutProps.filterItems

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:42

    +
    +

    Optional hasDetailsView#

    +

    • hasDetailsView? : boolean

    +

    Inherited from KubeObjectListLayoutProps.hasDetailsView

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:65

    +
    +

    Optional headerClassName#

    +

    • headerClassName? : IClassName

    +

    Inherited from KubeObjectListLayoutProps.headerClassName

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:46

    +
    +

    Optional hideFilters#

    +

    • hideFilters? : boolean

    +

    Inherited from KubeObjectListLayoutProps.hideFilters

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:40

    +
    +

    Optional isClusterScoped#

    +

    • isClusterScoped? : boolean

    +

    Inherited from KubeObjectListLayoutProps.isClusterScoped

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:39

    +
    +

    Optional isReady#

    +

    • isReady? : boolean

    +

    Inherited from KubeObjectListLayoutProps.isReady

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:51

    +
    +

    Optional isSearchable#

    +

    • isSearchable? : boolean

    +

    Inherited from KubeObjectListLayoutProps.isSearchable

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:53

    +
    +

    Optional isSelectable#

    +

    • isSelectable? : boolean

    +

    Inherited from KubeObjectListLayoutProps.isSelectable

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:52

    +
    +

    Optional onDetails#

    +

    • onDetails? : function

    +

    Inherited from KubeObjectListLayoutProps.onDetails

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:67

    +

    Type declaration:

    +

    ▸ (item: T): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +
    +

    Optional renderFooter#

    +

    • renderFooter? : function

    +

    Inherited from KubeObjectListLayoutProps.renderFooter

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:71

    +

    Type declaration:

    +

    ▸ (parent: ItemListLayout): React.ReactNode

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    parentItemListLayout
    +
    +

    Optional renderHeaderTitle#

    +

    • renderHeaderTitle? : ReactNode | function

    +

    Inherited from KubeObjectListLayoutProps.renderHeaderTitle

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:47

    +
    +

    Optional renderItemMenu#

    +

    • renderItemMenu? : function

    +

    Inherited from KubeObjectListLayoutProps.renderItemMenu

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:59

    +

    Type declaration:

    +

    ▸ (item: T, store: ItemStore‹T›): ReactNode

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    itemT
    storeItemStore‹T›
    +
    +

    renderTableContents#

    +

    • renderTableContents: function

    +

    Inherited from KubeObjectListLayoutProps.renderTableContents

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:58

    +

    Type declaration:

    +

    ▸ (item: T): (string | number | false | true | object | ReactElement‹any, string | function | object› | ReactNodeArray‹› | ReactPortal‹› | TableCellProps‹›)[]

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    itemT
    +
    +

    renderTableHeader#

    +

    • renderTableHeader: TableCellProps[] | null

    +

    Inherited from KubeObjectListLayoutProps.renderTableHeader

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:57

    +
    +

    Optional searchFilters#

    +

    • searchFilters? : SearchFilter‹T›[]

    +

    Inherited from KubeObjectListLayoutProps.searchFilters

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:41

    +
    +

    Optional showHeader#

    +

    • showHeader? : boolean

    +

    Inherited from KubeObjectListLayoutProps.showHeader

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:45

    +
    +

    Optional sortingCallbacks#

    +

    • sortingCallbacks? : object

    +

    Inherited from KubeObjectListLayoutProps.sortingCallbacks

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:55

    +

    Type declaration:

    + +
    +

    store#

    +

    • store: KubeObjectStore

    +

    Overrides void

    +

    Defined in src/renderer/components/kube-object/kube-object-list-layout.tsx:12

    +
    +

    Optional tableProps#

    +

    • tableProps? : Partial‹TableProps›

    +

    Inherited from KubeObjectListLayoutProps.tableProps

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:56

    +
    +

    Optional virtual#

    +

    • virtual? : boolean

    +

    Inherited from KubeObjectListLayoutProps.virtual

    +

    Defined in src/renderer/components/item-object-list/item-list-layout.tsx:62

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html new file mode 100644 index 0000000000..35296a4f79 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectmenuprops/index.html @@ -0,0 +1,1102 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMenuProps ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: KubeObjectMenuProps ‹T›#

    +

    Type parameters#

    +

    ▪ T: KubeObject

    +

    Hierarchy#

    +

    ↳ MenuActionsProps

    +

    ↳ KubeObjectMenuProps

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional className#

    +

    • className? : string

    +

    Inherited from MenuActionsProps.className

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:16

    +
    +

    Optional editable#

    +

    • editable? : boolean

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:13

    +
    +

    object#

    +

    • object: T

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:12

    +
    +

    Optional removable#

    +

    • removable? : boolean

    +

    Defined in src/renderer/components/kube-object/kube-object-menu.tsx:14

    +
    +

    Optional removeConfirmationMessage#

    +

    • removeConfirmationMessage? : React.ReactNode | function

    +

    Inherited from MenuActionsProps.removeConfirmationMessage

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:19

    +
    +

    Optional toolbar#

    +

    • toolbar? : boolean

    +

    Inherited from MenuActionsProps.toolbar

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:17

    +
    +

    Optional triggerIcon#

    +

    • triggerIcon? : string | IconProps | React.ReactNode

    +

    Inherited from MenuActionsProps.triggerIcon

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:18

    +

    Methods#

    +

    Optional removeAction#

    +

    ▸ removeAction(): void

    +

    Inherited from MenuActionsProps.removeAction

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:21

    +

    Returns: void

    +
    +

    Optional updateAction#

    +

    ▸ updateAction(): void

    +

    Inherited from MenuActionsProps.updateAction

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:20

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/index.html new file mode 100644 index 0000000000..62dab94cc2 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.kubeobjectmetaprops/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: KubeObjectMetaProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/index.html new file mode 100644 index 0000000000..09f3683b29 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.lineprogressprops/index.html @@ -0,0 +1,5807 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: LineProgressProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: LineProgressProps#

    +

    Hierarchy#

    + +

    ↳ LineProgressProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    • about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1775

    +
    +

    Optional accept#

    +

    • accept? : string

    +

    Inherited from LineProgressProps.accept

    +

    Defined in node_modules/@types/react/index.d.ts:1813

    +
    +

    Optional acceptCharset#

    +

    • acceptCharset? : string

    +

    Inherited from LineProgressProps.acceptCharset

    +

    Defined in node_modules/@types/react/index.d.ts:1814

    +
    +

    Optional accessKey#

    +

    • accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1751

    +
    +

    Optional action#

    +

    • action? : string

    +

    Inherited from LineProgressProps.action

    +

    Defined in node_modules/@types/react/index.d.ts:1815

    +
    +

    Optional allowFullScreen#

    +

    • allowFullScreen? : boolean

    +

    Inherited from LineProgressProps.allowFullScreen

    +

    Defined in node_modules/@types/react/index.d.ts:1816

    +
    +

    Optional allowTransparency#

    +

    • allowTransparency? : boolean

    +

    Inherited from LineProgressProps.allowTransparency

    +

    Defined in node_modules/@types/react/index.d.ts:1817

    +
    +

    Optional alt#

    +

    • alt? : string

    +

    Inherited from LineProgressProps.alt

    +

    Defined in node_modules/@types/react/index.d.ts:1818

    +
    +

    Optional aria-activedescendant#

    +

    • aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1558

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    • aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    • aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1565

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    • aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    • aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1572

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    • aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1577

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    • aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1582

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    • aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1587

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    • aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1592

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    • aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    • aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1599

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    • aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1604

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    • aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1609

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    • aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1614

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    • aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1619

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    • aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    • aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1626

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    • aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1631

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    • aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    • aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1638

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    • aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1643

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    • aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    • aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1650

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    • aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1655

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    • aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    • aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    • aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    • aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    • aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    • aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    • aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1673

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    • aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1678

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    • aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1683

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    • aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1688

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    • aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1693

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    • aria-relevant? : "additions" | "additions text" | "all" | "removals" | "text"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1698

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    • aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    • aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    • aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1707

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    • aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1712

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    • aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1717

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    • aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1722

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    • aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1727

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    • aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    • aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    • aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    • aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1738

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    • aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional as#

    +

    • as? : string

    +

    Inherited from LineProgressProps.as

    +

    Defined in node_modules/@types/react/index.d.ts:1819

    +
    +

    Optional async#

    +

    • async? : boolean

    +

    Inherited from LineProgressProps.async

    +

    Defined in node_modules/@types/react/index.d.ts:1820

    +
    +

    Optional autoCapitalize#

    +

    • autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1785

    +
    +

    Optional autoComplete#

    +

    • autoComplete? : string

    +

    Inherited from LineProgressProps.autoComplete

    +

    Defined in node_modules/@types/react/index.d.ts:1821

    +
    +

    Optional autoCorrect#

    +

    • autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1786

    +
    +

    Optional autoFocus#

    +

    • autoFocus? : boolean

    +

    Inherited from LineProgressProps.autoFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1822

    +
    +

    Optional autoPlay#

    +

    • autoPlay? : boolean

    +

    Inherited from LineProgressProps.autoPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1823

    +
    +

    Optional autoSave#

    +

    • autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional capture#

    +

    • capture? : boolean | string

    +

    Inherited from LineProgressProps.capture

    +

    Defined in node_modules/@types/react/index.d.ts:1824

    +
    +

    Optional cellPadding#

    +

    • cellPadding? : number | string

    +

    Inherited from LineProgressProps.cellPadding

    +

    Defined in node_modules/@types/react/index.d.ts:1825

    +
    +

    Optional cellSpacing#

    +

    • cellSpacing? : number | string

    +

    Inherited from LineProgressProps.cellSpacing

    +

    Defined in node_modules/@types/react/index.d.ts:1826

    +
    +

    Optional challenge#

    +

    • challenge? : string

    +

    Inherited from LineProgressProps.challenge

    +

    Defined in node_modules/@types/react/index.d.ts:1828

    +
    +

    Optional charSet#

    +

    • charSet? : string

    +

    Inherited from LineProgressProps.charSet

    +

    Defined in node_modules/@types/react/index.d.ts:1827

    +
    +

    Optional checked#

    +

    • checked? : boolean

    +

    Inherited from LineProgressProps.checked

    +

    Defined in node_modules/@types/react/index.d.ts:1829

    +
    + +

    • checkedLink? : ReactLink‹boolean›

    +

    Inherited from ButtonProps.checkedLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:26

    +
    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional cite#

    +

    • cite? : string

    +

    Inherited from LineProgressProps.cite

    +

    Defined in node_modules/@types/react/index.d.ts:1830

    +
    +

    Optional classID#

    +

    • classID? : string

    +

    Inherited from LineProgressProps.classID

    +

    Defined in node_modules/@types/react/index.d.ts:1831

    +
    +

    Optional className#

    +

    • className? : any

    +

    Overrides ButtonProps.className

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:10

    +
    +

    Optional colSpan#

    +

    • colSpan? : number

    +

    Inherited from LineProgressProps.colSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1833

    +
    +

    Optional color#

    +

    • color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional cols#

    +

    • cols? : number

    +

    Inherited from LineProgressProps.cols

    +

    Defined in node_modules/@types/react/index.d.ts:1832

    +
    +

    Optional content#

    +

    • content? : string

    +

    Inherited from LineProgressProps.content

    +

    Defined in node_modules/@types/react/index.d.ts:1834

    +
    +

    Optional contentEditable#

    +

    • contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional contextMenu#

    +

    • contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional controls#

    +

    • controls? : boolean

    +

    Inherited from LineProgressProps.controls

    +

    Defined in node_modules/@types/react/index.d.ts:1835

    +
    +

    Optional coords#

    +

    • coords? : string

    +

    Inherited from LineProgressProps.coords

    +

    Defined in node_modules/@types/react/index.d.ts:1836

    +
    +

    Optional crossOrigin#

    +

    • crossOrigin? : string

    +

    Inherited from LineProgressProps.crossOrigin

    +

    Defined in node_modules/@types/react/index.d.ts:1837

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    +

    Optional data#

    +

    • data? : string

    +

    Inherited from LineProgressProps.data

    +

    Defined in node_modules/@types/react/index.d.ts:1838

    +
    +

    Optional datatype#

    +

    • datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1776

    +
    +

    Optional dateTime#

    +

    • dateTime? : string

    +

    Inherited from LineProgressProps.dateTime

    +

    Defined in node_modules/@types/react/index.d.ts:1839

    +
    +

    Optional default#

    +

    • default? : boolean

    +

    Inherited from LineProgressProps.default

    +

    Defined in node_modules/@types/react/index.d.ts:1840

    +
    +

    Optional defaultChecked#

    +

    • defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1745

    +
    +

    Optional defaultValue#

    +

    • defaultValue? : string | number | string[]

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1746

    +
    +

    Optional defer#

    +

    • defer? : boolean

    +

    Inherited from LineProgressProps.defer

    +

    Defined in node_modules/@types/react/index.d.ts:1841

    +
    +

    Optional dir#

    +

    • dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional disabled#

    +

    • disabled? : boolean

    +

    Inherited from LineProgressProps.disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1842

    +
    +

    Optional download#

    +

    • download? : any

    +

    Inherited from LineProgressProps.download

    +

    Defined in node_modules/@types/react/index.d.ts:1843

    +
    +

    Optional draggable#

    +

    • draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional encType#

    +

    • encType? : string

    +

    Inherited from LineProgressProps.encType

    +

    Defined in node_modules/@types/react/index.d.ts:1844

    +
    +

    Optional form#

    +

    • form? : string

    +

    Inherited from LineProgressProps.form

    +

    Defined in node_modules/@types/react/index.d.ts:1845

    +
    +

    Optional formAction#

    +

    • formAction? : string

    +

    Inherited from LineProgressProps.formAction

    +

    Defined in node_modules/@types/react/index.d.ts:1846

    +
    +

    Optional formEncType#

    +

    • formEncType? : string

    +

    Inherited from LineProgressProps.formEncType

    +

    Defined in node_modules/@types/react/index.d.ts:1847

    +
    +

    Optional formMethod#

    +

    • formMethod? : string

    +

    Inherited from LineProgressProps.formMethod

    +

    Defined in node_modules/@types/react/index.d.ts:1848

    +
    +

    Optional formNoValidate#

    +

    • formNoValidate? : boolean

    +

    Inherited from LineProgressProps.formNoValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1849

    +
    +

    Optional formTarget#

    +

    • formTarget? : string

    +

    Inherited from LineProgressProps.formTarget

    +

    Defined in node_modules/@types/react/index.d.ts:1850

    +
    +

    Optional frameBorder#

    +

    • frameBorder? : number | string

    +

    Inherited from LineProgressProps.frameBorder

    +

    Defined in node_modules/@types/react/index.d.ts:1851

    +
    +

    Optional headers#

    +

    • headers? : string

    +

    Inherited from LineProgressProps.headers

    +

    Defined in node_modules/@types/react/index.d.ts:1852

    +
    +

    Optional height#

    +

    • height? : number | string

    +

    Inherited from LineProgressProps.height

    +

    Defined in node_modules/@types/react/index.d.ts:1853

    +
    +

    Optional hidden#

    +

    • hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional high#

    +

    • high? : number

    +

    Inherited from LineProgressProps.high

    +

    Defined in node_modules/@types/react/index.d.ts:1854

    +
    +

    Optional href#

    +

    • href? : string

    +

    Inherited from LineProgressProps.href

    +

    Defined in node_modules/@types/react/index.d.ts:1855

    +
    +

    Optional hrefLang#

    +

    • hrefLang? : string

    +

    Inherited from LineProgressProps.hrefLang

    +

    Defined in node_modules/@types/react/index.d.ts:1856

    +
    +

    Optional htmlFor#

    +

    • htmlFor? : string

    +

    Inherited from LineProgressProps.htmlFor

    +

    Defined in node_modules/@types/react/index.d.ts:1857

    +
    +

    Optional httpEquiv#

    +

    • httpEquiv? : string

    +

    Inherited from LineProgressProps.httpEquiv

    +

    Defined in node_modules/@types/react/index.d.ts:1858

    +
    +

    Optional id#

    +

    • id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional inlist#

    +

    • inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional inputMode#

    +

    • inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1803

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional integrity#

    +

    • integrity? : string

    +

    Inherited from LineProgressProps.integrity

    +

    Defined in node_modules/@types/react/index.d.ts:1859

    +
    +

    Optional is#

    +

    • is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1808

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    • itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemProp#

    +

    • itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional itemRef#

    +

    • itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional itemScope#

    +

    • itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional itemType#

    +

    • itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional key#

    +

    • key? : Key

    +

    Inherited from LineProgressProps.key

    +

    Defined in node_modules/@types/react/index.d.ts:139

    +
    +

    Optional keyParams#

    +

    • keyParams? : string

    +

    Inherited from LineProgressProps.keyParams

    +

    Defined in node_modules/@types/react/index.d.ts:1860

    +
    +

    Optional keyType#

    +

    • keyType? : string

    +

    Inherited from LineProgressProps.keyType

    +

    Defined in node_modules/@types/react/index.d.ts:1861

    +
    +

    Optional kind#

    +

    • kind? : string

    +

    Inherited from LineProgressProps.kind

    +

    Defined in node_modules/@types/react/index.d.ts:1862

    +
    +

    Optional label#

    +

    • label? : string

    +

    Inherited from LineProgressProps.label

    +

    Defined in node_modules/@types/react/index.d.ts:1863

    +
    +

    Optional lang#

    +

    • lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional list#

    +

    • list? : string

    +

    Inherited from LineProgressProps.list

    +

    Defined in node_modules/@types/react/index.d.ts:1864

    +
    +

    Optional loop#

    +

    • loop? : boolean

    +

    Inherited from LineProgressProps.loop

    +

    Defined in node_modules/@types/react/index.d.ts:1865

    +
    +

    Optional low#

    +

    • low? : number

    +

    Inherited from LineProgressProps.low

    +

    Defined in node_modules/@types/react/index.d.ts:1866

    +
    +

    Optional manifest#

    +

    • manifest? : string

    +

    Inherited from LineProgressProps.manifest

    +

    Defined in node_modules/@types/react/index.d.ts:1867

    +
    +

    Optional marginHeight#

    +

    • marginHeight? : number

    +

    Inherited from LineProgressProps.marginHeight

    +

    Defined in node_modules/@types/react/index.d.ts:1868

    +
    +

    Optional marginWidth#

    +

    • marginWidth? : number

    +

    Inherited from LineProgressProps.marginWidth

    +

    Defined in node_modules/@types/react/index.d.ts:1869

    +
    +

    Optional max#

    +

    • max? : number

    +

    Overrides MenuItemProps.max

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:9

    +
    +

    Optional maxLength#

    +

    • maxLength? : number

    +

    Inherited from LineProgressProps.maxLength

    +

    Defined in node_modules/@types/react/index.d.ts:1871

    +
    +

    Optional media#

    +

    • media? : string

    +

    Inherited from LineProgressProps.media

    +

    Defined in node_modules/@types/react/index.d.ts:1872

    +
    +

    Optional mediaGroup#

    +

    • mediaGroup? : string

    +

    Inherited from LineProgressProps.mediaGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1873

    +
    +

    Optional method#

    +

    • method? : string

    +

    Inherited from LineProgressProps.method

    +

    Defined in node_modules/@types/react/index.d.ts:1874

    +
    +

    Optional min#

    +

    • min? : number

    +

    Overrides MenuItemProps.min

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:8

    +
    +

    Optional minLength#

    +

    • minLength? : number

    +

    Inherited from LineProgressProps.minLength

    +

    Defined in node_modules/@types/react/index.d.ts:1876

    +
    +

    Optional multiple#

    +

    • multiple? : boolean

    +

    Inherited from LineProgressProps.multiple

    +

    Defined in node_modules/@types/react/index.d.ts:1877

    +
    +

    Optional muted#

    +

    • muted? : boolean

    +

    Inherited from LineProgressProps.muted

    +

    Defined in node_modules/@types/react/index.d.ts:1878

    +
    +

    Optional name#

    +

    • name? : string

    +

    Inherited from LineProgressProps.name

    +

    Defined in node_modules/@types/react/index.d.ts:1879

    +
    +

    Optional noValidate#

    +

    • noValidate? : boolean

    +

    Inherited from LineProgressProps.noValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1881

    +
    +

    Optional nonce#

    +

    • nonce? : string

    +

    Inherited from LineProgressProps.nonce

    +

    Defined in node_modules/@types/react/index.d.ts:1880

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    +
    +

    Optional open#

    +

    • open? : boolean

    +

    Inherited from LineProgressProps.open

    +

    Defined in node_modules/@types/react/index.d.ts:1882

    +
    +

    Optional optimum#

    +

    • optimum? : number

    +

    Inherited from LineProgressProps.optimum

    +

    Defined in node_modules/@types/react/index.d.ts:1883

    +
    +

    Optional pattern#

    +

    • pattern? : string

    +

    Inherited from LineProgressProps.pattern

    +

    Defined in node_modules/@types/react/index.d.ts:1884

    +
    +

    Optional placeholder#

    +

    • placeholder? : string

    +

    Inherited from LineProgressProps.placeholder

    +

    Overrides ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1885

    +
    +

    Optional playsInline#

    +

    • playsInline? : boolean

    +

    Inherited from LineProgressProps.playsInline

    +

    Defined in node_modules/@types/react/index.d.ts:1886

    +
    +

    Optional poster#

    +

    • poster? : string

    +

    Inherited from LineProgressProps.poster

    +

    Defined in node_modules/@types/react/index.d.ts:1887

    +
    +

    Optional precise#

    +

    • precise? : number

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:11

    +
    +

    Optional prefix#

    +

    • prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional preload#

    +

    • preload? : string

    +

    Inherited from LineProgressProps.preload

    +

    Defined in node_modules/@types/react/index.d.ts:1888

    +
    +

    Optional property#

    +

    • property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional radioGroup#

    +

    • radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1769

    +
    +

    Optional readOnly#

    +

    • readOnly? : boolean

    +

    Inherited from LineProgressProps.readOnly

    +

    Defined in node_modules/@types/react/index.d.ts:1889

    +
    +

    Optional ref#

    +

    • ref? : LegacyRef‹any›

    +

    Inherited from LineProgressProps.ref

    +

    Defined in node_modules/@types/react/index.d.ts:145

    +
    +

    Optional rel#

    +

    • rel? : string

    +

    Inherited from LineProgressProps.rel

    +

    Defined in node_modules/@types/react/index.d.ts:1890

    +
    +

    Optional required#

    +

    • required? : boolean

    +

    Inherited from LineProgressProps.required

    +

    Defined in node_modules/@types/react/index.d.ts:1891

    +
    +

    Optional resource#

    +

    • resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional results#

    +

    • results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional reversed#

    +

    • reversed? : boolean

    +

    Inherited from LineProgressProps.reversed

    +

    Defined in node_modules/@types/react/index.d.ts:1892

    +
    +

    Optional role#

    +

    • role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1772

    +
    +

    Optional rowSpan#

    +

    • rowSpan? : number

    +

    Inherited from LineProgressProps.rowSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1894

    +
    +

    Optional rows#

    +

    • rows? : number

    +

    Inherited from LineProgressProps.rows

    +

    Defined in node_modules/@types/react/index.d.ts:1893

    +
    +

    Optional sandbox#

    +

    • sandbox? : string

    +

    Inherited from LineProgressProps.sandbox

    +

    Defined in node_modules/@types/react/index.d.ts:1895

    +
    +

    Optional scope#

    +

    • scope? : string

    +

    Inherited from LineProgressProps.scope

    +

    Defined in node_modules/@types/react/index.d.ts:1896

    +
    +

    Optional scoped#

    +

    • scoped? : boolean

    +

    Inherited from LineProgressProps.scoped

    +

    Defined in node_modules/@types/react/index.d.ts:1897

    +
    +

    Optional scrolling#

    +

    • scrolling? : string

    +

    Inherited from LineProgressProps.scrolling

    +

    Defined in node_modules/@types/react/index.d.ts:1898

    +
    +

    Optional seamless#

    +

    • seamless? : boolean

    +

    Inherited from LineProgressProps.seamless

    +

    Defined in node_modules/@types/react/index.d.ts:1899

    +
    +

    Optional security#

    +

    • security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional selected#

    +

    • selected? : boolean

    +

    Inherited from LineProgressProps.selected

    +

    Defined in node_modules/@types/react/index.d.ts:1900

    +
    +

    Optional shape#

    +

    • shape? : string

    +

    Inherited from LineProgressProps.shape

    +

    Defined in node_modules/@types/react/index.d.ts:1901

    +
    +

    Optional size#

    +

    • size? : number

    +

    Inherited from LineProgressProps.size

    +

    Defined in node_modules/@types/react/index.d.ts:1902

    +
    +

    Optional sizes#

    +

    • sizes? : string

    +

    Inherited from LineProgressProps.sizes

    +

    Defined in node_modules/@types/react/index.d.ts:1903

    +
    +

    Optional slot#

    +

    • slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional span#

    +

    • span? : number

    +

    Inherited from LineProgressProps.span

    +

    Defined in node_modules/@types/react/index.d.ts:1904

    +
    +

    Optional spellCheck#

    +

    • spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional src#

    +

    • src? : string

    +

    Inherited from LineProgressProps.src

    +

    Defined in node_modules/@types/react/index.d.ts:1905

    +
    +

    Optional srcDoc#

    +

    • srcDoc? : string

    +

    Inherited from LineProgressProps.srcDoc

    +

    Defined in node_modules/@types/react/index.d.ts:1906

    +
    +

    Optional srcLang#

    +

    • srcLang? : string

    +

    Inherited from LineProgressProps.srcLang

    +

    Defined in node_modules/@types/react/index.d.ts:1907

    +
    +

    Optional srcSet#

    +

    • srcSet? : string

    +

    Inherited from LineProgressProps.srcSet

    +

    Defined in node_modules/@types/react/index.d.ts:1908

    +
    +

    Optional start#

    +

    • start? : number

    +

    Inherited from LineProgressProps.start

    +

    Defined in node_modules/@types/react/index.d.ts:1909

    +
    +

    Optional step#

    +

    • step? : number | string

    +

    Inherited from LineProgressProps.step

    +

    Defined in node_modules/@types/react/index.d.ts:1910

    +
    +

    Optional style#

    +

    • style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional summary#

    +

    • summary? : string

    +

    Inherited from LineProgressProps.summary

    +

    Defined in node_modules/@types/react/index.d.ts:1911

    +
    +

    Optional suppressContentEditableWarning#

    +

    • suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional suppressHydrationWarning#

    +

    • suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional tabIndex#

    +

    • tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional target#

    +

    • target? : string

    +

    Inherited from LineProgressProps.target

    +

    Defined in node_modules/@types/react/index.d.ts:1912

    +
    +

    Optional title#

    +

    • title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional tooltip#

    +

    • tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    +

    Inherited from ButtonProps.tooltip

    +

    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

    +

    forces tooltip to detect the target's parent for mouse events. This is +useful for displaying tooltips even when the target is "disabled"

    +
    +

    Optional translate#

    +

    • translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional type#

    +

    • type? : string

    +

    Inherited from LineProgressProps.type

    +

    Defined in node_modules/@types/react/index.d.ts:1913

    +
    +

    Optional typeof#

    +

    • typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional unselectable#

    +

    • unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional useMap#

    +

    • useMap? : string

    +

    Inherited from LineProgressProps.useMap

    +

    Defined in node_modules/@types/react/index.d.ts:1914

    +
    +

    value#

    +

    • value: number

    +

    Overrides MenuItemProps.value

    +

    Defined in src/renderer/components/line-progress/line-progress.tsx:7

    +
    + +

    • valueLink? : ReactLink‹boolean | string | number›

    +

    Inherited from ButtonProps.valueLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:27

    +
    +

    Optional vocab#

    +

    • vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional width#

    +

    • width? : number | string

    +

    Inherited from LineProgressProps.width

    +

    Defined in node_modules/@types/react/index.d.ts:1916

    +
    +

    Optional wmode#

    +

    • wmode? : string

    +

    Inherited from LineProgressProps.wmode

    +

    Defined in node_modules/@types/react/index.d.ts:1917

    +
    +

    Optional wrap#

    +

    • wrap? : string

    +

    Inherited from LineProgressProps.wrap

    +

    Defined in node_modules/@types/react/index.d.ts:1918

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/index.html new file mode 100644 index 0000000000..1bc14c6c34 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.menuactionsprops/index.html @@ -0,0 +1,1054 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: MenuActionsProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: MenuActionsProps#

    +

    Hierarchy#

    +
      +
    • object
      • +
    +

    ↳ MenuActionsProps

    +

    ↳ KubeObjectMenuProps

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional className#

    +

    • className? : string

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:16

    +
    +

    Optional removeConfirmationMessage#

    +

    • removeConfirmationMessage? : React.ReactNode | function

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:19

    +
    +

    Optional toolbar#

    +

    • toolbar? : boolean

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:17

    +
    +

    Optional triggerIcon#

    +

    • triggerIcon? : string | IconProps | React.ReactNode

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:18

    +

    Methods#

    +

    Optional removeAction#

    +

    ▸ removeAction(): void

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:21

    +

    Returns: void

    +
    +

    Optional updateAction#

    +

    ▸ updateAction(): void

    +

    Defined in src/renderer/components/menu/menu-actions.tsx:20

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.menuitemprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.menuitemprops/index.html new file mode 100644 index 0000000000..a6f4a87119 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.menuitemprops/index.html @@ -0,0 +1,5798 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: MenuItemProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: MenuItemProps#

    +

    Hierarchy#

    +
      +
    • HTMLProps‹any›
      • +
    +

    ↳ MenuItemProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    • about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1775

    +
    +

    Optional accept#

    +

    • accept? : string

    +

    Inherited from LineProgressProps.accept

    +

    Defined in node_modules/@types/react/index.d.ts:1813

    +
    +

    Optional acceptCharset#

    +

    • acceptCharset? : string

    +

    Inherited from LineProgressProps.acceptCharset

    +

    Defined in node_modules/@types/react/index.d.ts:1814

    +
    +

    Optional accessKey#

    +

    • accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1751

    +
    +

    Optional action#

    +

    • action? : string

    +

    Inherited from LineProgressProps.action

    +

    Defined in node_modules/@types/react/index.d.ts:1815

    +
    +

    Optional active#

    +

    • active? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:293

    +
    +

    Optional allowFullScreen#

    +

    • allowFullScreen? : boolean

    +

    Inherited from LineProgressProps.allowFullScreen

    +

    Defined in node_modules/@types/react/index.d.ts:1816

    +
    +

    Optional allowTransparency#

    +

    • allowTransparency? : boolean

    +

    Inherited from LineProgressProps.allowTransparency

    +

    Defined in node_modules/@types/react/index.d.ts:1817

    +
    +

    Optional alt#

    +

    • alt? : string

    +

    Inherited from LineProgressProps.alt

    +

    Defined in node_modules/@types/react/index.d.ts:1818

    +
    +

    Optional aria-activedescendant#

    +

    • aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1558

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    • aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    • aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1565

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    • aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    • aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1572

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    • aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1577

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    • aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1582

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    • aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1587

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    • aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1592

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    • aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    • aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1599

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    • aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1604

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    • aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1609

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    • aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1614

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    • aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1619

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    • aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    • aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1626

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    • aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1631

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    • aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    • aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1638

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    • aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1643

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    • aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    • aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1650

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    • aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1655

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    • aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    • aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    • aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    • aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    • aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    • aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    • aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1673

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    • aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1678

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    • aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1683

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    • aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1688

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    • aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1693

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    • aria-relevant? : "additions" | "additions text" | "all" | "removals" | "text"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1698

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    • aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    • aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    • aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1707

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    • aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1712

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    • aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1717

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    • aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1722

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    • aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1727

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    • aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    • aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    • aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    • aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1738

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    • aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional as#

    +

    • as? : string

    +

    Inherited from LineProgressProps.as

    +

    Defined in node_modules/@types/react/index.d.ts:1819

    +
    +

    Optional async#

    +

    • async? : boolean

    +

    Inherited from LineProgressProps.async

    +

    Defined in node_modules/@types/react/index.d.ts:1820

    +
    +

    Optional autoCapitalize#

    +

    • autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1785

    +
    +

    Optional autoComplete#

    +

    • autoComplete? : string

    +

    Inherited from LineProgressProps.autoComplete

    +

    Defined in node_modules/@types/react/index.d.ts:1821

    +
    +

    Optional autoCorrect#

    +

    • autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1786

    +
    +

    Optional autoFocus#

    +

    • autoFocus? : boolean

    +

    Inherited from LineProgressProps.autoFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1822

    +
    +

    Optional autoPlay#

    +

    • autoPlay? : boolean

    +

    Inherited from LineProgressProps.autoPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1823

    +
    +

    Optional autoSave#

    +

    • autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional capture#

    +

    • capture? : boolean | string

    +

    Inherited from LineProgressProps.capture

    +

    Defined in node_modules/@types/react/index.d.ts:1824

    +
    +

    Optional cellPadding#

    +

    • cellPadding? : number | string

    +

    Inherited from LineProgressProps.cellPadding

    +

    Defined in node_modules/@types/react/index.d.ts:1825

    +
    +

    Optional cellSpacing#

    +

    • cellSpacing? : number | string

    +

    Inherited from LineProgressProps.cellSpacing

    +

    Defined in node_modules/@types/react/index.d.ts:1826

    +
    +

    Optional challenge#

    +

    • challenge? : string

    +

    Inherited from LineProgressProps.challenge

    +

    Defined in node_modules/@types/react/index.d.ts:1828

    +
    +

    Optional charSet#

    +

    • charSet? : string

    +

    Inherited from LineProgressProps.charSet

    +

    Defined in node_modules/@types/react/index.d.ts:1827

    +
    +

    Optional checked#

    +

    • checked? : boolean

    +

    Inherited from LineProgressProps.checked

    +

    Defined in node_modules/@types/react/index.d.ts:1829

    +
    + +

    • checkedLink? : ReactLink‹boolean›

    +

    Inherited from ButtonProps.checkedLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:26

    +
    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional cite#

    +

    • cite? : string

    +

    Inherited from LineProgressProps.cite

    +

    Defined in node_modules/@types/react/index.d.ts:1830

    +
    +

    Optional classID#

    +

    • classID? : string

    +

    Inherited from LineProgressProps.classID

    +

    Defined in node_modules/@types/react/index.d.ts:1831

    +
    +

    Optional className#

    +

    • className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1752

    +
    +

    Optional colSpan#

    +

    • colSpan? : number

    +

    Inherited from LineProgressProps.colSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1833

    +
    +

    Optional color#

    +

    • color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional cols#

    +

    • cols? : number

    +

    Inherited from LineProgressProps.cols

    +

    Defined in node_modules/@types/react/index.d.ts:1832

    +
    +

    Optional content#

    +

    • content? : string

    +

    Inherited from LineProgressProps.content

    +

    Defined in node_modules/@types/react/index.d.ts:1834

    +
    +

    Optional contentEditable#

    +

    • contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional contextMenu#

    +

    • contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional controls#

    +

    • controls? : boolean

    +

    Inherited from LineProgressProps.controls

    +

    Defined in node_modules/@types/react/index.d.ts:1835

    +
    +

    Optional coords#

    +

    • coords? : string

    +

    Inherited from LineProgressProps.coords

    +

    Defined in node_modules/@types/react/index.d.ts:1836

    +
    +

    Optional crossOrigin#

    +

    • crossOrigin? : string

    +

    Inherited from LineProgressProps.crossOrigin

    +

    Defined in node_modules/@types/react/index.d.ts:1837

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    +

    Optional data#

    +

    • data? : string

    +

    Inherited from LineProgressProps.data

    +

    Defined in node_modules/@types/react/index.d.ts:1838

    +
    +

    Optional datatype#

    +

    • datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1776

    +
    +

    Optional dateTime#

    +

    • dateTime? : string

    +

    Inherited from LineProgressProps.dateTime

    +

    Defined in node_modules/@types/react/index.d.ts:1839

    +
    +

    Optional default#

    +

    • default? : boolean

    +

    Inherited from LineProgressProps.default

    +

    Defined in node_modules/@types/react/index.d.ts:1840

    +
    +

    Optional defaultChecked#

    +

    • defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1745

    +
    +

    Optional defaultValue#

    +

    • defaultValue? : string | number | string[]

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1746

    +
    +

    Optional defer#

    +

    • defer? : boolean

    +

    Inherited from LineProgressProps.defer

    +

    Defined in node_modules/@types/react/index.d.ts:1841

    +
    +

    Optional dir#

    +

    • dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional disabled#

    +

    • disabled? : boolean

    +

    Overrides LineProgressProps.disabled

    +

    Defined in src/renderer/components/menu/menu.tsx:292

    +
    +

    Optional download#

    +

    • download? : any

    +

    Inherited from LineProgressProps.download

    +

    Defined in node_modules/@types/react/index.d.ts:1843

    +
    +

    Optional draggable#

    +

    • draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional encType#

    +

    • encType? : string

    +

    Inherited from LineProgressProps.encType

    +

    Defined in node_modules/@types/react/index.d.ts:1844

    +
    +

    Optional form#

    +

    • form? : string

    +

    Inherited from LineProgressProps.form

    +

    Defined in node_modules/@types/react/index.d.ts:1845

    +
    +

    Optional formAction#

    +

    • formAction? : string

    +

    Inherited from LineProgressProps.formAction

    +

    Defined in node_modules/@types/react/index.d.ts:1846

    +
    +

    Optional formEncType#

    +

    • formEncType? : string

    +

    Inherited from LineProgressProps.formEncType

    +

    Defined in node_modules/@types/react/index.d.ts:1847

    +
    +

    Optional formMethod#

    +

    • formMethod? : string

    +

    Inherited from LineProgressProps.formMethod

    +

    Defined in node_modules/@types/react/index.d.ts:1848

    +
    +

    Optional formNoValidate#

    +

    • formNoValidate? : boolean

    +

    Inherited from LineProgressProps.formNoValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1849

    +
    +

    Optional formTarget#

    +

    • formTarget? : string

    +

    Inherited from LineProgressProps.formTarget

    +

    Defined in node_modules/@types/react/index.d.ts:1850

    +
    +

    Optional frameBorder#

    +

    • frameBorder? : number | string

    +

    Inherited from LineProgressProps.frameBorder

    +

    Defined in node_modules/@types/react/index.d.ts:1851

    +
    +

    Optional headers#

    +

    • headers? : string

    +

    Inherited from LineProgressProps.headers

    +

    Defined in node_modules/@types/react/index.d.ts:1852

    +
    +

    Optional height#

    +

    • height? : number | string

    +

    Inherited from LineProgressProps.height

    +

    Defined in node_modules/@types/react/index.d.ts:1853

    +
    +

    Optional hidden#

    +

    • hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional high#

    +

    • high? : number

    +

    Inherited from LineProgressProps.high

    +

    Defined in node_modules/@types/react/index.d.ts:1854

    +
    +

    Optional href#

    +

    • href? : string

    +

    Overrides LineProgressProps.href

    +

    Defined in src/renderer/components/menu/menu.tsx:295

    +
    +

    Optional hrefLang#

    +

    • hrefLang? : string

    +

    Inherited from LineProgressProps.hrefLang

    +

    Defined in node_modules/@types/react/index.d.ts:1856

    +
    +

    Optional htmlFor#

    +

    • htmlFor? : string

    +

    Inherited from LineProgressProps.htmlFor

    +

    Defined in node_modules/@types/react/index.d.ts:1857

    +
    +

    Optional httpEquiv#

    +

    • httpEquiv? : string

    +

    Inherited from LineProgressProps.httpEquiv

    +

    Defined in node_modules/@types/react/index.d.ts:1858

    +
    +

    Optional icon#

    +

    • icon? : string | Partial‹IconProps›

    +

    Defined in src/renderer/components/menu/menu.tsx:291

    +
    +

    Optional id#

    +

    • id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional inlist#

    +

    • inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional inputMode#

    +

    • inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1803

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional integrity#

    +

    • integrity? : string

    +

    Inherited from LineProgressProps.integrity

    +

    Defined in node_modules/@types/react/index.d.ts:1859

    +
    +

    Optional is#

    +

    • is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1808

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    • itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemProp#

    +

    • itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional itemRef#

    +

    • itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional itemScope#

    +

    • itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional itemType#

    +

    • itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional key#

    +

    • key? : Key

    +

    Inherited from LineProgressProps.key

    +

    Defined in node_modules/@types/react/index.d.ts:139

    +
    +

    Optional keyParams#

    +

    • keyParams? : string

    +

    Inherited from LineProgressProps.keyParams

    +

    Defined in node_modules/@types/react/index.d.ts:1860

    +
    +

    Optional keyType#

    +

    • keyType? : string

    +

    Inherited from LineProgressProps.keyType

    +

    Defined in node_modules/@types/react/index.d.ts:1861

    +
    +

    Optional kind#

    +

    • kind? : string

    +

    Inherited from LineProgressProps.kind

    +

    Defined in node_modules/@types/react/index.d.ts:1862

    +
    +

    Optional label#

    +

    • label? : string

    +

    Inherited from LineProgressProps.label

    +

    Defined in node_modules/@types/react/index.d.ts:1863

    +
    +

    Optional lang#

    +

    • lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional list#

    +

    • list? : string

    +

    Inherited from LineProgressProps.list

    +

    Defined in node_modules/@types/react/index.d.ts:1864

    +
    +

    Optional loop#

    +

    • loop? : boolean

    +

    Inherited from LineProgressProps.loop

    +

    Defined in node_modules/@types/react/index.d.ts:1865

    +
    +

    Optional low#

    +

    • low? : number

    +

    Inherited from LineProgressProps.low

    +

    Defined in node_modules/@types/react/index.d.ts:1866

    +
    +

    Optional manifest#

    +

    • manifest? : string

    +

    Inherited from LineProgressProps.manifest

    +

    Defined in node_modules/@types/react/index.d.ts:1867

    +
    +

    Optional marginHeight#

    +

    • marginHeight? : number

    +

    Inherited from LineProgressProps.marginHeight

    +

    Defined in node_modules/@types/react/index.d.ts:1868

    +
    +

    Optional marginWidth#

    +

    • marginWidth? : number

    +

    Inherited from LineProgressProps.marginWidth

    +

    Defined in node_modules/@types/react/index.d.ts:1869

    +
    +

    Optional max#

    +

    • max? : number | string

    +

    Inherited from MenuItemProps.max

    +

    Defined in node_modules/@types/react/index.d.ts:1870

    +
    +

    Optional maxLength#

    +

    • maxLength? : number

    +

    Inherited from LineProgressProps.maxLength

    +

    Defined in node_modules/@types/react/index.d.ts:1871

    +
    +

    Optional media#

    +

    • media? : string

    +

    Inherited from LineProgressProps.media

    +

    Defined in node_modules/@types/react/index.d.ts:1872

    +
    +

    Optional mediaGroup#

    +

    • mediaGroup? : string

    +

    Inherited from LineProgressProps.mediaGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1873

    +
    +

    Optional method#

    +

    • method? : string

    +

    Inherited from LineProgressProps.method

    +

    Defined in node_modules/@types/react/index.d.ts:1874

    +
    +

    Optional min#

    +

    • min? : number | string

    +

    Inherited from MenuItemProps.min

    +

    Defined in node_modules/@types/react/index.d.ts:1875

    +
    +

    Optional minLength#

    +

    • minLength? : number

    +

    Inherited from LineProgressProps.minLength

    +

    Defined in node_modules/@types/react/index.d.ts:1876

    +
    +

    Optional multiple#

    +

    • multiple? : boolean

    +

    Inherited from LineProgressProps.multiple

    +

    Defined in node_modules/@types/react/index.d.ts:1877

    +
    +

    Optional muted#

    +

    • muted? : boolean

    +

    Inherited from LineProgressProps.muted

    +

    Defined in node_modules/@types/react/index.d.ts:1878

    +
    +

    Optional name#

    +

    • name? : string

    +

    Inherited from LineProgressProps.name

    +

    Defined in node_modules/@types/react/index.d.ts:1879

    +
    +

    Optional noValidate#

    +

    • noValidate? : boolean

    +

    Inherited from LineProgressProps.noValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1881

    +
    +

    Optional nonce#

    +

    • nonce? : string

    +

    Inherited from LineProgressProps.nonce

    +

    Defined in node_modules/@types/react/index.d.ts:1880

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    +
    +

    Optional open#

    +

    • open? : boolean

    +

    Inherited from LineProgressProps.open

    +

    Defined in node_modules/@types/react/index.d.ts:1882

    +
    +

    Optional optimum#

    +

    • optimum? : number

    +

    Inherited from LineProgressProps.optimum

    +

    Defined in node_modules/@types/react/index.d.ts:1883

    +
    +

    Optional pattern#

    +

    • pattern? : string

    +

    Inherited from LineProgressProps.pattern

    +

    Defined in node_modules/@types/react/index.d.ts:1884

    +
    +

    Optional placeholder#

    +

    • placeholder? : string

    +

    Inherited from LineProgressProps.placeholder

    +

    Overrides ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1885

    +
    +

    Optional playsInline#

    +

    • playsInline? : boolean

    +

    Inherited from LineProgressProps.playsInline

    +

    Defined in node_modules/@types/react/index.d.ts:1886

    +
    +

    Optional poster#

    +

    • poster? : string

    +

    Inherited from LineProgressProps.poster

    +

    Defined in node_modules/@types/react/index.d.ts:1887

    +
    +

    Optional prefix#

    +

    • prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional preload#

    +

    • preload? : string

    +

    Inherited from LineProgressProps.preload

    +

    Defined in node_modules/@types/react/index.d.ts:1888

    +
    +

    Optional property#

    +

    • property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional radioGroup#

    +

    • radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1769

    +
    +

    Optional readOnly#

    +

    • readOnly? : boolean

    +

    Inherited from LineProgressProps.readOnly

    +

    Defined in node_modules/@types/react/index.d.ts:1889

    +
    +

    Optional ref#

    +

    • ref? : LegacyRef‹any›

    +

    Inherited from LineProgressProps.ref

    +

    Defined in node_modules/@types/react/index.d.ts:145

    +
    +

    Optional rel#

    +

    • rel? : string

    +

    Inherited from LineProgressProps.rel

    +

    Defined in node_modules/@types/react/index.d.ts:1890

    +
    +

    Optional required#

    +

    • required? : boolean

    +

    Inherited from LineProgressProps.required

    +

    Defined in node_modules/@types/react/index.d.ts:1891

    +
    +

    Optional resource#

    +

    • resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional results#

    +

    • results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional reversed#

    +

    • reversed? : boolean

    +

    Inherited from LineProgressProps.reversed

    +

    Defined in node_modules/@types/react/index.d.ts:1892

    +
    +

    Optional role#

    +

    • role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1772

    +
    +

    Optional rowSpan#

    +

    • rowSpan? : number

    +

    Inherited from LineProgressProps.rowSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1894

    +
    +

    Optional rows#

    +

    • rows? : number

    +

    Inherited from LineProgressProps.rows

    +

    Defined in node_modules/@types/react/index.d.ts:1893

    +
    +

    Optional sandbox#

    +

    • sandbox? : string

    +

    Inherited from LineProgressProps.sandbox

    +

    Defined in node_modules/@types/react/index.d.ts:1895

    +
    +

    Optional scope#

    +

    • scope? : string

    +

    Inherited from LineProgressProps.scope

    +

    Defined in node_modules/@types/react/index.d.ts:1896

    +
    +

    Optional scoped#

    +

    • scoped? : boolean

    +

    Inherited from LineProgressProps.scoped

    +

    Defined in node_modules/@types/react/index.d.ts:1897

    +
    +

    Optional scrolling#

    +

    • scrolling? : string

    +

    Inherited from LineProgressProps.scrolling

    +

    Defined in node_modules/@types/react/index.d.ts:1898

    +
    +

    Optional seamless#

    +

    • seamless? : boolean

    +

    Inherited from LineProgressProps.seamless

    +

    Defined in node_modules/@types/react/index.d.ts:1899

    +
    +

    Optional security#

    +

    • security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional selected#

    +

    • selected? : boolean

    +

    Inherited from LineProgressProps.selected

    +

    Defined in node_modules/@types/react/index.d.ts:1900

    +
    +

    Optional shape#

    +

    • shape? : string

    +

    Inherited from LineProgressProps.shape

    +

    Defined in node_modules/@types/react/index.d.ts:1901

    +
    +

    Optional size#

    +

    • size? : number

    +

    Inherited from LineProgressProps.size

    +

    Defined in node_modules/@types/react/index.d.ts:1902

    +
    +

    Optional sizes#

    +

    • sizes? : string

    +

    Inherited from LineProgressProps.sizes

    +

    Defined in node_modules/@types/react/index.d.ts:1903

    +
    +

    Optional slot#

    +

    • slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional spacer#

    +

    • spacer? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:294

    +
    +

    Optional span#

    +

    • span? : number

    +

    Inherited from LineProgressProps.span

    +

    Defined in node_modules/@types/react/index.d.ts:1904

    +
    +

    Optional spellCheck#

    +

    • spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional src#

    +

    • src? : string

    +

    Inherited from LineProgressProps.src

    +

    Defined in node_modules/@types/react/index.d.ts:1905

    +
    +

    Optional srcDoc#

    +

    • srcDoc? : string

    +

    Inherited from LineProgressProps.srcDoc

    +

    Defined in node_modules/@types/react/index.d.ts:1906

    +
    +

    Optional srcLang#

    +

    • srcLang? : string

    +

    Inherited from LineProgressProps.srcLang

    +

    Defined in node_modules/@types/react/index.d.ts:1907

    +
    +

    Optional srcSet#

    +

    • srcSet? : string

    +

    Inherited from LineProgressProps.srcSet

    +

    Defined in node_modules/@types/react/index.d.ts:1908

    +
    +

    Optional start#

    +

    • start? : number

    +

    Inherited from LineProgressProps.start

    +

    Defined in node_modules/@types/react/index.d.ts:1909

    +
    +

    Optional step#

    +

    • step? : number | string

    +

    Inherited from LineProgressProps.step

    +

    Defined in node_modules/@types/react/index.d.ts:1910

    +
    +

    Optional style#

    +

    • style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional summary#

    +

    • summary? : string

    +

    Inherited from LineProgressProps.summary

    +

    Defined in node_modules/@types/react/index.d.ts:1911

    +
    +

    Optional suppressContentEditableWarning#

    +

    • suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional suppressHydrationWarning#

    +

    • suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional tabIndex#

    +

    • tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional target#

    +

    • target? : string

    +

    Inherited from LineProgressProps.target

    +

    Defined in node_modules/@types/react/index.d.ts:1912

    +
    +

    Optional title#

    +

    • title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional translate#

    +

    • translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional type#

    +

    • type? : string

    +

    Inherited from LineProgressProps.type

    +

    Defined in node_modules/@types/react/index.d.ts:1913

    +
    +

    Optional typeof#

    +

    • typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional unselectable#

    +

    • unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional useMap#

    +

    • useMap? : string

    +

    Inherited from LineProgressProps.useMap

    +

    Defined in node_modules/@types/react/index.d.ts:1914

    +
    +

    Optional value#

    +

    • value? : string | string[] | number

    +

    Inherited from MenuItemProps.value

    +

    Defined in node_modules/@types/react/index.d.ts:1915

    +
    + +

    • valueLink? : ReactLink‹boolean | string | number›

    +

    Inherited from ButtonProps.valueLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:27

    +
    +

    Optional vocab#

    +

    • vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional width#

    +

    • width? : number | string

    +

    Inherited from LineProgressProps.width

    +

    Defined in node_modules/@types/react/index.d.ts:1916

    +
    +

    Optional wmode#

    +

    • wmode? : string

    +

    Inherited from LineProgressProps.wmode

    +

    Defined in node_modules/@types/react/index.d.ts:1917

    +
    +

    Optional wrap#

    +

    • wrap? : string

    +

    Inherited from LineProgressProps.wrap

    +

    Defined in node_modules/@types/react/index.d.ts:1918

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.menuposition/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.menuposition/index.html new file mode 100644 index 0000000000..8406235708 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.menuposition/index.html @@ -0,0 +1,1003 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: MenuPosition - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: MenuPosition#

    +

    Hierarchy#

    +
      +
    • MenuPosition
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional bottom#

    +

    • bottom? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:17

    +
    +

    Optional left#

    +

    • left? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:14

    +
    +

    Optional right#

    +

    • right? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:16

    +
    +

    Optional top#

    +

    • top? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:15

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.menuprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.menuprops/index.html new file mode 100644 index 0000000000..8663a5dd0f --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.menuprops/index.html @@ -0,0 +1,1136 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: MenuProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: MenuProps#

    +

    Hierarchy#

    +
      +
    • MenuProps
      • +
    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional autoFocus#

    +

    • autoFocus? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:27

    +
    +

    Optional children#

    +

    • children? : ReactNode

    +

    Defined in src/renderer/components/menu/menu.tsx:33

    +
    +

    Optional className#

    +

    • className? : string

    +

    Defined in src/renderer/components/menu/menu.tsx:25

    +
    +

    Optional closeOnClickItem#

    +

    • closeOnClickItem? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:29

    +
    +

    Optional closeOnClickOutside#

    +

    • closeOnClickOutside? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:30

    +
    +

    Optional closeOnScroll#

    +

    • closeOnScroll? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:31

    +
    +

    Optional htmlFor#

    +

    • htmlFor? : string

    +

    Defined in src/renderer/components/menu/menu.tsx:26

    +
    +

    Optional id#

    +

    • id? : string

    +

    Defined in src/renderer/components/menu/menu.tsx:24

    +
    +

    Optional isOpen#

    +

    • isOpen? : boolean

    +

    Defined in src/renderer/components/menu/menu.tsx:21

    +
    +

    Optional position#

    +

    • position? : MenuPosition

    +

    Defined in src/renderer/components/menu/menu.tsx:32

    +
    +

    Optional usePortal#

    +

    • usePortal? : boolean | HTMLElement

    +

    Defined in src/renderer/components/menu/menu.tsx:28

    +

    Methods#

    +

    close#

    +

    ▸ close(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:23

    +

    Returns: void

    +
    +

    open#

    +

    ▸ open(): void

    +

    Defined in src/renderer/components/menu/menu.tsx:22

    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.notification/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.notification/index.html new file mode 100644 index 0000000000..e1984e7119 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.notification/index.html @@ -0,0 +1,1003 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: Notification - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: Notification#

    +

    Hierarchy#

    +
      +
    • Notification
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional id#

    +

    • id? : NotificationId

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:17

    +
    +

    message#

    +

    • message: NotificationMessage

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:18

    +
    +

    Optional status#

    +

    • status? : NotificationStatus

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:19

    +
    +

    Optional timeout#

    +

    • timeout? : number

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:20

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html new file mode 100644 index 0000000000..0049baf0a2 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.pagelayoutprops/index.html @@ -0,0 +1,3179 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: PageLayoutProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: PageLayoutProps#

    +

    Hierarchy#

    +
      +
    • DOMAttributes‹any›
      • +
    +

    ↳ PageLayoutProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional back#

    +

    • back? : function

    +

    Defined in src/renderer/components/layout/page-layout.tsx:17

    +

    Type declaration:

    +

    ▸ (evt: MouseEvent | KeyboardEvent): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtMouseEvent | KeyboardEvent
    +
    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional className#

    +

    • className? : IClassName

    +

    Defined in src/renderer/components/layout/page-layout.tsx:10

    +
    +

    Optional contentClass#

    +

    • contentClass? : IClassName

    +

    Defined in src/renderer/components/layout/page-layout.tsx:13

    +
    +

    Optional contentGaps#

    +

    • contentGaps? : boolean

    +

    Defined in src/renderer/components/layout/page-layout.tsx:15

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    + +

    • header: React.ReactNode

    +

    Defined in src/renderer/components/layout/page-layout.tsx:11

    +
    +

    Optional headerClass#

    +

    • headerClass? : IClassName

    +

    Defined in src/renderer/components/layout/page-layout.tsx:12

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    +
    +

    Optional provideBackButtonNavigation#

    +

    • provideBackButtonNavigation? : boolean

    +

    Defined in src/renderer/components/layout/page-layout.tsx:14

    +
    +

    Optional showOnTop#

    +

    • showOnTop? : boolean

    +

    Defined in src/renderer/components/layout/page-layout.tsx:16

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html new file mode 100644 index 0000000000..04d8042ac9 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.radiogroupprops/index.html @@ -0,0 +1,1054 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: RadioGroupProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: RadioGroupProps#

    +

    Hierarchy#

    +
      +
    • RadioGroupProps
      • +
    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional asButtons#

    +

    • asButtons? : boolean

    +

    Defined in src/renderer/components/radio/radio.tsx:11

    +
    +

    Optional className#

    +

    • className? : any

    +

    Defined in src/renderer/components/radio/radio.tsx:9

    +
    +

    Optional disabled#

    +

    • disabled? : boolean

    +

    Defined in src/renderer/components/radio/radio.tsx:12

    +
    +

    Optional value#

    +

    • value? : any

    +

    Defined in src/renderer/components/radio/radio.tsx:10

    +

    Methods#

    +

    Optional onChange#

    +

    ▸ onChange(value: string): void

    +

    Defined in src/renderer/components/radio/radio.tsx:13

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    valuestring
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html new file mode 100644 index 0000000000..42664f231c --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.selectoption/index.html @@ -0,0 +1,988 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: SelectOption ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html new file mode 100644 index 0000000000..84da6acce8 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.selectprops/index.html @@ -0,0 +1,2253 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: SelectProps ‹**T**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: SelectProps ‹T›#

    +

    Type parameters#

    +

    ▪ T

    +

    Hierarchy#

    +
      +
    • +

      Props‹T›

      +
      • +
    • +

      CreatableProps‹T›

      +
      • +
    +

    ↳ SelectProps

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional allowCreateWhileLoading#

    +

    • allowCreateWhileLoading? : boolean

    +

    Inherited from SelectProps.allowCreateWhileLoading

    +

    Defined in node_modules/@types/react-select/src/Creatable.d.ts:11

    +
    +

    Optional aria-label#

    +

    • aria-label? : string

    +

    Inherited from SelectProps.aria-label

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:58

    +
    +

    Optional aria-labelledby#

    +

    • aria-labelledby? : string

    +

    Inherited from SelectProps.aria-labelledby

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:60

    +
    +

    Optional autoConvertOptions#

    +

    • autoConvertOptions? : boolean

    +

    Defined in src/renderer/components/select/select.tsx:30

    +
    +

    Optional autoFocus#

    +

    • autoFocus? : boolean

    +

    Inherited from SelectProps.autoFocus

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:62

    +
    +

    Optional backspaceRemovesValue#

    +

    • backspaceRemovesValue? : boolean

    +

    Inherited from SelectProps.backspaceRemovesValue

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:64

    +
    +

    Optional blurInputOnSelect#

    +

    • blurInputOnSelect? : boolean

    +

    Inherited from SelectProps.blurInputOnSelect

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:66

    +
    +

    Optional captureMenuScroll#

    +

    • captureMenuScroll? : boolean

    +

    Inherited from SelectProps.captureMenuScroll

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:68

    +
    +

    Optional className#

    +

    • className? : string

    +

    Inherited from SelectProps.className

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:70

    +
    +

    Optional classNamePrefix#

    +

    • classNamePrefix? : string | null

    +

    Inherited from SelectProps.classNamePrefix

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:72

    +
    +

    Optional closeMenuOnScroll#

    +

    • closeMenuOnScroll? : boolean | EventListener

    +

    Inherited from SelectProps.closeMenuOnScroll

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:87

    +
    +

    Optional closeMenuOnSelect#

    +

    • closeMenuOnSelect? : boolean

    +

    Inherited from SelectProps.closeMenuOnSelect

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:74

    +
    +

    Optional components#

    +

    • components? : SelectComponentsConfig‹T›

    +

    Inherited from SelectProps.components

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:97

    +
    +

    Optional controlShouldRenderValue#

    +

    • controlShouldRenderValue? : boolean

    +

    Inherited from SelectProps.controlShouldRenderValue

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:99

    +
    +

    Optional createOptionPosition#

    +

    • createOptionPosition? : "first" | "last"

    +

    Inherited from SelectProps.createOptionPosition

    +

    Defined in node_modules/@types/react-select/src/Creatable.d.ts:26

    +
    +

    Optional defaultInputValue#

    +

    • defaultInputValue? : string

    +

    Inherited from SelectProps.defaultInputValue

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:207

    +
    +

    Optional defaultMenuIsOpen#

    +

    • defaultMenuIsOpen? : boolean

    +

    Inherited from SelectProps.defaultMenuIsOpen

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:208

    +
    +

    Optional defaultValue#

    +

    • defaultValue? : ValueType‹T›

    +

    Inherited from SelectProps.defaultValue

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:209

    +
    +

    Optional delimiter#

    +

    • delimiter? : string

    +

    Inherited from SelectProps.delimiter

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:101

    +
    +

    Optional escapeClearsValue#

    +

    • escapeClearsValue? : boolean

    +

    Inherited from SelectProps.escapeClearsValue

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:103

    +
    +

    Optional filterOption#

    +

    • filterOption? : function | null

    +

    Inherited from SelectProps.filterOption

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:105

    +
    +

    Optional formatCreateLabel#

    +

    • formatCreateLabel? : function

    +

    Inherited from SelectProps.formatCreateLabel

    +

    Defined in node_modules/@types/react-select/src/Creatable.d.ts:14

    +

    Type declaration:

    +

    ▸ (inputValue: string): React.ReactNode

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    inputValuestring
    +
    +

    Optional formatGroupLabel#

    +

    • formatGroupLabel? : formatGroupLabel‹T›

    +

    Inherited from SelectProps.formatGroupLabel

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:110

    +
    +

    Optional formatOptionLabel#

    +

    • formatOptionLabel? : function

    +

    Inherited from SelectProps.formatOptionLabel

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:112

    +

    Type declaration:

    +

    ▸ (option: T, labelMeta: FormatOptionLabelMeta‹T›): React.ReactNode

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    optionT
    labelMetaFormatOptionLabelMeta‹T›
    +
    +

    Optional getNewOptionData#

    +

    • getNewOptionData? : function

    +

    Inherited from SelectProps.getNewOptionData

    +

    Defined in node_modules/@types/react-select/src/Creatable.d.ts:20

    +

    Type declaration:

    +

    ▸ (inputValue: string, optionLabel: React.ReactNode): T

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    inputValuestring
    optionLabelReact.ReactNode
    +
    +

    Optional getOptionLabel#

    +

    • getOptionLabel? : getOptionLabel‹T›

    +

    Inherited from SelectProps.getOptionLabel

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:114

    +
    +

    Optional getOptionValue#

    +

    • getOptionValue? : getOptionValue‹T›

    +

    Inherited from SelectProps.getOptionValue

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:116

    +
    +

    Optional hideSelectedOptions#

    +

    • hideSelectedOptions? : boolean

    +

    Inherited from SelectProps.hideSelectedOptions

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:118

    +
    +

    Optional id#

    +

    • id? : string

    +

    Inherited from SelectProps.id

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:120

    +
    +

    Optional inputId#

    +

    • inputId? : string

    +

    Inherited from SelectProps.inputId

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:124

    +
    +

    Optional inputValue#

    +

    • inputValue? : string

    +

    Inherited from SelectProps.inputValue

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:122

    +
    +

    Optional instanceId#

    +

    • instanceId? : number | string

    +

    Inherited from SelectProps.instanceId

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:126

    +
    +

    Optional isClearable#

    +

    • isClearable? : boolean

    +

    Inherited from SelectProps.isClearable

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:128

    +
    +

    Optional isCreatable#

    +

    • isCreatable? : boolean

    +

    Defined in src/renderer/components/select/select.tsx:29

    +
    +

    Optional isDisabled#

    +

    • isDisabled? : boolean

    +

    Inherited from SelectProps.isDisabled

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:130

    +
    +

    Optional isLoading#

    +

    • isLoading? : boolean

    +

    Inherited from SelectProps.isLoading

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:132

    +
    +

    Optional isMulti#

    +

    • isMulti? : boolean

    +

    Inherited from SelectProps.isMulti

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:138

    +
    +

    Optional isOptionDisabled#

    +

    • isOptionDisabled? : function

    +

    Inherited from SelectProps.isOptionDisabled

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:134

    +

    Type declaration:

    +

    ▸ (option: T, options: OptionsType‹T›): boolean | false

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    optionT
    optionsOptionsType‹T›
    +
    +

    Optional isOptionSelected#

    +

    • isOptionSelected? : function

    +

    Inherited from SelectProps.isOptionSelected

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:136

    +

    Type declaration:

    +

    ▸ (option: T, options: OptionsType‹T›): boolean

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    optionT
    optionsOptionsType‹T›
    +
    +

    Optional isRtl#

    +

    • isRtl? : boolean

    +

    Inherited from SelectProps.isRtl

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:140

    +
    +

    Optional isSearchable#

    +

    • isSearchable? : boolean

    +

    Inherited from SelectProps.isSearchable

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:142

    +
    +

    Optional isValidNewOption#

    +

    • isValidNewOption? : function

    +

    Inherited from SelectProps.isValidNewOption

    +

    Defined in node_modules/@types/react-select/src/Creatable.d.ts:17

    +

    Type declaration:

    +

    ▸ (inputValue: string, value: ValueType‹T›, options: OptionsType‹T›): boolean

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    inputValuestring
    valueValueType‹T›
    optionsOptionsType‹T›
    +
    +

    Optional loadingMessage#

    +

    • loadingMessage? : function

    +

    Inherited from SelectProps.loadingMessage

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:144

    +

    Type declaration:

    +

    ▸ (obj: object): string | null

    +

    Parameters:

    +

    ▪ obj: object

    + + + + + + + + + + + + + +
    NameType
    inputValuestring
    +
    +

    Optional maxMenuHeight#

    +

    • maxMenuHeight? : number

    +

    Inherited from SelectProps.maxMenuHeight

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:148

    +
    +

    Optional menuClass#

    +

    • menuClass? : string

    +

    Defined in src/renderer/components/select/select.tsx:28

    +
    +

    Optional menuIsOpen#

    +

    • menuIsOpen? : boolean

    +

    Inherited from SelectProps.menuIsOpen

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:150

    +
    +

    Optional menuPlacement#

    +

    • menuPlacement? : MenuPlacement

    +

    Inherited from SelectProps.menuPlacement

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:153

    +
    +

    Optional menuPortalTarget#

    +

    • menuPortalTarget? : HTMLElement | null

    +

    Inherited from SelectProps.menuPortalTarget

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:157

    +
    +

    Optional menuPosition#

    +

    • menuPosition? : MenuPosition

    +

    Inherited from SelectProps.menuPosition

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:155

    +
    +

    Optional menuShouldBlockScroll#

    +

    • menuShouldBlockScroll? : boolean

    +

    Inherited from SelectProps.menuShouldBlockScroll

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:159

    +
    +

    Optional menuShouldScrollIntoView#

    +

    • menuShouldScrollIntoView? : boolean

    +

    Inherited from SelectProps.menuShouldScrollIntoView

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:161

    +
    +

    Optional minMenuHeight#

    +

    • minMenuHeight? : number

    +

    Inherited from SelectProps.minMenuHeight

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:146

    +
    +

    Optional name#

    +

    • name? : string

    +

    Inherited from SelectProps.name

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:163

    +
    +

    Optional noOptionsMessage#

    +

    • noOptionsMessage? : function

    +

    Inherited from SelectProps.noOptionsMessage

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:165

    +

    Type declaration:

    +

    ▸ (obj: object): string | null

    +

    Parameters:

    +

    ▪ obj: object

    + + + + + + + + + + + + + +
    NameType
    inputValuestring
    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler

    +

    Inherited from SelectProps.onBlur

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:167

    +
    +

    Optional onCreateOption#

    +

    • onCreateOption? : function

    +

    Inherited from SelectProps.onCreateOption

    +

    Defined in node_modules/@types/react-select/src/Creatable.d.ts:24

    +

    Type declaration:

    +

    ▸ (inputValue: string): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    inputValuestring
    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler

    +

    Inherited from SelectProps.onFocus

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:171

    +
    +

    Optional onInputChange#

    +

    • onInputChange? : function

    +

    Inherited from SelectProps.onInputChange

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:173

    +

    Type declaration:

    +

    ▸ (newValue: string, actionMeta: InputActionMeta): void

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    newValuestring
    actionMetaInputActionMeta
    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler

    +

    Inherited from SelectProps.onKeyDown

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:175

    +
    +

    Optional onMenuClose#

    +

    • onMenuClose? : function

    +

    Inherited from SelectProps.onMenuClose

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:179

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional onMenuOpen#

    +

    • onMenuOpen? : function

    +

    Inherited from SelectProps.onMenuOpen

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:177

    +

    Type declaration:

    +

    ▸ (): void

    +
    +

    Optional onMenuScrollToBottom#

    +

    • onMenuScrollToBottom? : function

    +

    Inherited from SelectProps.onMenuScrollToBottom

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:183

    +

    Type declaration:

    +

    ▸ (event: SyntheticEvent‹HTMLElement›): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eventSyntheticEvent‹HTMLElement›
    +
    +

    Optional onMenuScrollToTop#

    +

    • onMenuScrollToTop? : function

    +

    Inherited from SelectProps.onMenuScrollToTop

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:181

    +

    Type declaration:

    +

    ▸ (event: SyntheticEvent‹HTMLElement›): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    eventSyntheticEvent‹HTMLElement›
    +
    +

    Optional openMenuOnClick#

    +

    • openMenuOnClick? : boolean

    +

    Inherited from SelectProps.openMenuOnClick

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:187

    +
    +

    Optional openMenuOnFocus#

    +

    • openMenuOnFocus? : boolean

    +

    Inherited from SelectProps.openMenuOnFocus

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:185

    +
    +

    Optional options#

    +

    • options? : GroupedOptionsType‹T› | OptionsType‹T›

    +

    Inherited from SelectProps.options

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:189

    +
    +

    Optional pageSize#

    +

    • pageSize? : number

    +

    Inherited from SelectProps.pageSize

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:191

    +
    +

    Optional placeholder#

    +

    • placeholder? : React.ReactNode

    +

    Inherited from SelectProps.placeholder

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:193

    +
    +

    Optional screenReaderStatus#

    +

    • screenReaderStatus? : function

    +

    Inherited from SelectProps.screenReaderStatus

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:195

    +

    Type declaration:

    +

    ▸ (obj: object): string

    +

    Parameters:

    +

    ▪ obj: object

    + + + + + + + + + + + + + +
    NameType
    countnumber
    +
    +

    Optional styles#

    +

    • styles? : StylesConfig

    +

    Inherited from SelectProps.styles

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:197

    +
    +

    Optional tabIndex#

    +

    • tabIndex? : string | null

    +

    Inherited from SelectProps.tabIndex

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:201

    +
    +

    Optional tabSelectsValue#

    +

    • tabSelectsValue? : boolean

    +

    Inherited from SelectProps.tabSelectsValue

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:203

    +
    +

    Optional theme#

    +

    • theme? : ThemeConfig

    +

    Inherited from SelectProps.theme

    +

    Defined in node_modules/@types/react-select/src/Select.d.ts:199

    +
    +

    Optional themeName#

    +

    • themeName? : "dark" | "light" | "outlined"

    +

    Defined in src/renderer/components/select/select.tsx:27

    +
    +

    Optional value#

    +

    • value? : T

    +

    Overrides void

    +

    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

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    optionT
    meta?ActionMeta‹any›
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html new file mode 100644 index 0000000000..1fb011ccf4 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.sliderprops/index.html @@ -0,0 +1,1023 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: SliderProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: SliderProps#

    +

    Hierarchy#

    +
      +
    • object
      • +
    +

    ↳ SliderProps

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional className#

    +

    • className? : string

    +

    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

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    evtFormEvent‹any›
    valuenumber
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html new file mode 100644 index 0000000000..97877a6f11 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.spinnerprops/index.html @@ -0,0 +1,5798 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: SpinnerProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: SpinnerProps#

    +

    Hierarchy#

    +
      +
    • HTMLProps‹any›
      • +
    +

    ↳ SpinnerProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    • about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1775

    +
    +

    Optional accept#

    +

    • accept? : string

    +

    Inherited from LineProgressProps.accept

    +

    Defined in node_modules/@types/react/index.d.ts:1813

    +
    +

    Optional acceptCharset#

    +

    • acceptCharset? : string

    +

    Inherited from LineProgressProps.acceptCharset

    +

    Defined in node_modules/@types/react/index.d.ts:1814

    +
    +

    Optional accessKey#

    +

    • accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1751

    +
    +

    Optional action#

    +

    • action? : string

    +

    Inherited from LineProgressProps.action

    +

    Defined in node_modules/@types/react/index.d.ts:1815

    +
    +

    Optional allowFullScreen#

    +

    • allowFullScreen? : boolean

    +

    Inherited from LineProgressProps.allowFullScreen

    +

    Defined in node_modules/@types/react/index.d.ts:1816

    +
    +

    Optional allowTransparency#

    +

    • allowTransparency? : boolean

    +

    Inherited from LineProgressProps.allowTransparency

    +

    Defined in node_modules/@types/react/index.d.ts:1817

    +
    +

    Optional alt#

    +

    • alt? : string

    +

    Inherited from LineProgressProps.alt

    +

    Defined in node_modules/@types/react/index.d.ts:1818

    +
    +

    Optional aria-activedescendant#

    +

    • aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1558

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    • aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    • aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1565

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    • aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    • aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1572

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    • aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1577

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    • aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1582

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    • aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1587

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    • aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1592

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    • aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    • aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1599

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    • aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1604

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    • aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1609

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    • aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1614

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    • aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1619

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    • aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    • aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1626

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    • aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1631

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    • aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    • aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1638

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    • aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1643

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    • aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    • aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1650

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    • aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1655

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    • aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    • aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    • aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    • aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    • aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    • aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    • aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1673

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    • aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1678

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    • aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1683

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    • aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1688

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    • aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1693

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    • aria-relevant? : "additions" | "additions text" | "all" | "removals" | "text"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1698

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    • aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    • aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    • aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1707

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    • aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1712

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    • aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1717

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    • aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1722

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    • aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1727

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    • aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    • aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    • aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    • aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1738

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    • aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional as#

    +

    • as? : string

    +

    Inherited from LineProgressProps.as

    +

    Defined in node_modules/@types/react/index.d.ts:1819

    +
    +

    Optional async#

    +

    • async? : boolean

    +

    Inherited from LineProgressProps.async

    +

    Defined in node_modules/@types/react/index.d.ts:1820

    +
    +

    Optional autoCapitalize#

    +

    • autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1785

    +
    +

    Optional autoComplete#

    +

    • autoComplete? : string

    +

    Inherited from LineProgressProps.autoComplete

    +

    Defined in node_modules/@types/react/index.d.ts:1821

    +
    +

    Optional autoCorrect#

    +

    • autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1786

    +
    +

    Optional autoFocus#

    +

    • autoFocus? : boolean

    +

    Inherited from LineProgressProps.autoFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1822

    +
    +

    Optional autoPlay#

    +

    • autoPlay? : boolean

    +

    Inherited from LineProgressProps.autoPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1823

    +
    +

    Optional autoSave#

    +

    • autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional capture#

    +

    • capture? : boolean | string

    +

    Inherited from LineProgressProps.capture

    +

    Defined in node_modules/@types/react/index.d.ts:1824

    +
    +

    Optional cellPadding#

    +

    • cellPadding? : number | string

    +

    Inherited from LineProgressProps.cellPadding

    +

    Defined in node_modules/@types/react/index.d.ts:1825

    +
    +

    Optional cellSpacing#

    +

    • cellSpacing? : number | string

    +

    Inherited from LineProgressProps.cellSpacing

    +

    Defined in node_modules/@types/react/index.d.ts:1826

    +
    +

    Optional center#

    +

    • center? : boolean

    +

    Defined in src/renderer/components/spinner/spinner.tsx:8

    +
    +

    Optional centerHorizontal#

    +

    • centerHorizontal? : boolean

    +

    Defined in src/renderer/components/spinner/spinner.tsx:9

    +
    +

    Optional challenge#

    +

    • challenge? : string

    +

    Inherited from LineProgressProps.challenge

    +

    Defined in node_modules/@types/react/index.d.ts:1828

    +
    +

    Optional charSet#

    +

    • charSet? : string

    +

    Inherited from LineProgressProps.charSet

    +

    Defined in node_modules/@types/react/index.d.ts:1827

    +
    +

    Optional checked#

    +

    • checked? : boolean

    +

    Inherited from LineProgressProps.checked

    +

    Defined in node_modules/@types/react/index.d.ts:1829

    +
    + +

    • checkedLink? : ReactLink‹boolean›

    +

    Inherited from ButtonProps.checkedLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:26

    +
    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional cite#

    +

    • cite? : string

    +

    Inherited from LineProgressProps.cite

    +

    Defined in node_modules/@types/react/index.d.ts:1830

    +
    +

    Optional classID#

    +

    • classID? : string

    +

    Inherited from LineProgressProps.classID

    +

    Defined in node_modules/@types/react/index.d.ts:1831

    +
    +

    Optional className#

    +

    • className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1752

    +
    +

    Optional colSpan#

    +

    • colSpan? : number

    +

    Inherited from LineProgressProps.colSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1833

    +
    +

    Optional color#

    +

    • color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional cols#

    +

    • cols? : number

    +

    Inherited from LineProgressProps.cols

    +

    Defined in node_modules/@types/react/index.d.ts:1832

    +
    +

    Optional content#

    +

    • content? : string

    +

    Inherited from LineProgressProps.content

    +

    Defined in node_modules/@types/react/index.d.ts:1834

    +
    +

    Optional contentEditable#

    +

    • contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional contextMenu#

    +

    • contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional controls#

    +

    • controls? : boolean

    +

    Inherited from LineProgressProps.controls

    +

    Defined in node_modules/@types/react/index.d.ts:1835

    +
    +

    Optional coords#

    +

    • coords? : string

    +

    Inherited from LineProgressProps.coords

    +

    Defined in node_modules/@types/react/index.d.ts:1836

    +
    +

    Optional crossOrigin#

    +

    • crossOrigin? : string

    +

    Inherited from LineProgressProps.crossOrigin

    +

    Defined in node_modules/@types/react/index.d.ts:1837

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    +

    Optional data#

    +

    • data? : string

    +

    Inherited from LineProgressProps.data

    +

    Defined in node_modules/@types/react/index.d.ts:1838

    +
    +

    Optional datatype#

    +

    • datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1776

    +
    +

    Optional dateTime#

    +

    • dateTime? : string

    +

    Inherited from LineProgressProps.dateTime

    +

    Defined in node_modules/@types/react/index.d.ts:1839

    +
    +

    Optional default#

    +

    • default? : boolean

    +

    Inherited from LineProgressProps.default

    +

    Defined in node_modules/@types/react/index.d.ts:1840

    +
    +

    Optional defaultChecked#

    +

    • defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1745

    +
    +

    Optional defaultValue#

    +

    • defaultValue? : string | number | string[]

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1746

    +
    +

    Optional defer#

    +

    • defer? : boolean

    +

    Inherited from LineProgressProps.defer

    +

    Defined in node_modules/@types/react/index.d.ts:1841

    +
    +

    Optional dir#

    +

    • dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional disabled#

    +

    • disabled? : boolean

    +

    Inherited from LineProgressProps.disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1842

    +
    +

    Optional download#

    +

    • download? : any

    +

    Inherited from LineProgressProps.download

    +

    Defined in node_modules/@types/react/index.d.ts:1843

    +
    +

    Optional draggable#

    +

    • draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional encType#

    +

    • encType? : string

    +

    Inherited from LineProgressProps.encType

    +

    Defined in node_modules/@types/react/index.d.ts:1844

    +
    +

    Optional form#

    +

    • form? : string

    +

    Inherited from LineProgressProps.form

    +

    Defined in node_modules/@types/react/index.d.ts:1845

    +
    +

    Optional formAction#

    +

    • formAction? : string

    +

    Inherited from LineProgressProps.formAction

    +

    Defined in node_modules/@types/react/index.d.ts:1846

    +
    +

    Optional formEncType#

    +

    • formEncType? : string

    +

    Inherited from LineProgressProps.formEncType

    +

    Defined in node_modules/@types/react/index.d.ts:1847

    +
    +

    Optional formMethod#

    +

    • formMethod? : string

    +

    Inherited from LineProgressProps.formMethod

    +

    Defined in node_modules/@types/react/index.d.ts:1848

    +
    +

    Optional formNoValidate#

    +

    • formNoValidate? : boolean

    +

    Inherited from LineProgressProps.formNoValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1849

    +
    +

    Optional formTarget#

    +

    • formTarget? : string

    +

    Inherited from LineProgressProps.formTarget

    +

    Defined in node_modules/@types/react/index.d.ts:1850

    +
    +

    Optional frameBorder#

    +

    • frameBorder? : number | string

    +

    Inherited from LineProgressProps.frameBorder

    +

    Defined in node_modules/@types/react/index.d.ts:1851

    +
    +

    Optional headers#

    +

    • headers? : string

    +

    Inherited from LineProgressProps.headers

    +

    Defined in node_modules/@types/react/index.d.ts:1852

    +
    +

    Optional height#

    +

    • height? : number | string

    +

    Inherited from LineProgressProps.height

    +

    Defined in node_modules/@types/react/index.d.ts:1853

    +
    +

    Optional hidden#

    +

    • hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional high#

    +

    • high? : number

    +

    Inherited from LineProgressProps.high

    +

    Defined in node_modules/@types/react/index.d.ts:1854

    +
    +

    Optional href#

    +

    • href? : string

    +

    Inherited from LineProgressProps.href

    +

    Defined in node_modules/@types/react/index.d.ts:1855

    +
    +

    Optional hrefLang#

    +

    • hrefLang? : string

    +

    Inherited from LineProgressProps.hrefLang

    +

    Defined in node_modules/@types/react/index.d.ts:1856

    +
    +

    Optional htmlFor#

    +

    • htmlFor? : string

    +

    Inherited from LineProgressProps.htmlFor

    +

    Defined in node_modules/@types/react/index.d.ts:1857

    +
    +

    Optional httpEquiv#

    +

    • httpEquiv? : string

    +

    Inherited from LineProgressProps.httpEquiv

    +

    Defined in node_modules/@types/react/index.d.ts:1858

    +
    +

    Optional id#

    +

    • id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional inlist#

    +

    • inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional inputMode#

    +

    • inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1803

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional integrity#

    +

    • integrity? : string

    +

    Inherited from LineProgressProps.integrity

    +

    Defined in node_modules/@types/react/index.d.ts:1859

    +
    +

    Optional is#

    +

    • is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1808

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    • itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemProp#

    +

    • itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional itemRef#

    +

    • itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional itemScope#

    +

    • itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional itemType#

    +

    • itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional key#

    +

    • key? : Key

    +

    Inherited from LineProgressProps.key

    +

    Defined in node_modules/@types/react/index.d.ts:139

    +
    +

    Optional keyParams#

    +

    • keyParams? : string

    +

    Inherited from LineProgressProps.keyParams

    +

    Defined in node_modules/@types/react/index.d.ts:1860

    +
    +

    Optional keyType#

    +

    • keyType? : string

    +

    Inherited from LineProgressProps.keyType

    +

    Defined in node_modules/@types/react/index.d.ts:1861

    +
    +

    Optional kind#

    +

    • kind? : string

    +

    Inherited from LineProgressProps.kind

    +

    Defined in node_modules/@types/react/index.d.ts:1862

    +
    +

    Optional label#

    +

    • label? : string

    +

    Inherited from LineProgressProps.label

    +

    Defined in node_modules/@types/react/index.d.ts:1863

    +
    +

    Optional lang#

    +

    • lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional list#

    +

    • list? : string

    +

    Inherited from LineProgressProps.list

    +

    Defined in node_modules/@types/react/index.d.ts:1864

    +
    +

    Optional loop#

    +

    • loop? : boolean

    +

    Inherited from LineProgressProps.loop

    +

    Defined in node_modules/@types/react/index.d.ts:1865

    +
    +

    Optional low#

    +

    • low? : number

    +

    Inherited from LineProgressProps.low

    +

    Defined in node_modules/@types/react/index.d.ts:1866

    +
    +

    Optional manifest#

    +

    • manifest? : string

    +

    Inherited from LineProgressProps.manifest

    +

    Defined in node_modules/@types/react/index.d.ts:1867

    +
    +

    Optional marginHeight#

    +

    • marginHeight? : number

    +

    Inherited from LineProgressProps.marginHeight

    +

    Defined in node_modules/@types/react/index.d.ts:1868

    +
    +

    Optional marginWidth#

    +

    • marginWidth? : number

    +

    Inherited from LineProgressProps.marginWidth

    +

    Defined in node_modules/@types/react/index.d.ts:1869

    +
    +

    Optional max#

    +

    • max? : number | string

    +

    Inherited from MenuItemProps.max

    +

    Defined in node_modules/@types/react/index.d.ts:1870

    +
    +

    Optional maxLength#

    +

    • maxLength? : number

    +

    Inherited from LineProgressProps.maxLength

    +

    Defined in node_modules/@types/react/index.d.ts:1871

    +
    +

    Optional media#

    +

    • media? : string

    +

    Inherited from LineProgressProps.media

    +

    Defined in node_modules/@types/react/index.d.ts:1872

    +
    +

    Optional mediaGroup#

    +

    • mediaGroup? : string

    +

    Inherited from LineProgressProps.mediaGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1873

    +
    +

    Optional method#

    +

    • method? : string

    +

    Inherited from LineProgressProps.method

    +

    Defined in node_modules/@types/react/index.d.ts:1874

    +
    +

    Optional min#

    +

    • min? : number | string

    +

    Inherited from MenuItemProps.min

    +

    Defined in node_modules/@types/react/index.d.ts:1875

    +
    +

    Optional minLength#

    +

    • minLength? : number

    +

    Inherited from LineProgressProps.minLength

    +

    Defined in node_modules/@types/react/index.d.ts:1876

    +
    +

    Optional multiple#

    +

    • multiple? : boolean

    +

    Inherited from LineProgressProps.multiple

    +

    Defined in node_modules/@types/react/index.d.ts:1877

    +
    +

    Optional muted#

    +

    • muted? : boolean

    +

    Inherited from LineProgressProps.muted

    +

    Defined in node_modules/@types/react/index.d.ts:1878

    +
    +

    Optional name#

    +

    • name? : string

    +

    Inherited from LineProgressProps.name

    +

    Defined in node_modules/@types/react/index.d.ts:1879

    +
    +

    Optional noValidate#

    +

    • noValidate? : boolean

    +

    Inherited from LineProgressProps.noValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1881

    +
    +

    Optional nonce#

    +

    • nonce? : string

    +

    Inherited from LineProgressProps.nonce

    +

    Defined in node_modules/@types/react/index.d.ts:1880

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    +
    +

    Optional open#

    +

    • open? : boolean

    +

    Inherited from LineProgressProps.open

    +

    Defined in node_modules/@types/react/index.d.ts:1882

    +
    +

    Optional optimum#

    +

    • optimum? : number

    +

    Inherited from LineProgressProps.optimum

    +

    Defined in node_modules/@types/react/index.d.ts:1883

    +
    +

    Optional pattern#

    +

    • pattern? : string

    +

    Inherited from LineProgressProps.pattern

    +

    Defined in node_modules/@types/react/index.d.ts:1884

    +
    +

    Optional placeholder#

    +

    • placeholder? : string

    +

    Inherited from LineProgressProps.placeholder

    +

    Overrides ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1885

    +
    +

    Optional playsInline#

    +

    • playsInline? : boolean

    +

    Inherited from LineProgressProps.playsInline

    +

    Defined in node_modules/@types/react/index.d.ts:1886

    +
    +

    Optional poster#

    +

    • poster? : string

    +

    Inherited from LineProgressProps.poster

    +

    Defined in node_modules/@types/react/index.d.ts:1887

    +
    +

    Optional prefix#

    +

    • prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional preload#

    +

    • preload? : string

    +

    Inherited from LineProgressProps.preload

    +

    Defined in node_modules/@types/react/index.d.ts:1888

    +
    +

    Optional property#

    +

    • property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional radioGroup#

    +

    • radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1769

    +
    +

    Optional readOnly#

    +

    • readOnly? : boolean

    +

    Inherited from LineProgressProps.readOnly

    +

    Defined in node_modules/@types/react/index.d.ts:1889

    +
    +

    Optional ref#

    +

    • ref? : LegacyRef‹any›

    +

    Inherited from LineProgressProps.ref

    +

    Defined in node_modules/@types/react/index.d.ts:145

    +
    +

    Optional rel#

    +

    • rel? : string

    +

    Inherited from LineProgressProps.rel

    +

    Defined in node_modules/@types/react/index.d.ts:1890

    +
    +

    Optional required#

    +

    • required? : boolean

    +

    Inherited from LineProgressProps.required

    +

    Defined in node_modules/@types/react/index.d.ts:1891

    +
    +

    Optional resource#

    +

    • resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional results#

    +

    • results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional reversed#

    +

    • reversed? : boolean

    +

    Inherited from LineProgressProps.reversed

    +

    Defined in node_modules/@types/react/index.d.ts:1892

    +
    +

    Optional role#

    +

    • role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1772

    +
    +

    Optional rowSpan#

    +

    • rowSpan? : number

    +

    Inherited from LineProgressProps.rowSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1894

    +
    +

    Optional rows#

    +

    • rows? : number

    +

    Inherited from LineProgressProps.rows

    +

    Defined in node_modules/@types/react/index.d.ts:1893

    +
    +

    Optional sandbox#

    +

    • sandbox? : string

    +

    Inherited from LineProgressProps.sandbox

    +

    Defined in node_modules/@types/react/index.d.ts:1895

    +
    +

    Optional scope#

    +

    • scope? : string

    +

    Inherited from LineProgressProps.scope

    +

    Defined in node_modules/@types/react/index.d.ts:1896

    +
    +

    Optional scoped#

    +

    • scoped? : boolean

    +

    Inherited from LineProgressProps.scoped

    +

    Defined in node_modules/@types/react/index.d.ts:1897

    +
    +

    Optional scrolling#

    +

    • scrolling? : string

    +

    Inherited from LineProgressProps.scrolling

    +

    Defined in node_modules/@types/react/index.d.ts:1898

    +
    +

    Optional seamless#

    +

    • seamless? : boolean

    +

    Inherited from LineProgressProps.seamless

    +

    Defined in node_modules/@types/react/index.d.ts:1899

    +
    +

    Optional security#

    +

    • security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional selected#

    +

    • selected? : boolean

    +

    Inherited from LineProgressProps.selected

    +

    Defined in node_modules/@types/react/index.d.ts:1900

    +
    +

    Optional shape#

    +

    • shape? : string

    +

    Inherited from LineProgressProps.shape

    +

    Defined in node_modules/@types/react/index.d.ts:1901

    +
    +

    Optional singleColor#

    +

    • singleColor? : boolean

    +

    Defined in src/renderer/components/spinner/spinner.tsx:7

    +
    +

    Optional size#

    +

    • size? : number

    +

    Inherited from LineProgressProps.size

    +

    Defined in node_modules/@types/react/index.d.ts:1902

    +
    +

    Optional sizes#

    +

    • sizes? : string

    +

    Inherited from LineProgressProps.sizes

    +

    Defined in node_modules/@types/react/index.d.ts:1903

    +
    +

    Optional slot#

    +

    • slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional span#

    +

    • span? : number

    +

    Inherited from LineProgressProps.span

    +

    Defined in node_modules/@types/react/index.d.ts:1904

    +
    +

    Optional spellCheck#

    +

    • spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional src#

    +

    • src? : string

    +

    Inherited from LineProgressProps.src

    +

    Defined in node_modules/@types/react/index.d.ts:1905

    +
    +

    Optional srcDoc#

    +

    • srcDoc? : string

    +

    Inherited from LineProgressProps.srcDoc

    +

    Defined in node_modules/@types/react/index.d.ts:1906

    +
    +

    Optional srcLang#

    +

    • srcLang? : string

    +

    Inherited from LineProgressProps.srcLang

    +

    Defined in node_modules/@types/react/index.d.ts:1907

    +
    +

    Optional srcSet#

    +

    • srcSet? : string

    +

    Inherited from LineProgressProps.srcSet

    +

    Defined in node_modules/@types/react/index.d.ts:1908

    +
    +

    Optional start#

    +

    • start? : number

    +

    Inherited from LineProgressProps.start

    +

    Defined in node_modules/@types/react/index.d.ts:1909

    +
    +

    Optional step#

    +

    • step? : number | string

    +

    Inherited from LineProgressProps.step

    +

    Defined in node_modules/@types/react/index.d.ts:1910

    +
    +

    Optional style#

    +

    • style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional summary#

    +

    • summary? : string

    +

    Inherited from LineProgressProps.summary

    +

    Defined in node_modules/@types/react/index.d.ts:1911

    +
    +

    Optional suppressContentEditableWarning#

    +

    • suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional suppressHydrationWarning#

    +

    • suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional tabIndex#

    +

    • tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional target#

    +

    • target? : string

    +

    Inherited from LineProgressProps.target

    +

    Defined in node_modules/@types/react/index.d.ts:1912

    +
    +

    Optional title#

    +

    • title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional translate#

    +

    • translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional type#

    +

    • type? : string

    +

    Inherited from LineProgressProps.type

    +

    Defined in node_modules/@types/react/index.d.ts:1913

    +
    +

    Optional typeof#

    +

    • typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional unselectable#

    +

    • unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional useMap#

    +

    • useMap? : string

    +

    Inherited from LineProgressProps.useMap

    +

    Defined in node_modules/@types/react/index.d.ts:1914

    +
    +

    Optional value#

    +

    • value? : string | string[] | number

    +

    Inherited from MenuItemProps.value

    +

    Defined in node_modules/@types/react/index.d.ts:1915

    +
    + +

    • valueLink? : ReactLink‹boolean | string | number›

    +

    Inherited from ButtonProps.valueLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:27

    +
    +

    Optional vocab#

    +

    • vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional width#

    +

    • width? : number | string

    +

    Inherited from LineProgressProps.width

    +

    Defined in node_modules/@types/react/index.d.ts:1916

    +
    +

    Optional wmode#

    +

    • wmode? : string

    +

    Inherited from LineProgressProps.wmode

    +

    Defined in node_modules/@types/react/index.d.ts:1917

    +
    +

    Optional wrap#

    +

    • wrap? : string

    +

    Inherited from LineProgressProps.wrap

    +

    Defined in node_modules/@types/react/index.d.ts:1918

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html new file mode 100644 index 0000000000..d6b9c343c4 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.statusbrickprops/index.html @@ -0,0 +1,4403 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: StatusBrickProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: StatusBrickProps#

    +

    Hierarchy#

    + +

    ↳ StatusBrickProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    • about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1775

    +
    +

    Optional accessKey#

    +

    • accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1751

    +
    +

    Optional aria-activedescendant#

    +

    • aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1558

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    • aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    • aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1565

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    • aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    • aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1572

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    • aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1577

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    • aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1582

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    • aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1587

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    • aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1592

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    • aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    • aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1599

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    • aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1604

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    • aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1609

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    • aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1614

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    • aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1619

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    • aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    • aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1626

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    • aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1631

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    • aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    • aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1638

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    • aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1643

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    • aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    • aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1650

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    • aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1655

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    • aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    • aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    • aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    • aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    • aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    • aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    • aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1673

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    • aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1678

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    • aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1683

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    • aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1688

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    • aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1693

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    • aria-relevant? : "additions" | "additions text" | "all" | "removals" | "text"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1698

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    • aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    • aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    • aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1707

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    • aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1712

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    • aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1717

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    • aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1722

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    • aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1727

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    • aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    • aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    • aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    • aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1738

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    • aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional autoCapitalize#

    +

    • autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1785

    +
    +

    Optional autoCorrect#

    +

    • autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1786

    +
    +

    Optional autoSave#

    +

    • autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    + +

    • checkedLink? : ReactLink‹boolean›

    +

    Inherited from ButtonProps.checkedLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:26

    +
    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional className#

    +

    • className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1752

    +
    +

    Optional color#

    +

    • color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional contentEditable#

    +

    • contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional contextMenu#

    +

    • contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    +

    Optional datatype#

    +

    • datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1776

    +
    +

    Optional defaultChecked#

    +

    • defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1745

    +
    +

    Optional defaultValue#

    +

    • defaultValue? : string | number | string[]

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1746

    +
    +

    Optional dir#

    +

    • dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional draggable#

    +

    • draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional hidden#

    +

    • hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional id#

    +

    • id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional inlist#

    +

    • inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional inputMode#

    +

    • inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1803

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional is#

    +

    • is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1808

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    • itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemProp#

    +

    • itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional itemRef#

    +

    • itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional itemScope#

    +

    • itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional itemType#

    +

    • itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional lang#

    +

    • lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    +
    +

    Optional placeholder#

    +

    • placeholder? : string

    +

    Inherited from ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1760

    +
    +

    Optional prefix#

    +

    • prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional property#

    +

    • property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional radioGroup#

    +

    • radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1769

    +
    +

    Optional resource#

    +

    • resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional results#

    +

    • results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional role#

    +

    • role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1772

    +
    +

    Optional security#

    +

    • security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional slot#

    +

    • slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional spellCheck#

    +

    • spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional style#

    +

    • style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional suppressContentEditableWarning#

    +

    • suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional suppressHydrationWarning#

    +

    • suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional tabIndex#

    +

    • tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional title#

    +

    • title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional tooltip#

    +

    • tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    +

    Inherited from ButtonProps.tooltip

    +

    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

    +

    forces tooltip to detect the target's parent for mouse events. This is +useful for displaying tooltips even when the target is "disabled"

    +
    +

    Optional translate#

    +

    • translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional typeof#

    +

    • typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional unselectable#

    +

    • unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    + +

    • valueLink? : ReactLink‹boolean | string | number›

    +

    Inherited from ButtonProps.valueLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:27

    +
    +

    Optional vocab#

    +

    • vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html new file mode 100644 index 0000000000..43cb9f402f --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.stepperprops/index.html @@ -0,0 +1,5774 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: StepperProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: StepperProps#

    +

    Hierarchy#

    +
      +
    • HTMLProps‹any›
      • +
    +

    ↳ StepperProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional about#

    +

    • about? : string

    +

    Inherited from ButtonProps.about

    +

    Defined in node_modules/@types/react/index.d.ts:1775

    +
    +

    Optional accept#

    +

    • accept? : string

    +

    Inherited from LineProgressProps.accept

    +

    Defined in node_modules/@types/react/index.d.ts:1813

    +
    +

    Optional acceptCharset#

    +

    • acceptCharset? : string

    +

    Inherited from LineProgressProps.acceptCharset

    +

    Defined in node_modules/@types/react/index.d.ts:1814

    +
    +

    Optional accessKey#

    +

    • accessKey? : string

    +

    Inherited from ButtonProps.accessKey

    +

    Defined in node_modules/@types/react/index.d.ts:1751

    +
    +

    Optional action#

    +

    • action? : string

    +

    Inherited from LineProgressProps.action

    +

    Defined in node_modules/@types/react/index.d.ts:1815

    +
    +

    Optional allowFullScreen#

    +

    • allowFullScreen? : boolean

    +

    Inherited from LineProgressProps.allowFullScreen

    +

    Defined in node_modules/@types/react/index.d.ts:1816

    +
    +

    Optional allowTransparency#

    +

    • allowTransparency? : boolean

    +

    Inherited from LineProgressProps.allowTransparency

    +

    Defined in node_modules/@types/react/index.d.ts:1817

    +
    +

    Optional alt#

    +

    • alt? : string

    +

    Inherited from LineProgressProps.alt

    +

    Defined in node_modules/@types/react/index.d.ts:1818

    +
    +

    Optional aria-activedescendant#

    +

    • aria-activedescendant? : string

    +

    Inherited from ButtonProps.aria-activedescendant

    +

    Defined in node_modules/@types/react/index.d.ts:1558

    +

    Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

    +
    +

    Optional aria-atomic#

    +

    • aria-atomic? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-atomic

    +

    Defined in node_modules/@types/react/index.d.ts:1560

    +

    Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

    +
    +

    Optional aria-autocomplete#

    +

    • aria-autocomplete? : "none" | "inline" | "list" | "both"

    +

    Inherited from ButtonProps.aria-autocomplete

    +

    Defined in node_modules/@types/react/index.d.ts:1565

    +

    Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be +presented if they are made.

    +
    +

    Optional aria-busy#

    +

    • aria-busy? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-busy

    +

    Defined in node_modules/@types/react/index.d.ts:1567

    +

    Indicates an element is being modified and that assistive technologies MAY want to wait until the modifications are complete before exposing them to the user.

    +
    +

    Optional aria-checked#

    +

    • aria-checked? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-checked

    +

    Defined in node_modules/@types/react/index.d.ts:1572

    +

    Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

    +

    see aria-pressed @see aria-selected.

    +
    +

    Optional aria-colcount#

    +

    • aria-colcount? : number

    +

    Inherited from ButtonProps.aria-colcount

    +

    Defined in node_modules/@types/react/index.d.ts:1577

    +

    Defines the total number of columns in a table, grid, or treegrid.

    +

    see aria-colindex.

    +
    +

    Optional aria-colindex#

    +

    • aria-colindex? : number

    +

    Inherited from ButtonProps.aria-colindex

    +

    Defined in node_modules/@types/react/index.d.ts:1582

    +

    Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

    +

    see aria-colcount @see aria-colspan.

    +
    +

    Optional aria-colspan#

    +

    • aria-colspan? : number

    +

    Inherited from ButtonProps.aria-colspan

    +

    Defined in node_modules/@types/react/index.d.ts:1587

    +

    Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-colindex @see aria-rowspan.

    +
    +

    Optional aria-controls#

    +

    • aria-controls? : string

    +

    Inherited from ButtonProps.aria-controls

    +

    Defined in node_modules/@types/react/index.d.ts:1592

    +

    Identifies the element (or elements) whose contents or presence are controlled by the current element.

    +

    see aria-owns.

    +
    +

    Optional aria-current#

    +

    • aria-current? : boolean | "false" | "true" | "page" | "step" | "location" | "date" | "time"

    +

    Inherited from ButtonProps.aria-current

    +

    Defined in node_modules/@types/react/index.d.ts:1594

    +

    Indicates the element that represents the current item within a container or set of related elements.

    +
    +

    Optional aria-describedby#

    +

    • aria-describedby? : string

    +

    Inherited from ButtonProps.aria-describedby

    +

    Defined in node_modules/@types/react/index.d.ts:1599

    +

    Identifies the element (or elements) that describes the object.

    +

    see aria-labelledby

    +
    +

    Optional aria-details#

    +

    • aria-details? : string

    +

    Inherited from ButtonProps.aria-details

    +

    Defined in node_modules/@types/react/index.d.ts:1604

    +

    Identifies the element that provides a detailed, extended description for the object.

    +

    see aria-describedby.

    +
    +

    Optional aria-disabled#

    +

    • aria-disabled? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1609

    +

    Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

    +

    see aria-hidden @see aria-readonly.

    +
    +

    Optional aria-dropeffect#

    +

    • aria-dropeffect? : "none" | "copy" | "execute" | "link" | "move" | "popup"

    +

    Inherited from ButtonProps.aria-dropeffect

    +

    Defined in node_modules/@types/react/index.d.ts:1614

    +

    Indicates what functions can be performed when a dragged object is released on the drop target.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-errormessage#

    +

    • aria-errormessage? : string

    +

    Inherited from ButtonProps.aria-errormessage

    +

    Defined in node_modules/@types/react/index.d.ts:1619

    +

    Identifies the element that provides an error message for the object.

    +

    see aria-invalid @see aria-describedby.

    +
    +

    Optional aria-expanded#

    +

    • aria-expanded? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-expanded

    +

    Defined in node_modules/@types/react/index.d.ts:1621

    +

    Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

    +
    +

    Optional aria-flowto#

    +

    • aria-flowto? : string

    +

    Inherited from ButtonProps.aria-flowto

    +

    Defined in node_modules/@types/react/index.d.ts:1626

    +

    Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, +allows assistive technology to override the general default of reading in document source order.

    +
    +

    Optional aria-grabbed#

    +

    • aria-grabbed? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-grabbed

    +

    Defined in node_modules/@types/react/index.d.ts:1631

    +

    Indicates an element's "grabbed" state in a drag-and-drop operation.

    +

    deprecated in ARIA 1.1

    +
    +

    Optional aria-haspopup#

    +

    • aria-haspopup? : boolean | "false" | "true" | "menu" | "listbox" | "tree" | "grid" | "dialog"

    +

    Inherited from ButtonProps.aria-haspopup

    +

    Defined in node_modules/@types/react/index.d.ts:1633

    +

    Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

    +
    +

    Optional aria-hidden#

    +

    • aria-hidden? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1638

    +

    Indicates whether the element is exposed to an accessibility API.

    +

    see aria-disabled.

    +
    +

    Optional aria-invalid#

    +

    • aria-invalid? : boolean | "false" | "true" | "grammar" | "spelling"

    +

    Inherited from ButtonProps.aria-invalid

    +

    Defined in node_modules/@types/react/index.d.ts:1643

    +

    Indicates the entered value does not conform to the format expected by the application.

    +

    see aria-errormessage.

    +
    +

    Optional aria-keyshortcuts#

    +

    • aria-keyshortcuts? : string

    +

    Inherited from ButtonProps.aria-keyshortcuts

    +

    Defined in node_modules/@types/react/index.d.ts:1645

    +

    Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

    +
    +

    Optional aria-label#

    +

    • aria-label? : string

    +

    Inherited from ButtonProps.aria-label

    +

    Defined in node_modules/@types/react/index.d.ts:1650

    +

    Defines a string value that labels the current element.

    +

    see aria-labelledby.

    +
    +

    Optional aria-labelledby#

    +

    • aria-labelledby? : string

    +

    Inherited from ButtonProps.aria-labelledby

    +

    Defined in node_modules/@types/react/index.d.ts:1655

    +

    Identifies the element (or elements) that labels the current element.

    +

    see aria-describedby.

    +
    +

    Optional aria-level#

    +

    • aria-level? : number

    +

    Inherited from ButtonProps.aria-level

    +

    Defined in node_modules/@types/react/index.d.ts:1657

    +

    Defines the hierarchical level of an element within a structure.

    +
    +

    Optional aria-live#

    +

    • aria-live? : "off" | "assertive" | "polite"

    +

    Inherited from ButtonProps.aria-live

    +

    Defined in node_modules/@types/react/index.d.ts:1659

    +

    Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

    +
    +

    Optional aria-modal#

    +

    • aria-modal? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-modal

    +

    Defined in node_modules/@types/react/index.d.ts:1661

    +

    Indicates whether an element is modal when displayed.

    +
    +

    Optional aria-multiline#

    +

    • aria-multiline? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiline

    +

    Defined in node_modules/@types/react/index.d.ts:1663

    +

    Indicates whether a text box accepts multiple lines of input or only a single line.

    +
    +

    Optional aria-multiselectable#

    +

    • aria-multiselectable? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-multiselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1665

    +

    Indicates that the user may select more than one item from the current selectable descendants.

    +
    +

    Optional aria-orientation#

    +

    • aria-orientation? : "horizontal" | "vertical"

    +

    Inherited from ButtonProps.aria-orientation

    +

    Defined in node_modules/@types/react/index.d.ts:1667

    +

    Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

    +
    +

    Optional aria-owns#

    +

    • aria-owns? : string

    +

    Inherited from ButtonProps.aria-owns

    +

    Defined in node_modules/@types/react/index.d.ts:1673

    +

    Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship +between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

    +

    see aria-controls.

    +
    +

    Optional aria-placeholder#

    +

    • aria-placeholder? : string

    +

    Inherited from ButtonProps.aria-placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1678

    +

    Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. +A hint could be a sample value or a brief description of the expected format.

    +
    +

    Optional aria-posinset#

    +

    • aria-posinset? : number

    +

    Inherited from ButtonProps.aria-posinset

    +

    Defined in node_modules/@types/react/index.d.ts:1683

    +

    Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-setsize.

    +
    +

    Optional aria-pressed#

    +

    • aria-pressed? : boolean | "false" | "mixed" | "true"

    +

    Inherited from ButtonProps.aria-pressed

    +

    Defined in node_modules/@types/react/index.d.ts:1688

    +

    Indicates the current "pressed" state of toggle buttons.

    +

    see aria-checked @see aria-selected.

    +
    +

    Optional aria-readonly#

    +

    • aria-readonly? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-readonly

    +

    Defined in node_modules/@types/react/index.d.ts:1693

    +

    Indicates that the element is not editable, but is otherwise operable.

    +

    see aria-disabled.

    +
    +

    Optional aria-relevant#

    +

    • aria-relevant? : "additions" | "additions text" | "all" | "removals" | "text"

    +

    Inherited from ButtonProps.aria-relevant

    +

    Defined in node_modules/@types/react/index.d.ts:1698

    +

    Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

    +

    see aria-atomic.

    +
    +

    Optional aria-required#

    +

    • aria-required? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-required

    +

    Defined in node_modules/@types/react/index.d.ts:1700

    +

    Indicates that user input is required on the element before a form may be submitted.

    +
    +

    Optional aria-roledescription#

    +

    • aria-roledescription? : string

    +

    Inherited from ButtonProps.aria-roledescription

    +

    Defined in node_modules/@types/react/index.d.ts:1702

    +

    Defines a human-readable, author-localized description for the role of an element.

    +
    +

    Optional aria-rowcount#

    +

    • aria-rowcount? : number

    +

    Inherited from ButtonProps.aria-rowcount

    +

    Defined in node_modules/@types/react/index.d.ts:1707

    +

    Defines the total number of rows in a table, grid, or treegrid.

    +

    see aria-rowindex.

    +
    +

    Optional aria-rowindex#

    +

    • aria-rowindex? : number

    +

    Inherited from ButtonProps.aria-rowindex

    +

    Defined in node_modules/@types/react/index.d.ts:1712

    +

    Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

    +

    see aria-rowcount @see aria-rowspan.

    +
    +

    Optional aria-rowspan#

    +

    • aria-rowspan? : number

    +

    Inherited from ButtonProps.aria-rowspan

    +

    Defined in node_modules/@types/react/index.d.ts:1717

    +

    Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.

    +

    see aria-rowindex @see aria-colspan.

    +
    +

    Optional aria-selected#

    +

    • aria-selected? : boolean | "false" | "true"

    +

    Inherited from ButtonProps.aria-selected

    +

    Defined in node_modules/@types/react/index.d.ts:1722

    +

    Indicates the current "selected" state of various widgets.

    +

    see aria-checked @see aria-pressed.

    +
    +

    Optional aria-setsize#

    +

    • aria-setsize? : number

    +

    Inherited from ButtonProps.aria-setsize

    +

    Defined in node_modules/@types/react/index.d.ts:1727

    +

    Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

    +

    see aria-posinset.

    +
    +

    Optional aria-sort#

    +

    • aria-sort? : "none" | "ascending" | "descending" | "other"

    +

    Inherited from ButtonProps.aria-sort

    +

    Defined in node_modules/@types/react/index.d.ts:1729

    +

    Indicates if items in a table or grid are sorted in ascending or descending order.

    +
    +

    Optional aria-valuemax#

    +

    • aria-valuemax? : number

    +

    Inherited from ButtonProps.aria-valuemax

    +

    Defined in node_modules/@types/react/index.d.ts:1731

    +

    Defines the maximum allowed value for a range widget.

    +
    +

    Optional aria-valuemin#

    +

    • aria-valuemin? : number

    +

    Inherited from ButtonProps.aria-valuemin

    +

    Defined in node_modules/@types/react/index.d.ts:1733

    +

    Defines the minimum allowed value for a range widget.

    +
    +

    Optional aria-valuenow#

    +

    • aria-valuenow? : number

    +

    Inherited from ButtonProps.aria-valuenow

    +

    Defined in node_modules/@types/react/index.d.ts:1738

    +

    Defines the current value for a range widget.

    +

    see aria-valuetext.

    +
    +

    Optional aria-valuetext#

    +

    • aria-valuetext? : string

    +

    Inherited from ButtonProps.aria-valuetext

    +

    Defined in node_modules/@types/react/index.d.ts:1740

    +

    Defines the human readable text alternative of aria-valuenow for a range widget.

    +
    +

    Optional as#

    +

    • as? : string

    +

    Inherited from LineProgressProps.as

    +

    Defined in node_modules/@types/react/index.d.ts:1819

    +
    +

    Optional async#

    +

    • async? : boolean

    +

    Inherited from LineProgressProps.async

    +

    Defined in node_modules/@types/react/index.d.ts:1820

    +
    +

    Optional autoCapitalize#

    +

    • autoCapitalize? : string

    +

    Inherited from ButtonProps.autoCapitalize

    +

    Defined in node_modules/@types/react/index.d.ts:1785

    +
    +

    Optional autoComplete#

    +

    • autoComplete? : string

    +

    Inherited from LineProgressProps.autoComplete

    +

    Defined in node_modules/@types/react/index.d.ts:1821

    +
    +

    Optional autoCorrect#

    +

    • autoCorrect? : string

    +

    Inherited from ButtonProps.autoCorrect

    +

    Defined in node_modules/@types/react/index.d.ts:1786

    +
    +

    Optional autoFocus#

    +

    • autoFocus? : boolean

    +

    Inherited from LineProgressProps.autoFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1822

    +
    +

    Optional autoPlay#

    +

    • autoPlay? : boolean

    +

    Inherited from LineProgressProps.autoPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1823

    +
    +

    Optional autoSave#

    +

    • autoSave? : string

    +

    Inherited from ButtonProps.autoSave

    +

    Defined in node_modules/@types/react/index.d.ts:1787

    +
    +

    Optional capture#

    +

    • capture? : boolean | string

    +

    Inherited from LineProgressProps.capture

    +

    Defined in node_modules/@types/react/index.d.ts:1824

    +
    +

    Optional cellPadding#

    +

    • cellPadding? : number | string

    +

    Inherited from LineProgressProps.cellPadding

    +

    Defined in node_modules/@types/react/index.d.ts:1825

    +
    +

    Optional cellSpacing#

    +

    • cellSpacing? : number | string

    +

    Inherited from LineProgressProps.cellSpacing

    +

    Defined in node_modules/@types/react/index.d.ts:1826

    +
    +

    Optional challenge#

    +

    • challenge? : string

    +

    Inherited from LineProgressProps.challenge

    +

    Defined in node_modules/@types/react/index.d.ts:1828

    +
    +

    Optional charSet#

    +

    • charSet? : string

    +

    Inherited from LineProgressProps.charSet

    +

    Defined in node_modules/@types/react/index.d.ts:1827

    +
    +

    Optional checked#

    +

    • checked? : boolean

    +

    Inherited from LineProgressProps.checked

    +

    Defined in node_modules/@types/react/index.d.ts:1829

    +
    + +

    • checkedLink? : ReactLink‹boolean›

    +

    Inherited from ButtonProps.checkedLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:26

    +
    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional cite#

    +

    • cite? : string

    +

    Inherited from LineProgressProps.cite

    +

    Defined in node_modules/@types/react/index.d.ts:1830

    +
    +

    Optional classID#

    +

    • classID? : string

    +

    Inherited from LineProgressProps.classID

    +

    Defined in node_modules/@types/react/index.d.ts:1831

    +
    +

    Optional className#

    +

    • className? : string

    +

    Inherited from ButtonProps.className

    +

    Defined in node_modules/@types/react/index.d.ts:1752

    +
    +

    Optional colSpan#

    +

    • colSpan? : number

    +

    Inherited from LineProgressProps.colSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1833

    +
    +

    Optional color#

    +

    • color? : string

    +

    Inherited from ButtonProps.color

    +

    Defined in node_modules/@types/react/index.d.ts:1788

    +
    +

    Optional cols#

    +

    • cols? : number

    +

    Inherited from LineProgressProps.cols

    +

    Defined in node_modules/@types/react/index.d.ts:1832

    +
    +

    Optional content#

    +

    • content? : string

    +

    Inherited from LineProgressProps.content

    +

    Defined in node_modules/@types/react/index.d.ts:1834

    +
    +

    Optional contentEditable#

    +

    • contentEditable? : Booleanish | "inherit"

    +

    Inherited from ButtonProps.contentEditable

    +

    Defined in node_modules/@types/react/index.d.ts:1753

    +
    +

    Optional contextMenu#

    +

    • contextMenu? : string

    +

    Inherited from ButtonProps.contextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1754

    +
    +

    Optional controls#

    +

    • controls? : boolean

    +

    Inherited from LineProgressProps.controls

    +

    Defined in node_modules/@types/react/index.d.ts:1835

    +
    +

    Optional coords#

    +

    • coords? : string

    +

    Inherited from LineProgressProps.coords

    +

    Defined in node_modules/@types/react/index.d.ts:1836

    +
    +

    Optional crossOrigin#

    +

    • crossOrigin? : string

    +

    Inherited from LineProgressProps.crossOrigin

    +

    Defined in node_modules/@types/react/index.d.ts:1837

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    +

    Optional data#

    +

    • data? : string

    +

    Inherited from LineProgressProps.data

    +

    Defined in node_modules/@types/react/index.d.ts:1838

    +
    +

    Optional datatype#

    +

    • datatype? : string

    +

    Inherited from ButtonProps.datatype

    +

    Defined in node_modules/@types/react/index.d.ts:1776

    +
    +

    Optional dateTime#

    +

    • dateTime? : string

    +

    Inherited from LineProgressProps.dateTime

    +

    Defined in node_modules/@types/react/index.d.ts:1839

    +
    +

    Optional default#

    +

    • default? : boolean

    +

    Inherited from LineProgressProps.default

    +

    Defined in node_modules/@types/react/index.d.ts:1840

    +
    +

    Optional defaultChecked#

    +

    • defaultChecked? : boolean

    +

    Inherited from ButtonProps.defaultChecked

    +

    Defined in node_modules/@types/react/index.d.ts:1745

    +
    +

    Optional defaultValue#

    +

    • defaultValue? : string | number | string[]

    +

    Inherited from ButtonProps.defaultValue

    +

    Defined in node_modules/@types/react/index.d.ts:1746

    +
    +

    Optional defer#

    +

    • defer? : boolean

    +

    Inherited from LineProgressProps.defer

    +

    Defined in node_modules/@types/react/index.d.ts:1841

    +
    +

    Optional dir#

    +

    • dir? : string

    +

    Inherited from ButtonProps.dir

    +

    Defined in node_modules/@types/react/index.d.ts:1755

    +
    +

    Optional disabled#

    +

    • disabled? : boolean

    +

    Inherited from LineProgressProps.disabled

    +

    Defined in node_modules/@types/react/index.d.ts:1842

    +
    +

    Optional download#

    +

    • download? : any

    +

    Inherited from LineProgressProps.download

    +

    Defined in node_modules/@types/react/index.d.ts:1843

    +
    +

    Optional draggable#

    +

    • draggable? : Booleanish

    +

    Inherited from ButtonProps.draggable

    +

    Defined in node_modules/@types/react/index.d.ts:1756

    +
    +

    Optional encType#

    +

    • encType? : string

    +

    Inherited from LineProgressProps.encType

    +

    Defined in node_modules/@types/react/index.d.ts:1844

    +
    +

    Optional form#

    +

    • form? : string

    +

    Inherited from LineProgressProps.form

    +

    Defined in node_modules/@types/react/index.d.ts:1845

    +
    +

    Optional formAction#

    +

    • formAction? : string

    +

    Inherited from LineProgressProps.formAction

    +

    Defined in node_modules/@types/react/index.d.ts:1846

    +
    +

    Optional formEncType#

    +

    • formEncType? : string

    +

    Inherited from LineProgressProps.formEncType

    +

    Defined in node_modules/@types/react/index.d.ts:1847

    +
    +

    Optional formMethod#

    +

    • formMethod? : string

    +

    Inherited from LineProgressProps.formMethod

    +

    Defined in node_modules/@types/react/index.d.ts:1848

    +
    +

    Optional formNoValidate#

    +

    • formNoValidate? : boolean

    +

    Inherited from LineProgressProps.formNoValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1849

    +
    +

    Optional formTarget#

    +

    • formTarget? : string

    +

    Inherited from LineProgressProps.formTarget

    +

    Defined in node_modules/@types/react/index.d.ts:1850

    +
    +

    Optional frameBorder#

    +

    • frameBorder? : number | string

    +

    Inherited from LineProgressProps.frameBorder

    +

    Defined in node_modules/@types/react/index.d.ts:1851

    +
    +

    Optional headers#

    +

    • headers? : string

    +

    Inherited from LineProgressProps.headers

    +

    Defined in node_modules/@types/react/index.d.ts:1852

    +
    +

    Optional height#

    +

    • height? : number | string

    +

    Inherited from LineProgressProps.height

    +

    Defined in node_modules/@types/react/index.d.ts:1853

    +
    +

    Optional hidden#

    +

    • hidden? : boolean

    +

    Inherited from IconProps.hidden

    +

    Defined in node_modules/@types/react/index.d.ts:1757

    +
    +

    Optional high#

    +

    • high? : number

    +

    Inherited from LineProgressProps.high

    +

    Defined in node_modules/@types/react/index.d.ts:1854

    +
    +

    Optional href#

    +

    • href? : string

    +

    Inherited from LineProgressProps.href

    +

    Defined in node_modules/@types/react/index.d.ts:1855

    +
    +

    Optional hrefLang#

    +

    • hrefLang? : string

    +

    Inherited from LineProgressProps.hrefLang

    +

    Defined in node_modules/@types/react/index.d.ts:1856

    +
    +

    Optional htmlFor#

    +

    • htmlFor? : string

    +

    Inherited from LineProgressProps.htmlFor

    +

    Defined in node_modules/@types/react/index.d.ts:1857

    +
    +

    Optional httpEquiv#

    +

    • httpEquiv? : string

    +

    Inherited from LineProgressProps.httpEquiv

    +

    Defined in node_modules/@types/react/index.d.ts:1858

    +
    +

    Optional id#

    +

    • id? : string

    +

    Inherited from ButtonProps.id

    +

    Defined in node_modules/@types/react/index.d.ts:1758

    +
    +

    Optional inlist#

    +

    • inlist? : any

    +

    Inherited from ButtonProps.inlist

    +

    Defined in node_modules/@types/react/index.d.ts:1777

    +
    +

    Optional inputMode#

    +

    • inputMode? : "none" | "text" | "tel" | "url" | "email" | "numeric" | "decimal" | "search"

    +

    Inherited from ButtonProps.inputMode

    +

    Defined in node_modules/@types/react/index.d.ts:1803

    +

    Hints at the type of data that might be entered by the user while editing the element or its contents

    +

    see https://html.spec.whatwg.org/multipage/interaction.html#input-modalities:-the-inputmode-attribute

    +
    +

    Optional integrity#

    +

    • integrity? : string

    +

    Inherited from LineProgressProps.integrity

    +

    Defined in node_modules/@types/react/index.d.ts:1859

    +
    +

    Optional is#

    +

    • is? : string

    +

    Inherited from ButtonProps.is

    +

    Defined in node_modules/@types/react/index.d.ts:1808

    +

    Specify that a standard HTML element should behave like a defined custom built-in element

    +

    see https://html.spec.whatwg.org/multipage/custom-elements.html#attr-is

    +
    +

    Optional itemID#

    +

    • itemID? : string

    +

    Inherited from ButtonProps.itemID

    +

    Defined in node_modules/@types/react/index.d.ts:1792

    +
    +

    Optional itemProp#

    +

    • itemProp? : string

    +

    Inherited from ButtonProps.itemProp

    +

    Defined in node_modules/@types/react/index.d.ts:1789

    +
    +

    Optional itemRef#

    +

    • itemRef? : string

    +

    Inherited from ButtonProps.itemRef

    +

    Defined in node_modules/@types/react/index.d.ts:1793

    +
    +

    Optional itemScope#

    +

    • itemScope? : boolean

    +

    Inherited from ButtonProps.itemScope

    +

    Defined in node_modules/@types/react/index.d.ts:1790

    +
    +

    Optional itemType#

    +

    • itemType? : string

    +

    Inherited from ButtonProps.itemType

    +

    Defined in node_modules/@types/react/index.d.ts:1791

    +
    +

    Optional key#

    +

    • key? : Key

    +

    Inherited from LineProgressProps.key

    +

    Defined in node_modules/@types/react/index.d.ts:139

    +
    +

    Optional keyParams#

    +

    • keyParams? : string

    +

    Inherited from LineProgressProps.keyParams

    +

    Defined in node_modules/@types/react/index.d.ts:1860

    +
    +

    Optional keyType#

    +

    • keyType? : string

    +

    Inherited from LineProgressProps.keyType

    +

    Defined in node_modules/@types/react/index.d.ts:1861

    +
    +

    Optional kind#

    +

    • kind? : string

    +

    Inherited from LineProgressProps.kind

    +

    Defined in node_modules/@types/react/index.d.ts:1862

    +
    +

    Optional label#

    +

    • label? : string

    +

    Inherited from LineProgressProps.label

    +

    Defined in node_modules/@types/react/index.d.ts:1863

    +
    +

    Optional lang#

    +

    • lang? : string

    +

    Inherited from ButtonProps.lang

    +

    Defined in node_modules/@types/react/index.d.ts:1759

    +
    +

    Optional list#

    +

    • list? : string

    +

    Inherited from LineProgressProps.list

    +

    Defined in node_modules/@types/react/index.d.ts:1864

    +
    +

    Optional loop#

    +

    • loop? : boolean

    +

    Inherited from LineProgressProps.loop

    +

    Defined in node_modules/@types/react/index.d.ts:1865

    +
    +

    Optional low#

    +

    • low? : number

    +

    Inherited from LineProgressProps.low

    +

    Defined in node_modules/@types/react/index.d.ts:1866

    +
    +

    Optional manifest#

    +

    • manifest? : string

    +

    Inherited from LineProgressProps.manifest

    +

    Defined in node_modules/@types/react/index.d.ts:1867

    +
    +

    Optional marginHeight#

    +

    • marginHeight? : number

    +

    Inherited from LineProgressProps.marginHeight

    +

    Defined in node_modules/@types/react/index.d.ts:1868

    +
    +

    Optional marginWidth#

    +

    • marginWidth? : number

    +

    Inherited from LineProgressProps.marginWidth

    +

    Defined in node_modules/@types/react/index.d.ts:1869

    +
    +

    Optional max#

    +

    • max? : number | string

    +

    Inherited from MenuItemProps.max

    +

    Defined in node_modules/@types/react/index.d.ts:1870

    +
    +

    Optional maxLength#

    +

    • maxLength? : number

    +

    Inherited from LineProgressProps.maxLength

    +

    Defined in node_modules/@types/react/index.d.ts:1871

    +
    +

    Optional media#

    +

    • media? : string

    +

    Inherited from LineProgressProps.media

    +

    Defined in node_modules/@types/react/index.d.ts:1872

    +
    +

    Optional mediaGroup#

    +

    • mediaGroup? : string

    +

    Inherited from LineProgressProps.mediaGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1873

    +
    +

    Optional method#

    +

    • method? : string

    +

    Inherited from LineProgressProps.method

    +

    Defined in node_modules/@types/react/index.d.ts:1874

    +
    +

    Optional min#

    +

    • min? : number | string

    +

    Inherited from MenuItemProps.min

    +

    Defined in node_modules/@types/react/index.d.ts:1875

    +
    +

    Optional minLength#

    +

    • minLength? : number

    +

    Inherited from LineProgressProps.minLength

    +

    Defined in node_modules/@types/react/index.d.ts:1876

    +
    +

    Optional multiple#

    +

    • multiple? : boolean

    +

    Inherited from LineProgressProps.multiple

    +

    Defined in node_modules/@types/react/index.d.ts:1877

    +
    +

    Optional muted#

    +

    • muted? : boolean

    +

    Inherited from LineProgressProps.muted

    +

    Defined in node_modules/@types/react/index.d.ts:1878

    +
    +

    Optional name#

    +

    • name? : string

    +

    Inherited from LineProgressProps.name

    +

    Defined in node_modules/@types/react/index.d.ts:1879

    +
    +

    Optional noValidate#

    +

    • noValidate? : boolean

    +

    Inherited from LineProgressProps.noValidate

    +

    Defined in node_modules/@types/react/index.d.ts:1881

    +
    +

    Optional nonce#

    +

    • nonce? : string

    +

    Inherited from LineProgressProps.nonce

    +

    Defined in node_modules/@types/react/index.d.ts:1880

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    +
    +

    Optional open#

    +

    • open? : boolean

    +

    Inherited from LineProgressProps.open

    +

    Defined in node_modules/@types/react/index.d.ts:1882

    +
    +

    Optional optimum#

    +

    • optimum? : number

    +

    Inherited from LineProgressProps.optimum

    +

    Defined in node_modules/@types/react/index.d.ts:1883

    +
    +

    Optional pattern#

    +

    • pattern? : string

    +

    Inherited from LineProgressProps.pattern

    +

    Defined in node_modules/@types/react/index.d.ts:1884

    +
    +

    Optional placeholder#

    +

    • placeholder? : string

    +

    Inherited from LineProgressProps.placeholder

    +

    Overrides ButtonProps.placeholder

    +

    Defined in node_modules/@types/react/index.d.ts:1885

    +
    +

    Optional playsInline#

    +

    • playsInline? : boolean

    +

    Inherited from LineProgressProps.playsInline

    +

    Defined in node_modules/@types/react/index.d.ts:1886

    +
    +

    Optional poster#

    +

    • poster? : string

    +

    Inherited from LineProgressProps.poster

    +

    Defined in node_modules/@types/react/index.d.ts:1887

    +
    +

    Optional prefix#

    +

    • prefix? : string

    +

    Inherited from ButtonProps.prefix

    +

    Defined in node_modules/@types/react/index.d.ts:1778

    +
    +

    Optional preload#

    +

    • preload? : string

    +

    Inherited from LineProgressProps.preload

    +

    Defined in node_modules/@types/react/index.d.ts:1888

    +
    +

    Optional property#

    +

    • property? : string

    +

    Inherited from ButtonProps.property

    +

    Defined in node_modules/@types/react/index.d.ts:1779

    +
    +

    Optional radioGroup#

    +

    • radioGroup? : string

    +

    Inherited from ButtonProps.radioGroup

    +

    Defined in node_modules/@types/react/index.d.ts:1769

    +
    +

    Optional readOnly#

    +

    • readOnly? : boolean

    +

    Inherited from LineProgressProps.readOnly

    +

    Defined in node_modules/@types/react/index.d.ts:1889

    +
    +

    Optional ref#

    +

    • ref? : LegacyRef‹any›

    +

    Inherited from LineProgressProps.ref

    +

    Defined in node_modules/@types/react/index.d.ts:145

    +
    +

    Optional rel#

    +

    • rel? : string

    +

    Inherited from LineProgressProps.rel

    +

    Defined in node_modules/@types/react/index.d.ts:1890

    +
    +

    Optional required#

    +

    • required? : boolean

    +

    Inherited from LineProgressProps.required

    +

    Defined in node_modules/@types/react/index.d.ts:1891

    +
    +

    Optional resource#

    +

    • resource? : string

    +

    Inherited from ButtonProps.resource

    +

    Defined in node_modules/@types/react/index.d.ts:1780

    +
    +

    Optional results#

    +

    • results? : number

    +

    Inherited from ButtonProps.results

    +

    Defined in node_modules/@types/react/index.d.ts:1794

    +
    +

    Optional reversed#

    +

    • reversed? : boolean

    +

    Inherited from LineProgressProps.reversed

    +

    Defined in node_modules/@types/react/index.d.ts:1892

    +
    +

    Optional role#

    +

    • role? : string

    +

    Inherited from ButtonProps.role

    +

    Defined in node_modules/@types/react/index.d.ts:1772

    +
    +

    Optional rowSpan#

    +

    • rowSpan? : number

    +

    Inherited from LineProgressProps.rowSpan

    +

    Defined in node_modules/@types/react/index.d.ts:1894

    +
    +

    Optional rows#

    +

    • rows? : number

    +

    Inherited from LineProgressProps.rows

    +

    Defined in node_modules/@types/react/index.d.ts:1893

    +
    +

    Optional sandbox#

    +

    • sandbox? : string

    +

    Inherited from LineProgressProps.sandbox

    +

    Defined in node_modules/@types/react/index.d.ts:1895

    +
    +

    Optional scope#

    +

    • scope? : string

    +

    Inherited from LineProgressProps.scope

    +

    Defined in node_modules/@types/react/index.d.ts:1896

    +
    +

    Optional scoped#

    +

    • scoped? : boolean

    +

    Inherited from LineProgressProps.scoped

    +

    Defined in node_modules/@types/react/index.d.ts:1897

    +
    +

    Optional scrolling#

    +

    • scrolling? : string

    +

    Inherited from LineProgressProps.scrolling

    +

    Defined in node_modules/@types/react/index.d.ts:1898

    +
    +

    Optional seamless#

    +

    • seamless? : boolean

    +

    Inherited from LineProgressProps.seamless

    +

    Defined in node_modules/@types/react/index.d.ts:1899

    +
    +

    Optional security#

    +

    • security? : string

    +

    Inherited from ButtonProps.security

    +

    Defined in node_modules/@types/react/index.d.ts:1795

    +
    +

    Optional selected#

    +

    • selected? : boolean

    +

    Inherited from LineProgressProps.selected

    +

    Defined in node_modules/@types/react/index.d.ts:1900

    +
    +

    Optional shape#

    +

    • shape? : string

    +

    Inherited from LineProgressProps.shape

    +

    Defined in node_modules/@types/react/index.d.ts:1901

    +
    +

    Optional size#

    +

    • size? : number

    +

    Inherited from LineProgressProps.size

    +

    Defined in node_modules/@types/react/index.d.ts:1902

    +
    +

    Optional sizes#

    +

    • sizes? : string

    +

    Inherited from LineProgressProps.sizes

    +

    Defined in node_modules/@types/react/index.d.ts:1903

    +
    +

    Optional slot#

    +

    • slot? : string

    +

    Inherited from ButtonProps.slot

    +

    Defined in node_modules/@types/react/index.d.ts:1761

    +
    +

    Optional span#

    +

    • span? : number

    +

    Inherited from LineProgressProps.span

    +

    Defined in node_modules/@types/react/index.d.ts:1904

    +
    +

    Optional spellCheck#

    +

    • spellCheck? : Booleanish

    +

    Inherited from ButtonProps.spellCheck

    +

    Defined in node_modules/@types/react/index.d.ts:1762

    +
    +

    Optional src#

    +

    • src? : string

    +

    Inherited from LineProgressProps.src

    +

    Defined in node_modules/@types/react/index.d.ts:1905

    +
    +

    Optional srcDoc#

    +

    • srcDoc? : string

    +

    Inherited from LineProgressProps.srcDoc

    +

    Defined in node_modules/@types/react/index.d.ts:1906

    +
    +

    Optional srcLang#

    +

    • srcLang? : string

    +

    Inherited from LineProgressProps.srcLang

    +

    Defined in node_modules/@types/react/index.d.ts:1907

    +
    +

    Optional srcSet#

    +

    • srcSet? : string

    +

    Inherited from LineProgressProps.srcSet

    +

    Defined in node_modules/@types/react/index.d.ts:1908

    +
    +

    Optional start#

    +

    • start? : number

    +

    Inherited from LineProgressProps.start

    +

    Defined in node_modules/@types/react/index.d.ts:1909

    +
    +

    step#

    +

    • step: number

    +

    Overrides LineProgressProps.step

    +

    Defined in src/renderer/components/stepper/stepper.tsx:6

    +
    +

    steps#

    +

    • steps: Step[]

    +

    Defined in src/renderer/components/stepper/stepper.tsx:7

    +
    +

    Optional style#

    +

    • style? : CSSProperties

    +

    Inherited from ButtonProps.style

    +

    Defined in node_modules/@types/react/index.d.ts:1763

    +
    +

    Optional summary#

    +

    • summary? : string

    +

    Inherited from LineProgressProps.summary

    +

    Defined in node_modules/@types/react/index.d.ts:1911

    +
    +

    Optional suppressContentEditableWarning#

    +

    • suppressContentEditableWarning? : boolean

    +

    Inherited from ButtonProps.suppressContentEditableWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1747

    +
    +

    Optional suppressHydrationWarning#

    +

    • suppressHydrationWarning? : boolean

    +

    Inherited from ButtonProps.suppressHydrationWarning

    +

    Defined in node_modules/@types/react/index.d.ts:1748

    +
    +

    Optional tabIndex#

    +

    • tabIndex? : number

    +

    Inherited from ButtonProps.tabIndex

    +

    Defined in node_modules/@types/react/index.d.ts:1764

    +
    +

    Optional target#

    +

    • target? : string

    +

    Inherited from LineProgressProps.target

    +

    Defined in node_modules/@types/react/index.d.ts:1912

    +
    +

    Optional title#

    +

    • title? : string

    +

    Inherited from ButtonProps.title

    +

    Defined in node_modules/@types/react/index.d.ts:1765

    +
    +

    Optional translate#

    +

    • translate? : "yes" | "no"

    +

    Inherited from ButtonProps.translate

    +

    Defined in node_modules/@types/react/index.d.ts:1766

    +
    +

    Optional type#

    +

    • type? : string

    +

    Inherited from LineProgressProps.type

    +

    Defined in node_modules/@types/react/index.d.ts:1913

    +
    +

    Optional typeof#

    +

    • typeof? : string

    +

    Inherited from ButtonProps.typeof

    +

    Defined in node_modules/@types/react/index.d.ts:1781

    +
    +

    Optional unselectable#

    +

    • unselectable? : "on" | "off"

    +

    Inherited from ButtonProps.unselectable

    +

    Defined in node_modules/@types/react/index.d.ts:1796

    +
    +

    Optional useMap#

    +

    • useMap? : string

    +

    Inherited from LineProgressProps.useMap

    +

    Defined in node_modules/@types/react/index.d.ts:1914

    +
    +

    Optional value#

    +

    • value? : string | string[] | number

    +

    Inherited from MenuItemProps.value

    +

    Defined in node_modules/@types/react/index.d.ts:1915

    +
    + +

    • valueLink? : ReactLink‹boolean | string | number›

    +

    Inherited from ButtonProps.valueLink

    +

    Defined in node_modules/@types/react-addons-linked-state-mixin/index.d.ts:27

    +
    +

    Optional vocab#

    +

    • vocab? : string

    +

    Inherited from ButtonProps.vocab

    +

    Defined in node_modules/@types/react/index.d.ts:1782

    +
    +

    Optional width#

    +

    • width? : number | string

    +

    Inherited from LineProgressProps.width

    +

    Defined in node_modules/@types/react/index.d.ts:1916

    +
    +

    Optional wmode#

    +

    • wmode? : string

    +

    Inherited from LineProgressProps.wmode

    +

    Defined in node_modules/@types/react/index.d.ts:1917

    +
    +

    Optional wrap#

    +

    • wrap? : string

    +

    Inherited from LineProgressProps.wrap

    +

    Defined in node_modules/@types/react/index.d.ts:1918

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html new file mode 100644 index 0000000000..4dea4fcad3 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tablayoutprops/index.html @@ -0,0 +1,1003 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TabLayoutProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TabLayoutProps#

    +

    Hierarchy#

    +
      +
    • TabLayoutProps
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional children#

    +

    • children? : ReactNode

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:15

    +
    +

    Optional className#

    +

    • className? : IClassName

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:12

    +
    +

    Optional contentClass#

    +

    • contentClass? : IClassName

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:13

    +
    +

    Optional tabs#

    +

    • tabs? : TabLayoutRoute[]

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:14

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html new file mode 100644 index 0000000000..cd0c0640dc --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tablayoutroute/index.html @@ -0,0 +1,1027 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TabLayoutRoute - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TabLayoutRoute#

    +

    Hierarchy#

    +
      +
    • TabLayoutRoute
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    component#

    +

    • component: React.ComponentType‹any›

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:21

    +
    +

    Optional default#

    +

    • default? : boolean

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:24

    +
    +

    Optional exact#

    +

    • exact? : boolean

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:23

    +
    +

    routePath#

    +

    • routePath: string

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:19

    +
    +

    title#

    +

    • title: React.ReactNode

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:20

    +
    +

    Optional url#

    +

    • url? : string

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:22

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html new file mode 100644 index 0000000000..42f9d45eff --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tablecellprops/index.html @@ -0,0 +1,3213 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TableCellProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TableCellProps#

    +

    Hierarchy#

    +
      +
    • DOMAttributes‹HTMLDivElement›
      • +
    +

    ↳ TableCellProps

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional _nowrap#

    +

    • _nowrap? : boolean

    +

    Defined in src/renderer/components/table/table-cell.tsx:20

    +
    +

    Optional _sorting#

    +

    • _sorting? : Partial‹TableSortParams›

    +

    Defined in src/renderer/components/table/table-cell.tsx:18

    +
    +

    Optional checkbox#

    +

    • checkbox? : boolean

    +

    Defined in src/renderer/components/table/table-cell.tsx:14

    +
    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional className#

    +

    • className? : string

    +

    Defined in src/renderer/components/table/table-cell.tsx:12

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    +

    Optional isChecked#

    +

    • isChecked? : boolean

    +

    Defined in src/renderer/components/table/table-cell.tsx:15

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    +
    +

    Optional renderBoolean#

    +

    • renderBoolean? : boolean

    +

    Defined in src/renderer/components/table/table-cell.tsx:16

    +
    +

    Optional sortBy#

    +

    • sortBy? : TableSortBy

    +

    Defined in src/renderer/components/table/table-cell.tsx:17

    +
    +

    Optional title#

    +

    • title? : ReactNode

    +

    Defined in src/renderer/components/table/table-cell.tsx:13

    +

    Methods#

    +

    Optional _sort#

    +

    ▸ _sort(sortBy: TableSortBy): void

    +

    Defined in src/renderer/components/table/table-cell.tsx:19

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    sortByTableSortBy
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html new file mode 100644 index 0000000000..83e3db75da --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tableheadprops/index.html @@ -0,0 +1,3114 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TableHeadProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TableHeadProps#

    +

    Hierarchy#

    +
      +
    • DOMAttributes‹HTMLDivElement›
      • +
    +

    ↳ TableHeadProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional className#

    +

    • className? : string

    +

    Defined in src/renderer/components/table/table-head.tsx:9

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    +

    Optional nowrap#

    +

    • nowrap? : boolean

    +

    Defined in src/renderer/components/table/table-head.tsx:12

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    +
    +

    Optional showTopLine#

    +

    • showTopLine? : boolean

    +

    Defined in src/renderer/components/table/table-head.tsx:10

    +
    +

    Optional sticky#

    +

    • sticky? : boolean

    +

    Defined in src/renderer/components/table/table-head.tsx:11

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html new file mode 100644 index 0000000000..bfe024736a --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tableprops/index.html @@ -0,0 +1,3333 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TableProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TableProps#

    +

    Hierarchy#

    +
      +
    • DOMAttributes‹HTMLDivElement›
      • +
    +

    ↳ TableProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional autoSize#

    +

    • autoSize? : boolean

    +

    Defined in src/renderer/components/table/table.tsx:25

    +
    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional className#

    +

    • className? : string

    +

    Defined in src/renderer/components/table/table.tsx:24

    +
    +

    Optional customRowHeights#

    +

    • customRowHeights? : function

    +

    Defined in src/renderer/components/table/table.tsx:42

    +

    Type declaration:

    +

    ▸ (item: object, lineHeight: number, paddings: number): number

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + + +
    NameType
    itemobject
    lineHeightnumber
    paddingsnumber
    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    +

    Optional getTableRow#

    +

    • getTableRow? : function

    +

    Defined in src/renderer/components/table/table.tsx:43

    +

    Type declaration:

    +

    ▸ (uid: string): ReactElement‹TableRowProps›

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    uidstring
    +
    +

    Optional items#

    +

    • items? : ItemObject[]

    +

    Defined in src/renderer/components/table/table.tsx:23

    +
    +

    Optional noItems#

    +

    • noItems? : React.ReactNode

    +

    Defined in src/renderer/components/table/table.tsx:37

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onSort#

    +

    • onSort? : function

    +

    Defined in src/renderer/components/table/table.tsx:36

    +

    Type declaration:

    +

    ▸ (params: TableSortParams): void

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    paramsTableSortParams
    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    +
    +

    Optional rowLineHeight#

    +

    • rowLineHeight? : string

    +

    Defined in src/renderer/components/table/table.tsx:41

    +
    +

    Optional rowPadding#

    +

    • rowPadding? : string

    +

    Defined in src/renderer/components/table/table.tsx:40

    +
    +

    Optional scrollable#

    +

    • scrollable? : boolean

    +

    Defined in src/renderer/components/table/table.tsx:27

    +
    +

    Optional selectable#

    +

    • selectable? : boolean

    +

    Defined in src/renderer/components/table/table.tsx:26

    +
    +

    Optional selectedItemId#

    +

    • selectedItemId? : string

    +

    Defined in src/renderer/components/table/table.tsx:38

    +
    +

    Optional sortByDefault#

    +

    • sortByDefault? : Partial‹TableSortParams›

    +

    Defined in src/renderer/components/table/table.tsx:35

    +
    +

    Optional sortSyncWithUrl#

    +

    • sortSyncWithUrl? : boolean

    +

    Defined in src/renderer/components/table/table.tsx:34

    +
    +

    Optional sortable#

    +

    • sortable? : object

    +

    Defined in src/renderer/components/table/table.tsx:29

    +

    Type declaration:

    + +
    +

    Optional storageKey#

    +

    • storageKey? : string

    +

    Defined in src/renderer/components/table/table.tsx:28

    +
    +

    Optional virtual#

    +

    • virtual? : boolean

    +

    Defined in src/renderer/components/table/table.tsx:39

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html new file mode 100644 index 0000000000..bdb8ab2afe --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tablerowprops/index.html @@ -0,0 +1,3150 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TableRowProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TableRowProps#

    +

    Hierarchy#

    +
      +
    • DOMAttributes‹HTMLDivElement›
      • +
    +

    ↳ TableRowProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional className#

    +

    • className? : string

    +

    Defined in src/renderer/components/table/table-row.tsx:10

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    +

    Optional disabled#

    +

    • disabled? : boolean

    +

    Defined in src/renderer/components/table/table-row.tsx:16

    +
    +

    Optional nowrap#

    +

    • nowrap? : boolean

    +

    Defined in src/renderer/components/table/table-row.tsx:13

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹HTMLDivElement›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    +
    +

    Optional searchItem#

    +

    • searchItem? : ItemObject | any

    +

    Defined in src/renderer/components/table/table-row.tsx:15

    +
    +

    Optional selected#

    +

    • selected? : boolean

    +

    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

    +
    +

    Optional style#

    +

    • style? : CSSProperties

    +

    Defined in src/renderer/components/table/table-row.tsx:12

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html new file mode 100644 index 0000000000..7ba1aba74a --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tabprops/index.html @@ -0,0 +1,3147 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TabProps ‹**D**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TabProps ‹D›#

    +

    Type parameters#

    +

    ▪ D

    +

    Hierarchy#

    +
      +
    • DOMAttributes‹HTMLElement›
      • +
    +

    ↳ TabProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional active#

    +

    • active? : boolean

    +

    Defined in src/renderer/components/tabs/tabs.tsx:55

    +
    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional className#

    +

    • className? : string

    +

    Defined in src/renderer/components/tabs/tabs.tsx:54

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    +

    Optional disabled#

    +

    • disabled? : boolean

    +

    Defined in src/renderer/components/tabs/tabs.tsx:56

    +
    +

    Optional icon#

    +

    • icon? : React.ReactNode | string

    +

    Defined in src/renderer/components/tabs/tabs.tsx:57

    +
    +

    Optional label#

    +

    • label? : React.ReactNode

    +

    Defined in src/renderer/components/tabs/tabs.tsx:58

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹HTMLElement›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    +
    +

    value#

    +

    • value: D

    +

    Defined in src/renderer/components/tabs/tabs.tsx:59

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html new file mode 100644 index 0000000000..2c052ae875 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tabsprops/index.html @@ -0,0 +1,1109 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TabsProps ‹**D**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TabsProps ‹D›#

    +

    Type parameters#

    +

    ▪ D

    +

    Hierarchy#

    +
      +
    • +

      TabsContextValue‹D›

      +
      • +
    • +

      object

      +
      • +
    +

    ↳ TabsProps

    +

    Index#

    +

    Properties#

    + +

    Methods#

    + +

    Properties#

    +

    Optional autoFocus#

    +

    • autoFocus? : boolean

    +

    Inherited from TabsProps.autoFocus

    +

    Defined in src/renderer/components/tabs/tabs.tsx:9

    +
    +

    Optional center#

    +

    • center? : boolean

    +

    Defined in src/renderer/components/tabs/tabs.tsx:19

    +
    +

    Optional className#

    +

    • className? : string

    +

    Defined in src/renderer/components/tabs/tabs.tsx:18

    +
    +

    Optional scrollable#

    +

    • scrollable? : boolean

    +

    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

    +
    +

    Optional withBorder#

    +

    • withBorder? : boolean

    +

    Inherited from TabsProps.withBorder

    +

    Defined in src/renderer/components/tabs/tabs.tsx:10

    +
    +

    Optional wrap#

    +

    • wrap? : boolean

    +

    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

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    valueD
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html new file mode 100644 index 0000000000..cff05112a1 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tooltipcontentformatters/index.html @@ -0,0 +1,1015 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TooltipContentFormatters - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TooltipContentFormatters#

    +

    Hierarchy#

    +
      +
    • TooltipContentFormatters
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional narrow#

    +

    • narrow? : boolean

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:34

    +
    +

    Optional nowrap#

    +

    • nowrap? : boolean

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:37

    +
    +

    Optional small#

    +

    • small? : boolean

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:36

    +
    +

    Optional tableView#

    +

    • tableView? : boolean

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:38

    +
    +

    Optional warning#

    +

    • warning? : boolean

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:35

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html new file mode 100644 index 0000000000..f3120469de --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tooltipdecoratorprops/index.html @@ -0,0 +1,986 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TooltipDecoratorProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TooltipDecoratorProps#

    +

    Hierarchy#

    +
      +
    • TooltipDecoratorProps
      • +
    +

    ↳ ButtonProps

    +

    ↳ IconProps

    +

    ↳ BadgeProps

    +

    ↳ LineProgressProps

    +

    ↳ StatusBrickProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional tooltip#

    +

    • tooltip? : ReactNode | Omit‹TooltipProps, "targetId"›

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:10

    +
    +

    Optional tooltipOverrideDisabled#

    +

    • tooltipOverrideDisabled? : boolean

    +

    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"

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html new file mode 100644 index 0000000000..5f90d9656d --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.tooltipprops/index.html @@ -0,0 +1,1075 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: TooltipProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: TooltipProps#

    +

    Hierarchy#

    +
      +
    • TooltipProps
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional children#

    +

    • children? : React.ReactNode

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:30

    +
    +

    Optional className#

    +

    • className? : IClassName

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:27

    +
    +

    Optional formatters#

    +

    • formatters? : TooltipContentFormatters

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:28

    +
    +

    Optional offset#

    +

    • offset? : number

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:24

    +
    +

    Optional preferredPositions#

    +

    • preferredPositions? : TooltipPosition | TooltipPosition[]

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:26

    +
    +

    Optional style#

    +

    • style? : CSSProperties

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:29

    +
    +

    targetId#

    +

    • targetId: string

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:21

    +
    +

    Optional tooltipOnParentHover#

    +

    • tooltipOnParentHover? : boolean

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:22

    +
    +

    Optional usePortal#

    +

    • usePortal? : boolean

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:25

    +
    +

    Optional visible#

    +

    • visible? : boolean

    +

    Defined in src/renderer/components/tooltip/tooltip.tsx:23

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html new file mode 100644 index 0000000000..730a2beea3 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_components_.wizardlayoutprops/index.html @@ -0,0 +1,3150 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: WizardLayoutProps - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: WizardLayoutProps#

    +

    Hierarchy#

    +
      +
    • DOMAttributes‹any›
      • +
    +

    ↳ WizardLayoutProps

    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional centered#

    +

    • centered? : boolean

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:13

    +
    +

    Optional children#

    +

    • children? : ReactNode

    +

    Inherited from PageLayoutProps.children

    +

    Defined in node_modules/@types/react/index.d.ts:1348

    +
    +

    Optional className#

    +

    • className? : IClassName

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:7

    +
    +

    Optional contentClass#

    +

    • contentClass? : IClassName

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:10

    +
    +

    Optional dangerouslySetInnerHTML#

    +

    • dangerouslySetInnerHTML? : object

    +

    Inherited from PageLayoutProps.dangerouslySetInnerHTML

    +

    Defined in node_modules/@types/react/index.d.ts:1349

    +

    Type declaration:

    +
      +
    • __html: string
      • +
    +
    +

    Optional header#

    +

    • header? : React.ReactNode

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:8

    +
    +

    Optional headerClass#

    +

    • headerClass? : IClassName

    +

    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

    +
    +

    Optional infoPanelClass#

    +

    • infoPanelClass? : IClassName

    +

    Defined in src/renderer/components/layout/wizard-layout.tsx:11

    +
    +

    Optional onAbort#

    +

    • onAbort? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbort

    +

    Defined in node_modules/@types/react/index.d.ts:1404

    +
    +

    Optional onAbortCapture#

    +

    • onAbortCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAbortCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1405

    +
    +

    Optional onAnimationEnd#

    +

    • onAnimationEnd? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1534

    +
    +

    Optional onAnimationEndCapture#

    +

    • onAnimationEndCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1535

    +
    +

    Optional onAnimationIteration#

    +

    • onAnimationIteration? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIteration

    +

    Defined in node_modules/@types/react/index.d.ts:1536

    +
    +

    Optional onAnimationIterationCapture#

    +

    • onAnimationIterationCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationIterationCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1537

    +
    +

    Optional onAnimationStart#

    +

    • onAnimationStart? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStart

    +

    Defined in node_modules/@types/react/index.d.ts:1532

    +
    +

    Optional onAnimationStartCapture#

    +

    • onAnimationStartCapture? : AnimationEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAnimationStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1533

    +
    +

    Optional onAuxClick#

    +

    • onAuxClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClick

    +

    Defined in node_modules/@types/react/index.d.ts:1450

    +
    +

    Optional onAuxClickCapture#

    +

    • onAuxClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onAuxClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1451

    +
    +

    Optional onBeforeInput#

    +

    • onBeforeInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInput

    +

    Defined in node_modules/@types/react/index.d.ts:1378

    +
    +

    Optional onBeforeInputCapture#

    +

    • onBeforeInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBeforeInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1379

    +
    +

    Optional onBlur#

    +

    • onBlur? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlur

    +

    Defined in node_modules/@types/react/index.d.ts:1372

    +
    +

    Optional onBlurCapture#

    +

    • onBlurCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onBlurCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1373

    +
    +

    Optional onCanPlay#

    +

    • onCanPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1406

    +
    +

    Optional onCanPlayCapture#

    +

    • onCanPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1407

    +
    +

    Optional onCanPlayThrough#

    +

    • onCanPlayThrough? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThrough

    +

    Defined in node_modules/@types/react/index.d.ts:1408

    +
    +

    Optional onCanPlayThroughCapture#

    +

    • onCanPlayThroughCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCanPlayThroughCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1409

    +
    +

    Optional onChange#

    +

    • onChange? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChange

    +

    Defined in node_modules/@types/react/index.d.ts:1376

    +
    +

    Optional onChangeCapture#

    +

    • onChangeCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1377

    +
    +

    Optional onClick#

    +

    • onClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClick

    +

    Defined in node_modules/@types/react/index.d.ts:1452

    +
    +

    Optional onClickCapture#

    +

    • onClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1453

    +
    +

    Optional onCompositionEnd#

    +

    • onCompositionEnd? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1362

    +
    +

    Optional onCompositionEndCapture#

    +

    • onCompositionEndCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1363

    +
    +

    Optional onCompositionStart#

    +

    • onCompositionStart? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStart

    +

    Defined in node_modules/@types/react/index.d.ts:1364

    +
    +

    Optional onCompositionStartCapture#

    +

    • onCompositionStartCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1365

    +
    +

    Optional onCompositionUpdate#

    +

    • onCompositionUpdate? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1366

    +
    +

    Optional onCompositionUpdateCapture#

    +

    • onCompositionUpdateCapture? : CompositionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCompositionUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1367

    +
    +

    Optional onContextMenu#

    +

    • onContextMenu? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenu

    +

    Defined in node_modules/@types/react/index.d.ts:1454

    +
    +

    Optional onContextMenuCapture#

    +

    • onContextMenuCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onContextMenuCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1455

    +
    +

    Optional onCopy#

    +

    • onCopy? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopy

    +

    Defined in node_modules/@types/react/index.d.ts:1354

    +
    +

    Optional onCopyCapture#

    +

    • onCopyCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCopyCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1355

    +
    +

    Optional onCut#

    +

    • onCut? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCut

    +

    Defined in node_modules/@types/react/index.d.ts:1356

    +
    +

    Optional onCutCapture#

    +

    • onCutCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onCutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1357

    +
    +

    Optional onDoubleClick#

    +

    • onDoubleClick? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClick

    +

    Defined in node_modules/@types/react/index.d.ts:1456

    +
    +

    Optional onDoubleClickCapture#

    +

    • onDoubleClickCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDoubleClickCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1457

    +
    +

    Optional onDrag#

    +

    • onDrag? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrag

    +

    Defined in node_modules/@types/react/index.d.ts:1458

    +
    +

    Optional onDragCapture#

    +

    • onDragCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1459

    +
    +

    Optional onDragEnd#

    +

    • onDragEnd? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1460

    +
    +

    Optional onDragEndCapture#

    +

    • onDragEndCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1461

    +
    +

    Optional onDragEnter#

    +

    • onDragEnter? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1462

    +
    +

    Optional onDragEnterCapture#

    +

    • onDragEnterCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1463

    +
    +

    Optional onDragExit#

    +

    • onDragExit? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExit

    +

    Defined in node_modules/@types/react/index.d.ts:1464

    +
    +

    Optional onDragExitCapture#

    +

    • onDragExitCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragExitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1465

    +
    +

    Optional onDragLeave#

    +

    • onDragLeave? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1466

    +
    +

    Optional onDragLeaveCapture#

    +

    • onDragLeaveCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1467

    +
    +

    Optional onDragOver#

    +

    • onDragOver? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOver

    +

    Defined in node_modules/@types/react/index.d.ts:1468

    +
    +

    Optional onDragOverCapture#

    +

    • onDragOverCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1469

    +
    +

    Optional onDragStart#

    +

    • onDragStart? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStart

    +

    Defined in node_modules/@types/react/index.d.ts:1470

    +
    +

    Optional onDragStartCapture#

    +

    • onDragStartCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDragStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1471

    +
    +

    Optional onDrop#

    +

    • onDrop? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDrop

    +

    Defined in node_modules/@types/react/index.d.ts:1472

    +
    +

    Optional onDropCapture#

    +

    • onDropCapture? : DragEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDropCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1473

    +
    +

    Optional onDurationChange#

    +

    • onDurationChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChange

    +

    Defined in node_modules/@types/react/index.d.ts:1410

    +
    +

    Optional onDurationChangeCapture#

    +

    • onDurationChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onDurationChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1411

    +
    +

    Optional onEmptied#

    +

    • onEmptied? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptied

    +

    Defined in node_modules/@types/react/index.d.ts:1412

    +
    +

    Optional onEmptiedCapture#

    +

    • onEmptiedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEmptiedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1413

    +
    +

    Optional onEncrypted#

    +

    • onEncrypted? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncrypted

    +

    Defined in node_modules/@types/react/index.d.ts:1414

    +
    +

    Optional onEncryptedCapture#

    +

    • onEncryptedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEncryptedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1415

    +
    +

    Optional onEnded#

    +

    • onEnded? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEnded

    +

    Defined in node_modules/@types/react/index.d.ts:1416

    +
    +

    Optional onEndedCapture#

    +

    • onEndedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onEndedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1417

    +
    +

    Optional onError#

    +

    • onError? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onError

    +

    Defined in node_modules/@types/react/index.d.ts:1392

    +
    +

    Optional onErrorCapture#

    +

    • onErrorCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onErrorCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1393

    +
    +

    Optional onFocus#

    +

    • onFocus? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocus

    +

    Defined in node_modules/@types/react/index.d.ts:1370

    +
    +

    Optional onFocusCapture#

    +

    • onFocusCapture? : FocusEventHandler‹any›

    +

    Inherited from PageLayoutProps.onFocusCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1371

    +
    +

    Optional onGotPointerCapture#

    +

    • onGotPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1518

    +
    +

    Optional onGotPointerCaptureCapture#

    +

    • onGotPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onGotPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1519

    +
    +

    Optional onInput#

    +

    • onInput? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInput

    +

    Defined in node_modules/@types/react/index.d.ts:1380

    +
    +

    Optional onInputCapture#

    +

    • onInputCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInputCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1381

    +
    +

    Optional onInvalid#

    +

    • onInvalid? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalid

    +

    Defined in node_modules/@types/react/index.d.ts:1386

    +
    +

    Optional onInvalidCapture#

    +

    • onInvalidCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onInvalidCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1387

    +
    +

    Optional onKeyDown#

    +

    • onKeyDown? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDown

    +

    Defined in node_modules/@types/react/index.d.ts:1396

    +
    +

    Optional onKeyDownCapture#

    +

    • onKeyDownCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1397

    +
    +

    Optional onKeyPress#

    +

    • onKeyPress? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPress

    +

    Defined in node_modules/@types/react/index.d.ts:1398

    +
    +

    Optional onKeyPressCapture#

    +

    • onKeyPressCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyPressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1399

    +
    +

    Optional onKeyUp#

    +

    • onKeyUp? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUp

    +

    Defined in node_modules/@types/react/index.d.ts:1400

    +
    +

    Optional onKeyUpCapture#

    +

    • onKeyUpCapture? : KeyboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onKeyUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1401

    +
    +

    Optional onLoad#

    +

    • onLoad? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoad

    +

    Defined in node_modules/@types/react/index.d.ts:1390

    +
    +

    Optional onLoadCapture#

    +

    • onLoadCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1391

    +
    +

    Optional onLoadStart#

    +

    • onLoadStart? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStart

    +

    Defined in node_modules/@types/react/index.d.ts:1422

    +
    +

    Optional onLoadStartCapture#

    +

    • onLoadStartCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1423

    +
    +

    Optional onLoadedData#

    +

    • onLoadedData? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedData

    +

    Defined in node_modules/@types/react/index.d.ts:1418

    +
    +

    Optional onLoadedDataCapture#

    +

    • onLoadedDataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedDataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1419

    +
    +

    Optional onLoadedMetadata#

    +

    • onLoadedMetadata? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadata

    +

    Defined in node_modules/@types/react/index.d.ts:1420

    +
    +

    Optional onLoadedMetadataCapture#

    +

    • onLoadedMetadataCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLoadedMetadataCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1421

    +
    +

    Optional onLostPointerCapture#

    +

    • onLostPointerCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1520

    +
    +

    Optional onLostPointerCaptureCapture#

    +

    • onLostPointerCaptureCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onLostPointerCaptureCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1521

    +
    +

    Optional onMouseDown#

    +

    • onMouseDown? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDown

    +

    Defined in node_modules/@types/react/index.d.ts:1474

    +
    +

    Optional onMouseDownCapture#

    +

    • onMouseDownCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1475

    +
    +

    Optional onMouseEnter#

    +

    • onMouseEnter? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1476

    +
    +

    Optional onMouseLeave#

    +

    • onMouseLeave? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1477

    +
    +

    Optional onMouseMove#

    +

    • onMouseMove? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMove

    +

    Defined in node_modules/@types/react/index.d.ts:1478

    +
    +

    Optional onMouseMoveCapture#

    +

    • onMouseMoveCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1479

    +
    +

    Optional onMouseOut#

    +

    • onMouseOut? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOut

    +

    Defined in node_modules/@types/react/index.d.ts:1480

    +
    +

    Optional onMouseOutCapture#

    +

    • onMouseOutCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1481

    +
    +

    Optional onMouseOver#

    +

    • onMouseOver? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOver

    +

    Defined in node_modules/@types/react/index.d.ts:1482

    +
    +

    Optional onMouseOverCapture#

    +

    • onMouseOverCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1483

    +
    +

    Optional onMouseUp#

    +

    • onMouseUp? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUp

    +

    Defined in node_modules/@types/react/index.d.ts:1484

    +
    +

    Optional onMouseUpCapture#

    +

    • onMouseUpCapture? : MouseEventHandler‹any›

    +

    Inherited from PageLayoutProps.onMouseUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1485

    +
    +

    Optional onPaste#

    +

    • onPaste? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPaste

    +

    Defined in node_modules/@types/react/index.d.ts:1358

    +
    +

    Optional onPasteCapture#

    +

    • onPasteCapture? : ClipboardEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPasteCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1359

    +
    +

    Optional onPause#

    +

    • onPause? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPause

    +

    Defined in node_modules/@types/react/index.d.ts:1424

    +
    +

    Optional onPauseCapture#

    +

    • onPauseCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPauseCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1425

    +
    +

    Optional onPlay#

    +

    • onPlay? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlay

    +

    Defined in node_modules/@types/react/index.d.ts:1426

    +
    +

    Optional onPlayCapture#

    +

    • onPlayCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1427

    +
    +

    Optional onPlaying#

    +

    • onPlaying? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlaying

    +

    Defined in node_modules/@types/react/index.d.ts:1428

    +
    +

    Optional onPlayingCapture#

    +

    • onPlayingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPlayingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1429

    +
    +

    Optional onPointerCancel#

    +

    • onPointerCancel? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1508

    +
    +

    Optional onPointerCancelCapture#

    +

    • onPointerCancelCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1509

    +
    +

    Optional onPointerDown#

    +

    • onPointerDown? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDown

    +

    Defined in node_modules/@types/react/index.d.ts:1502

    +
    +

    Optional onPointerDownCapture#

    +

    • onPointerDownCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerDownCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1503

    +
    +

    Optional onPointerEnter#

    +

    • onPointerEnter? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnter

    +

    Defined in node_modules/@types/react/index.d.ts:1510

    +
    +

    Optional onPointerEnterCapture#

    +

    • onPointerEnterCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerEnterCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1511

    +
    +

    Optional onPointerLeave#

    +

    • onPointerLeave? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeave

    +

    Defined in node_modules/@types/react/index.d.ts:1512

    +
    +

    Optional onPointerLeaveCapture#

    +

    • onPointerLeaveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerLeaveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1513

    +
    +

    Optional onPointerMove#

    +

    • onPointerMove? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMove

    +

    Defined in node_modules/@types/react/index.d.ts:1504

    +
    +

    Optional onPointerMoveCapture#

    +

    • onPointerMoveCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1505

    +
    +

    Optional onPointerOut#

    +

    • onPointerOut? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOut

    +

    Defined in node_modules/@types/react/index.d.ts:1516

    +
    +

    Optional onPointerOutCapture#

    +

    • onPointerOutCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOutCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1517

    +
    +

    Optional onPointerOver#

    +

    • onPointerOver? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOver

    +

    Defined in node_modules/@types/react/index.d.ts:1514

    +
    +

    Optional onPointerOverCapture#

    +

    • onPointerOverCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerOverCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1515

    +
    +

    Optional onPointerUp#

    +

    • onPointerUp? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUp

    +

    Defined in node_modules/@types/react/index.d.ts:1506

    +
    +

    Optional onPointerUpCapture#

    +

    • onPointerUpCapture? : PointerEventHandler‹any›

    +

    Inherited from PageLayoutProps.onPointerUpCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1507

    +
    +

    Optional onProgress#

    +

    • onProgress? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgress

    +

    Defined in node_modules/@types/react/index.d.ts:1430

    +
    +

    Optional onProgressCapture#

    +

    • onProgressCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onProgressCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1431

    +
    +

    Optional onRateChange#

    +

    • onRateChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChange

    +

    Defined in node_modules/@types/react/index.d.ts:1432

    +
    +

    Optional onRateChangeCapture#

    +

    • onRateChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onRateChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1433

    +
    +

    Optional onReset#

    +

    • onReset? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onReset

    +

    Defined in node_modules/@types/react/index.d.ts:1382

    +
    +

    Optional onResetCapture#

    +

    • onResetCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onResetCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1383

    +
    +

    Optional onScroll#

    +

    • onScroll? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScroll

    +

    Defined in node_modules/@types/react/index.d.ts:1524

    +
    +

    Optional onScrollCapture#

    +

    • onScrollCapture? : UIEventHandler‹any›

    +

    Inherited from PageLayoutProps.onScrollCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1525

    +
    +

    Optional onSeeked#

    +

    • onSeeked? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeked

    +

    Defined in node_modules/@types/react/index.d.ts:1434

    +
    +

    Optional onSeekedCapture#

    +

    • onSeekedCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekedCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1435

    +
    +

    Optional onSeeking#

    +

    • onSeeking? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeeking

    +

    Defined in node_modules/@types/react/index.d.ts:1436

    +
    +

    Optional onSeekingCapture#

    +

    • onSeekingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSeekingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1437

    +
    +

    Optional onSelect#

    +

    • onSelect? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelect

    +

    Defined in node_modules/@types/react/index.d.ts:1488

    +
    +

    Optional onSelectCapture#

    +

    • onSelectCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSelectCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1489

    +
    +

    Optional onStalled#

    +

    • onStalled? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalled

    +

    Defined in node_modules/@types/react/index.d.ts:1438

    +
    +

    Optional onStalledCapture#

    +

    • onStalledCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onStalledCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1439

    +
    +

    Optional onSubmit#

    +

    • onSubmit? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmit

    +

    Defined in node_modules/@types/react/index.d.ts:1384

    +
    +

    Optional onSubmitCapture#

    +

    • onSubmitCapture? : FormEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSubmitCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1385

    +
    +

    Optional onSuspend#

    +

    • onSuspend? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspend

    +

    Defined in node_modules/@types/react/index.d.ts:1440

    +
    +

    Optional onSuspendCapture#

    +

    • onSuspendCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onSuspendCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1441

    +
    +

    Optional onTimeUpdate#

    +

    • onTimeUpdate? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdate

    +

    Defined in node_modules/@types/react/index.d.ts:1442

    +
    +

    Optional onTimeUpdateCapture#

    +

    • onTimeUpdateCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTimeUpdateCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1443

    +
    +

    Optional onTouchCancel#

    +

    • onTouchCancel? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancel

    +

    Defined in node_modules/@types/react/index.d.ts:1492

    +
    +

    Optional onTouchCancelCapture#

    +

    • onTouchCancelCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchCancelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1493

    +
    +

    Optional onTouchEnd#

    +

    • onTouchEnd? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1494

    +
    +

    Optional onTouchEndCapture#

    +

    • onTouchEndCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1495

    +
    +

    Optional onTouchMove#

    +

    • onTouchMove? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMove

    +

    Defined in node_modules/@types/react/index.d.ts:1496

    +
    +

    Optional onTouchMoveCapture#

    +

    • onTouchMoveCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchMoveCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1497

    +
    +

    Optional onTouchStart#

    +

    • onTouchStart? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStart

    +

    Defined in node_modules/@types/react/index.d.ts:1498

    +
    +

    Optional onTouchStartCapture#

    +

    • onTouchStartCapture? : TouchEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTouchStartCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1499

    +
    +

    Optional onTransitionEnd#

    +

    • onTransitionEnd? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEnd

    +

    Defined in node_modules/@types/react/index.d.ts:1540

    +
    +

    Optional onTransitionEndCapture#

    +

    • onTransitionEndCapture? : TransitionEventHandler‹any›

    +

    Inherited from PageLayoutProps.onTransitionEndCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1541

    +
    +

    Optional onVolumeChange#

    +

    • onVolumeChange? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChange

    +

    Defined in node_modules/@types/react/index.d.ts:1444

    +
    +

    Optional onVolumeChangeCapture#

    +

    • onVolumeChangeCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onVolumeChangeCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1445

    +
    +

    Optional onWaiting#

    +

    • onWaiting? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaiting

    +

    Defined in node_modules/@types/react/index.d.ts:1446

    +
    +

    Optional onWaitingCapture#

    +

    • onWaitingCapture? : ReactEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWaitingCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1447

    +
    +

    Optional onWheel#

    +

    • onWheel? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheel

    +

    Defined in node_modules/@types/react/index.d.ts:1528

    +
    +

    Optional onWheelCapture#

    +

    • onWheelCapture? : WheelEventHandler‹any›

    +

    Inherited from PageLayoutProps.onWheelCapture

    +

    Defined in node_modules/@types/react/index.d.ts:1529

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html new file mode 100644 index 0000000000..8401680a9f --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_k8s_api_.ikubeapicluster/index.html @@ -0,0 +1,967 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: IKubeApiCluster - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html new file mode 100644 index 0000000000..95f4457a52 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainer/index.html @@ -0,0 +1,1120 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: IPodContainer - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: IPodContainer#

    +

    Hierarchy#

    +
      +
    • IPodContainer
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    Optional args#

    +

    • args? : string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:69

    +
    +

    Optional command#

    +

    • command? : string[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:68

    +
    +

    Optional env#

    +

    • env? : object[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:85

    +
    +

    Optional envFrom#

    +

    • envFrom? : object[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:103

    +
    +

    image#

    +

    • image: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:67

    +
    +

    imagePullPolicy#

    +

    • imagePullPolicy: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:115

    +
    +

    Optional livenessProbe#

    +

    • livenessProbe? : IContainerProbe

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:113

    +
    +

    name#

    +

    • name: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:66

    +
    +

    ports#

    +

    • ports: object[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:70

    +
    +

    Optional readinessProbe#

    +

    • readinessProbe? : IContainerProbe

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:114

    +
    +

    Optional resources#

    +

    • resources? : object

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:75

    +

    Type declaration:

    +
      +
    • +

      limits(): object

      +
      • +
    • +

      cpu: string

      +
      • +
    • +

      memory: string

      +
      • +
    • +

      requests(): object

      +
      • +
    • +

      cpu: string

      +
      • +
    • +

      memory: string

      +
      • +
    +
    +

    Optional volumeMounts#

    +

    • volumeMounts? : object[]

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:108

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/index.html new file mode 100644 index 0000000000..35bdad8fc4 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_k8s_api_.ipodcontainerstatus/index.html @@ -0,0 +1,1111 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: IPodContainerStatus - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Interface: IPodContainerStatus#

    +

    Hierarchy#

    +
      +
    • IPodContainerStatus
      • +
    +

    Index#

    +

    Properties#

    + +

    Properties#

    +

    containerID#

    +

    • containerID: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:170

    +
    +

    image#

    +

    • image: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:168

    +
    +

    imageID#

    +

    • imageID: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:169

    +
    +

    lastState#

    +

    • lastState: object

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:156

    +

    Type declaration:

    +
      +
    • +

      [ index: string]: object

      +
      • +
    • +

      terminated(): object

      +
      • +
    • +

      containerID: string

      +
      • +
    • +

      exitCode: number

      +
      • +
    • +

      finishedAt: string

      +
      • +
    • +

      reason: string

      +
      • +
    • +

      startedAt: string

      +
      • +
    +
    +

    name#

    +

    • name: string

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:139

    +
    +

    ready#

    +

    • ready: boolean

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:166

    +
    +

    restartCount#

    +

    • restartCount: number

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:167

    +
    +

    state#

    +

    • state: object

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:140

    +

    Type declaration:

    +
      +
    • +

      [ index: string]: object

      +
      • +
    • +

      running(): object

      +
      • +
    • +

      startedAt: string

      +
      • +
    • +

      terminated(): object

      +
      • +
    • +

      exitCode: number

      +
      • +
    • +

      finishedAt: string

      +
      • +
    • +

      reason: string

      +
      • +
    • +

      startedAt: string

      +
      • +
    • +

      waiting(): object

      +
      • +
    • +

      message: string

      +
      • +
    • +

      reason: string

      +
      • +
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/index.html new file mode 100644 index 0000000000..0a808c8885 --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_k8s_api_.isecretref/index.html @@ -0,0 +1,979 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: ISecretRef - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html b/v4.0.1/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html new file mode 100644 index 0000000000..e89ca958ac --- /dev/null +++ b/v4.0.1/extensions/api/interfaces/_renderer_api_navigation_.iurlparams/index.html @@ -0,0 +1,989 @@ + + + + + + + + + + + + + + + + + + + + + + Interface: IURLParams ‹**P, Q**› - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/modules/_core_api_app_/index.html b/v4.0.1/extensions/api/modules/_core_api_app_/index.html new file mode 100644 index 0000000000..c0072557c2 --- /dev/null +++ b/v4.0.1/extensions/api/modules/_core_api_app_/index.html @@ -0,0 +1,1076 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "core-api/app" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Module: "core-api/app"#

    +

    Index#

    +

    Variables#

    + +

    Functions#

    + +

    Variables#

    +

    Const appName#

    +

    • appName: string = ${packageInfo.productName}${isDevelopment ? "Dev" : ""}

    +

    Defined in src/common/vars.ts:15

    +
    +

    Const isLinux#

    +

    • isLinux: boolean = process.platform === "linux"

    +

    Defined in src/common/vars.ts:8

    +
    +

    Const isMac#

    +

    • isMac: boolean = process.platform === "darwin"

    +

    Defined in src/common/vars.ts:6

    +
    +

    Const isSnap#

    +

    • isSnap: boolean = !!process.env.SNAP

    +

    Defined in src/common/vars.ts:10

    +
    +

    Const isWindows#

    +

    • isWindows: boolean = process.platform === "win32"

    +

    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

    +
    +

    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

    +
    +

    Const version#

    +

    • version: string = getAppVersion()

    +

    Defined in src/extensions/core-api/app.ts:4

    +

    Functions#

    +

    getEnabledExtensions#

    +

    ▸ getEnabledExtensions(): string[]

    +

    Defined in src/extensions/core-api/app.ts:7

    +

    Returns: string[]

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/modules/_core_api_cluster_feature_/index.html b/v4.0.1/extensions/api/modules/_core_api_cluster_feature_/index.html new file mode 100644 index 0000000000..1794aedb14 --- /dev/null +++ b/v4.0.1/extensions/api/modules/_core_api_cluster_feature_/index.html @@ -0,0 +1,943 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "core-api/cluster-feature" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/modules/_core_api_event_bus_/index.html b/v4.0.1/extensions/api/modules/_core_api_event_bus_/index.html new file mode 100644 index 0000000000..7a3c5c5f4a --- /dev/null +++ b/v4.0.1/extensions/api/modules/_core_api_event_bus_/index.html @@ -0,0 +1,1003 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "core-api/event-bus" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Module: "core-api/event-bus"#

    +

    Index#

    +

    Type aliases#

    + +

    Variables#

    + +

    Type aliases#

    +

    AppEvent#

    +

    Ƭ AppEvent: object

    +

    Defined in src/common/event-bus.ts:3

    +

    Type declaration:

    +
      +
    • +

      action: string

      +
      • +
    • +

      name: string

      +
      • +
    • +

      params? : object

      +
      • +
    +

    Variables#

    +

    Const appEventBus#

    +

    • appEventBus: EventEmitter‹[object]› = new EventEmitter<[AppEvent]>()

    +

    Defined in src/common/event-bus.ts:9

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/modules/_core_api_stores_/index.html b/v4.0.1/extensions/api/modules/_core_api_stores_/index.html new file mode 100644 index 0000000000..6b9c0325e4 --- /dev/null +++ b/v4.0.1/extensions/api/modules/_core_api_stores_/index.html @@ -0,0 +1,1042 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "core-api/stores" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Module: "core-api/stores"#

    +

    Index#

    +

    Classes#

    + +

    Interfaces#

    + +

    Type aliases#

    + +

    Variables#

    + +

    Type aliases#

    +

    ClusterId#

    +

    Ƭ ClusterId: string

    +

    Defined in src/common/cluster-store.ts:40

    +
    +

    WorkspaceId#

    +

    Ƭ WorkspaceId: string

    +

    Defined in src/common/workspace-store.ts:10

    +

    Variables#

    +

    Const clusterStore#

    +

    • clusterStore: ClusterStore‹› = ClusterStore.getInstance()

    +

    Defined in src/extensions/stores/cluster-store.ts:128

    +
    +

    Const workspaceStore#

    +

    • workspaceStore: WorkspaceStore‹› = WorkspaceStore.getInstance()

    +

    Defined in src/extensions/stores/workspace-store.ts:118

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/modules/_core_api_utils_/index.html b/v4.0.1/extensions/api/modules/_core_api_utils_/index.html new file mode 100644 index 0000000000..bcb8b7f59e --- /dev/null +++ b/v4.0.1/extensions/api/modules/_core_api_utils_/index.html @@ -0,0 +1,1072 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "core-api/utils" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Module: "core-api/utils"#

    +

    Index#

    +

    Classes#

    + +

    Functions#

    + +

    Functions#

    +

    cssNames#

    +

    ▸ cssNames(...args: IClassName[]): string

    +

    Defined in src/renderer/utils/cssNames.ts:8

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    ...argsIClassName[]
    +

    Returns: string

    +
    +

    openExternal#

    +

    ▸ openExternal(url: string): Promise‹void›

    +

    Defined in src/common/utils/openExternal.ts:4

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    urlstring
    +

    Returns: Promise‹void›

    +
    +

    prevDefault#

    +

    ▸ prevDefault‹E›(callback: function): (Anonymous function)

    +

    Defined in src/renderer/utils/prevDefault.ts:15

    +

    Type parameters:

    +

    ▪ E: SyntheticEvent | Event

    +

    Parameters:

    +

    ▪ callback: function

    +

    ▸ (evt: E): any

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtE
    +

    Returns: (Anonymous function)

    +
    +

    stopPropagation#

    +

    ▸ stopPropagation(evt: Event | SyntheticEvent): void

    +

    Defined in src/renderer/utils/prevDefault.ts:24

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    evtEvent | SyntheticEvent
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/modules/_interfaces_index_/index.html b/v4.0.1/extensions/api/modules/_interfaces_index_/index.html new file mode 100644 index 0000000000..f80c8a2986 --- /dev/null +++ b/v4.0.1/extensions/api/modules/_interfaces_index_/index.html @@ -0,0 +1,945 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "interfaces/index" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/modules/_renderer_api_components_/index.html b/v4.0.1/extensions/api/modules/_renderer_api_components_/index.html new file mode 100644 index 0000000000..5584709bd7 --- /dev/null +++ b/v4.0.1/extensions/api/modules/_renderer_api_components_/index.html @@ -0,0 +1,1518 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "renderer-api/components" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Module: "renderer-api/components"#

    +

    Index#

    +

    Enumerations#

    + +

    Classes#

    + +

    Interfaces#

    + +

    Type aliases#

    + +

    Variables#

    + +

    Functions#

    + +

    Type aliases#

    +

    InputProps#

    +

    Ƭ InputProps: Omit‹InputElementProps, "onChange" | "onSubmit"› & object

    +

    Defined in src/renderer/components/input/input.tsx:21

    +
    + +

    Ƭ MenuContextValue: Menu

    +

    Defined in src/renderer/components/menu/menu.tsx:11

    +
    +

    NotificationId#

    +

    Ƭ NotificationId: string | number

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:7

    +
    +

    NotificationMessage#

    +

    Ƭ NotificationMessage: React.ReactNode | React.ReactNode[] | JsonApiErrorParsed

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:8

    +
    +

    RadioProps#

    +

    Ƭ RadioProps: HTMLProps‹any› & object

    +

    Defined in src/renderer/components/radio/radio.tsx:40

    +
    +

    TableCellElem#

    +

    Ƭ TableCellElem: ReactElement‹TableCellProps›

    +

    Defined in src/renderer/components/table/table-cell.tsx:9

    +
    +

    TableHeadElem#

    +

    Ƭ TableHeadElem: ReactElement‹TableHeadProps›

    +

    Defined in src/renderer/components/table/table-head.tsx:6

    +
    +

    TableOrderBy#

    +

    Ƭ TableOrderBy: "asc" | "desc" | string

    +

    Defined in src/renderer/components/table/table.tsx:18

    +
    +

    TableRowElem#

    +

    Ƭ TableRowElem: ReactElement‹TableRowProps›

    +

    Defined in src/renderer/components/table/table-row.tsx:7

    +
    +

    TableSortBy#

    +

    Ƭ TableSortBy: string

    +

    Defined in src/renderer/components/table/table.tsx:17

    +
    +

    TableSortCallback#

    +

    Ƭ TableSortCallback: function

    +

    Defined in src/renderer/components/table/table.tsx:20

    +

    Type declaration:

    +

    ▸ (data: D): string | number | (string | number)[]

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    dataD
    +
    +

    TableSortParams#

    +

    Ƭ TableSortParams: object

    +

    Defined in src/renderer/components/table/table.tsx:19

    +

    Type declaration:

    + +

    Variables#

    +

    InputValidators#

    +

    • InputValidators: InputValidators

    +

    Defined in src/renderer/components/input/input.tsx:14

    +
    +

    Const MenuContext#

    +

    • MenuContext: Context‹Menu‹›› = React.createContext(null)

    +

    Defined in src/renderer/components/menu/menu.tsx:10

    +
    +

    Const TabLayout#

    +

    • TabLayout: (Anonymous function) = observer(({ className, contentClass, tabs = [], children }: TabLayoutProps) => { + const currentLocation = navigation.location.pathname; + const hasTabs = tabs.length > 0; + const startTabUrl = hasTabs ? (tabs.find(tab => tab.default) || tabs[0])?.url : null;

    +

    return ( +

    + {hasTabs && ( + navigate(url)}> + {tabs.map(({ title, routePath, url = routePath, exact }) => { + const isActive = !!matchPath(currentLocation, { path: routePath, exact });

    +
            return <Tab key={url} label={title} value={url} active={isActive}/>;
+      })}
+    </Tabs>
+  )}
+  <main className={cssNames(contentClass)}>
+    <ErrorBoundary>
+      {hasTabs && (
+        <Switch>
+          {tabs.map(({ routePath, exact, component }) => {
+            return <Route key={routePath} exact={exact} path={routePath} component={component}/>;
+          })}
+          <Redirect to={startTabUrl}/>
+        </Switch>
+      )}
+      {children}
+    </ErrorBoundary>
+  </main>
+</div>
+
    +

    ); +})

    +

    Defined in src/renderer/components/layout/tab-layout.tsx:27

    +
    +

    Const notificationsStore#

    +

    • notificationsStore: NotificationsStore‹› = new NotificationsStore()

    +

    Defined in src/renderer/components/notifications/notifications.store.ts:77

    +
    +

    Const terminalStore#

    +

    • terminalStore: TerminalStore‹› = new TerminalStore()

    +

    Defined in src/renderer/components/dock/terminal.store.ts:124

    +

    Functions#

    +

    DrawerItemLabels#

    +

    ▸ DrawerItemLabels(props: DrawerItemLabelsProps): Element‹›

    +

    Defined in src/renderer/components/drawer/drawer-item-labels.tsx:9

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsDrawerItemLabelsProps
    +

    Returns: Element‹›

    +
    + +

    ▸ SubMenu(props: Partial‹MenuProps›): Element‹›

    +

    Defined in src/renderer/components/menu/menu.tsx:275

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    propsPartial‹MenuProps›
    +

    Returns: Element‹›

    +
    +

    createPodLogsTab#

    +

    ▸ createPodLogsTab(data: IPodLogsData, tabParams: Partial‹IDockTab›): IDockTab

    +

    Defined in src/renderer/components/dock/pod-logs.store.ts:190

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    dataIPodLogsData-
    tabParamsPartial‹IDockTab›{}
    +

    Returns: IDockTab

    +
    +

    createTerminalTab#

    +

    ▸ createTerminalTab(tabParams: Partial‹ITerminalTab›): IDockTab

    +

    Defined in src/renderer/components/dock/terminal.store.ts:18

    +

    Parameters:

    + + + + + + + + + + + + + + + +
    NameTypeDefault
    tabParamsPartial‹ITerminalTab›{}
    +

    Returns: IDockTab

    +
    +

    withTooltip#

    +

    ▸ withTooltip‹T›(Target: T): T

    +

    Defined in src/renderer/components/tooltip/withTooltip.tsx:18

    +

    Type parameters:

    +

    ▪ T: React.ComponentType‹any›

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    TargetT
    +

    Returns: T

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/modules/_renderer_api_k8s_api_/index.html b/v4.0.1/extensions/api/modules/_renderer_api_k8s_api_/index.html new file mode 100644 index 0000000000..44221dffed --- /dev/null +++ b/v4.0.1/extensions/api/modules/_renderer_api_k8s_api_/index.html @@ -0,0 +1,1583 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "renderer-api/k8s-api" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Module: "renderer-api/k8s-api"#

    +

    Index#

    +

    Enumerations#

    + +

    Classes#

    + +

    Interfaces#

    + +

    Type aliases#

    + +

    Variables#

    + +

    Functions#

    + +

    Type aliases#

    +

    KubeObjectStatus#

    +

    Ƭ KubeObjectStatus: object

    +

    Defined in src/extensions/renderer-api/kube-object-status.ts:1

    +

    Type declaration:

    + +

    Variables#

    +

    Const apiManager#

    +

    • apiManager: ApiManager‹› = new ApiManager()

    +

    Defined in src/renderer/api/api-manager.ts:54

    +
    +

    Const clusterRoleApi#

    +

    • clusterRoleApi: KubeApi‹ClusterRole‹›› = new KubeApi({ + objectConstructor: ClusterRole, +})

    +

    Defined in src/renderer/api/endpoints/cluster-role.api.ts:12

    +
    +

    Const clusterRoleBindingApi#

    +

    • clusterRoleBindingApi: KubeApi‹ClusterRoleBinding‹›› = new KubeApi({ + objectConstructor: ClusterRoleBinding, +})

    +

    Defined in src/renderer/api/endpoints/cluster-role-binding.api.ts:10

    +
    +

    Const configMapApi#

    +

    • configMapApi: KubeApi‹ConfigMap‹›› = new KubeApi({ + objectConstructor: ConfigMap, +})

    +

    Defined in src/renderer/api/endpoints/configmap.api.ts:26

    +
    +

    Const crdApi#

    +

    • crdApi: KubeApi‹CustomResourceDefinition‹›› = new KubeApi({ + objectConstructor: CustomResourceDefinition, + checkPreferredVersion: true, +})

    +

    Defined in src/renderer/api/endpoints/crd.api.ts:154

    +
    +

    Const cronJobApi#

    +

    • cronJobApi: KubeApi‹CronJob‹›› = new KubeApi({ + objectConstructor: CronJob, +})

    +

    Defined in src/renderer/api/endpoints/cron-job.api.ts:95

    +
    +

    Const daemonSetApi#

    +

    • daemonSetApi: KubeApi‹DaemonSet‹›› = new KubeApi({ + objectConstructor: DaemonSet, +})

    +

    Defined in src/renderer/api/endpoints/daemon-set.api.ts:74

    +
    +

    Const deploymentApi#

    +

    • deploymentApi: DeploymentApi‹› = new DeploymentApi({ + objectConstructor: Deployment, +})

    +

    Defined in src/renderer/api/endpoints/deployment.api.ts:193

    +
    +

    Const endpointApi#

    +

    • endpointApi: KubeApi‹Endpoint‹›› = new KubeApi({ + objectConstructor: Endpoint, +})

    +

    Defined in src/renderer/api/endpoints/endpoint.api.ts:127

    +
    +

    Const eventApi#

    +

    • eventApi: KubeApi‹KubeEvent‹›› = new KubeApi({ + objectConstructor: KubeEvent, +})

    +

    Defined in src/renderer/api/endpoints/events.api.ts:59

    +
    +

    Const hpaApi#

    +

    • hpaApi: KubeApi‹HorizontalPodAutoscaler‹›› = new KubeApi({ + objectConstructor: HorizontalPodAutoscaler, +})

    +

    Defined in src/renderer/api/endpoints/hpa.api.ts:143

    +
    +

    Const ingressApi#

    +

    • ingressApi: IngressApi‹› = new IngressApi({ + objectConstructor: Ingress, + // Add fallback for Kubernetes <1.19 + checkPreferredVersion: true, + fallbackApiBases: ["/apis/extensions/v1beta1/ingresses"], + logStuff: true +} as any)

    +

    Defined in src/renderer/api/endpoints/ingress.api.ts:177

    +
    +

    Const jobApi#

    +

    • jobApi: KubeApi‹Job‹›› = new KubeApi({ + objectConstructor: Job, +})

    +

    Defined in src/renderer/api/endpoints/job.api.ts:110

    +
    +

    Const namespacesApi#

    +

    • namespacesApi: KubeApi‹Namespace‹›› = new KubeApi({ + objectConstructor: Namespace, +})

    +

    Defined in src/renderer/api/endpoints/namespaces.api.ts:25

    +
    +

    Const networkPolicyApi#

    +

    • networkPolicyApi: KubeApi‹NetworkPolicy‹›› = new KubeApi({ + objectConstructor: NetworkPolicy, +})

    +

    Defined in src/renderer/api/endpoints/network-policy.api.ts:71

    +
    +

    Const nodesApi#

    +

    • nodesApi: NodesApi‹› = new NodesApi({ + objectConstructor: Node, +})

    +

    Defined in src/renderer/api/endpoints/nodes.api.ts:169

    +
    +

    Const pdbApi#

    +

    • pdbApi: KubeApi‹PodDisruptionBudget‹›› = new KubeApi({ + objectConstructor: PodDisruptionBudget, +})

    +

    Defined in src/renderer/api/endpoints/poddisruptionbudget.api.ts:47

    +
    +

    Const persistentVolumeApi#

    +

    • persistentVolumeApi: KubeApi‹PersistentVolume‹›› = new KubeApi({ + objectConstructor: PersistentVolume, +})

    +

    Defined in src/renderer/api/endpoints/persistent-volume.api.ts:73

    +
    +

    Const podsApi#

    +

    • podsApi: PodsApi‹› = new PodsApi({ + objectConstructor: Pod, +})

    +

    Defined in src/renderer/api/endpoints/pods.api.ts:459

    +
    +

    Const pvcApi#

    +

    • pvcApi: PersistentVolumeClaimsApi‹› = new PersistentVolumeClaimsApi({ + objectConstructor: PersistentVolumeClaim, +})

    +

    Defined in src/renderer/api/endpoints/persistent-volume-claims.api.ts:90

    +
    +

    Const replicaSetApi#

    +

    • replicaSetApi: KubeApi‹ReplicaSet‹›› = new KubeApi({ + objectConstructor: ReplicaSet, +})

    +

    Defined in src/renderer/api/endpoints/replica-set.api.ts:56

    +
    +

    Const resourceQuotaApi#

    +

    • resourceQuotaApi: KubeApi‹ResourceQuota‹›› = new KubeApi({ + objectConstructor: ResourceQuota, +})

    +

    Defined in src/renderer/api/endpoints/resource-quota.api.ts:66

    +
    +

    Const roleApi#

    +

    • roleApi: KubeApi‹Role‹›› = new KubeApi({ + objectConstructor: Role, +})

    +

    Defined in src/renderer/api/endpoints/role.api.ts:21

    +
    +

    Const roleBindingApi#

    +

    • roleBindingApi: KubeApi‹RoleBinding‹›› = new KubeApi({ + objectConstructor: RoleBinding, +})

    +

    Defined in src/renderer/api/endpoints/role-binding.api.ts:34

    +
    +

    Const secretsApi#

    +

    • secretsApi: KubeApi‹Secret‹›› = new KubeApi({ + objectConstructor: Secret, +})

    +

    Defined in src/renderer/api/endpoints/secret.api.ts:48

    +
    +

    Const serviceAccountsApi#

    +

    • serviceAccountsApi: KubeApi‹ServiceAccount‹›› = new KubeApi({ + objectConstructor: ServiceAccount, +})

    +

    Defined in src/renderer/api/endpoints/service-accounts.api.ts:27

    +
    +

    Const serviceApi#

    +

    • serviceApi: KubeApi‹Service‹›› = new KubeApi({ + objectConstructor: Service, +})

    +

    Defined in src/renderer/api/endpoints/service.api.ts:101

    +
    +

    Const statefulSetApi#

    +

    • statefulSetApi: StatefulSetApi‹› = new StatefulSetApi({ + objectConstructor: StatefulSet, +})

    +

    Defined in src/renderer/api/endpoints/stateful-set.api.ts:110

    +
    +

    Const storageClassApi#

    +

    • storageClassApi: KubeApi‹StorageClass‹›› = new KubeApi({ + objectConstructor: StorageClass, +})

    +

    Defined in src/renderer/api/endpoints/storage-class.api.ts:37

    +

    Functions#

    +

    forCluster#

    +

    ▸ forCluster‹T›(cluster: IKubeApiCluster, kubeClass: IKubeObjectConstructor‹T›): KubeApi‹T›

    +

    Defined in src/renderer/api/kube-api.ts:66

    +

    Type parameters:

    +

    ▪ T: KubeObject

    +

    Parameters:

    + + + + + + + + + + + + + + + + + +
    NameType
    clusterIKubeApiCluster
    kubeClassIKubeObjectConstructor‹T›
    +

    Returns: KubeApi‹T›

    +
    +

    isAllowedResource#

    +

    ▸ isAllowedResource(resources: KubeResource | KubeResource[]): boolean

    +

    Defined in src/common/rbac.ts:40

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    resourcesKubeResource | KubeResource[]
    +

    Returns: boolean

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/modules/_renderer_api_navigation_/index.html b/v4.0.1/extensions/api/modules/_renderer_api_navigation_/index.html new file mode 100644 index 0000000000..be902574a4 --- /dev/null +++ b/v4.0.1/extensions/api/modules/_renderer_api_navigation_/index.html @@ -0,0 +1,1062 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "renderer-api/navigation" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Module: "renderer-api/navigation"#

    +

    Index#

    +

    Interfaces#

    + +

    Functions#

    + +

    Functions#

    +

    getDetailsUrl#

    +

    ▸ getDetailsUrl(details: string): string

    +

    Defined in src/renderer/navigation.ts:71

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    detailsstring
    +

    Returns: string

    +
    +

    hideDetails#

    +

    ▸ hideDetails(): void

    +

    Defined in src/renderer/navigation.ts:93

    +

    Hide details. Works only in renderer.

    +

    Returns: void

    +
    + +

    ▸ navigate(location: LocationDescriptor): void

    +

    Defined in src/renderer/navigation.ts:17

    +

    Navigate to a location. Works only in renderer.

    +

    Parameters:

    + + + + + + + + + + + + + +
    NameType
    locationLocationDescriptor
    +

    Returns: void

    +
    +

    showDetails#

    +

    ▸ showDetails(path: string, resetSelected: boolean): void

    +

    Defined in src/renderer/navigation.ts:83

    +

    Show details. Works only in renderer.

    +

    Parameters:

    + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault
    pathstring-
    resetSelectedbooleantrue
    +

    Returns: void

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/api/modules/_renderer_api_theming_/index.html b/v4.0.1/extensions/api/modules/_renderer_api_theming_/index.html new file mode 100644 index 0000000000..0f0b624281 --- /dev/null +++ b/v4.0.1/extensions/api/modules/_renderer_api_theming_/index.html @@ -0,0 +1,957 @@ + + + + + + + + + + + + + + + + + + + + + + Module: "renderer-api/theming" - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/capabilities/color-reference/index.html b/v4.0.1/extensions/capabilities/color-reference/index.html new file mode 100644 index 0000000000..fae59b8c0c --- /dev/null +++ b/v4.0.1/extensions/capabilities/color-reference/index.html @@ -0,0 +1,1300 @@ + + + + + + + + + + + + + + + + + + + + + + Color Reference - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Theme Color Reference#

    +

    You can use theme-based CSS Variables to style an extension according to the active theme.

    +

    Base Colors#

    +
      +
    • --blue: blue color.
      • +
    • --magenta: magenta color.
      • +
    • --golden: gold/yellow color.
      • +
    • --halfGray: gray with some apacity applied.
      • +
    • --primary: Lens brand (blue) color.
      • +
    • --colorSuccess: successfull operations color.
      • +
    • --colorOk: successfull operations (bright version) color.
      • +
    • --colorInfo: informational, in-progress color.
      • +
    • --colorError: critical error color.
      • +
    • --colorSoftError: error color.
      • +
    • --colorWarning: warning color.
      • +
    • --colorVague: soft gray color for notices, hints etc.
      • +
    • --colorTerminated: terminated, closed, stale color.
      • +
    • --boxShadow: semi-transparent box-shadow color.
      • +
    +

    Text Colors#

    +
      +
    • --textColorPrimary: foreground text color.
      • +
    • --textColorSecondary: foreground text color for different paragraps, parts of text.
      • +
    • --textColorAccent: foreground text color to highlight its parts.
      • +
    +

    Border Colors#

    +
      +
    • --borderColor: border color.
      • +
    • --borderFaintColor: fainted (lighter or darker, which depends on the theme) border color.
      • +
    +

    Layout Colors#

    +
      +
    • --mainBackground: main background color for the app.
      • +
    • --contentColor: background color for panels contains some data.
      • +
    • --layoutBackground: background color for layout parts.
      • +
    • --layoutTabsBackground: background color for general tabs.
      • +
    • --layoutTabsActiveColor: foreground color for general tabs.
      • +
    • --layoutTabsLineColor: background color for lines under general tabs.
      • +
    + +
      +
    • --sidebarLogoBackground: background color behind logo in sidebar.
      • +
    • --sidebarActiveColor: foreground color for active menu items in sidebar.
      • +
    • --sidebarSubmenuActiveColor: foreground color for active submenu items in sidebar.
      • +
    • --sidebarBackground: background color for sidebar.
      • +
    +

    Button Colors#

    +
      +
    • --buttonPrimaryBackground: button background color for primary actions.
      • +
    • --buttonDefaultBackground: default button background color.
      • +
    • --buttonAccentBackground: accent button background color.
      • +
    • --buttonDisabledBackground: disabled button background color.
      • +
    +

    Table Colors#

    +
      +
    • --tableBgcStripe: background color for odd rows in table.
      • +
    • --tableBgcSelected: background color for selected row in table.
      • +
    • --tableHeaderBackground: background color for table header.
      • +
    • --tableHeaderBorderWidth: border width under table header.
      • +
    • --tableHeaderBorderColor: border color for line under table header.
      • +
    • --tableHeaderColor: foreground color for table header.
      • +
    • --tableSelectedRowColor: foreground color for selected row in table.
      • +
    +

    Dock Colors#

    +
      +
    • --dockHeadBackground: background color for dock's header.
      • +
    • --dockInfoBackground: background color for dock's info panel.
      • +
    • --dockInfoBorderColor: border color for dock's info panel.
      • +
    +

    Helm Chart Colors#

    +
      +
    • --helmLogoBackground: background color for chart logo.
      • +
    • --helmImgBackground: background color for chart image.
      • +
    • --helmStableRepo: background color for stable repo.
      • +
    • --helmIncubatorRepo: background color for incubator repo.
      • +
    • --helmDescriptionHr: Helm chart description separator line color.
      • +
    • --helmDescriptionBlockqouteColor: Helm chart description blockquote color.
      • +
    • --helmDescriptionBlockqouteBorder: Helm chart description blockquote border color.
      • +
    • --helmDescriptionBlockquoteBackground: Helm chart description blockquote background color.
      • +
    • --helmDescriptionHeaders: Helm chart description headers color.
      • +
    • --helmDescriptionH6: Helm chart description header foreground color.
      • +
    • --helmDescriptionTdBorder: Helm chart description table cell border color.
      • +
    • --helmDescriptionTrBackground: Helm chart description table row background color.
      • +
    • --helmDescriptionCodeBackground: Helm chart description code background color.
      • +
    • --helmDescriptionPreBackground: Helm chart description pre background color.
      • +
    • --helmDescriptionPreColor: Helm chart description pre foreground color.
      • +
    +

    Terminal Colors#

    +
      +
    • --terminalBackground: Terminal background color.
      • +
    • --terminalForeground: Terminal foreground color.
      • +
    • --terminalCursor: Terminal cursor color.
      • +
    • --terminalCursorAccent: Terminal cursor accent color.
      • +
    • --terminalSelection: Terminal selection background color.
      • +
    • --terminalBlack: Terminal black color.
      • +
    • --terminalRed: Terminal red color.
      • +
    • --terminalGreen: Terminal green color.
      • +
    • --terminalYellow: Terminal yellow color.
      • +
    • --terminalBlue: Terminal blue color.
      • +
    • --terminalMagenta: Terminal magenta color.
      • +
    • --terminalCyan: Terminal cyan color.
      • +
    • --terminalWhite: Terminal white color.
      • +
    • --terminalBrightBlack: Terminal bright black color.
      • +
    • --terminalBrightRed: Terminal bright red color.
      • +
    • --terminalBrightGreen: Terminal bright green color.
      • +
    • --terminalBrightYellow: Terminal bright yellow color.
      • +
    • --terminalBrightBlue: Terminal bright blue color.
      • +
    • --terminalBrightMagenta: Terminal bright magenta color.
      • +
    • --terminalBrightCyan: Terminal bright cyan color.
      • +
    • --terminalBrightWhite: Terminal bright white color.
      • +
    +

    Dialog Colors#

    +
      +
    • --dialogHeaderBackground: background color for dialog header.
      • +
    • --dialogFooterBackground: background color for dialog footer.
      • +
    +

    Detail Panel (Drawer) Colors#

    +
      +
    • --drawerTitleText: drawer title foreground color.
      • +
    • --drawerSubtitleBackground: drawer subtitle foreground color.
      • +
    • --drawerItemNameColor: foreground color for item name in drawer.
      • +
    • --drawerItemValueColor: foreground color for item value in drawer.
      • +
    +

    Misc Colors#

    +
      +
    • --logsBackground: background color for pod logs.
      • +
    • --clusterMenuBackground: background color for cluster menu.
      • +
    • --clusterMenuBorderColor: border color for cluster menu.
      • +
    • --clusterSettingsBackground: background color for cluster settings.
      • +
    • --addClusterIconColor: add cluster button background color.
      • +
    • --iconActiveColor: active cluster icon foreground color.
      • +
    • --iconActiveBackground: active cluster icon background color.
      • +
    • --filterAreaBackground: page filter area (where selected namespaces are lister) background color.
      • +
    • --chartStripesColor: bar chart zebra stripes background color.
      • +
    • --chartCapacityColor: background color for capacity values in bar charts.
      • +
    • --pieChartDefaultColor: default background color for pie chart values.
      • +
    • --selectOptionHoveredColor: foregrond color for selected element in dropdown list.
      • +
    • --lineProgressBackground: background color for progress line.
      • +
    • --radioActiveBackground: background color for active radio buttons.
      • +
    • --menuActiveBackground: background color for active menu items.
      • +
    +

    In most cases you would only need base, text and some of the layout colors.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/capabilities/common-capabilities/index.html b/v4.0.1/extensions/capabilities/common-capabilities/index.html new file mode 100644 index 0000000000..215d21352e --- /dev/null +++ b/v4.0.1/extensions/capabilities/common-capabilities/index.html @@ -0,0 +1,1411 @@ + + + + + + + + + + + + + + + + + + + + + + Common Capabilities - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Common Capabilities#

    +

    Here we will discuss common and important building blocks for your extensions, and explain how you can use them. Almost all extensions use some of these functionalities.

    +

    Main Extension#

    +

    The main extension runs in the background. It adds app menu items to the Lens UI. In order to see logs from this extension, you need to start Lens from the command line.

    +

    Activate#

    +

    This extension can register a custom callback that is executed when an extension is activated (started).

    +
    import { LensMainExtension } from "@k8slens/extensions"
+
+export default class ExampleMainExtension extends LensMainExtension {
+  async onActivate() {
+    console.log("hello world")
+  }
+}
+
    +

    Deactivate#

    +

    This extension can register a custom callback that is executed when an extension is deactivated (stopped).

    +
    import { LensMainExtension } from "@k8slens/extensions"
+
+export default class ExampleMainExtension extends LensMainExtension {
+  async onDeactivate() {
+    console.log("bye bye")
+  }
+}
+
    +

    App Menus#

    +

    This extension can register custom app menus that will be displayed on OS native menus.

    +

    Example:

    +
    import { LensMainExtension, windowManager } from "@k8slens/extensions"
+
+export default class ExampleMainExtension extends LensMainExtension {
+  appMenus = [
+    {
+      parentId: "help",
+      label: "Example item",
+      click() {
+        windowManager.navigate("https://k8slens.dev");
+      }
+    }
+  ]
+}
+
    +

    Renderer Extension#

    +

    The renderer extension runs in a browser context, and is visible in Lens's main window. In order to see logs from this extension you need to check them via View > Toggle Developer Tools > Console.

    +

    Activate#

    +

    This extension can register a custom callback that is executed when an extension is activated (started).

    +
    import { LensRendererExtension } from "@k8slens/extensions"
+
+export default class ExampleExtension extends LensRendererExtension {
+  async onActivate() {
+    console.log("hello world")
+  }
+}
+
    +

    Deactivate#

    +

    This extension can register a custom callback that is executed when an extension is deactivated (stopped).

    +
    import { LensRendererExtension } from "@k8slens/extensions"
+
+export default class ExampleMainExtension extends LensRendererExtension {
+  async onDeactivate() {
+    console.log("bye bye")
+  }
+}
+
    +

    Global Pages#

    +

    This extension can register custom global pages (views) to Lens's main window. The global page is a full-screen page that hides all other content from a window.

    +
    import React from "react"
+import { Component, LensRendererExtension } from "@k8slens/extensions"
+import { ExamplePage } from "./src/example-page"
+
+export default class ExampleRendererExtension extends LensRendererExtension {
+  globalPages = [
+    {
+      id: "example",
+      components: {
+        Page: ExamplePage,
+      }
+    }
+  ]
+
+  globalPageMenus = [
+    {
+      title: "Example page", // used in icon's tooltip
+      target: { pageId: "example" }
+      components: {
+        Icon: () => <Component.Icon material="arrow"/>,
+      }
+    }
+  ]
+}
+
    +

    App Preferences#

    +

    This extension can register custom app preferences. It is responsible for storing a state for custom preferences.

    +
    import React from "react"
+import { LensRendererExtension } from "@k8slens/extensions"
+import { myCustomPreferencesStore } from "./src/my-custom-preferences-store"
+import { MyCustomPreferenceHint, MyCustomPreferenceInput } from "./src/my-custom-preference"
+
+
+export default class ExampleRendererExtension extends LensRendererExtension {
+  appPreferences = [
+    {
+      title: "My Custom Preference",
+      components: {
+        Hint: () => <MyCustomPreferenceHint/>,
+        Input: () => <MyCustomPreferenceInput store={myCustomPreferencesStore}/>
+      }
+    }
+  ]
+}
+
    +

    Cluster Pages#

    +

    This extension can register custom cluster pages. These pages are visible in a cluster menu when a cluster is opened.

    +
    import React from "react"
+import { LensRendererExtension } from "@k8slens/extensions";
+import { ExampleIcon, ExamplePage } from "./src/page"
+
+export default class ExampleExtension extends LensRendererExtension {
+  clusterPages = [
+    {
+      id: "extension-example", // optional
+      exact: true, // optional
+      components: {
+        Page: () => <ExamplePage extension={this}/>,
+      }
+    }
+  ]
+
+  clusterPageMenus = [
+    {
+      url: "/extension-example", // optional
+      title: "Example Extension",
+      components: {
+        Icon: ExampleIcon,
+      }
+    }
+  ]
+}
+
    +

    Cluster Features#

    +

    This extension can register installable features for a cluster. These features are visible in the "Cluster Settings" page.

    +
    import React from "react"
+import { LensRendererExtension } from "@k8slens/extensions"
+import { MyCustomFeature } from "./src/my-custom-feature"
+
+export default class ExampleExtension extends LensRendererExtension {
+  clusterFeatures = [
+    {
+      title: "My Custom Feature",
+      components: {
+        Description: () => {
+          return (
+            <span>
+              Just an example.
+            </span>
+          )
+        }
+      },
+      feature: new MyCustomFeature()
+    }
+  ]
+}
+
    +

    Status Bar Items#

    +

    This extension can register custom icons and text to a status bar area.

    +
    import React from "react";
+import { Component, LensRendererExtension, Navigation } from "@k8slens/extensions";
+
+export default class ExampleExtension extends LensRendererExtension {
+  statusBarItems = [
+    {
+      item: (
+        <div className="flex align-center gaps hover-highlight" onClick={() => this.navigate("/example-page")} >
+          <Component.Icon material="favorite" />
+        </div>
+      )
+    }
+  ]
+}
+
    +

    Kubernetes Object Menu Items#

    +

    This extension can register custom menu items (actions) for specified Kubernetes kinds/apiVersions.

    +
    import React from "react"
+import { LensRendererExtension } from "@k8slens/extensions";
+import { CustomMenuItem, CustomMenuItemProps } from "./src/custom-menu-item"
+
+export default class ExampleExtension extends LensRendererExtension {
+  kubeObjectMenuItems = [
+    {
+      kind: "Node",
+      apiVersions: ["v1"],
+      components: {
+        MenuItem: (props: CustomMenuItemProps) => <CustomMenuItem {...props} />
+      }
+    }
+  ]
+}
+
    +

    Kubernetes Object Details#

    +

    This extension can register custom details (content) for specified Kubernetes kinds/apiVersions.

    +
    import React from "react"
+import { LensRendererExtension } from "@k8slens/extensions";
+import { CustomKindDetails, CustomKindDetailsProps } from "./src/custom-kind-details"
+
+export default class ExampleExtension extends LensRendererExtension {
+  kubeObjectDetailItems = [
+    {
+      kind: "CustomKind",
+      apiVersions: ["custom.acme.org/v1"],
+      components: {
+        Details: (props: CustomKindDetailsProps) => <CustomKindDetails {...props} />
+      }
+    }
+  ]
+}
+
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/capabilities/images/css-vars-in-devtools.png b/v4.0.1/extensions/capabilities/images/css-vars-in-devtools.png new file mode 100644 index 0000000000..a9df97e6bb Binary files /dev/null and b/v4.0.1/extensions/capabilities/images/css-vars-in-devtools.png differ diff --git a/v4.0.1/extensions/capabilities/images/theme-selector.png b/v4.0.1/extensions/capabilities/images/theme-selector.png new file mode 100644 index 0000000000..5c2eba3165 Binary files /dev/null and b/v4.0.1/extensions/capabilities/images/theme-selector.png differ diff --git a/v4.0.1/extensions/capabilities/index.html b/v4.0.1/extensions/capabilities/index.html new file mode 100644 index 0000000000..82e819ca43 --- /dev/null +++ b/v4.0.1/extensions/capabilities/index.html @@ -0,0 +1,875 @@ + + + + + + + + + + + + + + + + + + + + + + Index - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + +

    Index

    + + + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/capabilities/styling/index.html b/v4.0.1/extensions/capabilities/styling/index.html new file mode 100644 index 0000000000..5a13ad45cd --- /dev/null +++ b/v4.0.1/extensions/capabilities/styling/index.html @@ -0,0 +1,1225 @@ + + + + + + + + + + + + + + + + + + + + + + Styling - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Styling an Extension#

    +

    Lens provides a set of global styles and UI components that can be used by any extension to preserve the look and feel of the application.

    +

    Layout#

    +

    For layout tasks, Lens uses the flex.box library which provides helpful class names to specify some of the flexbox properties. For example, consider the following HTML and its associated CSS properties:

    +
    <div className="flex column align-center"></div>
+
    +
    div {
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+}
+
    +

    However, you are free to use any styling technique or framework you like, including Emotion or even plain CSS.

    +

    Layout Variables#

    +

    There is a set of CSS variables available for for basic layout needs. They are located inside :root and are defined in app.scss:

    +
    --unit: 8px;
+--padding: var(--unit);
+--margin: var(--unit);
+--border-radius: 3px;
+
    +

    These variables are intended to set consistent margins and paddings across components. For example:

    +
    .status {
+  padding-left: calc(var(--padding) * 2);
+  border-radius: var(--border-radius);
+}
+
    +

    Themes#

    +

    Lens uses two built-in themes defined in the themes directory – one light and one dark.

    +

    Theme Variables#

    +

    When Lens is loaded, it transforms the selected theme's json file into a list of CSS Custom Properties (CSS Variables). This list then gets injected into the :root element so that any of the down-level components can use them. +CSS vars listed in devtools

    +

    When the user changes the theme, the above process is repeated, and new CSS variables appear, replacing the previous ones.

    +

    If you want to preserve Lens's native look and feel, with respect to the lightness or darkness of your extension, you can use the provided variables and built-in Lens components such as Button, Select, Table, and so on.

    +

    There is a set of CSS variables available for extensions to use for theming. They are all located inside :root and are defined in app.scss:

    +
    --font-main: 'Roboto', 'Helvetica', 'Arial', sans-serif;
+--font-monospace: Lucida Console, Monaco, Consolas, monospace;
+--font-size-small: calc(1.5 * var(--unit));
+--font-size: calc(1.75 * var(--unit));
+--font-size-big: calc(2 * var(--unit));
+--font-weight-thin: 300;
+--font-weight-normal: 400;
+--font-weight-bold: 500;
+
    +

    as well as in the theme modules:

    +
    --blue: #3d90ce;
+--magenta: #c93dce;
+--golden: #ffc63d;
+--halfGray: #87909c80;
+--primary: #3d90ce;
+--textColorPrimary: #555555;
+--textColorSecondary: #51575d;
+--textColorAccent: #333333;
+--borderColor: #c9cfd3;
+--borderFaintColor: #dfdfdf;
+--mainBackground: #f1f1f1;
+--contentColor: #ffffff;
+--layoutBackground: #e8e8e8;
+--layoutTabsBackground: #f8f8f8;
+--layoutTabsActiveColor: #333333;
+--layoutTabsLineColor: #87909c80;
+...
+
    +

    These variables can be used in the following form: var(--magenta). For example:

    +
    .status {
+  font-size: var(--font-size-small);
+  background-color: var(--colorSuccess);
+}
+
    +

    A complete list of themable colors can be found in the Color Reference.

    +

    Theme Switching#

    +

    When the light theme is active, the <body> element gets a "theme-light" class, or: <body class="theme-light">. If the class isn't there, the theme defaults to dark. The active theme can be changed in the Preferences page: +Color Theme

    +

    There is a way of detect active theme and its changes in JS. MobX observer function/decorator can be used for this purpose.

    +
    import React from "react"
+import { observer } from "mobx-react"
+import { App, Component, Theme } from "@k8slens/extensions";
+
+@observer
+export class SupportPage extends React.Component {
+  render() {
+    return (
+      <div className="SupportPage">
+        <h1>Active theme is {Theme.getActiveTheme().name}</h1>
+      </div>
+    );
+  }
+}
+
    +

    Theme entity from @k8slens/extensions provides active theme object and @observer decorator makes component reactive - so it will rerender each time any of the observables (active theme in our case) will be changed.

    +

    Working example provided in Styling with Emotion sample extension.

    +

    Injected Styles#

    +

    Every extension is affected by the list of default global styles defined in app.scss. These are basic browser resets and element styles, including:

    +
      +
    • setting the box-sizing property for every element
      • +
    • default text and background colors
      • +
    • default font sizes
      • +
    • basic heading (h1, h2, etc) formatting
      • +
    • custom scrollbar styling
      • +
    +

    Extensions may overwrite these defaults if needed. They have low CSS specificity, so overriding them should be fairly easy.

    +

    CSS-in-JS#

    +

    If an extension uses a system like Emotion to work with styles, it can use CSS variables as follows:

    +
    const Container = styled.div(() => ({
+  backgroundColor: 'var(--mainBackground)'
+}));
+
    +

    Examples#

    +

    You can explore samples for each styling technique that you can use for extensions:

    + + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/get-started/anatomy/index.html b/v4.0.1/extensions/get-started/anatomy/index.html new file mode 100644 index 0000000000..79b070e3f4 --- /dev/null +++ b/v4.0.1/extensions/get-started/anatomy/index.html @@ -0,0 +1,1111 @@ + + + + + + + + + + + + + + + + + + + + + + Extension Anatomy - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Extension Anatomy#

    +

    In the previous section you learned how to create your first extension. In this section you will learn how this extension works under the hood.

    +

    The Hello World sample extension does three things:

    +
      +
    • Implements onActivate() and outputs a message to the console.
      • +
    • Implements onDectivate() and outputs a message to the console.
      • +
    • Registers ClusterPage so that the page is visible in the left-side menu of the cluster dashboard.
      • +
    +

    Let's take a closer look at our Hello World sample's source code and see how these three things are achieved.

    +

    Extension File Structure#

    +
    .
+├── .gitignore          // Ignore build output and node_modules
+├── Makefile            // Config for build tasks that compiles the extension
+├── README.md           // Readable description of your extension's functionality
+├── src
+│   └── page.tsx         // Extension's additional source code
+├── main.ts              // Source code for extension's main entrypoint
+├── package.json         // Extension manifest and dependencies
+├── renderer.tsx         // Source code for extension's renderer entrypoint
+├── tsconfig.json        // TypeScript configuration
+├── webpack.config.js    // Webpack configuration
+
    +

    The extension directory contains the extension's entry files and a few configuration files. Three files: package.json, main.ts and renderer.tsx are essential to understanding the Hello World sample extension. We'll look at those first.

    +

    Extension Manifest#

    +

    Each Lens extension must have a package.json file. It contains a mix of Node.js fields, including scripts and dependencies, and Lens-specific fields such as publisher and contributes. Some of the most-important fields include:

    +
      +
    • name and publisher: Lens uses @<publisher>/<name> as a unique ID for the extension. For example, the Hello World sample has the ID @lensapp-samples/helloworld-sample. Lens uses this ID to uniquely identify your extension.
      • +
    • main: the extension's entry point run in main process.
      • +
    • renderer: the extension's entry point run in renderer process.
      • +
    • engines.lens: the minimum version of Lens API that the extension depends upon.
      • +
    +
    {
+  "name": "helloworld-sample",
+  "publisher": "lens-samples",
+  "version": "0.0.1",
+  "description": "Lens helloworld-sample",
+  "license": "MIT",
+  "homepage": "https://github.com/lensapp/lens-extension-samples",
+  "engines": {
+    "lens": "^4.0.0"
+  },
+  "main": "dist/main.js",
+  "renderer": "dist/renderer.js",
+  "scripts": {
+    "build": "webpack --config webpack.config.js",
+    "dev": "npm run build --watch"
+  },
+  "dependencies": {
+    "react-open-doodles": "^1.0.5"
+  },
+  "devDependencies": {
+    "@k8slens/extensions": "^4.0.0-alpha.2",
+    "ts-loader": "^8.0.4",
+    "typescript": "^4.0.3",
+    "@types/react": "^16.9.35",
+    "@types/node": "^12.0.0",
+    "webpack": "^4.44.2",
+    "webpack-cli": "^3.3.11"
+  }
+}
+
    +

    Extension Entry Files#

    +

    Lens extensions can have two separate entry files. One file is used in the main process of the Lens application and the other is used in the renderer process. The main entry file exports the class that extends LensMainExtension, and the renderer entry file exports the class that extends LensRendererExtension.

    +

    Both extension classes have onActivate and onDeactivate methods. The onActivate method is executed when your extension is activated. If you need to initialize something in your extension, this is where such an operation should occur. The onDeactivate method gives you a chance to clean up before your extension becomes deactivated. For extensions where explicit cleanup is not required, you don't need to override this method. However, if an extension needs to perform an operation when Lens is shutting down (or if the extension is disabled or uninstalled), this is the method where such an operation should occur.

    +

    The Hello World sample extension does not do anything on the main process, so we'll focus on the renderer process, instead. On the renderer entry point, the Hello World sample extension defines the Cluster Page object. The Cluster Page object registers the /extension-example path, and this path renders the ExamplePage React component. It also registers the MenuItem component that displays the ExampleIcon React component and the "Hello World" text in the left-side menu of the cluster dashboard. These React components are defined in the additional ./src/page.tsx file.

    +
    import { LensRendererExtension } from "@k8slens/extensions";
+import { ExampleIcon, ExamplePage } from "./page"
+import React from "react"
+
+export default class ExampleExtension extends LensRendererExtension {
+  clusterPages = [
+    {
+      id: "extension-example",
+      components: {
+        Page: () => <ExamplePage extension={this}/>,
+      }
+    }
+  ]
+}
+
    +

    The Hello World sample extension uses the Cluster Page capability, which is just one of the Lens extension API's capabilities. The Common Capabilities page will help you home in on the right capabilities to use with your own extensions.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/get-started/overview/index.html b/v4.0.1/extensions/get-started/overview/index.html new file mode 100644 index 0000000000..2e466f45ee --- /dev/null +++ b/v4.0.1/extensions/get-started/overview/index.html @@ -0,0 +1,1018 @@ + + + + + + + + + + + + + + + + + + + + + + Overview - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Extension Development Overview#

    +

    This is a general overview to how the development of an extension will procede. For building extensions there will be a few things that you should have installed, and some other things that might be of help.

    +

    Required:#

    +
      +
    • Node.js
      • +
    • Git
      • +
    • Some sort of text editor – we recommend VSCode
      • +
    • We use Webpack for compilation. All extension need to be at least compatable with a webpack system.
      • +
    + +

    All Lens extensions are javascript packages. We recommend that you program in Typescript because it catches many common errors.

    +

    Lens is a standard Electron application with both main and renderer processes. An extension is made up of two parts, one for each of Lens's core processes. When an extension is loaded, each part is first loaded and issues a notification that it has been loaded. From there, the extension can start doing is work.

    +

    Lens uses React as its UI framework and provides some of Lens's own components for reuse with extensions. An extension is resonsible for the lifetime of any resources it spins up. If an extension's main part starts new processes they all must be stopped and cleaned up when the extension is deactivated or unloaded.

    +

    See Your First Extension to get started.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/get-started/wrapping-up/index.html b/v4.0.1/extensions/get-started/wrapping-up/index.html new file mode 100644 index 0000000000..ec4eb5e3d4 --- /dev/null +++ b/v4.0.1/extensions/get-started/wrapping-up/index.html @@ -0,0 +1,1030 @@ + + + + + + + + + + + + + + + + + + + + + + Wrapping Up - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Wrapping Up#

    +

    In Your First Extension, you learned how to create and run an extension. In Extension Anatomy, you learned in detail how a basic extension works. This is just a glimpse into what can be created with Lens extensions. Below are some suggested routes for learning more.

    +

    Extension Capabilities#

    +

    In this section, you'll find information on common extension capabilities, styling information, and a color reference guide. Determine whether your idea for an extension is doable and get ideas for new extensions by reading through the Common Capabilities page.

    +

    Guides and Samples#

    +

    Here you'll find a collection of sample extensions that you can use as a base to work from. Some of these samples include a detailed guide that explains the source code. You can find all samples and guides in the lens-extension-samples repository.

    +

    Testing and Publishing#

    +

    In this section, you can learn:

    + + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/get-started/your-first-extension/index.html b/v4.0.1/extensions/get-started/your-first-extension/index.html new file mode 100644 index 0000000000..5c7ee69211 --- /dev/null +++ b/v4.0.1/extensions/get-started/your-first-extension/index.html @@ -0,0 +1,1141 @@ + + + + + + + + + + + + + + + + + + + + + + Your First Extension - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Your First Extension#

    +

    We recommend to always use Yeoman generator for Lens Extension to start new extension project. Read the generator guide here.

    +

    If you want to setup the project manually, please continue reading.

    +

    First Extension#

    +

    In this topic, you'll learn the basics of building extensions by creating an extension that adds a "Hello World" page to a cluster menu.

    +

    Install the Extension#

    +

    To install the extension, clone the Lens Extension samples repository to your local machine:

    +
    git clone https://github.com/lensapp/lens-extension-samples.git
+
    +

    Next you need to create a symlink. A symlink connects the directory that Lens will monitor for user-installed extensions to the sample extension. In this case the sample extension is helloworld-sample.

    +

    Linux & macOS#

    +
    mkdir -p ~/.k8slens/extensions
+cd ~/.k8slens/extensions
+ln -s lens-extension-samples/helloworld-sample helloworld-sample
+
    +

    Windows#

    +

    Create the directory that Lens will monitor for user-installed extensions:

    +
    mkdir C:\Users\<user>\.k8slens\extensions -force
+cd C:\Users\<user>\.k8slens\extensions
+
    +

    If you have administrator rights, you can create symlink to the sample extension – in this case helloworld-sample:

    +
    cmd /c mklink /D helloworld-sample lens-extension-samples\helloworld-sample
+
    +

    Without administrator rights, you need to copy the extensions sample directory into C:\Users\<user>\.k8slens\extensions:

    +
    Copy-Item 'lens-extension-samples\helloworld-sample' 'C:\Users\<user>\.k8slens\extensions\helloworld-sample'
+
    +

    Build the Extension#

    +

    To build the extension you can use make or run the npm commands manually:

    +
    cd <lens-extension-samples directory>/helloworld-sample
+make build
+
    +

    To run the npm commands, enter:

    +
    cd <lens-extension-samples directory>/helloworld-sample
+npm install
+npm run build
+
    +

    Optionally, automatically rebuild the extension by watching for changes to the source code. To do so, enter:

    +
    cd <lens-extension-samples directory>/helloworld-sample
+npm run dev
+
    +

    You must restart Lens for the extension to load. After this initial restart, reload Lens and it will automatically pick up changes any time the extension rebuilds.

    +

    With Lens running, either connect to an existing cluster or create a new one. You will see the "Hello World" page in the left-side cluster menu.

    +

    Develop the Extension#

    +

    Finally, you'll make a change to the message that our Hello World sample extension displays:

    +
      +
    1. Navigate to <lens-extension-samples directory>/helloworld-sample.
      2. +
    2. In page.tsx, change the message from HelloWorld! to Hello Lens Extensions.
      3. +
    3. Rebuild the extension. If you used npm run dev, the extension will rebuild automatically.
      4. +
    4. Reload the Lens window.
      5. +
    5. Click on the Hello World page.
      6. +
    6. The updated message will appear.
      7. +
    +

    Next Steps#

    +

    In the next topic, we'll take a closer look at the source code of our Hello World sample.

    +

    You can find the source code for this tutorial at: lensapp/lens-extension-samples. Extension Guides contains additional samples.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/guides/anatomy/index.html b/v4.0.1/extensions/guides/anatomy/index.html new file mode 100644 index 0000000000..1c0aa7320e --- /dev/null +++ b/v4.0.1/extensions/guides/anatomy/index.html @@ -0,0 +1,913 @@ + + + + + + + + + + + + + + + + + + + + + + Anatomy - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Anatomy

    + +
    +

    WIP#

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/guides/components/index.html b/v4.0.1/extensions/guides/components/index.html new file mode 100644 index 0000000000..b32d1c7e23 --- /dev/null +++ b/v4.0.1/extensions/guides/components/index.html @@ -0,0 +1,913 @@ + + + + + + + + + + + + + + + + + + + + + + Components - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Components

    + +
    +

    WIP#

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/guides/generator/index.html b/v4.0.1/extensions/guides/generator/index.html new file mode 100644 index 0000000000..3f6e14c04f --- /dev/null +++ b/v4.0.1/extensions/guides/generator/index.html @@ -0,0 +1,1060 @@ + + + + + + + + + + + + + + + + + + + + + + Generator - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    New Extension Project with Generator#

    +

    The Lens Extension Generator scaffolds a project ready for development. Install Yeoman and Lens Extension Generator with:

    +
    npm install -g yo generator-lens-ext
+
    +

    Run the generator and fill out a few fields for a TypeScript project:

    +
    yo lens-ext
+# ? What type of extension do you want to create? New Extension (TypeScript)
+# ? What's the name of your extension? my-first-lens-ext
+# ? What's the description of your extension? My hello world extension
+# ? What's your extension's publisher name? @my-org/my-first-lens-ext
+# ? Initialize a git repository? Yes
+# ? Install dependencies after initialization? Yes
+# ? Which package manager to use? yarn
+# ? symlink created extension folder to ~/.k8slens/extensions (mac/linux) or :User
+s\<user>\.k8slens\extensions (windows)? Yes
+
    +

    Start webpack, which watches the my-first-lens-ext folder.

    +
    cd my-first-lens-ext
+npm start # start the webpack server in watch mode
+
    +

    Then, open Lens, you should see a Hello World item in the menu:

    +

    Hello World

    +

    Developing the Extension#

    +

    Try to change my-first-lens-ext/renderer.tsx to "Hello Lens!":

    +
    clusterPageMenus = [
+    {
+        target: { pageId: "hello" },
+        title: "Hello Lens",
+        components: {
+            Icon: ExampleIcon,
+        }
+    }
+]
+
    +

    Then, Reload Lens by CMD+R (Mac) / Ctrl+R (Linux/Windows), you should see the menu item text changes:

    +

    Hello World

    +

    Debugging the Extension#

    +

    Testing

    +

    Next steps#

    +

    You can take a closer look at Common Capabilities of extension, how to style the extension. Or the Extension Anatomy.

    +

    You are welcome to raise an issue for Lens Extension Generator, if you find problems, or have feature requests.

    +

    The source code of the generator is hosted at Github

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/guides/images/certificates-crd-list.png b/v4.0.1/extensions/guides/images/certificates-crd-list.png new file mode 100644 index 0000000000..19c9558f71 Binary files /dev/null and b/v4.0.1/extensions/guides/images/certificates-crd-list.png differ diff --git a/v4.0.1/extensions/guides/images/hello-lens.png b/v4.0.1/extensions/guides/images/hello-lens.png new file mode 100644 index 0000000000..5e2c0ac0a5 Binary files /dev/null and b/v4.0.1/extensions/guides/images/hello-lens.png differ diff --git a/v4.0.1/extensions/guides/images/hello-world.png b/v4.0.1/extensions/guides/images/hello-world.png new file mode 100644 index 0000000000..1a4a9c73a9 Binary files /dev/null and b/v4.0.1/extensions/guides/images/hello-world.png differ diff --git a/v4.0.1/extensions/guides/images/kubeobjectdetailitem.png b/v4.0.1/extensions/guides/images/kubeobjectdetailitem.png new file mode 100644 index 0000000000..e2d68f0c3b Binary files /dev/null and b/v4.0.1/extensions/guides/images/kubeobjectdetailitem.png differ diff --git a/v4.0.1/extensions/guides/images/kubeobjectdetailitemwithpods.png b/v4.0.1/extensions/guides/images/kubeobjectdetailitemwithpods.png new file mode 100644 index 0000000000..9a91f230f3 Binary files /dev/null and b/v4.0.1/extensions/guides/images/kubeobjectdetailitemwithpods.png differ diff --git a/v4.0.1/extensions/guides/images/kubeobjectmenuitem.png b/v4.0.1/extensions/guides/images/kubeobjectmenuitem.png new file mode 100644 index 0000000000..f9f91675de Binary files /dev/null and b/v4.0.1/extensions/guides/images/kubeobjectmenuitem.png differ diff --git a/v4.0.1/extensions/guides/images/kubeobjectmenuitemdetail.png b/v4.0.1/extensions/guides/images/kubeobjectmenuitemdetail.png new file mode 100644 index 0000000000..ab5f9ac0f0 Binary files /dev/null and b/v4.0.1/extensions/guides/images/kubeobjectmenuitemdetail.png differ diff --git a/v4.0.1/extensions/guides/index.html b/v4.0.1/extensions/guides/index.html new file mode 100644 index 0000000000..f9e158edd8 --- /dev/null +++ b/v4.0.1/extensions/guides/index.html @@ -0,0 +1,1088 @@ + + + + + + + + + + + + + + + + + + + + + + Overview - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Extension Guides#

    +

    The basics of the Lens Extension API are covered in Your First Extension. In this section detailed code guides and samples are used to explain how to use specific Lens Extension APIs.

    +

    Each guide or sample will include:

    +
      +
    • Clearly commented source code.
      • +
    • Instructions for running the sample extension.
      • +
    • Image of the sample extension's appearance and usage.
      • +
    • Listing of Extension API being used.
      • +
    • Explanation of Extension API concepts.
      • +
    +

    Guides#

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    GuideAPIs
    Generate new extension project
    Main process extensionLensMainExtension
    Renderer process extensionLensRendererExtension
    Stores
    Components
    KubeObjectListLayout
    Working with mobx
    +

    Samples#

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    SampleAPIs
    helloworldLensMainExtension
    LensRendererExtension
    Component.Icon
    Component.IconProps
    minikubeLensMainExtension
    Store.clusterStore
    Store.workspaceStore
    styling-css-modules-sampleLensMainExtension
    LensRendererExtension
    Component.Icon
    Component.IconProps
    styling-emotion-sampleLensMainExtension
    LensRendererExtension
    Component.Icon
    Component.IconProps
    styling-sass-sampleLensMainExtension
    LensRendererExtension
    Component.Icon
    Component.IconProps
    custom-resource-pageLensRendererExtension
    K8sApi.KubeApi
    K8sApi.KubeObjectStore
    Component.KubeObjectListLayout
    Component.KubeObjectDetailsProps
    Component.IconProps
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/guides/kube-object-list-layout/index.html b/v4.0.1/extensions/guides/kube-object-list-layout/index.html new file mode 100644 index 0000000000..e0735a16c7 --- /dev/null +++ b/v4.0.1/extensions/guides/kube-object-list-layout/index.html @@ -0,0 +1,1174 @@ + + + + + + + + + + + + + + + + + + + + + + KubeObjectListLayout Sample - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    KubeObjectListLayout Sample#

    +

    In this guide we will learn how to list Kubernetes CRD objects on the cluster dashboard. You can see the complete source code for this guide here.

    +

    +

    Next, we will go the implementation through in steps. To achieve our goal, we need to:

    +
      +
    1. Register ClustePage and ClusterPageMenu objects
      2. +
    2. List Certificate Objects on the Cluster Page
      3. +
    3. Customize Details Panel
      4. +
    +

    Register clusterPage and clusterPageMenu Objects#

    +

    First thing we need to do with our extension is to register new menu item in the cluster menu and create a cluster page that is opened when clicking the menu item. We will do this in our extension class CrdSampleExtension that is derived LensRendererExtension class:

    +
    export default class CrdSampleExtension extends LensRendererExtension {
+}
+
    +

    To register menu item in the cluster menu we need to register PageMenuRegistration object. This object will register a menu item with "Certificates" text. It will also use CertificateIcon component to render an icon and navigate to cluster page that is having certificates page id.

    +
    export function CertificateIcon(props: Component.IconProps) {
+  return <Component.Icon {...props} material="security" tooltip="Certificates"/>
+}
+
+export default class CrdSampleExtension extends LensRendererExtension {
+
+  clusterPageMenus = [
+    {
+      target: { pageId: "certificates" },
+      title: "Certificates",
+      components: {
+        Icon: CertificateIcon,
+      }
+    },
+  ]
+}
+
    +

    Then we need to register PageRegistration object with certificates id and define CertificatePage component to render certificates.

    +
    export default class CrdSampleExtension extends LensRendererExtension {
+  ...
+
+  clusterPages = [{
+    id: "certificates",
+    components: {
+      Page: () => <CertificatePage extension={this} />,
+      MenuIcon: CertificateIcon,
+    }
+  }]
+}
+
    +

    List Certificate Objects on the Cluster Page#

    +

    In the previous step we defined CertificatePage component to render certificates. In this step we will actually implement that. CertificatePage is a React component that will render Component.KubeObjectListLayout component to list Certificate CRD objects.

    +

    Get CRD objects#

    +

    In order to list CRD objects, we need first fetch those from Kubernetes API. Lens Extensions API provides easy mechanism to do this. We just need to define Certificate class derived from K8sApi.KubeObject, CertificatesApiderived from K8sApi.KubeApi and CertificatesStore derived from K8sApi.KubeObjectStore.

    +

    Certificate class defines properties found in the CRD object:

    +
    export class Certificate extends K8sApi.KubeObject {
+  static kind = "Certificate"
+  static namespaced = true
+  static apiBase = "/apis/cert-manager.io/v1alpha2/certificates"
+
+  kind: string
+  apiVersion: string
+  metadata: {
+    name: string;
+    namespace: string;
+    selfLink: string;
+    uid: string;
+    resourceVersion: string;
+    creationTimestamp: string;
+    labels: {
+      [key: string]: string;
+    };
+    annotations: {
+      [key: string]: string;
+    };
+  }
+  spec: {
+    dnsNames: string[];
+    issuerRef: {
+      group: string;
+      kind: string;
+      name: string;
+    }
+    secretName: string
+  }
+  status: {
+    conditions: {
+      lastTransitionTime: string;
+      message: string;
+      reason: string;
+      status: string;
+      type?: string;
+    }[];
+  }
+}
+
    +

    With CertificatesApi class we are able to manage Certificate objects in Kubernetes API:

    +
    export class CertificatesApi extends K8sApi.KubeApi<Certificate> {
+}
+export const certificatesApi = new CertificatesApi({
+  objectConstructor: Certificate
+});
+
    +

    CertificateStore defines storage for Certificate objects

    +
    export class CertificatesStore extends K8sApi.KubeObjectStore<Certificate> {
+  api = certificatesApi
+}
+
+export const certificatesStore = new CertificatesStore();
+
    +

    And, finally, we register this store to Lens's API manager.

    +
    K8sApi.apiManager.registerStore(certificatesStore);
+
    +

    Create CertificatePage component#

    +

    Now we have created mechanism to manage Certificate objects in Kubernetes API. Then we need to fetch those and render them in the UI.

    +

    First we define CertificatePage class that extends React.Component.

    +
    import { Component, LensRendererExtension } from "@k8slens/extensions";
+import React from "react";
+import { certificatesStore } from "../certificate-store";
+import { Certificate } from "../certificate"
+
+export class CertificatePage extends React.Component<{ extension: LensRendererExtension }> {
+
+}
+
    +

    Next we will implement render method that will display certificates in a list. To do that, we just need to add Component.KubeObjectListLayout component inside Component.TabLayout component in render method. To define which objects the list is showing, we need to pass certificateStore object to Component.KubeObjectListLayout in store property. Component.KubeObjectListLayout will fetch automacially items from the given store when component is mounted. Also, we can define needed sorting callbacks and search filters for the list:

    +
    enum sortBy {
+  name = "name",
+  namespace = "namespace",
+  issuer = "issuer"
+}
+
+export class CertificatePage extends React.Component<{ extension: LensRendererExtension }> {
+  // ...
+
+  render() {
+    return (
+      <Component.TabLayout>
+        <Component.KubeObjectListLayout
+          className="Certicates" store={certificatesStore}
+          sortingCallbacks={{
+            [sortBy.name]: (certificate: Certificate) => certificate.getName(),
+            [sortBy.namespace]: (certificate: Certificate) => certificate.metadata.namespace,
+            [sortBy.issuer]: (certificate: Certificate) => certificate.spec.issuerRef.name
+          }}
+          searchFilters={[
+            (certificate: Certificate) => certificate.getSearchFields()
+          ]}
+          renderHeaderTitle="Certificates"
+          renderTableHeader={[
+            { title: "Name", className: "name", sortBy: sortBy.name },
+            { title: "Namespace", className: "namespace", sortBy: sortBy.namespace },
+            { title: "Issuer", className: "issuer", sortBy: sortBy.namespace },
+          ]}
+          renderTableContents={(certificate: Certificate) => [
+            certificate.getName(),
+            certificate.metadata.namespace,
+            certificate.spec.issuerRef.name
+          ]}
+        />
+      </Component.TabLayout>
+    )
+  }
+}
+
    +

    Customize Details panel#

    +

    We have learned now, how to list CRD objects in a list view. Next, we will learn how to customize details panel that will be opened when the object is clicked in the list.

    +

    First, we need to register our custom component to render details for the specific Kubernetes custom resource, in our case Certificate. We will do this again in CrdSampleExtension class:

    +
    export default class CrdSampleExtension extends LensRendererExtension {
+  //...
+
+  kubeObjectDetailItems = [{
+    kind: Certificate.kind,
+    apiVersions: ["cert-manager.io/v1alpha2"],
+    components: {
+      Details: (props: CertificateDetailsProps) => <CertificateDetails {...props} />
+    }
+  }]
+}
+
    +

    Here we defined that CertificateDetails component will render the resource details. So, next we need to implement that component. Lens will inject Certificate object into our component so we just need to render some information out of it. We can use Component.DrawerItem component from Lens Extensions API to give the same look and feel as Lens is using elsewhere:

    +
    import { Component, K8sApi } from "@k8slens/extensions";
+import React from "react";
+import { Certificate } from "../certificate";
+
+export interface CertificateDetailsProps extends Component.KubeObjectDetailsProps<Certificate>{
+}
+
+export class CertificateDetails extends React.Component<CertificateDetailsProps> {
+
+  render() {
+    const { object: certificate } = this.props;
+    if (!certificate) return null;
+    return (
+      <div className="Certificate">
+        <Component.DrawerItem name="Created">
+          {certificate.getAge(true, false)} ago ({certificate.metadata.creationTimestamp })
+        </Component.DrawerItem>
+        <Component.DrawerItem name="DNS Names">
+          {certificate.spec.dnsNames.join(",")}
+        </Component.DrawerItem>
+        <Component.DrawerItem name="Secret">
+          {certificate.spec.secretName}
+        </Component.DrawerItem>
+        <Component.DrawerItem name="Status" className="status" labelsOnly>
+          {certificate.status.conditions.map((condition, index) => {
+            const { type, reason, message, status } = condition;
+            const kind = type || reason;
+            if (!kind) return null;
+            return (
+              <Component.Badge
+                key={kind + index} label={kind}
+                className={"success "+kind.toLowerCase()}
+                tooltip={message}
+              />
+            );
+          })}
+        </Component.DrawerItem>
+      </div>
+    )
+  }
+}
+
    +

    Summary#

    +

    Like we can see above, it's very easy to add custom pages and fetch Kubernetes resources by using Extensions API. Please see the complete source code to test it out.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/guides/main-extension/index.html b/v4.0.1/extensions/guides/main-extension/index.html new file mode 100644 index 0000000000..d2eb020e0b --- /dev/null +++ b/v4.0.1/extensions/guides/main-extension/index.html @@ -0,0 +1,1077 @@ + + + + + + + + + + + + + + + + + + + + + + Main Extension - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Main Extension#

    +

    The main extension api is the interface to Lens' main process (Lens runs in main and renderer processes). It allows you to access, configure, and customize Lens data, add custom application menu items, and generally run custom code in Lens' main process.

    +

    LensMainExtension Class#

    +

    To create a main extension simply extend the LensMainExtension class:

    +
    import { LensMainExtension } from "@k8slens/extensions";
+
+export default class ExampleExtensionMain extends LensMainExtension {
+  onActivate() {
+    console.log('custom main process extension code started');
+  }
+
+  onDeactivate() {
+    console.log('custom main process extension de-activated');
+  }
+}
+
    +

    There are two methods that you can implement to facilitate running your custom code. onActivate() is called when your extension has been successfully enabled. By implementing onActivate() you can initiate your custom code. onDeactivate() is called when the extension is disabled (typically from the Lens Extensions Page) and when implemented gives you a chance to clean up after your extension, if necessary. The example above simply logs messages when the extension is enabled and disabled. Note that to see standard output from the main process there must be a console connected to it. This is typically achieved by starting Lens from the command prompt.

    +

    The following example is a little more interesting in that it accesses some Lens state data and periodically logs the name of the currently active cluster in Lens.

    +
    import { LensMainExtension, Store } from "@k8slens/extensions";
+
+const clusterStore = Store.clusterStore
+
+export default class ActiveClusterExtensionMain extends LensMainExtension {
+
+  timer: NodeJS.Timeout
+
+  onActivate() {
+    console.log("Cluster logger activated");
+    this.timer = setInterval(() => {
+      if (!clusterStore.active) {
+        console.log("No active cluster");
+        return;
+      }
+      console.log("active cluster is", clusterStore.active.contextName)
+    }, 5000)
+  }
+
+  onDeactivate() {
+      clearInterval(this.timer)
+      console.log("Cluster logger deactivated");
+  }
+}
+
    +

    See the Stores guide for more details on accessing Lens state data.

    +

    appMenus#

    +

    The only UI feature customizable in the main extension api is the application menu. Custom menu items can be inserted and linked to custom functionality, such as navigating to a specific page. The following example demonstrates adding a menu item to the Help menu.

    +
    import { LensMainExtension } from "@k8slens/extensions";
+
+export default class SamplePageMainExtension extends LensMainExtension {
+  appMenus = [
+    {
+      parentId: "help",
+      label: "Sample",
+      click() {
+        console.log("Sample clicked");
+      }
+    }
+  ]
+}
+
    +

    appMenus is an array of objects satisfying the MenuRegistration interface. MenuRegistration extends React's MenuItemConstructorOptions interface. parentId is the id of the menu to put this menu item under (todo: is this case sensitive and how do we know what the available ids are?), label is the text to show on the menu item, and click() is called when the menu item is selected. In this example we simply log a message, but typically you would navigate to a specific page or perform some operation. Pages are associated with the LensRendererExtension class and can be defined when you extend it.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/guides/renderer-extension/index.html b/v4.0.1/extensions/guides/renderer-extension/index.html new file mode 100644 index 0000000000..fdb605a5a9 --- /dev/null +++ b/v4.0.1/extensions/guides/renderer-extension/index.html @@ -0,0 +1,1822 @@ + + + + + + + + + + + + + + + + + + + + + + Renderer Extension - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Renderer Extension#

    +

    The renderer extension api is the interface to Lens's renderer process (Lens runs in main and renderer processes). +It allows you to access, configure, and customize Lens data, add custom Lens UI elements, and generally run custom code in Lens's renderer process. +The custom Lens UI elements that can be added include global pages, cluster pages, cluster page menus, cluster features, app preferences, status bar items, KubeObject menu items, and KubeObject details items. +These UI elements are based on React components.

    +

    LensRendererExtension Class#

    +

    To create a renderer extension simply extend the LensRendererExtension class:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
+
+export default class ExampleExtensionMain extends LensRendererExtension {
+  onActivate() {
+    console.log('custom renderer process extension code started');
+  }
+
+  onDeactivate() {
+    console.log('custom renderer process extension de-activated');
+  }
+}
+
    +

    There are two methods that you can implement to facilitate running your custom code. +onActivate() is called when your extension has been successfully enabled. +By implementing onActivate() you can initiate your custom code. +onDeactivate() is called when the extension is disabled (typically from the Lens Extensions Page) and when implemented gives you a chance to clean up after your extension, if necessary. +The example above simply logs messages when the extension is enabled and disabled.

    +

    clusterPages#

    +

    Cluster pages appear as part of the cluster dashboard. +They are accessible from the side bar, and are shown in the menu list after Custom Resources. +It is conventional to use a cluster page to show information or provide functionality pertaining to the active cluster, along with custom data and functionality your extension may have. +However, it is not limited to the active cluster. +Also, your extension can gain access to the Kubernetes resources in the active cluster in a straightforward manner using the clusterStore.

    +

    The following example adds a cluster page definition to a LensRendererExtension subclass:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
+import { ExampleIcon, ExamplePage } from "./page"
+import React from "react"
+
+export default class ExampleExtension extends LensRendererExtension {
+  clusterPages = [
+    {
+      id: "hello",
+      components: {
+        Page: () => <ExamplePage extension={this}/>,
+      }
+    }
+  ];
+}
+
    +

    Cluster pages are objects matching the PageRegistration interface. +The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. +The 'id' field can also convey route path details, such as variable parameters provided to a page (See example below). +The components field matches the PageComponents interface for wich there is one field, Page. +Page is of type React.ComponentType<any>, which gives you great flexibility in defining the appearance and behaviour of your page. +For the example above ExamplePage can be defined in page.tsx:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
+import React from "react"
+
+export class ExamplePage extends React.Component<{ extension: LensRendererExtension }> {
+  render() {
+    return (
+      <div>
+        <p>Hello world!</p>
+      </div>
+    )
+  }
+}
+
    +

    Note that the ExamplePage class defines a property named extension. +This allows the ExampleExtension object to be passed in React-style in the cluster page definition, so that ExamplePage can access any ExampleExtension subclass data.

    +

    clusterPageMenus#

    +

    The above example code shows how to create a cluster page but not how to make it available to the Lens user. +Cluster pages are typically made available through a menu item in the cluster dashboard sidebar. +Expanding on the above example a cluster page menu is added to the ExampleExtension definition:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
+import { ExampleIcon, ExamplePage } from "./page"
+import React from "react"
+
+export default class ExampleExtension extends LensRendererExtension {
+  clusterPages = [
+    {
+      id: "hello",
+      components: {
+        Page: () => <ExamplePage extension={this}/>,
+      }
+    }
+  ];
+
+  clusterPageMenus = [
+    {
+      target: { pageId: "hello" },
+      title: "Hello World",
+      components: {
+        Icon: ExampleIcon,
+      }
+    },
+  ];
+}
+
    +

    Cluster page menus are objects matching the ClusterPageMenuRegistration interface. +They define the appearance of the cluster page menu item in the cluster dashboard sidebar and the behaviour when the cluster page menu item is activated (typically by a mouse click). +The example above uses the target field to set the behaviour as a link to the cluster page with id of "hello". +This is done by setting target's pageId field to "hello". +The cluster page menu item's appearance is defined by setting the title field to the text that is to be displayed in the cluster dashboard sidebar. +The components field is used to set an icon that appears to the left of the title text in the sidebar. +Thus when the "Hello World" menu item is activated the cluster dashboard will show the contents of ExamplePage. +This example requires the definition of another React-based component, ExampleIcon, which has been added to page.tsx:

    +
    import { LensRendererExtension, Component } from "@k8slens/extensions";
+import React from "react"
+
+export function ExampleIcon(props: Component.IconProps) {
+  return <Component.Icon {...props} material="pages" tooltip={"Hi!"}/>
+}
+
+export class ExamplePage extends React.Component<{ extension: LensRendererExtension }> {
+  render() {
+    return (
+      <div>
+        <p>Hello world!</p>
+      </div>
+    )
+  }
+}
+
    +

    ExampleIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon. +Built in are the Material Design icons. +One can be selected by name via the material field. +ExampleIcon also sets a tooltip, shown when the Lens user hovers over the icon with a mouse, by setting the tooltip field.

    +

    A cluster page menu can also be used to define a foldout submenu in the cluster dashboard sidebar. +This enables the grouping of cluster pages. +The following example shows how to specify a submenu having two menu items:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
+import { ExampleIcon, ExamplePage } from "./page"
+import React from "react"
+
+export default class ExampleExtension extends LensRendererExtension {
+  clusterPages = [
+    {
+      id: "hello",
+      components: {
+        Page: () => <ExamplePage extension={this}/>,
+      }
+    },
+    {
+      id: "bonjour",
+      components: {
+        Page: () => <ExemplePage extension={this}/>,
+      }
+    }
+  ];
+
+  clusterPageMenus = [
+    {
+      id: "example",
+      title: "Greetings",
+      components: {
+        Icon: ExampleIcon,
+      }
+    },
+    {
+      parentId: "example",
+      target: { pageId: "hello" },
+      title: "Hello World",
+      components: {
+        Icon: ExampleIcon,
+      }
+    },
+    {
+      parentId: "example",
+      target: { pageId: "bonjour" },
+      title: "Bonjour le monde",
+      components: {
+        Icon: ExempleIcon,
+      }
+    }
+  ];
+}
+
    +

    The above defines two cluster pages and three cluster page menu objects. +The cluster page definitons are straightforward. +The first cluster page menu object defines the parent of a foldout submenu. +Setting the id field in a cluster page menu definition implies that it is defining a foldout submenu. +Also note that the target field is not specified (it is ignored if the id field is specified). +This cluster page menu object specifies the title and components fields, which are used in displaying the menu item in the cluster dashboard sidebar. +Initially the submenu is hidden. +Activating this menu item toggles on and off the appearance of the submenu below it. +The remaining two cluster page menu objects define the contents of the submenu. +A cluster page menu object is defined to be a submenu item by setting the parentId field to the id of the parent of a foldout submenu, "example" in this case

    +

    globalPages#

    +

    Global pages appear independently of the cluster dashboard and they fill the Lens UI space. +A global page is typically triggered from the cluster menu using a global page menu. +They can also be triggered by a custom app menu selection from a Main Extension or a custom status bar item. +Global pages can appear even when there is no active cluster, unlike cluster pages. +It is conventional to use a global page to show information and provide functionality relevant across clusters, along with custom data and functionality that your extension may have.

    +

    The following example defines a LensRendererExtension subclass with a single global page definition:

    +
    import { LensRendererExtension } from '@k8slens/extensions';
+import { HelpPage } from './page';
+import React from 'react';
+
+export default class HelpExtension extends LensRendererExtension {
+  globalPages = [
+    {
+      id: "help",
+      components: {
+        Page: () => <HelpPage extension={this}/>,
+      }
+    }
+  ];
+}
+
    +

    Global pages are objects matching the PageRegistration interface. +The id field identifies the page, and at its simplest is just a string identifier, as shown in the example above. +The 'id' field can also convey route path details, such as variable parameters provided to a page (See example below). +The components field matches the PageComponents interface for which there is one field, Page. +Page is of type React.ComponentType<any>, which gives you great flexibility in defining the appearance and behaviour of your page. +For the example above HelpPage can be defined in page.tsx:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
+import React from "react"
+
+export class HelpPage extends React.Component<{ extension: LensRendererExtension }> {
+  render() {
+    return (
+      <div>
+        <p>Help yourself</p>
+      </div>
+    )
+  }
+}
+
    +

    Note that the HelpPage class defines a property named extension. +This allows the HelpExtension object to be passed in React-style in the global page definition, so that HelpPage can access any HelpExtension subclass data.

    +

    This example code shows how to create a global page but not how to make it available to the Lens user. +Global pages are typically made available through a number of ways. +Menu items can be added to the Lens app menu system and set to open a global page when activated (See appMenus in the Main Extension guide). +Interactive elements can be placed on the status bar (the blue strip along the bottom of the Lens UI) and can be configured to link to a global page when activated (See statusBarItems). +As well, global pages can be made accessible from the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. +Global page menu icons that are defined using globalPageMenus appear below the Add Cluster icon.

    +

    globalPageMenus#

    +

    Global page menus connect a global page to the cluster menu, which is the vertical strip along the left side of the Lens UI showing the available cluster icons, and the Add Cluster icon. +Expanding on the example from globalPages a global page menu is added to the HelpExtension definition:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
+import { HelpIcon, HelpPage } from "./page"
+import React from "react"
+
+export default class HelpExtension extends LensRendererExtension {
+  globalPages = [
+    {
+      id: "help",
+      components: {
+        Page: () => <HelpPage extension={this}/>,
+      }
+    }
+  ];
+
+  globalPageMenus = [
+    {
+      target: { pageId: "help" },
+      title: "Help",
+      components: {
+        Icon: HelpIcon,
+      }
+    },
+  ];
+}
+
    +

    Global page menus are objects matching the PageMenuRegistration interface. +They define the appearance of the global page menu item in the cluster menu and the behaviour when the global page menu item is activated (typically by a mouse click). +The example above uses the target field to set the behaviour as a link to the global page with id of "help". +This is done by setting target's pageId field to "help". +The global page menu item's appearance is defined by setting the title field to the text that is to be displayed as a tooltip in the cluster menu. +The components field is used to set an icon that appears in the cluster menu. +Thus when the "Help" icon is activated the contents of ExamplePage will be shown. +This example requires the definition of another React-based component, HelpIcon, which has been added to page.tsx:

    +
    import { LensRendererExtension, Component } from "@k8slens/extensions";
+import React from "react"
+
+export function HelpIcon(props: Component.IconProps) {
+  return <Component.Icon {...props} material="help"/>
+}
+
+export class HelpPage extends React.Component<{ extension: LensRendererExtension }> {
+  render() {
+    return (
+      <div>
+        <p>Help</p>
+      </div>
+    )
+  }
+}
+
    +

    HelpIcon introduces one of Lens's built-in components available to extension developers, the Component.Icon. +Built in are the Material Design icons. +One can be selected by name via the material field.

    +

    clusterFeatures#

    +

    Cluster features are Kubernetes resources that can be applied to and managed within the active cluster. +They can be installed/uninstalled by the Lens user from the cluster settings page.

    +

    The following example shows how to add a cluster feature as part of a LensRendererExtension:

    +

    import { LensRendererExtension } from "@k8slens/extensions"
+import { ExampleFeature } from "./src/example-feature"
+import React from "react"
+
+export default class ExampleFeatureExtension extends LensRendererExtension {
+  clusterFeatures = [
+    {
+      title: "Example Feature",
+      components: {
+        Description: () => {
+          return (
+            <span>
+                Enable an example feature.
+            </span>
+          )
+        }
+      },
+      feature: new ExampleFeature()
+    }
+  ];
+}
+
    +The title and components.Description fields provide content that appears on the cluster settings page, in the Features section. +The feature field must specify an instance which extends the abstract class ClusterFeature.Feature, and specifically implement the following methods:

    +
      abstract install(cluster: Cluster): Promise<void>;
+  abstract upgrade(cluster: Cluster): Promise<void>;
+  abstract uninstall(cluster: Cluster): Promise<void>;
+  abstract updateStatus(cluster: Cluster): Promise<ClusterFeatureStatus>;
+
    +

    The install() method is typically called by Lens when a user has indicated that this feature is to be installed (i.e. clicked Install for the feature on the cluster settings page). +The implementation of this method should install kubernetes resources using the applyResources() method, or by directly accessing the kubernetes api (K8sApi).

    +

    The upgrade() method is typically called by Lens when a user has indicated that this feature is to be upgraded (i.e. clicked Upgrade for the feature on the cluster settings page). +The implementation of this method should upgrade the kubernetes resources already installed, if relevant to the feature.

    +

    The uninstall() method is typically called by Lens when a user has indicated that this feature is to be uninstalled (i.e. clicked Uninstall for the feature on the cluster settings page). +The implementation of this method should uninstall kubernetes resources using the kubernetes api (K8sApi)

    +

    The updateStatus() 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 in the status field of the ClusterFeature.Feature parent class. +The status.currentVersion and status.latestVersion fields may be displayed by Lens in describing the feature. +The status.installed field should be set to true if the feature is currently installed, otherwise false. +Also, Lens relies on the status.canUpgrade field to determine if the feature can be upgraded (i.e a new version could be available) so the implementation should set the status.canUpgrade field according to specific rules for the feature, if relevant.

    +

    The following shows a very simple implementation of a ClusterFeature:

    +
    import { ClusterFeature, Store, K8sApi } from "@k8slens/extensions";
+import * as path from "path";
+
+export class ExampleFeature extends ClusterFeature.Feature {
+
+  async install(cluster: Store.Cluster): Promise<void> {
+
+    super.applyResources(cluster, path.join(__dirname, "../resources/"));
+  }
+
+  async upgrade(cluster: Store.Cluster): Promise<void> {
+    return this.install(cluster);
+  }
+
+  async updateStatus(cluster: Store.Cluster): Promise<ClusterFeature.FeatureStatus> {
+    try {
+      const pod = K8sApi.forCluster(cluster, K8sApi.Pod);
+      const examplePod = await pod.get({name: "example-pod", namespace: "default"});
+      if (examplePod?.kind) {
+        this.status.installed = true;
+        this.status.currentVersion = examplePod.spec.containers[0].image.split(":")[1];
+        this.status.canUpgrade = true;  // a real implementation would perform a check here that is relevant to the specific feature
+      } else {
+        this.status.installed = false;
+        this.status.canUpgrade = false;
+      }
+    } catch(e) {
+      if (e?.error?.code === 404) {
+        this.status.installed = false;
+        this.status.canUpgrade = false;
+      }
+    }
+
+    return this.status;
+  }
+
+  async uninstall(cluster: Store.Cluster): Promise<void> {
+    const podApi = K8sApi.forCluster(cluster, K8sApi.Pod);
+    await podApi.delete({name: "example-pod", namespace: "default"});
+  }
+}
+
    +

    This example implements the install() method by simply invoking the helper applyResources() method. +applyResources() tries to apply all resources read from all files found in the folder path provided. +In this case this folder path is the ../resources subfolder relative to current source code's folder. +The file ../resources/example-pod.yml could contain:

    +
    apiVersion: v1
+kind: Pod
+metadata:
+  name: example-pod
+spec:
+  containers:
+  - name: example-pod
+    image: nginx
+
    +

    The upgrade() method in the example above is implemented by simply invoking the install() method. +Depending on the feature to be supported by an extension, upgrading may require additional and/or different steps.

    +

    The uninstall() method is implemented in the example above by utilizing the K8sApi provided by Lens to simply delete the example-pod pod applied by the install() method.

    +

    The updateStatus() method is implemented above by using the K8sApi as well, this time to get information from the example-pod pod, in particular to determine if it is installed, what version is associated with it, and if it can be upgraded. +How the status is updated for a specific cluster feature is up to the implementation.

    +

    appPreferences#

    +

    The Preferences page is a built-in global page. +Extensions can add custom preferences to the Preferences page, thus providing a single location for users to configure global options, for Lens and extensions alike. +The following example demonstrates adding a custom preference:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
+import { ExamplePreferenceHint, ExamplePreferenceInput } from "./src/example-preference";
+import { observable } from "mobx";
+import React from "react";
+
+export default class ExampleRendererExtension extends LensRendererExtension {
+
+  @observable preference = { enabled: false };
+
+  appPreferences = [
+    {
+      title: "Example Preferences",
+      components: {
+        Input: () => <ExamplePreferenceInput preference={this.preference}/>,
+        Hint: () => <ExamplePreferenceHint/>
+      }
+    }
+  ];
+}
+
    +

    App preferences are objects matching the AppPreferenceRegistration interface. +The title field specifies the text to show as the heading on the Preferences page. +The components field specifies two React.Component objects defining the interface for the preference. +Input should specify an interactive input element for your preference and Hint should provide descriptive information for the preference, which is shown below the Input element. +ExamplePreferenceInput expects its React props set to an ExamplePreferenceProps instance, which is how ExampleRendererExtension handles the state of the preference input. +ExampleRendererExtension has the field preference, which is provided to ExamplePreferenceInput when it is created. +In this example ExamplePreferenceInput, ExamplePreferenceHint, and ExamplePreferenceProps are defined in ./src/example-preference.tsx:

    +
    import { Component } from "@k8slens/extensions";
+import { observer } from "mobx-react";
+import React from "react";
+
+export class ExamplePreferenceProps {
+  preference: {
+    enabled: boolean;
+  }
+}
+
+@observer
+export class ExamplePreferenceInput extends React.Component<ExamplePreferenceProps> {
+
+  render() {
+    const { preference } = this.props;
+    return (
+      <Component.Checkbox
+        label="I understand appPreferences"
+        value={preference.enabled}
+        onChange={v => { preference.enabled = v; }}
+      />
+    );
+  }
+}
+
+export class ExamplePreferenceHint extends React.Component {
+  render() {
+    return (
+      <span>This is an example of an appPreference for extensions.</span>
+    );
+  }
+}
+
    +

    ExamplePreferenceInput implements a simple checkbox (using Lens's Component.Checkbox). +It provides label as the text to display next to the checkbox and an onChange function, which reacts to the checkbox state change. +The checkbox's value is initially set to preference.enabled. +ExamplePreferenceInput is defined with React props of ExamplePreferenceProps type, which is an object with a single field, enabled. +This is used to indicate the state of the preference, and is bound to the checkbox state in onChange. +ExamplePreferenceHint is a simple text span. +Note that the input and the hint could comprise of more sophisticated elements, according to the needs of the extension.

    +

    Note that the above example introduces decorators observable and observer from the mobx and mobx-react packages. +mobx simplifies state management and without it this example would not visually update the checkbox properly when the user activates it. +Lens uses mobx extensively for state management of its own UI elements and it is recommended that extensions rely on it too. +Alternatively, React's state management can be used, though mobx is typically simpler to use.

    +

    Also note that an extension's state data can be managed using an ExtensionStore object, which conveniently handles persistence and synchronization. +The example above defined a preference field in the ExampleRendererExtension class definition to hold the extension's state primarily to simplify the code for this guide, but it is recommended to manage your extension's state data using ExtensionStore

    +

    statusBarItems#

    +

    The Status bar is the blue strip along the bottom of the Lens UI. +Status bar items are React.ReactNode types, which can be used to convey status information, or act as a link to a global page, or even an external page.

    +

    The following example adds a status bar item definition, as well as a global page definition, to a LensRendererExtension subclass, and configures the status bar item to navigate to the global page upon activation (normally a mouse click):

    +
    import { LensRendererExtension } from '@k8slens/extensions';
+import { HelpIcon, HelpPage } from "./page"
+import React from 'react';
+
+export default class HelpExtension extends LensRendererExtension {
+  globalPages = [
+    {
+      id: "help",
+      components: {
+        Page: () => <HelpPage extension={this}/>,
+      }
+    }
+  ];
+
+  statusBarItems = [
+    {
+      item: (
+        <div
+          className="flex align-center gaps"
+          onClick={() => this.navigate("help")}
+        >
+          <HelpIcon />
+          My Status Bar Item
+        </div>
+      ),
+    },
+  ];
+}
+
    +

    The item field of a status bar item specifies the React.Component to be shown on the status bar. +By default items are added starting from the right side of the status bar. +Typically, item would specify an icon and/or a short string of text, considering the limited space on the status bar. +In the example above the HelpIcon from the globalPageMenus guide is reused. +Also, the item provides a link to the global page by setting the onClick property to a function that calls the LensRendererExtension navigate() method. +navigate() takes as a parameter the id of the global page, which is shown when navigate() is called.

    +

    kubeObjectMenuItems#

    +

    An extension can add custom menu items (including actions) for specific Kubernetes resource kinds/apiVersions. +These menu items appear under the ... for each listed resource in the cluster dashboard, and on the title bar of the details page for a specific resource:

    +

    List

    +

    Details

    +

    The following example shows how to add a menu for Namespace resources, and associate an action with it:

    +
    import React from "react"
+import { LensRendererExtension } from "@k8slens/extensions";
+import { NamespaceMenuItem } from "./src/namespace-menu-item"
+
+export default class ExampleExtension extends LensRendererExtension {
+  kubeObjectMenuItems = [
+    {
+      kind: "Namespace",
+      apiVersions: ["v1"],
+      components: {
+        MenuItem: (props: Component.KubeObjectMenuProps<K8sApi.Namespace>) => <NamespaceMenuItem {...props} />
+      }
+    }
+  ];
+}
+
    +

    Kube object menu items are objects matching the KubeObjectMenuRegistration interface. +The kind field specifies the kubernetes resource type to apply this menu item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. +This example adds a menu item for namespaces in the cluster dashboard. +The components field defines the menu item's appearance and behaviour. +The MenuItem field provides a function that returns a React.Component given a set of menu item properties. +In this example a NamespaceMenuItem object is returned. +NamespaceMenuItem is defined in ./src/namespace-menu-item.tsx:

    +
    import React from "react";
+import { Component, K8sApi, Navigation} from "@k8slens/extensions";
+
+export function NamespaceMenuItem(props: Component.KubeObjectMenuProps<K8sApi.Namespace>) {
+  const { object: namespace, toolbar } = props;
+  if (!namespace) return null;
+
+  const namespaceName = namespace.getName();
+
+  const sendToTerminal = (command: string) => {
+    Component.terminalStore.sendCommand(command, {
+      enter: true,
+      newTab: true,
+    });
+    Navigation.hideDetails();
+  };
+
+  const getPods = () => {
+    sendToTerminal(`kubectl get pods -n ${namespaceName}`);
+  };
+
+  return (
+    <Component.MenuItem onClick={getPods}>
+    <Component.Icon material="speaker_group" interactive={toolbar} title="Get pods in terminal"/>
+    <span className="title">Get Pods</span>
+    </Component.MenuItem>
+  );
+}
+
    +

    NamespaceMenuItem returns a Component.MenuItem defining the menu item's appearance (icon and text) and behaviour when activated via the onClick property. +getPods() shows how to open a terminal tab and run a command, specifically it runs kubectl to get a list of pods running in the current namespace. +See Component.terminalStore.sendCommand for more details on running terminal commands. +The name of the namespace is retrieved from props passed into NamespaceMenuItem(). +namespace is the props.object, which is of type K8sApi.Namespace. +This is the api for accessing namespaces, and the current namespace in this example is simply given by namespace.getName(). +Thus kube object menu items are afforded convenient access to the specific resource selected by the user.

    +

    kubeObjectDetailItems#

    +

    An extension can add custom details (content) for specified Kubernetes resource kinds/apiVersions. +These custom details appear on the details page for a specific resource, such as a Namespace:

    +

    Details

    +

    The following example shows how to add a tabulated list of pods to the Namespace resource details page:

    +
    import React from "react"
+import { LensRendererExtension } from "@k8slens/extensions";
+import { NamespaceDetailsItem } from "./src/namespace-details-item"
+
+export default class ExampleExtension extends LensRendererExtension {
+  kubeObjectDetailItems = [
+    {
+      kind: "Namespace",
+      apiVersions: ["v1"],
+      priority: 10,
+      components: {
+        Details: (props: Component.KubeObjectDetailsProps<K8sApi.Namespace>) => <NamespaceDetailsItem {...props} />
+      }
+    }
+  ];
+}
+
    +

    Kube object detail items are objects matching the KubeObjectDetailRegistration interface. +The kind field specifies the kubernetes resource type to apply this detail item to, and the apiVersion field specifies the kubernetes api to use in relation to this resource type. +This example adds a detail item for namespaces in the cluster dashboard. +The components field defines the detail item's appearance and behaviour. +The Details field provides a function that returns a React.Component given a set of detail item properties. +In this example a NamespaceDetailsItem object is returned. +NamespaceDetailsItem is defined in ./src/namespace-details-item.tsx:

    +
    import { Component, K8sApi } from "@k8slens/extensions";
+import { PodsDetailsList } from "./pods-details-list";
+import React from "react";
+import { observable } from "mobx";
+import { observer } from "mobx-react";
+
+@observer
+export class NamespaceDetailsItem extends React.Component<Component.KubeObjectDetailsProps<K8sApi.Namespace>> {
+
+  @observable private pods: K8sApi.Pod[];
+
+  async componentDidMount() {
+    this.pods = await K8sApi.podsApi.list({namespace: this.props.object.getName()});
+  }
+
+  render() {
+    return (
+      <div>
+        <Component.DrawerTitle title="Pods" />
+        <PodsDetailsList pods={this.pods}/>
+      </div>
+    )
+  }
+}
+
    +

    Since NamespaceDetailsItem extends React.Component<Component.KubeObjectDetailsProps<K8sApi.Namespace>> it can access the current namespace object (type K8sApi.Namespace) through this.props.object. +This object can be queried for many details about the current namespace. +In this example the namespace's name is obtained in componentDidMount() using the K8sApi.Namespace getName() method. +The namespace's name is needed to limit the list of pods to only those in this namespace. +To get the list of pods this example uses the kubernetes pods api, specifically the K8sApi.podsApi.list() method. +The K8sApi.podsApi is automatically configured for the currently active cluster.

    +

    Note that K8sApi.podsApi.list() is an asynchronous method, and ideally getting the pods list should be done before rendering the NamespaceDetailsItem. +It is a common technique in React development to await async calls in componentDidMount(). +However, componentDidMount() is called right after the first call to render(). +In order to effect a subsequent render() call React must be made aware of a state change. +Like in the appPreferences guide, mobx and mobx-react are used to ensure NamespaceDetailsItem renders when the pods list is updated. +This is done simply by marking the pods field as an observable and the NamespaceDetailsItem class itself as an observer.

    +

    Finally, the NamespaceDetailsItem is rendered using the render() method. +Details are placed in drawers, and using Component.DrawerTitle provides a separator from details above this one. +Multiple details in a drawer can be placed in <Component.DrawerItem> elements for further separation, if desired. +The rest of this example's details are defined in PodsDetailsList, found in ./pods-details-list.tsx:

    +
    import React from "react";
+import { Component, K8sApi } from "@k8slens/extensions";
+
+interface Props {
+  pods: K8sApi.Pod[];
+}
+
+export class PodsDetailsList extends React.Component<Props> {
+
+  getTableRow(index: number) {
+      const {pods} = this.props;
+      return (
+          <Component.TableRow key={index} nowrap>
+              <Component.TableCell className="podName">{pods[index].getName()}</Component.TableCell>
+              <Component.TableCell className="podAge">{pods[index].getAge()}</Component.TableCell>
+              <Component.TableCell className="podStatus">{pods[index].getStatus()}</Component.TableCell>
+          </Component.TableRow>
+      )
+  }
+
+  render() {
+      const {pods} = this.props
+      if (!pods?.length) {
+          return null;
+      }
+
+      return (
+          <div >
+              <Component.Table>
+                  <Component.TableHead>
+                      <Component.TableCell className="podName">Name</Component.TableCell>
+                      <Component.TableCell className="podAge">Age</Component.TableCell>
+                      <Component.TableCell className="podStatus">Status</Component.TableCell>
+                  </Component.TableHead>
+                  {
+                      pods.map((pod, index) => this.getTableRow(index))
+                  }
+              </Component.Table>
+          </div>
+      )
+  }
+}
+
    +

    PodsDetailsList produces a simple table showing a list of the pods found in this namespace:

    +

    DetailsWithPods

    +

    For each pod the name, age, and status are obtained using the K8sApi.Pod methods. +The table is constructed using the Component.Table and related elements. +See Component documentation for further details.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/guides/stores/index.html b/v4.0.1/extensions/guides/stores/index.html new file mode 100644 index 0000000000..66233b2430 --- /dev/null +++ b/v4.0.1/extensions/guides/stores/index.html @@ -0,0 +1,1127 @@ + + + + + + + + + + + + + + + + + + + + + + Stores - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Stores#

    +

    Stores are components that persist and synchronize state data. Lens utilizes a number of stores for maintaining a variety of state information. +A few of these are exposed by the extensions api for use by the extension developer.

    +
      +
    • The ClusterStore manages cluster state data such as cluster details, and which cluster is active.
      • +
    • The WorkspaceStore similarly manages workspace state data, such as workspace name, and which clusters belong to a given workspace.
      • +
    • The ExtensionStore is a store for managing custom extension state data.
      • +
    +

    ExtensionStore#

    +

    Extension developers can create their own store for managing state data by extending the ExtensionStore class. +This guide shows how to create a store for the appPreferences guide example, which demonstrates how to add a custom preference to the Preferences page. +The preference is a simple boolean that indicates whether something is enabled or not. +The problem with that example is that the enabled state is not stored anywhere, and reverts to the default the next time Lens is started.

    +

    The following example code creates a store for the appPreferences guide example:

    +
    import { Store } from "@k8slens/extensions";
+import { observable, toJS } from "mobx";
+
+export type ExamplePreferencesModel = {
+  enabled: boolean;
+};
+
+export class ExamplePreferencesStore extends Store.ExtensionStore<ExamplePreferencesModel> {
+
+  @observable  enabled = false;
+
+  private constructor() {
+    super({
+      configName: "example-preferences-store",
+      defaults: {
+        enabled: false
+      }
+    });
+  }
+
+  protected fromStore({ enabled }: ExamplePreferencesModel): void {
+    this.enabled = enabled;
+  }
+
+  toJSON(): ExamplePreferencesModel {
+    return toJS({
+      enabled: this.enabled
+    }, {
+      recurseEverything: true
+    });
+  }
+}
+
+export const examplePreferencesStore = ExamplePreferencesStore.getInstance<ExamplePreferencesStore>();
+
    +

    First the extension's data model is defined using a simple type, ExamplePreferencesModel, which has a single field, enabled, representing the preference's state. +ExamplePreferencesStore extends Store.ExtensionStore, based on the ExamplePreferencesModel. +The field enabled is added to the ExamplePreferencesStore class to hold the "live" or current state of the preference. +Note the use of the observer decorator on the enabled field. +As for the appPreferences guide example, mobx is used for the UI state management, ensuring the checkbox updates when activated by the user.

    +

    Then the constructor and two abstract methods are implemented. +In the constructor, the name of the store ("example-preferences-store"), and the default (initial) value for the preference state (enabled: false) are specified. +The fromStore() method is called by Lens internals when the store is loaded, and gives the extension the opportunity to retrieve the stored state data values based on the defined data model. +Here, the enabled field of the ExamplePreferencesStore is set to the value from the store whenever fromStore() is invoked. +The toJSON() method is complementary to fromStore(), and is called when the store is being saved. +toJSON() must provide a JSON serializable object, facilitating its storage in JSON format. +The toJS() function from mobx is convenient for this purpose, and is used here.

    +

    Finally, examplePreferencesStore is created by calling ExamplePreferencesStore.getInstance<ExamplePreferencesStore>(), and exported for use by other parts of the extension. +Note that examplePreferencesStore is a singleton, calling this function again will not create a new store.

    +

    The following example code, modified from the appPreferences guide example demonstrates how to use the extension store. +examplePreferencesStore must be loaded in the main process, where loaded stores are automatically saved when exiting Lens. This can be done in ./main.ts:

    +
    import { LensMainExtension } from "@k8slens/extensions";
+import { examplePreferencesStore } from "./src/example-preference-store";
+
+export default class ExampleMainExtension extends LensMainExtension {
+  async onActivate() {
+    await examplePreferencesStore.loadExtension(this);
+  }
+}
+
    +

    Here, examplePreferencesStore is loaded with examplePreferencesStore.loadExtension(this), which is conveniently called from the onActivate() method of ExampleMainExtension. +Similarly, examplePreferencesStore must be loaded in the renderer process where the appPreferences are handled. This can be done in ./renderer.ts:

    +
    import { LensRendererExtension } from "@k8slens/extensions";
+import { ExamplePreferenceHint, ExamplePreferenceInput } from "./src/example-preference";
+import { examplePreferencesStore } from "./src/example-preference-store";
+import React from "react";
+
+export default class ExampleRendererExtension extends LensRendererExtension {
+
+  async onActivate() {
+    await examplePreferencesStore.loadExtension(this);
+  }
+
+  appPreferences = [
+    {
+      title: "Example Preferences",
+      components: {
+        Input: () => <ExamplePreferenceInput preference={examplePreferencesStore}/>,
+        Hint: () => <ExamplePreferenceHint/>
+      }
+    }
+  ];
+}
+
    +

    Again, examplePreferencesStore.loadExtension(this) is called to load examplePreferencesStore, this time from the onActivate() method of ExampleRendererExtension. +Also, there is no longer the need for the preference field in the ExampleRendererExtension class, as the props for ExamplePreferenceInput is now examplePreferencesStore. +ExamplePreferenceInput is defined in ./src/example-preference.tsx:

    +
    import { Component } from "@k8slens/extensions";
+import { observer } from "mobx-react";
+import React from "react";
+import { ExamplePreferencesStore } from "./example-preference-store";
+
+export class ExamplePreferenceProps {
+  preference: ExamplePreferencesStore;
+}
+
+@observer
+export class ExamplePreferenceInput extends React.Component<ExamplePreferenceProps> {
+
+  render() {
+    const { preference } = this.props;
+
+    return (
+      <Component.Checkbox
+        label="I understand appPreferences"
+        value={preference.enabled}
+        onChange={v => { preference.enabled = v; }}
+      />
+    );
+  }
+}
+
+export class ExamplePreferenceHint extends React.Component {
+  render() {
+    return (
+      <span>This is an example of an appPreference for extensions.</span>
+    );
+  }
+}
+
    +

    The only change here is that ExamplePreferenceProps defines its preference field as an ExamplePreferencesStore type. +Everything else works as before except now the enabled state persists across Lens restarts because it is managed by the +examplePreferencesStore.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/guides/working-with-mobx/index.html b/v4.0.1/extensions/guides/working-with-mobx/index.html new file mode 100644 index 0000000000..a66a54fb1d --- /dev/null +++ b/v4.0.1/extensions/guides/working-with-mobx/index.html @@ -0,0 +1,1023 @@ + + + + + + + + + + + + + + + + + + + + + + Working with mobx - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Working with mobx#

    +

    Introduction#

    +

    Lens uses mobx as its state manager on top of React's state management system. +This helps with having a more declarative style of managing state, as opposed to React's native setState mechanism. +You should already have a basic understanding of how React handles state (read here for more information). +However, if you do not, here is a quick overview.

    +
      +
    • A React.Component is generic over both Props and State (with default empty object types).
      • +
    • Props should be considered read-only from the point of view of the component and is the mechanism for passing in "arguments" to a component.
      • +
    • State is a component's internal state and can be read by accessing the parent field state.
      • +
    • State must be updated using the setState parent method which merges the new data with the old state.
      • +
    • React does do some optimizations around re-rendering components after quick successions of setState calls.
      • +
    +

    How mobx works:#

    +

    mobx is a package that provides an abstraction over React's state management. The three main concepts are: +- observable: data stored in the component's state +- action: a function that modifies any observable data +- computed: data that is derived from observable data but is not actually stored. Think of this as computing isEmpty vs an observable field called count.

    +

    Further reading is available from mobx's website.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/index.html b/v4.0.1/extensions/index.html new file mode 100644 index 0000000000..8e7ab470e2 --- /dev/null +++ b/v4.0.1/extensions/index.html @@ -0,0 +1,1075 @@ + + + + + + + + + + + + + + + + + + + + + + Overview - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Lens Extension API#

    +

    Customize and enhance the Lens experience with the Lens Extension API. Use the extension API to create menus or page content. The same extension API was used to create many of Lens's core features.

    +

    This documentation describes:

    +
      +
    • How to build, run, test, and publish an extension.
      • +
    • How to take full advantage of the Lens Extension API.
      • +
    • Where to find guides and code samples to help get you started.
      • +
    +

    What Extensions Can Do#

    +

    Here are some examples of what you can achieve with the Extension API:

    +
      +
    • Add custom components & views in the UI - Extending the Lens Workbench
      • +
    +

    For an overview of the Lens Extension API, refer to the Common Capabilities page. Extension Guides Overview also includes a list of code samples and guides that illustrate various ways of using the Lens Extension API.

    +

    How to Build Extensions#

    +

    Here is what each section of the Lens Extension API docs can help you with:

    +
      +
    • Getting Started teaches fundamental concepts for building extensions with the Hello World sample.
      • +
    • Extension Capabilities dissects Lens's Extension API into smaller categories and points you to more detailed topics.
      • +
    • Extension Guides includes guides and code samples that explain specific usages of Lens Extension API.
      • +
    • Testing and Publishing includes in-depth guides on various extension development topics, such as testing and publishing extensions.
      • +
    • API Reference contains exhaustive references for the Lens Extension API, Contribution Points, and many other topics.
      • +
    +

    What's New#

    +

    Just like Lens itself, the extension API updates on a monthly cadence, rolling out new features with every release.

    +

    Keep up with Lens and the Lens Extension API by reviewing the release notes.

    +

    Looking for Help#

    +

    If you have questions for extension development, try asking on the Lens Dev Slack. It's a public chatroom for Lens developers, where Lens team members chime in from time to time.

    +

    To provide feedback on the documentation or issues with the Lens Extension API, create new issues at lensapp/lens. Please use the labels area/documentation and/or area/extension.

    +

    Downloading Lens#

    +

    Download Lens for macOS, Windows, or Linux.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/testing-and-publishing/bundling/index.html b/v4.0.1/extensions/testing-and-publishing/bundling/index.html new file mode 100644 index 0000000000..695330de32 --- /dev/null +++ b/v4.0.1/extensions/testing-and-publishing/bundling/index.html @@ -0,0 +1,875 @@ + + + + + + + + + + + + + + + + + + + + + + Bundling - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + +
    +
    + + + +

    Bundling

    + + + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/testing-and-publishing/publishing/index.html b/v4.0.1/extensions/testing-and-publishing/publishing/index.html new file mode 100644 index 0000000000..6aadfb7045 --- /dev/null +++ b/v4.0.1/extensions/testing-and-publishing/publishing/index.html @@ -0,0 +1,1074 @@ + + + + + + + + + + + + + + + + + + + + + + Publishing Extensions - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Publishing Extensions#

    +

    To be able to easily share extensions with users they need to be published somewhere. +Lens currently only supports installing extensions from NPM tarballs. +All hosted extensions must, therefore, be retrievable in a NPM tarball.

    +

    Places To Host Your Extension#

    +

    We recommend to host your extension somewhere on the web so that it is easy for people to search for and download it. +We recommend either hosting it as an NPM package on https://www.npmjs.com or through GitHub releases. +We recommend against using GitHub packages (https://github.com/features/packages) as it requires a GitHub token to access the package.

    +

    Publishing via NPM#

    +

    This is the easiest method of publishing as NPM comes built in with mechanism to get a link to download the package as a tarball. +Once you have set up an account with NPM (https://www.npmjs.com/signup) and logged in with their CLI (npm login) you will be ready to publish.

    +
      +
    • Run npm version <major|minor|patch> to bump the version of your extension by the appropriate amount.
      • +
    • Run npm publish to publish your extension to NPM
      • +
    • Run git push && git push --tags to push the commit that NPM creates to your git remote.
      • +
    +

    It is probably a good idea to put into your README.md the following instructions for your users to get the tarball download link.

    +
    npm view <extension-name> dist.tarball
+
    +

    This will output the link that they will need to give to Lens to install your extension.

    +

    Publish via GitHub Releases#

    +

    Another method of publishing your extensions is to do so with the releases mechanism built into GitHub. +We recommend reading GitHub's Releases Documentation for how to actually do the steps of a release. +The following will be a quick walk through on how to make the tarball which will be the released file.

    +

    Making a NPM Tarball of Your Extension#

    +

    While this is necessary for hosting on GitHub releases, this is also the means for creating a tarball if you plan on hosting on a different file hosting platform.

    +

    Say you have your project folder at ~/my-extension/ and you want to create an NPM package we need to do the following within your git repo:

    +
    npm pack
+
    +

    This will create a NPM tarball that can be hosted on Github Releases or any other publicly available file hosting service.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/testing-and-publishing/testing/index.html b/v4.0.1/extensions/testing-and-publishing/testing/index.html new file mode 100644 index 0000000000..98070834c8 --- /dev/null +++ b/v4.0.1/extensions/testing-and-publishing/testing/index.html @@ -0,0 +1,1127 @@ + + + + + + + + + + + + + + + + + + + + + + Testing Extensions - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Testing Extensions#

    +

    Renderer Process Unit Testing#

    +

    UI components in extension renderer process are based on React/ReactDOM. These components can be tested by popular React testing tools like React Testing Library.

    +

    If you are using the Yeoman Lens Extension Generator to scaffold extension project. The testing environment for render process are already setup for you. Just use npm start or yarn test to run the tests.

    +

    For example, I have a component GlobalPageMenuIcon and want to test if props.navigate is called when user clicks the icon.

    +

    My component GlobalPageMenuIcon

    +
    import React from "react"
+import { Component: { Icon } } from "@k8slens/extensions";
+
+const GlobalPageMenuIcon = ({ navigate }: { navigate?: () => void }): JSX.Element => (
+  <Icon
+    material="trip_origin"
+    onClick={() => navigate()}
+    data-testid="global-page-menu-icon"
+  />
+)
+
    +

    The test

    +
    import React from "react"
+import { render, screen, fireEvent } from "@testing-library/react";
+
+import GlobalPageMenuIcon from "./GlobalPageMenuIcon";
+
+test("click called navigate()", () => {
+    const navigate = jest.fn();
+    render(<GlobalPageMenuIcon navigate={navigate} />);
+    fireEvent.click(screen.getByTestId("global-page-menu-icon"));
+    expect(navigate).toHaveBeenCalled();
+  });
+
    +

    In the example we used React Testing Library but any React testing framework can be used to test renderer process UI components.

    +

    There are more example tests in the generator's template. Extend your tests based on the examples.

    +

    Main Process Unit Testing#

    +

    Code in the extension main process are just normal JavaScript files that has access to extension api, you can write unit tests using any testing framework.

    +

    If you are using the Yeoman Lens Extension Generator to scaffold your extension project. The testing environment Jest are setup for you. Just use npm start or yarn test to run the tests.

    +

    Tips#

    +

    Console.log#

    +

    Extension developers might find console.log() useful for printing out information and errors from extensions. To use console.log(), note that Lens is based on Electron, and that Electron has two types of processes: Main and Renderer.

    +

    Renderer Process Logs#

    +

    In the Renderer process, console.log() is printed in the Console in Developer Tools (View > Toggle Developer Tools).

    +

    Main Process Logs#

    +

    Viewing the logs from the Main process is a little trickier, since they cannot be printed using Developer Tools.

    +

    macOS

    +

    On macOS, view the Main process logs by running Lens from the terminal:

    +
    /Applications/Lens.app/Contents/MacOS/Lens
+
    +

    You can also use Console.app to view the Main process logs.

    +

    Linux

    +

    On Linux, you can access the Main process logs using the Lens PID. First get the PID:

    +
    ps aux | grep Lens | grep -v grep
+
    +

    Then get the Main process logs using the PID:

    +
    tail -f /proc/[pid]/fd/1 # stdout (console.log)
+tail -f /proc/[pid]/fd/2 # stdout (console.error)
+
    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/extensions/typedoc-readme.md.tpl b/v4.0.1/extensions/typedoc-readme.md.tpl new file mode 100644 index 0000000000..6e23d197d5 --- /dev/null +++ b/v4.0.1/extensions/typedoc-readme.md.tpl @@ -0,0 +1,18 @@ +# Extension API Reference + +## Modules + +* [App](modules/_core_api_app_.md) +* [ClusterFeature](modules/_core_api_cluster_feature_.md) +* [EventBus](modules/_core_api_event_bus_.md) +* [Store](modules/_core_api_stores_.md) +* [Util](modules/_core_api_utils_.md) +* [Component](modules/_renderer_api_components_.md) +* [K8sApi](modules/_renderer_api_k8s_api_.md) +* [Navigation](modules/_renderer_api_navigation_.md) + +## Classes + +* [LensMainExtension](classes/lensmainextension.md) +* [LensRendererExtension](classes/lensrendererextension.md) + diff --git a/v4.0.1/extensions/usage/images/extensions.png b/v4.0.1/extensions/usage/images/extensions.png new file mode 100644 index 0000000000..5deb8e4bd2 Binary files /dev/null and b/v4.0.1/extensions/usage/images/extensions.png differ diff --git a/v4.0.1/extensions/usage/index.html b/v4.0.1/extensions/usage/index.html new file mode 100644 index 0000000000..d54873e4a1 --- /dev/null +++ b/v4.0.1/extensions/usage/index.html @@ -0,0 +1,1032 @@ + + + + + + + + + + + + + + + + + + + + + + Using Extensions - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Using Extensions#

    +

    The features that Lens includes out-of-the-box are just the start. +Lens extensions let you add new features to your installation to support your workflow. +Rich extensibility model lets extension authors plug directly into the Lens UI and contribute functionality through the same APIs used by Lens itself. +The start using Lens Extensions go to File (or Lens on macOS) > Extensions in the application menu. +This is the Extensions management page where all the management of the extensions you want to use is done.

    +

    Extensions

    +

    Installing an Extension#

    +

    There are three ways to install extensions. +If you have the extension as a .tgz file then dragging and dropping it in the extension management page will install it for you. +If it is hosted on the web, you can paste the URL and click Install and Lens will download and install it. +The third way is to move the extension into your ~/.k8slens/extensions (or C:\Users\<user>\.k8slens\extensions) folder and Lens will automatically detect it and install the extension.

    +

    Enabling or Disabling an Extension#

    +

    Go to the extension management page and click either the Enable or Disable buttons. +Extensions will be enabled by default when you first install them. +A disabled extension is not loaded by Lens and is not run.

    +

    Uninstalling an Extension#

    +

    If, for whatever reason, you wish to remove the installation of an extension simple click the Uninstall button. This will remove all the files that Lens would need to run the extension.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/faq/index.html b/v4.0.1/faq/index.html new file mode 100644 index 0000000000..721af409c3 --- /dev/null +++ b/v4.0.1/faq/index.html @@ -0,0 +1,1123 @@ + + + + + + + + + + + + + + + + + + + + + + FAQ - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    FAQ#

    +

    What operating systems does Lens support?#

    +

    Lens supports MacOS, Windows and Linux operating systems. For Linux there are Snap and AppImage versions. For MacOS there are DMG and Homebrew options.

    +

    Lens application is not opening, what might be wrong?#

    +

    When Lens is started, it will start HTTP proxy server on the background and requires that operating system allows to start listening to some free port. You can see the port allocated for Lens from application logs. Lens expects also that localhost DNS points to 127.0.0.1 address.

    +

    Why can't I add any clusters?#

    +

    When adding new clusters, a valid Kubeconfig file is required. Please check that all contexts present in Kubeconfig file are valid.

    +

    Why Cluster dashboard is not opening?#

    +

    To see Cluster dashboard properly, Kubernetes cluster must be reachable either directly from your computer or via HTTP proxy. You can configure HTTP proxy in Cluster Settigns. Also, provided credentials in Kubeconfig must be valid. If Kubeconfig uses exec command, the binary must be available in global PATH or absolute path must be used. Lens application can't see PATH modifications made by any shell init scripts. There might be also some issues on the Snap version if the exec binary is installed also from Snap and requires additional symlinking, please see #699.

    +

    Why I don't see anything on Cluster dashboard?#

    +

    Users will see on Cluster dashboard only those resources that they are allowed to see (RBAC). Lens requires that user has access at least to one namespace. Lens tries first fetch namespaces from Kubernetes API. If user is not allowed to list namespaces, allowed namespaces can be configured in Cluster settings or in Kubeconfig.

    +

    Why I don't see any metrics or some of the metrics are not working?#

    +

    In order to display cluster metrics, Lens requires that Prometheus is running in the cluster. You can install Prometheus in Cluster settings if needed.

    +

    Lens tries to detect Prometheus installation automatically. If it fails to detect the installation properly, you can configure Prometheus service address in Cluster settings. If some of the metrics are not displayed correctly, you can see queries that Lens is using here and adapt your prometheus configuration to support those queries. Please refer Prometheus documentation or your Prometheus installer documentation how to do this.

    +

    Kubectl is not working in Lens terminal, what should I do?#

    +

    Lens tries to download correct Kubectl version for the cluster and use that in Lens terminal. Some operating systems (namely Windows) might have restrictions set that prevent downloading and executing binaries from the default location that Lens is using. You can change the directory where Lens downloads the binaries in App Preferences. It's also possible to change the Download mirror to use Azure if default Google is not reachable from your network. If downloading Kubectl is not option for you, you can define path to pre-installed Kubectl on your machine and Lens will use that binary instead.

    +

    How can I configure Helm repositories?#

    +

    Lens comes with bundled Helm 3 binary and Lens will add by default bitnami repository if no other repositories are configured. You can add more repositories from Artifact HUB in App preferences. At this moment it is not possible to add private repositories. Those and other public repositories can be added manually via command line.

    +

    Where can I find application logs?#

    +

    Lens will store application logs to following locations depending on your operating system: +- MacOS: ~/Library/Logs/Lens/ +- Windows: %USERPROFILE%\AppData\Roaming\Lens\logs\ +- Linux: ~/.config/Lens/logs/

    +

    How can I see more verbose logs?#

    +

    You can start Lens application on debug mode from the command line to see more verbose logs. To start application on debug mode, please provide DEBUG=true environment variable and before starting the application, for example: DEBUG=TRUE /Applications/Lens.app/Contents/MacOS/Lens

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/getting-started/images/color-theme.png b/v4.0.1/getting-started/images/color-theme.png new file mode 100644 index 0000000000..5e4f144560 Binary files /dev/null and b/v4.0.1/getting-started/images/color-theme.png differ diff --git a/v4.0.1/getting-started/images/disabled-telemetry-usage-tracking.png b/v4.0.1/getting-started/images/disabled-telemetry-usage-tracking.png new file mode 100644 index 0000000000..809a96056a Binary files /dev/null and b/v4.0.1/getting-started/images/disabled-telemetry-usage-tracking.png differ diff --git a/v4.0.1/getting-started/images/snap-store.png b/v4.0.1/getting-started/images/snap-store.png new file mode 100644 index 0000000000..5e652132c3 Binary files /dev/null and b/v4.0.1/getting-started/images/snap-store.png differ diff --git a/v4.0.1/getting-started/index.html b/v4.0.1/getting-started/index.html new file mode 100644 index 0000000000..d58119479b --- /dev/null +++ b/v4.0.1/getting-started/index.html @@ -0,0 +1,1116 @@ + + + + + + + + + + + + + + + + + + + + + + Getting Started - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Getting Started#

    +

    Lens is lightweight and simple to install. You'll be up and running in just a few minutes.

    +

    System Requirements#

    +

    Review the System Requirements to check if your computer configuration is supported.

    +

    macOS#

    +
      +
    1. Download Lens for macOS.
      2. +
    2. Open the browser's download list and locate the downloaded archive.
      3. +
    3. Select the 'magnifying glass' icon to open the archive in Finder.
      4. +
    4. Double-click Lens-{version}.dmg and drag Lens.app to the Applications folder, making it available in the macOS Launchpad.
      5. +
    5. Add Lens to your Dock by right-clicking on the icon to bring up the context menu and choosing Options, Keep in Dock.
      6. +
    +

    Windows#

    +
      +
    1. Download the Lens installer for Windows.
      2. +
    2. Once it is downloaded, run the installer Lens-Setup-{version}.exe. This will only take a minute.
      3. +
    3. By default, Lens is installed under C:\users\{username}\AppData\Local\Programs\Lens.
      4. +
    +

    Linux#

    +

    See the Download Lens page for a complete list of available installation options.

    +

    Snap#

    +

    Lens is officially distributed as a Snap package in the Snap Store:

    +

    Get it from the Snap Store

    +

    You can install it by running:

    +
    sudo snap install kontena-lens --classic
+
    +

    Update Cadence#

    +

    Lens releases a new version each month with new features and important bug fixes. Lens supports auto updating and you will be prompted to install the new release when it becomes available!

    +

    To stay current with the Lens features, you can review the release notes.

    +

    Next Steps#

    + + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/getting-started/introductory-videos/index.html b/v4.0.1/getting-started/introductory-videos/index.html new file mode 100644 index 0000000000..5af60ccc38 --- /dev/null +++ b/v4.0.1/getting-started/introductory-videos/index.html @@ -0,0 +1,917 @@ + + + + + + + + + + + + + + + + + + + + + + Introductory Videos - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + + + +
    + +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/getting-started/preferences/index.html b/v4.0.1/getting-started/preferences/index.html new file mode 100644 index 0000000000..1af14c5219 --- /dev/null +++ b/v4.0.1/getting-started/preferences/index.html @@ -0,0 +1,1045 @@ + + + + + + + + + + + + + + + + + + + + + + Preferences - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Preferences#

    +

    Color Themes#

    +

    The Color Themes option in Lens preferences lets you set the colors in the Lens user interface to suit your liking.

    +
      +
    1. Go to File > Preferences (Lens > Preferences on Mac).
      2. +
    2. Select your preferred theme from the Color Theme dropdown. +Color Theme
      3. +
    +

    Telemetry & Usage Tracking#

    +

    Lens collects telemetry data, which is used to help us understand how to improve the product. For example, this usage data helps us to debug issues and to prioritize new features. While we appreciate the insights this data provides, we also know that not everyone wants to send usage data. Please see our privacy statement to learn more.

    +

    Disable Telemetry Reporting#

    +

    If you don't wish to send usage data to Mirantis, you can disable the "Telemetry & Usage Tracking" in the Lens preferences.

    +
      +
    1. Go to File > Preferences (Lens > Preferences on Mac).
      2. +
    2. Scroll down to Telemetry & Usage Tracking
      3. +
    3. Uncheck Allow Telemetry & Usage Tracking.
      4. +
    +

    This will silence all telemetry events from Lens going forward. Telemetry information may have been collected and sent up until the point when you disable this setting. +Disable Telemetry & Usage Tracking

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/helm/images/helm-charts.png b/v4.0.1/helm/images/helm-charts.png new file mode 100644 index 0000000000..93548fca9e Binary files /dev/null and b/v4.0.1/helm/images/helm-charts.png differ diff --git a/v4.0.1/helm/index.html b/v4.0.1/helm/index.html new file mode 100644 index 0000000000..eae2c310f2 --- /dev/null +++ b/v4.0.1/helm/index.html @@ -0,0 +1,1039 @@ + + + + + + + + + + + + + + + + + + + + + + Using Helm Charts - Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    Using Helm Charts#

    +

    Lens has integration to Helm making it easy to install and manage Helm charts and releases in Apps section.

    +

    Helm Charts

    +

    Managing Helm Reporistories#

    +

    Used Helm repositories are possible to configure in the Preferences. Lens app will fetch available Helm repositories from the Artifact HUB and automatically add bitnami repository by default if no other repositories are already configured. If any other repositories are needed to add, those can be added manually via command line. Note! Configured Helm repositories are added globally to user's computer, so other processes can see those as well.

    +

    Installing a Helm Chart#

    +

    Lens will list all charts from configured Helm repositries on Apps section. To install a chart, you need to select a chart and click "Install" button. Lens will open the chart in the editor where you can select a chart version, target namespace and give optionally a name for the release and configure values for the release. Finally, by clicking "Install" button Lens will deploy the chart into the cluster.

    +

    Updating a Helm Release#

    +

    To update a Helm release, you can open the release details and modify the release values and click "Save" button. To upgrade or downgrade the release, click "Upgrade" button in the release details. In the release editor you can select a new chart version and edit the release values if needed and then click "Upgrade" or "Upgrade and Close" button.

    +

    Deleting a Helm Release#

    +

    To delete existing Helm release open the release details and click trash can icon on the top of the panel. Deletion removes all Kubernetes resources created by the Helm release. Note! If the release included any persistent volumes, those are required to remove manually!

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/img/favicon.ico b/v4.0.1/img/favicon.ico new file mode 100644 index 0000000000..19b2de71d1 Binary files /dev/null and b/v4.0.1/img/favicon.ico differ diff --git a/v4.0.1/img/lens-intro-video-screenshot.png b/v4.0.1/img/lens-intro-video-screenshot.png new file mode 100644 index 0000000000..2c5467b3f0 Binary files /dev/null and b/v4.0.1/img/lens-intro-video-screenshot.png differ diff --git a/v4.0.1/img/lens-logo-icon.svg b/v4.0.1/img/lens-logo-icon.svg new file mode 100644 index 0000000000..ede39244e5 --- /dev/null +++ b/v4.0.1/img/lens-logo-icon.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + diff --git a/v4.0.1/img/play.svg b/v4.0.1/img/play.svg new file mode 100644 index 0000000000..a94d6e88ab --- /dev/null +++ b/v4.0.1/img/play.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/v4.0.1/index.html b/v4.0.1/index.html new file mode 100644 index 0000000000..3330334f75 --- /dev/null +++ b/v4.0.1/index.html @@ -0,0 +1,1000 @@ + + + + + + + + + + + + + + + + + + + + + + Lens Documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    + + + + Skip to content + + +
    +
    + +
    + + + +
    + +
    + +
    + + + + +
    +
    + + +
    +
    +
    + + + +
    +
    +
    + + + + + + + +
    +
    +
    + + +
    +
    +
    + + + +
    +
    + + + +

    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:

    +

    Screenshot

    +

    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.

    + + + + + + + +
    +
    +
    +
    + + + + +
    + + + + + + + + + \ No newline at end of file diff --git a/v4.0.1/search/search_index.json b/v4.0.1/search/search_index.json new file mode 100644 index 0000000000..1c66258f2f --- /dev/null +++ b/v4.0.1/search/search_index.json @@ -0,0 +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). 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). 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 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/#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